Build an OpenSearch Algorithm Instance via CreateFunctionInstance API - OpenSearch

Creates an algorithm instance of a feature.

Operation description

You can call the GetFunctionCurrentVersion operation to query the latest version of a feature. The response of the operation includes the createParameters parameter that is used to create an algorithm instance, the usageParameters parameter, and the requirements for setting these parameters.

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

opensearch:WriteFunction

create

*FunctionInstance

acs:opensearch:{#regionId}:{#accountId}:apps/{#AppGroupId}

None

Request syntax

POST /v4/openapi/app-groups/{appGroupIdentity}/functions/{functionName}/instances HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
appGroupIdentity	string	Yes	The name of the application.	my_app_group_name
functionName	string	Yes	The feature name. Valid values: ctr: CTR model. pop: popularity model. category: category model. hot: hotword model. hint: hint model. suggest: drop-down suggestion model. analyzer: tokenization model. termweight: term weight model. synonym: synonym model.	ctr

Request parameters

Parameter	Type	Required	Description	Example
Body	object	No	The request body.	{ "instanceName": "ctr_test", "modelType": "tf_checkpoint", "createParameters": [ { "name": "title_field", "value": "title" }, { "name": "description_field", "value": "" }, { "name": "tags_field", "value": "" }, { "name": "id_field", "value": "item_id" }, { "name": "category_field", "value": "cate" } ], "description": "testinstance", }
instanceName	string	Yes	The instance name. The name must be 1 to 30 characters in length and can contain letters, digits, and underscores (_). The name is case-sensitive and must start with a letter.	ctr_test
modelType	string	Yes	The model type. The value varies based on the model. Click-through rate (CTR) model: tf_checkpoint Popularity model: pop Category model: offline_inference Hotword model: offline_inference Hint model: offline_inference Hotword model for real-time top searches: near_realtime Personalized hint model: near_realtime Drop-down suggestion model: offline_inference Tokenization model: text Term weight model: tf_checkpoint Synonym model: offline_inference	tf_checkpoint
functionType	string	No	The feature type. Default value: PAAS. Training is required before you can use the feature.	PAAS
description	string	No	The description.	testinstance
createParameters	array<object>	No	The parameters used to create the instance.	[ { "name": "param1", "value": "val1" } ]
	object	No	The parameter body.	{ "name": "title_field", "value": "title" }
name	string	No	The parameter name.	title_field
value	string	No	The parameter value.	title
usageParameters	array<object>	No	The parameters used to use the instance.
	object	No	The parameters that are used online, such as the blacklist and whitelist.
name	string	No	The parameter name.	allow_dict_id
value	string	No	The parameter value.	123
cron	string	No	The CRON expression used to schedule periodic training, in the format of Minutes Hours DayofMonth Month DayofWeek. The default value is empty, which specifies that no periodic training is performed. A value of 0 for DayofWeek specifies Sunday.	0 0 ? * 0,1,2,3,4,5,6

Sample requests (In this example, the functionName parameter is set to ctr.)

POST /v4/openapi/app-groups/my-app/functions/ctr/instances
{
    "instanceName": "my_ctr",
    "modelType": "tf_checkpoint",
    "functionType": "PAAS",
    "cron": "0 0 ? * 0,1,3,5",
    "description": "",
    "createParameters": [
        {
            "name": "id_field",
            "value": "id"
        },
        {
            "name": "title_field",
            "value": "title"
        }
    ],
    "usageParameters": []
}

Sample requests (In this example, the functionName parameter is set to hot.)

POST /v4/openapi/app-groups/my-app/functions/hot/instances
{
    "instanceName":"my_hot",
    "modelType":"offline_inference",
    "functionType":"PAAS",
    "createParameters":[
        {
            "name":"filter",
            "value":"biz_type != 1"
        }
    ],
    "usageParameters": [
        {
            "name":"allow_dict_id",
            "value":"123"
        },
        {
            "name":"deny_dict_id",
            "value":"456"
        }
    ],
    "cron":"12 4 ? * 1,2,3,4,5,6,0"
}

Response elements

Element	Type	Description	Example
	object	The parameter body.	{ "status" : "OK", "requestId" : "", "httpCode": 200, "code": "", "message": "", "latency" : 123, "result" : { } }
Status	string	The status of the request.	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The ID of the request.	98724351-D6B2-5D8A-B089-7FFD1821A7E9
Message	string	The error message. If no error occurs, this parameter is left empty.	version not exist.
Code	string	The error code.	Version.NotExist
Latency	integer	The time consumed for the request, in milliseconds.	123

Sample success responses

{
  "status" : "OK",
  "requestId" : "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "httpCode": 200,
  "code": "",
  "message": "",
  "latency" : 123,
  "result" : {}
}

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "98724351-D6B2-5D8A-B089-7FFD1821A7E9",
  "Message": "version not exist.",
  "Code": "Version.NotExist",
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.