Chat (Experimental API)

class ChatService

For interacting with Chat objects

delete(id_)

Delete a Chat by its id

Parameters:

id_ (str) –

get(id_, formatter=None)

Return a Chat by its id

Parameters:

• id_ (str) –

• formatter (InlineAttributionFormatter | None) –

Return type:

Chat

list(formatter=None)

Parameters:

formatter (InlineAttributionFormatter | None) –

Return type:

list[Chat]

new(name, formatter=None)

Create a new chat

Parameters:

• name (str) –

• formatter (InlineAttributionFormatter | None) –

Return type:

Chat

class ChatInteraction

Represents a single interaction with chat

field answer: str [Required]

field date_created: datetime [Required]

field interaction_timestamp: str [Required]

field last_updated: datetime [Required]

field question: str [Required]

field scope: ChatScope | None = None

Validated by:

• validate_scope

field sources: list[ChatSource] [Optional]

validator validate_scope  »  scope

class StreamingChatInteraction

Represents a streaming interaction in a chat session.

This class handles live interactions where the response is obtained in chunks, allowing for real-time processing while the interaction is ongoing.

__init__(_chat, _formatter, **values)

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

model_post_init(context, /)

This function is meant to behave like a BaseModel method to initialise private attributes.

It takes context as an argument since that’s what pydantic-core passes when calling it.

Parameters:

• self (BaseModel) – The BaseModel instance.

• context (Any) – The context.

Return type:

None

class Chat

ask(question, *, scope=None, formatter=None, streaming=False)

Ask a question in the chat

Parameters:

• question (str) –

• scope (ChatScope | None) –

• formatter (InlineAttributionFormatter | None) –

• streaming (bool) –

Return type:

ChatInteraction | StreamingChatInteraction

field date_created: datetime [Required]

delete()

Delete the chat

field id: str [Required]

property interactions: list[ChatInteraction]

field last_updated: datetime [Required]

field name: str [Required]

field user_id: str [Required]

class ChatScope

EARNING_CALLS = 'transcripts'

FILES = 'files'

NEWS = 'news'

REGULATORY_FILINGS = 'filings'

__new__(value)

class ChatSource

Represents a source in a chat message

field document_scope: str | None [Required]

field headline: str [Required]

field id: str [Required]

field rp_provider_id: str | None [Required]

field url: str | None [Required]

class InlineAttributionFormatter

Interface for formatting inline attributions in chat messages

abstract format(index, source)

Format an inline attribution.

Parameters:

• index (int) – The index of the attribution within the list of attributions.

• source (ChatSource) – The inline attribution to format.

Returns:

A string representing the formatted attribution.

Return type:

str

class DefaultFormatter

Default formatter for inline attributions in chat messages

format(index, source)

Format an inline attribution using a default reference style.

Parameters:

• index (int) – The index of the attribution within the list of attributions.

• source (ChatSource) – The inline attribution to format.

Returns:

A string representing the formatted attribution in default reference style.

Return type:

str

class MarkdownLinkFormatter

Formatter for inline attributions in chat messages that uses Markdown links

__init__(headline_length=None, skip_empty_urls=True)

Initialize the MarkdownLinkInlineAttributionFormatter.

Parameters:

• headline_length (int) – The maximum length of the headline to be displayed in the link. Default is 10.

• skip_empty_urls (bool) –

format(index, source)

Format an inline attribution as a Markdown link.

Parameters:

• index (int) – The index of the attribution within the list of attributions.

• source (ChatSource) – The inline attribution to format.

Returns:

A string representing the formatted attribution as a Markdown link.

Return type:

str