GetFunctionCurrentVersion - - Centre de documentation Alibaba Cloud

Obtient les informations de version utilisées lors de la création d'une instance pour la fonctionnalité actuelle.

Testez maintenant

Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale. Testez cette API dans OpenAPI Explorer, sans signature manuelle. Les appels réussis génèrent automatiquement du code SDK correspondant à vos paramètres. Téléchargez-le avec une sécurité intégrée des identifiants pour une utilisation locale.

Test

Autorisation RAM

Le tableau ci-dessous décrit les autorisations nécessaires pour appeler cette API. Vous pouvez les définir dans une politique Resource Access Management (RAM). Les colonnes du tableau sont détaillées ci-dessous :

Action : les actions peuvent être utilisées dans l'élément Action des instructions de politique de permissions RAM pour accorder les autorisations nécessaires à l'exécution de l'opération.
API : l'API que vous pouvez appeler pour exécuter l'action.
Niveau d'accès : le niveau d'accès prédéfini accordé pour chaque API. Valeurs valides : create, list, get, update et delete.
Type de ressource : le type de ressource qui prend en charge l'autorisation pour exécuter l'action. Il indique si l'action prend en charge les permissions au niveau de la ressource. La ressource spécifiée doit être compatible avec l'action. Sinon, la politique sera inefficace.
- Pour les API avec permissions au niveau de la ressource, les types de ressource requis sont marqués d'un astérisque (*). Spécifiez l'Alibaba Cloud Resource Name (ARN) correspondant dans l'élément Resource de la politique.
- Pour les API sans permissions au niveau de la ressource, la valeur All Resources est affichée. Utilisez un astérisque (*) dans l'élément Resource de la politique.
Clé de condition : les clés de condition définies par le service. La clé permet un contrôle granulaire, applicable aux actions seules ou aux actions associées à des ressources spécifiques. En plus des clés de condition propres au service, Alibaba Cloud fournit un ensemble de clés de condition communes applicables à tous les services pris en charge par RAM.
Action dépendante : les actions dépendantes requises pour exécuter l'action. Pour mener à bien l'opération, l'utilisateur RAM ou le rôle RAM doit disposer des permissions pour toutes les actions dépendantes.

opensearch:DescribeFunction

get

*Toutes les ressources.

*

Aucune

Syntaxe de la requête

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

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
functionName	string	Oui	Le nom de la fonctionnalité. Modèles pris en charge : Modèle CTR : ctr Modèle de popularité : pop Modèle de catégorie : category Modèle de mots tendance : hot Modèle d'indices : hint Modèle de suggestions déroulantes : suggest Modèle de tokenisation : analyzer Modèle de pondération des termes : termweight	ctr

Paramètres de requête

Paramètre	Type	Requis	Description	Exemple
modelType	string	Oui	Le type de modèle. Les types de modèles correspondant aux différentes fonctionnalités sont les suivants : Modèle CTR : tf_checkpoint Modèle de popularité : pop Modèle de catégorie : offline_inference Modèle de mots tendance : offline_inference Modèle d'indices : offline_inference Modèle de suggestions déroulantes : offline_inference Modèle de tokenisation : text Modèle de pondération des termes : tf_checkpoint Valeurs valides : pop : Modèle de popularité. offline_inference : Prédiction de mots tendance, d'indices ou de catégories. tf_checkpoint : CTR, pondération personnalisée des termes, et autres. text : Tokenisation personnalisée.	tf_checkpoint
functionType	string	Non	Le type de fonctionnalité. Valeurs valides : PAAS (par défaut) SAAS	PAAS
domain	string	Non	Le secteur d'activité. Valeur par défaut : vide, ce qui indique l'édition à usage général. Valeurs valides : education : Secteur de l'éducation. ecommerce : Secteur du commerce électronique. community : Communauté de contenu.	ecommerce
category	string	Non	La catégorie verticale. Valeur par défaut : vide. Valeurs valides : general : Général. question : Recherche de questions éducatives. it : Contenu informatique.	general

Exemples

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

Éléments de réponse

Élément	Type	Description	Exemple
	object	Le corps de la réponse.	{ "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	Le code d'état.	OK
httpCode	integer	Le code d'état HTTP.	200
requestId	string	L'identifiant de la requête.	1638157479281
message	string	Le message d'erreur.	version not exist.
code	string	Le code d'erreur.	Version.NotExist
result	object	Le résultat renvoyé.
functionName	string	Le nom de la fonctionnalité.	ctr
functionType	string	Le type de fonctionnalité. Valeurs valides : PAAS SAAS	PAAS
modelType	string	Le type de modèle.	tf_checkpoint
versionConfig	object	Les informations de configuration.
createParameters	array<object>	La liste des paramètres utilisés lors de la création d'une instance.
	object	Le corps du paramètre.
	string
depends	array<object>	La liste des dépendances de l'instance.
	object	Le corps du paramètre.
	string
usageParameters	array<object>	La liste des paramètres utilisés lors de l'utilisation en ligne de l'instance.
	object	Le corps du paramètre.
	string
versionId	integer	L'identifiant de la version.	101
versionName	string	Le nom de la version.	v1
latency	integer	La latence de la requête en millisecondes.	123

Exemples de réponses de réussite (modèle de mots tendance)

{
    "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 at least L1."
                }
            ],
            "deployment": "",
            "dagTemplate": "opensearch_hot_train"
        }
    }
}

Exemples

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": [
        {
          "key": ""
        }
      ],
      "depends": [
        {
          "key": ""
        }
      ],
      "usageParameters": [
        {
          "key": ""
        }
      ]
    },
    "versionId": 101,
    "versionName": "v1"
  },
  "latency": 123
}

Codes d'erreur

Consultez Codes d'erreur pour la liste complète.

Notes de version

Consultez Notes de version pour la liste complète.