GetFunctionCurrentVersion - OpenSearch - Alibaba Cloud Documentation Center

Retrieves the version information of the feature that is used to create an instance.

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

get

*All Resource

*

None

Request syntax

GET /v4/openapi/functions/{functionName}/current-version HTTP/1.1

Path Parameters

Parameter	Type	Required	Description	Example
functionName	string	Yes	The name of the feature. Valid values: ctr: Click-through rate (CTR) model pop: Popularity model category: Category model hot: Hotword model hint: Hint model suggest: Drop-down suggestion model analyzer: Word segmentation model termweight: Term weighting model	ctr

Request parameters

Parameter	Type	Required	Description	Example
modelType	string	Yes	The model type. Different features correspond to different model types: CTR model: tf_checkpoint Popularity model: pop Category model: offline_inference Hotword model: offline_inference Hint model: offline_inference Drop-down suggestion model: offline_inference Word segmentation model: text Term weighting model: tf_checkpoint Valid values: pop : Popularity model offline_inference : Models for hotwords, hints, and category prediction. tf_checkpoint : Models for CTR and custom term weighting. text : Custom tokenization.	tf_checkpoint
functionType	string	No	The type of the feature. Valid values: PAAS (default) SAAS	PAAS
domain	string	No	The industry. The default value is empty, which indicates the General-purpose Edition. Valid values: education : Education ecommerce : E-commerce community : Content community	ecommerce
category	string	No	The category. The default value is empty. Valid values: general : General question : Question-answering search for the education industry. it : IT content	general

Sample request

GET /v4/openapi/functions/ctr/current-version?modelType=_checkpoint&functionType=PAAS&domain=ecommerce&category=general

Response elements

Element	Type	Description	Example
	object	The response body.	{ "status": "OK", "requestId": "", "httpCode": 200, "code": "", "message": "", "latency": 123, "result": { "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ], "depends": [ { "dependency": "dependency", "condition": "condition", "description": "" } ], "usageParameters": [] } } }
Status	string	The status of the request.	OK
HttpCode	integer	The HTTP status code.	200
RequestId	string	The request ID.	1638157479281
Message	string	The error message.	version not exist.
Code	string	The error code.	Version.NotExist
Result	object	The returned result.	{ "versionName": "v1", "versionId": 101, "functionName": "ctr", "modelType": "tf_checkpoint", "functionType": "PAAS", "versionConfig": { "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ], "depends": [ { "dependency": "dependency", "condition": "condition", "description": "" } ], "usageParameters": [] } }
FunctionName	string	The name of the feature.	ctr
FunctionType	string	The type of the feature. Valid values: PAAS SAAS	PAAS
ModelType	string	The model type.	tf_checkpoint
VersionConfig	object	The configuration.	{ "createParameters": [ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ], "depends": [ { "dependency": "dependency", "condition": "condition", "description": "" } ], "usageParameters": [] }
CreateParameters	array<object>	The parameters used to create an instance.	[ { "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" } ]
	object	The parameter object.	{ "name": "params1", "required": "true", "formItemProps": "{\"required\": true, \"pattern?\": \"/^[a-zA-Z][a-zA-Z0-9_]{0,29}$/\"}", "componentProps": "{\"component\": \"Input\", \"attributes\": {\"defaultValue\": \"value1\"}}" }
Name	string	The name of the parameter.	params1
Required	string	Specifies whether the parameter is required.	true
Depends	array<object>	A list of instance dependencies.	[ { "dependency": "dependency", "condition": "condition", "description": "" } ]
	object	The parameter object.	{ "dependency": "dependency", "condition": "condition", "description": "" }
Condition	string	The condition.	""
Dependency	string	The dependency.	""
Description	string	The description.	""
UsageParameters	array<object>	The parameters for using the instance online.	[]
	object	The parameter object.	{}
Name	string	The name of the parameter.	""
Required	string	Specifies whether the parameter is required.	""
VersionId	integer	The version ID.	101
VersionName	string	The version name.	v1
Latency	integer	The request latency in milliseconds (ms).	123

Sample success response (hotword model)

{
    "status": "OK",
    "requestId": "165890826219877085621759",
    "latency": 0.049,
    "httpCode": 200,
    "code": "",
    "message": "",
    "result": {
        "versionId": 37,
        "versionName": "v2",
        "description": "",
        "status": "available",
        "functionName": "hot",
        "modelType": "offline_inference",
        "functionType": "PAAS",
        "versionConfig": {
            "createParameters": [
                {
                    "name": "filter",
                    "required": "false",
                    "validations": "[{\"preprocess\": {\"pattern\": \"(\\\\w+)\\\\s*(>=|<=|>|<|=|!=)\\\\s*(\\\\w+)\", \"type\": \"regex\", \"group\": 1}, \"params\": {\"data\": [\"user_id\", \"biz_type\"], \"type\": \"trival\"}, \"class\": \"EnumerateRule\"}]",
                    "value": "{\"component\":\"Input\",\"attributes\":{\"defaultValue\":\"\",\"dataSource\":\"\"}}",
                    "valueSplit": ","
                }
            ],
            "usageParameters": [
                {
                    "name": "allow_dict_id",
                    "required": "false",
                    "validations": "[{\"params\": {\"restrictions\": \"type=hot_allowlist\", \"type\": \"passthrough\", \"dataSource\": \"dicts\"}, \"class\": \"EnumerateRule\"}]",
                    "value": "{\"component\":\"Select\",\"attributes\":{\"defaultValue\":\"\",\"dataSource\":\"\"}}"
                },
                {
                    "name": "deny_dict_id",
                    "required": "false",
                    "validations": "[{\"params\": {\"restrictions\": \"type=hot_denylist\", \"type\": \"passthrough\", \"dataSource\": \"dicts\"}, \"class\": \"EnumerateRule\"}]",
                    "value": "{\"component\":\"Select\",\"attributes\":{\"defaultValue\":\"\",\"dataSource\":\"\"}}"
                }
            ],
            "depends": [
                {
                    "condition": "integrity_level >= 1",
                    "dependency": "integrity_level",
                    "description": "The data integrity level must be L1 or higher."
                }
            ],
            "deployment": "",
            "dagTemplate": "opensearch_hot_train"
        }
    }
}

Examples

Success response

JSON format

{
  "Status": "OK",
  "HttpCode": 200,
  "RequestId": "1638157479281",
  "Message": "version not exist.",
  "Code": "Version.NotExist",
  "Result": {
    "FunctionName": "ctr",
    "FunctionType": "PAAS",
    "ModelType": "tf_checkpoint",
    "VersionConfig": {
      "CreateParameters": [
        {
          "Name": "params1",
          "Required": "true"
        }
      ],
      "Depends": [
        {
          "Condition": "\"\"",
          "Dependency": "\"\"",
          "Description": "\"\""
        }
      ],
      "UsageParameters": [
        {
          "Name": "\"\"",
          "Required": "\"\""
        }
      ]
    },
    "VersionId": 101,
    "VersionName": "v1"
  },
  "Latency": 123
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.