CreateRecallManagementTable-阿里云帮助中心

Creates a recall management table that supports multiple data sources and configuration options.

Operation description

Request

The InstanceId, Name, Description, Type, and DataSource parameters are required.
The RecallType parameter is optional. If provided, it must be a valid enum value.
For each field in the Fields parameter, you must define its name, type, and attributes. You must mark at least one field as Primary.
If you use MaxCompute as the data source, you must specify the MaxcomputeProjectName and MaxcomputeTableName parameters. The MaxcomputeSchema parameter is optional.
For vector fields, the values of the VectorDimension and VectorMetricType parameters must match the actual data.
Use the Config field to provide additional configuration as a JSON string.
Use fluctuation threshold parameters, such as EnableRowCountFluctuationThreshold, to monitor changes in row count or table size. Enable these parameters and set appropriate thresholds as needed.

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

pairec:CreateRecallManagementTable

create

*All Resource

*

None

Request syntax

POST /api/v1/recallmanagementtables HTTP/1.1

Request parameters

Parameter	Type	Required	Description	Example
body	object	No	The request body.
InstanceId	string	Yes	The instance ID.	pairec-cn-test123
Name	string	No	The name of the table.	table-123
Description	string	No	The description of the table.	this is a test table
Type	string	No	The table type.	Recall
RecallType	string	No	The recall type of the table.	X2I
DataSource	string	No	The data source.	MaxcomputeAndApiApi
MaxcomputeProjectName	string	No	The MaxCompute project.	test
MaxcomputeTableName	string	No	The name of the table in MaxCompute.	table-1
Fields	array<object>	No	The list of fields.
	object	No	The details of a field.
Name	string	No	The name of the field.	age
Type	string	No	The data type of the field.	STRING(全大写)
Attributes	array	No	The attributes of the field. Valid values: `Primary`: The primary key field. `Item`: The item field. `Score`: The recall score field. `Vector`: The vector field. `Index`: The index field.
	string	No	An attribute of the field.	Primary
VectorDimension	integer	No	The vector dimension.	32
VectorMetricType	string	No	The vector metric type.	L2
Config	string	No	Additional settings for the table.	{"":""}
EnableRowCountFluctuationThreshold	boolean	No	Whether to enable the row count fluctuation threshold.	true
MinRowCountFluctuationThreshold	integer	No	The minimum row count fluctuation threshold.	10
MaxRowCountFluctuationThreshold	integer	No	The maximum row count fluctuation threshold.	100
EnableDataSizeFluctuationThreshold	boolean	No	Whether to enable the data size fluctuation threshold.	true
MinDataSizeFluctuationThreshold	integer	No	The minimum data size fluctuation threshold.	10
MaxDataSizeFluctuationThreshold	integer	No	The maximum data size fluctuation threshold.	100
MaxcomputeSchema	string	No	The schema in MaxCompute.	default

Response elements

Element	Type	Description	Example
	object	Response schema
RequestId	string	The ID of the request.	728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77
RecallManagementTableId	string	The ID of the recall management table.	3

Examples

Success response

JSON format

{
  "RequestId": "728C5E01-ABF6-5AA8-B9FC-B3BA05DECC77",
  "RecallManagementTableId": "3"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.