Search Knowledge Base Documents

Searches knowledge base documents with pagination and returns the list of documents that match the search conditions.

Request URL

POST {base_url}/uc-ai/api/v1/knowledge-base/documents/search-page

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.
Body parameters
Parameter Required Type Description
pageSize Yes Integer The number of records to retrieve per page.
pageNumber Yes Integer The page number to retrieve.
sorts No Array<Sort_Condition> The sort conditions.
keyword No String The keyword used for fuzzy matching.
name No String The name of the document, used for fuzzy matching as one of the OR targets of the keyword.
type No String

The document type used for exact filtering.

Valid value:

  • FILE: A file.
  • URL: A web page link.
  • TEXT: A text.
Sort_Condition
Parameter Required Type Description
direction No String The sort order.

Valid value:

  • asc: Sort in ascending order.
  • desc: Sort in descending order.
property No String The name of the field to sort by.

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 Object<Document_Page> The search result of knowledge base documents.
Document_Page
Parameter Type Description
pageSize Integer The number of records per page.
pageNumber Integer The current page number.
total Integer The total number of records that match the search conditions.
totalPages Integer The total number of pages.
empty Boolean Whether the current page is empty.
results Array<Document> The list of records that match the search conditions.
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).
usedByReceptionists Array<Object> The list of receptionists that use this document.

Example

Request example

POST /uc-ai/api/v1/knowledge-base/documents/search-page 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
{
  "pageNumber": 1,
  "pageSize": 10
}

Response example

HTTP/1.1 200 OK
{
  "result": {
    "pageSize": 10,
    "pageNumber": 1,
    "total": 3,
    "results": [
      {
        "id": "2112784500472999938",
        "documentId": "unDKABICdgk7ldGYnDZu",
        "name": "aitdoc-kb",
        "type": "TEXT",
        "createTime": 1792562053208,
        "updateTime": 1792562086616,
        "fileSize": 35,
        "ragStatus": "READY",
        "usedByReceptionists": []
      },
      {
        "id": "2090642366232358913",
        "documentId": "rzbAH2Xhu0Ph9MZHjnDx",
        "name": "123",
        "type": "TEXT",
        "createTime": 1787282957024,
        "updateTime": 1787282966173,
        "fileSize": 4,
        "ragStatus": "READY",
        "usedByReceptionists": []
      },
      {
        "id": "2090641172231450626",
        "documentId": "ql4AywuRmyWeMvMl7rtd",
        "name": "test",
        "type": "TEXT",
        "createTime": 1787282672352,
        "updateTime": 1787282721923,
        "fileSize": 4,
        "ragStatus": "READY",
        "usedByReceptionists": []
      }
    ],
    "totalPages": 1,
    "empty": false
  },
  "requestId": "819b50edefceeafe2cabccdf5d44d72f",
  "code": "200",
  "message": "SUCCESS"
}