Use GetUploadDocumentJob to query the progress and result of an asynchronous document upload job - AnalyticDB - Alibaba Cloud - AnalyticDB

Queries the progress and result of an asynchronous document upload job by job ID.

Operation description

Call UploadDocumentAsync to create an upload job and obtain a job ID, then call GetUploadDocumentJob to query the execution details of the job.

Note

Suggestions

Depending on document complexity and the number of vector chunks produced, the job typically completes within 2 hours.

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:GetUploadDocumentJob

create

*Document

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

None

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The ID of the instance for which vector engine optimization is enabled. Note You can call the DescribeDBInstances operation to query the information about all AnalyticDB for PostgreSQL instances within a region, including instance IDs.	gp-xxxxxxxxx
Namespace	string	No	The name of the namespace for tenant isolation. Default value: public. Note You can call the CreateNamespace operation to create a namespace and call the ListNamespaces operation to query a list of namespaces.	mynamespace
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 a list of document collections.	document
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou
NamespacePassword	string	Yes	The password of the namespace. Note This value is set when you call the CreateNamespace operation.	testpassword
JobId	string	Yes	The ID of the document upload job. You can call the `UploadDocumentAsync` operation to obtain the job ID.	bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1

Response elements

Element	Type	Description	Example
	object
RequestId	string	The request ID.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The returned message.	success
Status	string	The status of the operation. Valid values: success fail	success
Job	object	The document upload job details.
Id	string	The job ID.	231460f8-75dc-405e-a669-0c5204887e91
Completed	boolean	Indicates whether the job is complete.	false
CreateTime	string	The time when the job was created.	2024-01-08 16:52:04.864664
UpdateTime	string	The time when the job was last updated.	2024-01-08 16:53:04.864664
Status	string	The status of the job. Valid values: Success Failed (See the Error parameter for failure reasons.) Cancelling Cancelled Start Running Pending	Running
Error	string	The error message returned when the job encounters an error or fails.	Failed to connect database.
Progress	integer	The progress of the document upload job. Unit: %. A value of 100 indicates that the job is complete.	20
ErrorCode	string	The error code returned.	InternalError
ChunkResult	object	The chunking result.
ChunkFileUrl	string	The URL of the chunked file, valid for 2 hours. The file is in the JSONL format. Each line is in the `{"page_content":"***", "metadata": {"":"*","":"***"}` format.	http://xxx/test.jsonl
PlainChunkFileUrl	string	The URL of the chunked file without metadata, valid for 2 hours. The file is in TXT format, with one chunk per line, suitable for direct embedding use.	http://xxx/test.txt
DocumentLoaderResultFileUrl	string	The markdown output file generated by ADBPGLoader, valid for 2 hours.	http://oss.xxx/adbpg_loader_result.md
Usage	object	The token consumption for document understanding or embedding.
EmbeddingTokens	integer	The number of tokens consumed during vectorization. Note A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.	475
EmbeddingEntries	integer	The number of vector entries generated during vectorization.	10

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success",
  "Job": {
    "Id": "231460f8-75dc-405e-a669-0c5204887e91",
    "Completed": false,
    "CreateTime": "2024-01-08 16:52:04.864664",
    "UpdateTime": "2024-01-08 16:53:04.864664",
    "Status": "Running",
    "Error": "Failed to connect database.",
    "Progress": 20,
    "ErrorCode": "InternalError"
  },
  "ChunkResult": {
    "ChunkFileUrl": "http://xxx/test.jsonl",
    "PlainChunkFileUrl": "http://xxx/test.txt",
    "DocumentLoaderResultFileUrl": "http://oss.xxx/adbpg_loader_result.md"
  },
  "Usage": {
    "EmbeddingTokens": 475,
    "EmbeddingEntries": 10
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.