Class ConversationClient

Conversation client.

Hierarchy (View Summary)

ChatBotKitClient
- ConversationClient

Index

Constructors

constructor

new ConversationClient(options: ChatBotKitClientOptions): ConversationClient
Parameters
- options: ChatBotKitClientOptions
Returns ConversationClient
Overrides ChatBotKitClient.constructor
- Defined in conversation/index.js:34

Properties

attachment

attachment: ConversationAttachmentClient

message

message: ConversationMessageClient

session

session: ConversationSessionClient

Methods

clientProxy

clientProxy(
    path: string,
    options?: {
        buffer?: ArrayBuffer;
        endpoint?: string;
        external?: boolean;
        fetchFn?: FetchFunction;
        file?: { data: string | ArrayBuffer; name?: string; type?: string };
        headers?: Record<string, any>;
        method?: string;
        query?: Record<string, any>;
        record?: Record<string, any>;
        retries?: number;
        retryDelay?: number;
        retryTimeout?: boolean;
        timeout?: number;
    },
): Promise<Response>
Proxies a request and resolves the upstream Response. Successful and upstream-error responses pass through untouched - streaming, binary and large bodies are preserved (the body is never read on the success path). The one exception is a CBK authorization_required signal, which is thrown as an AuthorizationRequiredError carrying the url the user must visit to authenticate.
Parameters
- path: string
- Optionaloptions: {
      buffer?: ArrayBuffer;
      endpoint?: string;
      external?: boolean;
      fetchFn?: FetchFunction;
      file?: { data: string | ArrayBuffer; name?: string; type?: string };
      headers?: Record<string, any>;
      method?: string;
      query?: Record<string, any>;
      record?: Record<string, any>;
      retries?: number;
      retryDelay?: number;
      retryTimeout?: boolean;
      timeout?: number;
  }
Returns Promise<Response>
Inherited from ChatBotKitClient.clientProxy
- Defined in client.js:646

complete

complete(
conversationId: null,
request: {} & {} | Omit<{} & {}, "model"> & { model?: Model },
): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
Parameters
- conversationId: null
- request: {} & {} | Omit<{} & {}, "model"> & { model?: Model }
Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
- Defined in conversation/index.js:105
complete(
conversationId: string,
request: {},
): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
Parameters
- conversationId: string
- request: {}
Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
- Defined in conversation/index.js:112

create

create(request: ConversationCreateRequestBody): Promise<{}>
Creates a new conversation.
Parameters
- request: ConversationCreateRequestBody
Returns Promise<{}>
- Defined in conversation/index.js:79

delete

delete(conversationId: string): Promise<{}>
Deletes the conversation.
Parameters
- conversationId: string
Returns Promise<{}>
- Defined in conversation/index.js:100

dispatch

dispatch(
conversationId: string | null,
request: {} & {} | Omit<{} & {}, "model"> & { model?: Model } | {},
): Promise<{} | {}>
Dispatches a conversation completion to run in the background. Returns a channel ID that can be used to subscribe to completion events.
Parameters
- conversationId: string | null
- request: {} & {} | Omit<{} & {}, "model"> & { model?: Model } | {}
Returns Promise<{} | {}>
- Defined in conversation/index.js:150

downvote

downvote(conversationId: string, request: {}): Promise<{}>
Parameters
- conversationId: string
- request: {}
Returns Promise<{}>
- Defined in conversation/index.js:203

extend

extend(extensionOptions: Partial<ChatBotKitClientOptions>): ConversationClient
Creates a new instance of the same client type with extended options.

This is useful when you need to create a client with modified configuration (e.g., different endpoint, token, or headers) without affecting the original.

Note: This method creates a completely new instance rather than cloning, which is necessary because private class fields cannot be copied.
Parameters
- extensionOptions: Partial<ChatBotKitClientOptions>
  Options to merge with current options
Returns ConversationClient
A new instance of the same client class with extended options
Inherited from ChatBotKitClient.extend
- Defined in client.js:442

fetch

fetch(conversationId: string): ResponsePromise<{} & ({} | {}), never>
Fetches a conversation.
Parameters
- conversationId: string
Returns ResponsePromise<{} & ({} | {}), never>
- Defined in conversation/index.js:69

list

list(request?: ConversationListRequest): ResponsePromise<{}, {}>
Retrieves a list of all conversations.
Parameters
- Optionalrequest: ConversationListRequest
Returns ResponsePromise<{}, {}>
- Defined in conversation/index.js:59

receive

receive(
conversationId: string,
request: {},
): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
Receives a message from the conversation.
Parameters
- conversationId: string
- request: {}
Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
- Defined in conversation/index.js:185

send

send(
conversationId: string,
request: {},
): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
Sends a message to the conversation.
Parameters
- conversationId: string
- request: {}
Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>
- Defined in conversation/index.js:174

update

update(
conversationId: string,
request: ConversationUpdateRequestBody,
): Promise<{}>
Updates a conversation.
Parameters
- conversationId: string
- request: ConversationUpdateRequestBody
Returns Promise<{}>
- Defined in conversation/index.js:90

upvote

upvote(conversationId: string, request: {}): Promise<{}>
Parameters
- conversationId: string
- request: {}
Returns Promise<{}>
- Defined in conversation/index.js:194

Class ConversationClient

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConversationClient

Properties

attachment

message

session

Methods

clientProxy

Parameters

Returns Promise<Response>

complete

Parameters

Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

Parameters

Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

create

Parameters

Returns Promise<{}>

delete

Parameters

Returns Promise<{}>

dispatch

Parameters

Returns Promise<{} | {}>

downvote

Parameters

Returns Promise<{}>

extend

Parameters

Returns ConversationClient

fetch

Parameters

Returns ResponsePromise<{} & ({} | {}), never>

list

Parameters

Returns ResponsePromise<{}, {}>

receive

Parameters

Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

send

Parameters

Returns ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

update

Parameters

Returns Promise<{}>

upvote

Parameters

Returns Promise<{}>

Settings

On This Page