Class ConversationResource

Resource for managing conversations and interactions.

Index

Constructors

Methods

create createConversation finish finishConversation generateConversationStarters getConversationMessages getConversations getInteractionInsights getMessageSource interact interactWithConversation list messages recommendResponsesForInteraction

Constructors

constructor

new ConversationResource(c: AmigoFetch, orgId: OrgId): ConversationResource
Parameters
- c: AmigoFetch
- orgId: OrgId
Returns ConversationResource
- Defined in resources/conversation.ts:17

Methods

create

create(
options: { body: {}; headers?: {}; query: {}; signal?: AbortSignal },
): Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
Alias for createConversation.
Parameters
- options: { body: {}; headers?: {}; query: {}; signal?: AbortSignal }
Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
- Defined in resources/conversation.ts:274

createConversation

createConversation(
options: { body: {}; headers?: {}; query: {}; signal?: AbortSignal },
): Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
Create a new conversation and return an async stream of NDJSON events.
Parameters
- options: { body: {}; headers?: {}; query: {}; signal?: AbortSignal }
Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
- Defined in resources/conversation.ts:23

finish

finish(options: { conversationId: ConversationId; headers?: {} }): Promise<void>
Alias for finishConversation.
Parameters
- options: { conversationId: ConversationId; headers?: {} }
Returns Promise<void>
- Defined in resources/conversation.ts:284

finishConversation

finishConversation(
options: { conversationId: ConversationId; headers?: {} },
): Promise<void>
Finish (close) a conversation.
Parameters
- options: { conversationId: ConversationId; headers?: {} }
Returns Promise<void>
void
- Defined in resources/conversation.ts:164

generateConversationStarters

generateConversationStarters(body: {}, headers?: {}): Promise<{}>
Generate conversation starter suggestions.
Parameters
- body: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/conversation.ts:250

getConversationMessages

getConversationMessages(
options: { conversationId: ConversationId; headers?: {}; query?: {} },
): Promise<{}>
Get messages for a conversation.
Parameters
- options: { conversationId: ConversationId; headers?: {}; query?: {} }
Returns Promise<{}>
- Defined in resources/conversation.ts:143

getConversations

getConversations(queryParams?: {}, headers?: {}): Promise<{}>
List conversations, optionally filtered by query parameters.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/conversation.ts:130

getInteractionInsights

getInteractionInsights(
    options: {
        conversationId: ConversationId;
        headers?: {};
        interactionId: InteractionId;
    },
): Promise<{}>
Get insights for an interaction.
Parameters
- options: { conversationId: ConversationId; headers?: {}; interactionId: InteractionId }
Returns Promise<{}>
- Defined in resources/conversation.ts:205

getMessageSource

getMessageSource(
    options: {
        conversationId: ConversationId;
        headers?: {};
        messageId: MessageId;
    },
): Promise<{}>
Get the audio/media source URL for a message.
Parameters
- options: { conversationId: ConversationId; headers?: {}; messageId: MessageId }
Returns Promise<{}>
- Defined in resources/conversation.ts:229

interact

interact(
    options: {
        conversationId: ConversationId;
        headers?: {};
        input: InteractionInput;
        query: {};
        signal?: AbortSignal;
    },
): Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
Alias for interactWithConversation.
Parameters
- options: {
      conversationId: ConversationId;
      headers?: {};
      input: InteractionInput;
      query: {};
      signal?: AbortSignal;
  }
Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
- Defined in resources/conversation.ts:279

interactWithConversation

interactWithConversation(
    options: {
        conversationId: ConversationId;
        headers?: {};
        input: InteractionInput;
        query: {};
        signal?: AbortSignal;
    },
): Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
Send a text or voice interaction and return an async stream of NDJSON events.
Parameters
- options: {
      conversationId: ConversationId;
      headers?: {};
      input: InteractionInput;
      query: {};
      signal?: AbortSignal;
  }
Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>
- Defined in resources/conversation.ts:49

list

list(queryParams?: {}, headers?: {}): Promise<{}>
Alias for getConversations.
Parameters
- OptionalqueryParams: {}
- Optionalheaders: {}
Returns Promise<{}>
- Defined in resources/conversation.ts:266

messages

messages(
options: { conversationId: ConversationId; headers?: {}; query?: {} },
): Promise<{}>
Alias for getConversationMessages.
Parameters
- options: { conversationId: ConversationId; headers?: {}; query?: {} }
Returns Promise<{}>
- Defined in resources/conversation.ts:289

recommendResponsesForInteraction

recommendResponsesForInteraction(
    options: {
        body?: { context?: string };
        conversationId: ConversationId;
        headers?: {};
        interactionId: InteractionId;
    },
): Promise<{}>
Get recommended responses for an interaction.
Parameters
- options: {
      body?: { context?: string };
      conversationId: ConversationId;
      headers?: {};
      interactionId: InteractionId;
  }
Returns Promise<{}>
- Defined in resources/conversation.ts:179

Class ConversationResource

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns ConversationResource

Methods

create

Parameters

Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>

createConversation

Parameters

Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>

finish

Parameters

Returns Promise<void>

finishConversation

Parameters

Returns Promise<void>

generateConversationStarters

Parameters

Returns Promise<{}>

getConversationMessages

Parameters

Returns Promise<{}>

getConversations

Parameters

Returns Promise<{}>

getInteractionInsights

Parameters

Returns Promise<{}>

getMessageSource

Parameters

Returns Promise<{}>

interact

Parameters

Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>

interactWithConversation

Parameters

Returns Promise<AsyncGenerator<{} | {} | {} | {} | {}, any, any>>

list

Parameters

Returns Promise<{}>

messages

Parameters

Returns Promise<{}>

recommendResponsesForInteraction

Parameters

Returns Promise<{}>

Settings

On This Page