GetFunctionCurrentVersion - OpenSearch - Centro de documentación de Alibaba Cloud

Obtiene la información de la versión de la función que se utiliza para crear una instancia.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

opensearch:DescribeFunction

get

*All Resource

*

Ninguna

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
functionName	string	Sí	El nombre de la función. Valores válidos: ctr: modelo de tasa de clics (CTR) pop: modelo de popularidad category: modelo de categoría hot: modelo de palabras clave hint: modelo de sugerencias suggest: modelo de sugerencias desplegables analyzer: modelo de segmentación de palabras termweight: modelo de ponderación de términos	ctr

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
modelType	string	Sí	El tipo de modelo. Las diferentes funciones corresponden a distintos tipos de modelo: Modelo CTR: tf_checkpoint Modelo de popularidad: pop Modelo de categoría: offline_inference Modelo de palabras clave: offline_inference Modelo de sugerencias: offline_inference Modelo de sugerencias desplegables: offline_inference Modelo de segmentación de palabras: text Modelo de ponderación de términos: tf_checkpoint Valores válidos: pop : Modelo de popularidad. offline_inference : Modelos para palabras clave, sugerencias y predicción de categorías. tf_checkpoint : Modelos para CTR y ponderación de términos personalizada. text : Tokenización personalizada.	tf_checkpoint
functionType	string	No	El tipo de la función. Valores válidos: PAAS (valor predeterminado) SAAS	PAAS
domain	string	No	La industria. El valor predeterminado está vacío, lo que indica la edición de propósito general. Valores válidos: education : Educación. ecommerce : Comercio electrónico. community : Comunidad de contenido.	ecommerce
category	string	No	La categoría. El valor predeterminado está vacío. Valores válidos: general : General. question : Búsqueda de preguntas y respuestas para la industria educativa. it : Contenido de TI.	general

Solicitud de ejemplo

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

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	El cuerpo de la respuesta.	{ "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": "依赖项", "condition": "条件", "description": "" } ], "usageParameters": [] } } }
status	string
httpCode	integer
requestId	string
message	string
code	string
result	object
functionName	string
functionType	string
modelType	string
versionConfig	object
createParameters	array<object>
	object
	string
depends	array<object>
	object
	string
usageParameters	array<object>
	object
	string
versionId	integer
versionName	string
latency	integer

Respuesta de éxito de ejemplo (modelo de palabras clave)

{
    "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"
        }
    }
}

Ejemplos

Respuesta exitosa

JSON Formato

{
  "status": "",
  "httpCode": 0,
  "requestId": "",
  "message": "",
  "code": "",
  "result": {
    "functionName": "",
    "functionType": "",
    "modelType": "",
    "versionConfig": {
      "createParameters": [
        {
          "key": ""
        }
      ],
      "depends": [
        {
          "key": ""
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ]
    },
    "versionId": 0,
    "versionName": ""
  },
  "latency": 0
}

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.