Create a chatbot

POST 
/bv/aisk/v1/chatbots

This API is used to create a chatbot resource.

Request

application/json

Body

required

chatbot objectrequired

Required. The chatbot resource to be created.

name stringrequired

Required. The display name of the chatbot.

setting objectrequired

Required. The language model setting of the chatbot.

model stringrequired

Possible values: [MODEL_LITE]

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.

intents string[]

Possible values: [INTENT_CALCULATION, INTENT_INTRODUCTION, INTENT_RECOMMENDATION, INTENT_SUMMARY, INTENT_TRANSLATION]

Optional. The list of intents that will be used in the chatbot.

appearance objectrequired

Required. The appearance setting of the chatbot.

enabled boolean

Optional. Indicates to enable the customization appearance setting.

setting object

Optional. Required if enabled the customization appearance setting.

profile objectrequired

Required.

image objectrequired

Required.

id stringrequired

Required. The uuid of the file image.

display_name stringrequired

Required.

message objectrequired

Required.

welcome stringrequired

Required.

placeholder stringrequired

Required.

fallback string

Optional.

theme string

Possible values: [CHATBOT_THEME_DARK, CHATBOT_THEME_LIGHT]

Optional.

color objectrequired

Required.

user_message stringrequired

Required.

widget stringrequired

Required.

reference objectrequired

Required. The reference setting of the chatbot.

kb_selection boolean

Optional. Indicates the user is able to select which knowledge bases should be used in the chat.

display_citation boolean

Optional. Indicates the user can see the citation of the answer that is from which source.

player object

Optional. The player setting of the playable citation.

domain string

Optional. The BYO domain of the player.

domain_control object

Optional. Specify the domains that will be allowed to embed the iframe.

enabled boolean

Optional. Enable domain control.

domains string[]

Optional. The list of domains that will be allowed to embed the iframe.

rate_limit objectrequired

Required. The rate limit setting of the chatbot.

enabled boolean

Optional. Indicates to enable the rate limit setting.

setting object

Optional. Required if enabled the rate limit setting.

limit int32required

Required. Indicates the number of messages to throttle the chatbot. It should be set up together with duration to throttle the chatbot at the number of limit messages in a specified duration.

duration stringrequired

Required. Indicates the specified duration to throttle the chatbot. It should be set up together with limit to throttle the chatbot at the number of limit messages in a specified duration.

Example: 1s, 1m

throttle_message stringrequired

Required. Indicates the response of the message when the chatbot is being throttled.

vary_by string

Possible values: [RATE_LIMIT_VARY_BY_IP, RATE_LIMIT_VARY_BY_DEVICE_ID]

Optional. Indicates to vary rate limiting chatbot by the selected mode if provided.

quota_limit objectrequired

Required. The quota limit setting of the chatbot.

enabled boolean

Optional. Indicates to enable the quota limit setting.

setting object

Optional. Indicates to enable the quota limit setting.

limit int32required

Required. Indicates the number of quota messages to limit the chatbot.

reset stringrequired

Possible values: [QUOTA_LIMIT_RESET_DAILY]

Required. Indicates when the quota will be reset.

Responses

200

A successful response.

application/json

Schema

Schema

chatbot object

id string

Output only. The uuid of the chatbot resource.

name stringrequired

Required. The display name of the chatbot.

status string

Possible values: [CHATBOT_STATUS_TRAINING, CHATBOT_STATUS_READY, CHATBOT_STATUS_FAILED]

Output only. The status of the chatbot.

setting objectrequired

Required. The language model setting of the chatbot.

model stringrequired

Possible values: [MODEL_LITE]

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.

intents string[]

Possible values: [INTENT_CALCULATION, INTENT_INTRODUCTION, INTENT_RECOMMENDATION, INTENT_SUMMARY, INTENT_TRANSLATION]

Optional. The list of intents that will be used in the chatbot.

appearance objectrequired

Required. The appearance setting of the chatbot.

enabled boolean

Optional. Indicates to enable the customization appearance setting.

setting object

Optional. Required if enabled the customization appearance setting.

profile objectrequired

Required.

image objectrequired

Required.

id stringrequired

Required. The uuid of the file image.

url string

Output only. The image URL to be rendered.

name string

Output only. The name of the image.

display_name stringrequired

Required.

message objectrequired

Required.

welcome stringrequired

Required.

placeholder stringrequired

Required.

fallback string

Optional.

theme string

Possible values: [CHATBOT_THEME_DARK, CHATBOT_THEME_LIGHT]

Optional.

color objectrequired

Required.

user_message stringrequired

Required.

widget stringrequired

Required.

reference objectrequired

Required. The reference setting of the chatbot.

kb_selection boolean

Optional. Indicates the user is able to select which knowledge bases should be used in the chat.

display_citation boolean

Optional. Indicates the user can see the citation of the answer that is from which source.

player object

Optional. The player setting of the playable citation.

domain string

