Skip to main content

Chat with chatbot

POST 

/bv/aisk/v1/chatbots:chat

This API is used to chat with a chatbot for previewing.

Request

Body

required
    question stringrequired
    kb_ids string[]required
    setting objectrequired
    model stringrequired

    Possible values: [MODEL_GPT_4_128K]

    Required.

    character_role string

    Optional.

    character_description string

    Optional.

    creativity floatrequired

    Required.

    response_length objectrequired

    Required. The response length setting of the chatbot.

    enabled boolean

    Optional. Indicates to enable the custom limit response length.

    input int32

    Optional. Required if enabled the custom limit.

    output int32

    Optional. Required if enabled the custom limit.

    display_citation booleanrequired
    metadata objectrequired
    session_id string
    conversation_id string
    language string
    device object
    id device id, unique for each device (string)
    platform ios | android | windows (string)
    category desktop | mobile | tablet (string)
    browser Chrome 105 | Safari 15.4 (string)

Responses

A successful response.

Schema
    answer string
    citations object[]
  • Array [
  • type string

    Possible values: [SOURCE_TYPE_WEBSITE, SOURCE_TYPE_LOCAL_DRIVE, SOURCE_TYPE_VOD, SOURCE_TYPE_VIDEO, SOURCE_TYPE_SUBTITLE, SOURCE_TYPE_TEXT]

    local_drive object
    file_name string
    source_format string

    Possible values: [SOURCE_FORMAT_WEBSITE, SOURCE_FORMAT_PDF, SOURCE_FORMAT_DOC, SOURCE_FORMAT_DOCX, SOURCE_FORMAT_VOD_TO_TEXT, SOURCE_FORMAT_VIDEO_TO_TEXT, SOURCE_FORMAT_SRT, SOURCE_FORMAT_VTT, SOURCE_FORMAT_TEXT]

    Output only.

    download_url string
    web_link object
    url string
    title string
    thumbnail_url string
    vod object
    contents object[]
  • Array [
  • content string
    period object
    start_time string
    end_time string
  • ]
  • resource_id string
    name string
    thumbnail_url string
    duration_in_second float
    source_id string
    video object
    contents object[]
  • Array [
  • content string
    period object
    start_time string
    end_time string
  • ]
  • resource_id string
    name string
    thumbnail_url string
    duration_in_second float
  • ]
Loading...