Select Receptionist Knowledge Base Documents

Associates knowledge base documents with an AI receptionist. This operation replaces all existing associations with the specified list.

Request URL

POST {base_url}/uc-ai/api/v1/receptionists/{id}/knowledge-base/select

Request parameters

Headers
Parameter Required Type Description
Authorization Yes String The access token used for authentication.

Format: Bearer {access_token}.
x-tenant-code Yes String The tenant name.
Note: You can obtain tenant name using the Query Tenants interface.
Path parameters
Parameter Required Type Description
id Yes String The ID of the AI receptionist. You can obtain the ID using the Search AI Receptionists interface.
Body parameters
Parameter Required Type Description
documentIds Yes Array<Integer> The list of knowledge base document IDs to associate, which must not be null and can be an empty list. This operation is a full replacement: the existing associations are cleared and rebuilt by this list.

Response parameters

Parameter Type Description
requestId String The unique ID of the request, which can be used to quickly locate the request.
code String The HTTP status code of the request.
  • 200: Request succeeded.
  • Non-200 value: Request failed.
message String The status message of the request.
detailMessage String The detailed error information.

When the request is successful, this parameter returns empty.
result Array<Document> The list of documents associated with the receptionist after the operation.
Document
Parameter Type Description
id String The ID of the document.
documentId String The internal document ID of the knowledge base.
name String The name of the document.
type String

The type of the document:

  • FILE: A file.
  • URL: A web page link.
  • TEXT: A text.
fileSize Integer The size of the document file, in bytes. This parameter is returned for URL documents.
ragStatus String The parsing status of the document in the knowledge base, such as PARSING.
createTime String The creation time, in Unix timestamp format (milliseconds).
updateTime String The last update time, in Unix timestamp format (milliseconds).

Example

Request example

POST /uc-ai/api/v1/receptionists/{id}/knowledge-base/select HTTP/1.1
Host: api.cn.novoone.com
Authorization: Bearer eyJraWQiOiJjbi0wLWtleS0xIiwiYWxnIjoiUlMyNTYifQ.eyJzdWIiOiJkaXN0cmlidXRvcmV4YW1wbGVAb3V0bG9vay5jb20iLCJhcHBfa2V5Ijoic2xOdnQzaHc1NXB2Vm5HRlNhR2ZOVTNmMWxYQ3lpa08iLCJncmFudF90eXBlIjoib3BlbmFwaSIsImNsaWVudF9leHQiOnsiZGVzY3JpcHRpb24iOiLnrKzkuInmlrnlkIjkvZzkvJnkvLTlupTnlKgiLCJwYXJ0bmVyIjoi56S65L6L5ZCI5L2c5LyZ5Ly0In0sImNsaWVudF90eXBlIjoib3BlbmFwaSIsImV4cCI6MTc5MjU4MzY1MSwiaWF0IjoxNzkyNTYyMDUxLCJqdGkiOiI5ODRiZjY0Mi00YWNlLTRiZWEtOTk3YS1lNmVhMjVjMTc3NDYiLCJjbGllbnRfaWQiOiJub3ZvLW9wZW4tcGxhdGZvcm0iLCJ1c2VyX2V4dCI6eyJyb2xlSWRzIjpbM10sInN0eXBlIjoiQURNSU4iLCJ0ZW5hbnRDb2RlIjpudWxsLCJ0eXBlIjoiUF9BQ0NPVU5UIiwidXNlcklkIjozMDc2OTEzNjQ0OTE1OTk4NzIwLCJlbWFpbCI6ImRpc3RyaWJ1dG9yZXhhbXBsZUBvdXRsb29rLmNvbSIsInVzZXJuYW1lIjoiZGlzdHJpYnV0b3JleGFtcGxlQG91dGxvb2suY29tIiwidWNJZCI6MzA3NjkxMzY0NDg5MDgzMjg5Nn19.G2oipgaRjD1M48lPlOjh51mu3Iad7TF4PjFqGpZV8qar5rOq362P0tnF1U8U1HtqHfaIBiyPBJHjt6HVIanxps31_WI9aVw6Uyq4uRL2G3trENCeU8Now78Buvv_frAhxW8KTLiCtT2cNYC3Usn0FCv5H-jMAS4JueCb96nu60usm8V6ytMk7O0i5Bs-cqMwEmQBL75oy4vW70HtCgZrsW0ZCChdi9l5l-OtfnEgLTC1ohfSw592heykBkhCKgFM5RtXW7NFMRWRgtI3E7hdMd-ETIL2TIC-SHL17kRkku6qAzDIMDHro5XkBgccKJkGF2GXHcGgL6-dLgi9SFjrDw
x-tenant-code: jint
Content-Type: application/json
{
  "documentIds": [
    2112784500472999938
  ]
}

Response example

HTTP/1.1 200 OK
{
  "result": [
    {
      "id": "2112784500472999938",
      "documentId": "unDKABICdgk7ldGYnDZu",
      "name": "aitdoc-kb-upd",
      "type": "TEXT",
      "createTime": 1792562053208,
      "updateTime": 1792562087241,
      "fileSize": 35,
      "ragStatus": "READY",
      "content": "AI doc test knowledge base content."
    }
  ],
  "requestId": "6cc838c8bc8231d17cb2a26fb958c5dc",
  "code": "200",
  "message": "SUCCESS"
}