Use UpsertCollectionData to upload vector data - AnalyticDB - Alibaba Cloud - AnalyticDB

Uploads vector data to a vector collection.

Operation description

Important

The SDK was upgraded on November 8, 2023, and the maximum size of data per request increased from 512 KB to 10 MB. Use the latest SDK version or at least the following version:

Java:1.2.1
Go:v3.3.1
Python:3.3.1

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

create

*Collection

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

None

Request parameters

Parameter	Type	Required	Description	Example
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-bp152460513z****
Collection	string	Yes	The name of the collection.	document
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
NamespacePassword	string	Yes	The password of the namespace.	testpassword
Rows	array<object>	No	The vector data to upload.
	array<object>	No	The vector data to upload.
Id	string	No	The unique ID of the vector data. Note If left empty, a unique ID is automatically generated using uuidgen. If you specify an existing ID, the vector data for that ID is updated.	854c6949-411c-4b47-aec4-e324735f9574
Metadata	object	No	The metadata of the vector data. The key field must match the Metadata key specified when you call the CreateCollection operation.
	string	No	The metadata of the vector data.	{"title":"test title", "content": "test content"}
Vector	array	Yes	The vector data. The length must match the Dimension value specified when you call the CreateCollection operation.
	number	No	The vector data.	[1.0123,-0.1234]
SparseVector	object	No	The sparse vector data.
Indices	array	No	The indices. Note The size of indices cannot exceed 4000.
	integer	No	The index value.	1
Values	array	No	The sparse vector values.
	number	No	The sparse vector value.	1.2345
RegionId	string	Yes	The region ID of the instance. Note You can call the DescribeRegions operation to query the most recent region list.	cn-hangzhou
WorkspaceId	string	No	The workspace ID. A workspace consists of multiple AnalyticDB for PostgreSQL instances. Specify either WorkspaceId or DBInstanceId. If both are specified, WorkspaceId 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	Indicates whether the request was successful. Valid values: success fail	success

Examples

Success response

JSON format

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "success",
  "Status": "success"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.