GetModel - OpenSearch: Central de Documentação do Alibaba Cloud

Consulta a configuração detalhada de um modelo específico por ID da instância e nome do modelo.

Descrição da operação

Descrição da solicitação

Esta API obtém os detalhes de um modelo específico em uma instância, como seu tipo de modelo, URL e status.
Certifique-se de que o instanceId e o modelName fornecidos sejam válidos. Caso contrário, um erro será retornado ou o recurso não poderá ser encontrado.
A resposta inclui o conteúdo do modelo, como cabeçalhos e parâmetros da solicitação. Também contém os horários de criação e atualização. Essas informações ajudam você a entender a configuração do modelo e seu status atual.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Testar

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:

Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
API: A API que você pode chamar para executar a ação.
Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
- Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
- Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

searchengine:GetModel

get

*Instance

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

Nenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
instanceId	string	Sim	O ID da instância.	ha-cn-pl32rf0****
modelName	string	Sim	O nome do modelo.	test

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
requestId	string	O ID da solicitação.	38b079f1-7846-4226-8c90-3e2644b5c52b
result	object	A configuração do modelo.
name	string	O nome do modelo.	test
type	string	O tipo de modelo. a. Incorporação de texto: text_embedding b. Incorporação esparsa de texto: text_sparse_embedding c. Incorporação de imagem: image_embedding d. Análise de conteúdo de imagem: image_analyze Valores válidos: text_embedding : Incorporação de texto. image_embedding : Incorporação de imagem. image_analyze : Análise de conteúdo de imagem. text_sparse_embedding : Incorporação esparsa de texto.	text_embedding
url	string	A URL de acesso do modelo.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	O status do modelo. ok: Normal error: Anormal	ok
dimension	integer	A dimensão do modelo.	128
content	object	A configuração do modelo.
modelName	string	The model name.	test
modelType	string	The model type. a. Text embedding: text_embedding b. Text sparse embedding: text_sparse_embedding c. Image embedding: image_embedding d. Image content analysis: image_analyze	text_embedding
url	string	The model service endpoint.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	The HTTP method to access the model service. PUT and POST are supported.	POST
request	object	The request configuration.
header	object	The HTTP request header.
Authorization	string	Authentication information. The format is Bearer access_token.	Bearer OS-v0********6vvs
Content-Type	string	The HTTP request's content type.	application/json
urlParams	object	URL parameters. Some model services require you to pass parameters in the URL.
build	object	Parameters passed during index building.	key: value
search	object	Parameters passed during a query.	key: value
requestBody	string	The request body's template string.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
parameters	object	Define parameters here if they differ between the build and search phases.
build	object	Parameters for the index building phase.
input_type	string	The input type.	query
search	object	Parameters for the query phase.
input_type	string	The input type.	document
response	object	The method to parse the result. This is described in JSONPath format.
embeddings	string	The method to parse the result. This is described in JSONPath format.	$.result.embeddings[*].embedding
createTime	string	A hora de criação.	2024-05-21 16:05:26
updateTime	string	A hora de atualização.	2024-05-21 16:05:26

Exemplos

Resposta de sucesso

JSON formato

{
  "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\n",
          "Content-Type": "application/json\n"
        },
        "urlParams": {
          "build": {
            "test": "test",
            "test2": 1
          },
          "search": {
            "test": "test",
            "test2": 1
          }
        },
        "requestBody": "{\\\"input\\\": [\\\"%{input}\\\"], \\\"input_type\\\": \\\"%{input_type}\\\"}\n",
        "parameters": {
          "build": {
            "input_type": "query\n"
          },
          "search": {
            "input_type": "document\n"
          }
        }
      },
      "response": {
        "embeddings": "$.result.embeddings[*].embedding\n"
      }
    },
    "createTime": "2024-05-21 16:05:26",
    "updateTime": "2024-05-21 16:05:26"
  }
}

Códigos de erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.