Async Bulk Vector Upsert via UpsertCollectionDataAsync - AnalyticDB for PostgreSQL - Alibaba Cloud - AnalyticDB

Operation description

This is the asynchronous version of UpsertCollectionData. UpsertCollectionData supports up to 10 MB of data per request, whereas this operation supports up to 200 MB.

Note

Related operations:

Call the GetUpsertCollectionDataJob operation to query the progress and result of an upload job.
Call the CancelUpsertCollectionDataJob operation to cancel an upload job.

Note

Data can only be uploaded to the same collection serially.

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

create

*Collection

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

None

Request parameters

Parameter	Type	Required	Description	Example
RegionId	string	Yes	The region ID of the instance.	cn-hangzhou
DBInstanceId	string	No	The instance 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
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 collection. Note You can call the ListCollections operation to query a list of collections.	document
NamespacePassword	string	Yes	The password of the namespace. Note This value is set when you call the CreateNamespace operation.	testpassword
FileUrl	string	Yes	The publicly accessible URL of the vector data file. Note The file must be in JSONL format. Each line is a JSON object that represents one set of vector data. Each line follows this format: `{String Id; Map<String, Object> Metadata; List<Double> Vector}`. Example: `{"Id":"myid", "Metadata": {"my_meta_key": "my_meta_value"}, "Vector": [1.234, -0.123]}`. We recommend that you use SDKs to call this operation. SDKs provide the UpsertCollectionDataAsyncAdvance method to upload local files as data sources.	https://xx/vectors.jsonl
WorkspaceId	string	No	The workspace ID. A workspace consists of multiple database instances. You must specify either this parameter or DBInstanceId. If both are specified, this parameter takes precedence.	gp-ws-*****

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
JobId	string	The job ID, which you can use to query job status or cancel the job.	231460f8-75dc-405e-a669-0c5204887e91

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.