UpsertChunks - AnalyticDB - Alibaba Cloud Documentation Center

This topic is generated by a machine translation engine without any human intervention. ALIBABA CLOUD DOES NOT GUARANTEE THE ACCURACY OF MACHINE TRANSLATED CONTENT. To request a human-translated version of this topic or provide feedback on this translation, please include it in the feedback form.

Splits a document into chunks and uploads the vectorized chunks to a document collection.

Operation description

The vector algorithm that is used for the document is specified when you call the CreateDocumentCollection operation.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Debug

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

Operation: the value that you can use in the Action element to specify the operation on a resource.
Access level: the access level of each operation. The levels are read, write, and list.
Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- For mandatory resource types, indicate with a prefix of * .
- If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
Condition Key: the condition key that is defined by the cloud service.
Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.

Operation	Access level	Resource type	Condition key	Associated operation
gpdb:UpsertChunks	create	*Document `acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}`	none	none

Request parameters

Parameter	Type	Required	Description	Example
DBInstanceId	string	Yes	The cluster ID. 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
RegionId	string	Yes	The region ID of the cluster.	cn-hangzhou
NamespacePassword	string	Yes	The password of the namespace. Note The value of this parameter is specified when you call the CreateNamespace operation.	testpassword
Namespace	string	No	The name of the namespace. 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
FileName	string	No	The file name of the document. Note When a non-empty filename is specified, the system will decide whether to overwrite the data associated with that filename based on the value of the ShouldReplaceFile parameter. If you leave this parameter empty, the data of chunks is appended to the document collection.	mydoc.txt
ShouldReplaceFile	boolean	No	Specifies whether to overwrite the data associated with the file name specified by the FileName parameter. If you set ShouldReplaceFile to true, the system deletes all data associated with the file name and then inserts new data. If you set ShouldReplaceFile to false, the system does not delete the data associated with the file name, but inserts or updates the data of chunks based on the TextChunks parameter. Default value: true.	true
AllowInsertWithFilter	boolean	No	Based on the Filter input specified under TextChunks, this parameter controls whether data insertion is allowed when a Filter is provided. If AllowInsertWithFilter = true, the insert operation is performed when the filter does not match any data. If AllowInsertWithFilter = false, no action is performed if the filter does not match any data. Default value: true.	true
TextChunks	array<object>	No	List of document chunks after splitting.
	object	No	A single document object.
Filter	string	No	The condition that is used to filter the data to be updated. Specify this parameter in a format that is the same as the WHERE clause.	title = 'seagull'
Content	string	Yes	The content of the document.	Cloud-native data warehouse AnalyticDB PostgreSQL Edition provides a simple, fast, and cost-effective PB-level cloud data warehouse solution.
Metadata	object	No	The metadata.	{"title":"test"}
Id	string	No	The unique ID of the vector data.	273e3fc7-8f56-4167-a1bb-d35d2f3b9043

Response parameters

Parameter	Type	Description	Example
	object
RequestId	string	The unique ID of the request.	ABB39CC3-4488-4857-905D-2E4A051D0521
Message	string	The response message.	Successful
Status	string	The status of the operation. Valid values: success fail	success
EmbeddingTokens	string	The number of tokens that are consumed during vectorization. Note A token is the minimum unit for splitting text. A token can be a word, phrase, punctuation, or character.	100
JobId	string	The job ID. You can use the `GetGraphRAGJob` to view the job status. Note This parameter is returned only when the knowledge base is enabled.	231460f8-75dc-405e-a669-0c5204887e91

Examples

Sample success responses

JSONformat

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "EmbeddingTokens": 100,
  "JobId": "231460f8-75dc-405e-a669-0c5204887e91"
}

Error codes

For a list of error codes, visit the Service error codes.

Change history

Change time	Summary of changes	Operation

No change history