Interface Conversation

interface Conversation {
    createdAt: string;
    id: string;
    listMessages: ((input?) => ListReturnValue<ConversationMessage>);
    metadata?: Record<string, any>;
    name?: string;
    onStreamEvent: ((handler) => Subscription);
    sendMessage: ((input) => SingularReturnValue<ConversationMessage>);
    updatedAt: string;
}

Index

Properties

createdAt id listMessages metadata? name? onStreamEvent sendMessage updatedAt

Properties

createdAt

createdAt: string

id

id: string

listMessages

listMessages: ((input?) => ListReturnValue<ConversationMessage>)

Lists all existing messages for the current conversation.

Type declaration

- (input?): ListReturnValue<ConversationMessage>
- Lists all existing messages for the current conversation.
  Parameters
  - Optional input: ConversationListMessagesInput
  Returns ListReturnValue<ConversationMessage>

`Optional` metadata

metadata?: Record<string, any>

`Optional` name

name?: string

onStreamEvent

onStreamEvent: ((handler) => Subscription)

Subscribes to new stream events on the current conversation.

Type declaration

- (handler): Subscription
- Subscribes to new stream events on the current conversation.
  Parameters
  - handler: ConversationOnStreamEventHandler
  Returns Subscription

sendMessage

sendMessage: ((input) => SingularReturnValue<ConversationMessage>)

Sends a message to the current conversation.

Type declaration

- (input): SingularReturnValue<ConversationMessage>
- Sends a message to the current conversation.
  Parameters
  - input: ConversationSendMessageInput
  Returns SingularReturnValue<ConversationMessage>

updatedAt

updatedAt: string