GetModel - - Centre de documentation Alibaba Cloud

Consulte les informations de configuration détaillées d'un modèle spécifique par identifiant d'instance et nom de modèle.

Description de l'opération

Description de la requête

Cette opération récupère les détails d'un modèle spécifique sous une instance spécifiée, y compris le type de modèle, l'URL et l'état.
Assurez-vous que les paramètres instanceId et modelName fournis sont valides. Sinon, une erreur peut être renvoyée ou la ressource peut ne pas être trouvée.
La structure de données renvoyée contient le contenu du modèle, tel que les en-têtes et les paramètres de requête, ainsi que les heures de création et de mise à jour. Cela vous aide à comprendre la configuration spécifique et le dernier état du modèle.

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.

searchengine:GetModel

get

*Instance.

acs:searchengine:{#regionId}:{#accountId}:instance/{#InstanceId}

Aucune

Syntaxe de la requête

GET /openapi/ha3/instances/{instanceId}/models/{modelName} HTTP/1.1

Paramètres de chemin

Paramètre	Type	Requis	Description	Exemple
instanceId	string	Oui	L'identifiant de l'instance.	ha-cn-pl32rf0****
modelName	string	Oui	Le nom du modèle.	test

Paramètres de requête

Paramètre

Type

Requis

Description

Exemple

Éléments de réponse

Élément	Type	Description	Exemple
	object	Schéma de la réponse.
requestId	string	L'identifiant de la requête.	38b079f1-7846-4226-8c90-3e2644b5c52b
result	object	Les informations de configuration du modèle.
name	string	Le nom du modèle.	test
type	string	La catégorie du modèle. a. Embedding de texte : text_embedding b. Embedding sparse de texte : text_sparse_embedding c. Embedding d'image : image_embedding d. Analyse de contenu d'image : image_analyze Valeurs valides : text_embedding : Embedding de texte. image_embedding : Embedding d'image. image_analyze : Analyse de contenu d'image. text_sparse_embedding : Embedding sparse de texte.	text_embedding
url	string	L'URL d'accès au modèle.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	L'état du modèle. ok : Normal. error : Anormal. Valeurs valides : error : Anormal. ok : Normal.	ok
dimension	integer	Les dimensions du modèle.	128
content	object	Les informations de configuration du modèle.
modelName	string	Le nom du modèle.	test
modelType	string	La catégorie du modèle. a. Embedding de texte : text_embedding b. Embedding sparse de texte : text_sparse_embedding c. Embedding d'image : image_embedding d. Analyse de contenu d'image : image_analyze	text_embedding
url	string	L'adresse d'accès du service de modèle.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	La méthode HTTP utilisée pour accéder au service de modèle. Valeurs valides : PUT et POST.	POST
request	object	Les informations de configuration de la requête.
header	object	Les en-têtes de requête HTTP.
Authorization	string	Les informations d'authentification. Format : Bearer access_token.	Bearer OS-v0********6vvs
Content-Type	string	Le type de contenu de la requête HTTP.	application/json
urlParams	object	Les paramètres dans l'URL. Certains services de modèle nécessitent que les paramètres soient transmis dans l'URL.
build	object	Les paramètres transmis lors de la création de l'index.	key: value
search	object	Les paramètres transmis lors des requêtes.	key: value
requestBody	string	La chaîne de modèle du corps de la requête.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
parameters	object	Les paramètres de requête. Si les paramètres du corps doivent être distingués entre les phases de création et de recherche, ils peuvent être définis dans ce paramètre.
build	object	Les paramètres pour la phase de création de l'index.
input_type	string	Le type d'entrée.	query
search	object	Les paramètres pour la phase de requête.
input_type	string	Le type d'entrée.	document
response	object	La méthode d'analyse pour les informations de résultat, décrite au format JSONPath.
embeddings	string	La méthode d'analyse pour les informations de résultat, décrite au format JSONPath.	$.result.embeddings[*].embedding
createTime	string	L'heure de création. Format : YYYY-MM-DD HH:mm:ss.	2024-05-21 16:05:26
updateTime	string	L'heure de mise à jour. Format : YYYY-MM-DD HH:mm:ss.	2024-05-21 16:05:26

Exemples

JSON format

{
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "result": {
    "name": "test",
    "type": "text_embedding",
    "url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
    "status": "ok",
    "dimension": 128,
    "content": {
      "modelName": "test",
      "modelType": "text_embedding",
      "url": "http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001",
      "method": "POST",
      "request": {
        "header": {
          "Authorization": "Bearer OS-v0********6vvs",
          "Content-Type": "application/json"
        },
        "urlParams": {
          "build": {
            "test": "test",
            "test2": 1
          },
          "search": {
            "test": "test",
            "test2": 1
          }
        },
        "requestBody": "{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}",
        "parameters": {
          "build": {
            "input_type": "query"
          },
          "search": {
            "input_type": "document"
          }
        }
      },
      "response": {
        "embeddings": "$.result.embeddings[*].embedding"
      }
    },
    "createTime": "2024-05-21 16:05:26",
    "updateTime": "2024-05-21 16:05:26"
  }
}

Codes d'erreur

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

Notes de version

Consultez Notes de version pour la liste complète.