RetrievalKnowledgeBase - PolarDB - Alibaba Cloud Documentation Center

Retrieves information from a knowledge base.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

polardb:RetrievalKnowledgeBase

get

*All Resource

*

None

Request syntax

POST  HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID.	cn-beijing
KnowledgeBaseId	string	Yes	The unique identifier of the knowledge base. You can specify multiple knowledge bases separated by commas. A maximum of 50 knowledge bases can be specified.	pkb-1xxxxx,pkb-2xxxxx
QueryText	string	Yes	The query text.	Financial report
TopK	integer	No	The number of results to return.	5
ScoreThreshold	number	No	The similarity score threshold.	0.7
RerankEnabled	boolean	No	Specifies whether to enable reranking. Default value: true.	true

Response elements

Element	Type	Description	Example
	object	Schema of Response
QueryText	string	The query text.	Financial report
RequestId	string	Id of the request	CD35F3-F3-44CA-AFFF-BAF869******
ResultCount	integer	The number of results.	5
Results	array<object>	The search results.
	array<object>	The search results.
Captions	array	The list of figure or table captions associated with the chunk.
	string	The figure or table caption.	System architecture diagram
DocItems	array	The list of Docling source document structured element references associated with the chunk. You can use these references to precisely locate elements in the original document.
	string	The Docling source document structured element reference.	#/texts/2
FileId	string	The unique identifier of the file.	91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc
FileName	string	The name of the file.	2024FinancialReport.pdf
Headings	array	The chain of section headings to which the chunk belongs.
	string	The heading.	Financial report
ImageResources	array<object>	The list of image resources referenced by the chunk.
	object	The image resource.
DocumentIndex	integer	The index of the source document to which the image belongs, starting from 0.	0
Id	string	The unique identifier of the image resource.	document-0/pictures/1
ItemRef	string	The element reference of the image in the Docling source document structure.	#/pictures/1
MimeType	string	The media type of the image resource.	image/png
Uri	string	The OSS URI of the image resource.	oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png
Metadata	string	The metadata.	{}
PageNumbers	array	The list of page numbers to which the chunk belongs.
	integer	The page number to which the chunk belongs.	1
ShardContent	string	The text content of the chunk.	Financial report
ShardIndex	integer	The index of the chunk.	1
SimilarityScore	number	The similarity score.	0.8

Examples

Success response

JSON format

{
  "QueryText": "Financial report",
  "RequestId": "CD35F3-F3-44CA-AFFF-BAF869******",
  "ResultCount": 5,
  "Results": [
    {
      "Captions": [
        "System architecture diagram"
      ],
      "DocItems": [
        "#/texts/2"
      ],
      "FileId": "91b97b71-xxxx-xxxx-xxxx-33c6a6341cdc",
      "FileName": "2024FinancialReport.pdf",
      "Headings": [
        "Financial report"
      ],
      "ImageResources": [
        {
          "DocumentIndex": 0,
          "Id": "document-0/pictures/1",
          "ItemRef": "#/pictures/1",
          "MimeType": "image/png",
          "Uri": "oss://my-bucket/results/my-space/doc-001/artifacts/image-1.png"
        }
      ],
      "Metadata": "{}",
      "PageNumbers": [
        1
      ],
      "ShardContent": "Financial report",
      "ShardIndex": 1,
      "SimilarityScore": 0.8
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.