Optional. The BYO domain of the player.

domain_control object

Optional. Specify the domains that will be allowed to embed the iframe.

enabled boolean

Optional. Enable domain control.

domains string[]

Optional. The list of domains that will be allowed to embed the iframe.

character_count int64

Output only. The number of characters of this chatbot used.

rate_limit objectrequired

Required. The rate limit setting of the chatbot.

enabled boolean

Optional. Indicates to enable the rate limit setting.

setting object

Optional. Required if enabled the rate limit setting.

limit int32required

Required. Indicates the number of messages to throttle the chatbot. It should be set up together with duration to throttle the chatbot at the number of limit messages in a specified duration.

duration stringrequired

Required. Indicates the specified duration to throttle the chatbot. It should be set up together with limit to throttle the chatbot at the number of limit messages in a specified duration.

Example: 1s, 1m

throttle_message stringrequired

Required. Indicates the response of the message when the chatbot is being throttled.

vary_by string

Possible values: [RATE_LIMIT_VARY_BY_IP, RATE_LIMIT_VARY_BY_DEVICE_ID]

Optional. Indicates to vary rate limiting chatbot by the selected mode if provided.

quota_limit objectrequired

Required. The quota limit setting of the chatbot.

enabled boolean

Optional. Indicates to enable the quota limit setting.

setting object

Optional. Indicates to enable the quota limit setting.

limit int32required

Required. Indicates the number of quota messages to limit the chatbot.

reset stringrequired

Possible values: [QUOTA_LIMIT_RESET_DAILY]

Required. Indicates when the quota will be reset.

created_at date-time

Output only. The time that the chatbot created.

updated_at date-time

Output only. The time that the chatbot last updated.

Example (from schema)

{
  "chatbot": {
    "id": "string",
    "name": "string",
    "status": "CHATBOT_STATUS_TRAINING",
    "setting": {
      "model": "MODEL_LITE",
      "character_role": "string",
      "character_description": "string",
      "creativity": 0,
      "response_length": {
        "enabled": true,
        "input": 0,
        "output": 0
      },
      "intents": [
        "INTENT_CALCULATION"
      ]
    },
    "appearance": {
      "enabled": true,
      "setting": {
        "profile": {
          "image": {
            "id": "string",
            "url": "string",
            "name": "string"
          },
          "display_name": "string"
        },
        "message": {
          "welcome": "string",
          "placeholder": "string",
          "fallback": "string"
        },
        "theme": "CHATBOT_THEME_DARK",
        "color": {
          "user_message": "string",
          "widget": "string"
        }
      }
    },
    "reference": {
      "kb_selection": true,
      "display_citation": true,
      "player": {
        "domain": "string"
      }
    },
    "domain_control": {
      "enabled": true,
      "domains": [
        "string"
      ]
    },
    "character_count": "string",
    "rate_limit": {
      "enabled": true,
      "setting": {
        "limit": 0,
        "duration": "string",
        "throttle_message": "string",
        "vary_by": "RATE_LIMIT_VARY_BY_IP"
      }
    },
    "quota_limit": {
      "enabled": true,
      "setting": {
        "limit": 0,
        "reset": "QUOTA_LIMIT_RESET_DAILY"
      }
    },
    "created_at": "2024-07-29T15:51:28.071Z",
    "updated_at": "2024-07-29T15:51:28.071Z"
  }
}

400

A bad request response. The code is 3 means got an invalid argument. There are more HTTP status code mappings listed on here and gRPC code on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

401

A unauthenticated response. The header authorization was missing or unidentified.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

403

A forbidden response. It means that the provided authorization did not have enough permission to access the resource or the API.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

500

A server error response. There are more HTTP status code mappings listed on here.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

default

An unexpected error response.

application/json

Schema

Schema

code int32
message string
details object[]
Array [
@type string
A URL/resource name that uniquely identifies the type of the serialized protocol buffer message. This string must contain at least one "/" character. The last segment of the URL's path must represent the fully qualified name of the type (as in path/google.protobuf.Duration). The name should be in a canonical form (e.g., leading "." is not accepted).
In practice, teams usually precompile into the binary all types that they expect it to use in the context of Any. However, for URLs which use the scheme http, https, or no scheme, one can optionally set up a type server that maps type URLs to message definitions as follows:
• If no scheme is provided, https is assumed.
• An HTTP GET on the URL must yield a [google.protobuf.Type][] value in binary format, or produce an error.
• Applications are allowed to cache lookup results based on the URL, or have them precompiled into a binary to avoid any lookup. Therefore, binary compatibility needs to be preserved on changes to types. (Use versioned type names to manage breaking changes.)
Note: this functionality is not currently available in the official protobuf release, and it is not used for type URLs beginning with type.googleapis.com. As of May 2023, there are no widely used type server implementations and no plans to implement one.
Schemes other than http, https (or the empty scheme) might be used with implementation specific semantics.
]

Example (from schema)

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Loading...