Class ConversationClient

constructor

• new ConversationClient(options: ChatBotKitClientOptions): ConversationClient

  Parameters

  • options: ChatBotKitClientOptions

  Returns ConversationClient

attachment

message

session

complete

• complete(
      conversationId: null,
      request: {} & {} | Omit<{} & {}, "model"> & { model?: Model },
  ): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

  Parameters

  • conversationId: null
  • request: {} & {} | Omit<{} & {}, "model"> & { model?: Model }

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

• complete(
      conversationId: string,
      request: {},
  ): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

  Parameters

  • conversationId: string
  • request: {}

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

create

• create(request: ConversationCreateRequestBody): Promise<{}>

  Creates a new conversation.

  Parameters

  • request: ConversationCreateRequestBody

  Returns Promise<{}>

delete

• delete(conversationId: string): Promise<{}>

  Deletes the conversation.

  Parameters

  • conversationId: string

  Returns Promise<{}>

downvote

• downvote(conversationId: string, request: {}): Promise<{}>

  Parameters

  • conversationId: string
  • request: {}

  Returns Promise<{}>

fetch

• fetch(conversationId: string): ResponsePromise<{} & ({} | {}), never>

  Fetches a conversation.

  Parameters

  • conversationId: string

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

list

• list(request?: ConversationListRequest): ResponsePromise<{}, {}>

  Retrieves a list of all conversations.

  Parameters

  • Optionalrequest: ConversationListRequest

  Returns ResponsePromise<{}, {}>

receive

• receive(
      conversationId: string,
      request: {},
  ): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

  Receives a message from the conversation.

  Parameters

  • conversationId: string
  • request: {}

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

send

• send(
      conversationId: string,
      request: {},
  ): ResponsePromise<{}, {} | {} | {} | {} | {} | {} | {} | {} | {} | {}>

  Sends a message to the conversation.

  Parameters

  • conversationId: string
  • request: {}

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

update

• update(
      conversationId: string,
      request: ConversationUpdateRequestBody,
  ): Promise<{}>

  Updates a conversation.

  Parameters

  • conversationId: string
  • request: ConversationUpdateRequestBody

  Returns Promise<{}>

upvote

• upvote(conversationId: string, request: {}): Promise<{}>

  Parameters

  • conversationId: string
  • request: {}

  Returns Promise<{}>