Retrieve Vector Document Details via DescribeDocument - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Queries the details of a document.

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

gpdb:DescribeDocument

create

*Document

acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The instance ID. Note You can call the DescribeDBInstances operation to query the details of all AnalyticDB for PostgreSQL instances in a specific region, including the instance IDs.	gp-xxxxxxxxx
Namespace	string	No	The name of the namespace. The default value is `public`. Note You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query existing namespaces.	mynamespace
NamespacePassword	string	Yes	The password for the namespace. Note This value is specified when you call the CreateNamespace operation.	testpassword
Collection	string	Yes	The name of the document collection. Note You can call the CreateDocumentCollection operation to create a document collection and call the ListDocumentCollections operation to query existing document collections.	document
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
FileName	string	Yes	The file name. Note You can call the ListDocuments operation to query documents.	music.txt

Response elements

Element	Type	Description	Example
	object	The response object.
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	The status of the API request. Valid values: success: The request is successful. fail: The request fails.	success
FileName	string	The file name.	music.txt
FileExt	string	The file extension.	txt
FileVersion	integer	The document version. This value is incremented by 1 each time the document is updated.	1
FileMtime	string	The time when the document was last modified.	2023-11-01 10:01:01.123456
Source	string	The source of the document.	OSS
DocumentLoader	string	The name of the document loader.	RapidOCRPDFLoader
TextSplitter	string	The name of the text splitter.	ChineseRecursiveTextSplitter
FileSize	integer	The file size. Unit: bytes.	10000
FileMd5	string	The MD5 hash of the file.	b8078c9591413550f8963e37e24abcea
DocsCount	integer	The number of chunks into which the document is split.	100
FileUrl	string	The download URL of the document. The URL is valid for 2 hours.	http://oss.xxx/music.txt
PlainChunkFileUrl	string	The download URL of the plain text file that contains the document chunks without metadata. Each line in the file is a chunk. The URL is valid for 2 hours.	http://oss.xxx/music_plain_chunk.txt
ChunkFileUrl	string	The download URL of the file that contains the chunks. The URL is valid for 2 hours. The file is in the JSONL format. Each line is a JSON object that has the following structure: `{"page_content":"***", "metadata": {"":"*","":"***"}}`.	http://oss.xxx/music_chunk.jsonl
DocumentLoaderResultFileUrl	string	The download URL of the Markdown file that is parsed by the `ADBPGLoader` document loader. The URL is valid for 2 hours.	http://oss.xxx/adbpg_loader_result.md

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "FileName": "music.txt",
  "FileExt": "txt",
  "FileVersion": 1,
  "FileMtime": "2023-11-01 10:01:01.123456",
  "Source": "OSS\n",
  "DocumentLoader": "RapidOCRPDFLoader",
  "TextSplitter": "ChineseRecursiveTextSplitter",
  "FileSize": 10000,
  "FileMd5": "b8078c9591413550f8963e37e24abcea",
  "DocsCount": 100,
  "FileUrl": "http://oss.xxx/music.txt",
  "PlainChunkFileUrl": "http://oss.xxx/music_plain_chunk.txt",
  "ChunkFileUrl": "http://oss.xxx/music_chunk.jsonl",
  "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.