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

Consulta uma lista de modelos que atendem às condições especificadas pelo ID da instância.

Descrição da operação

Descrição da operação\nEsta operação de API obtém uma lista de modelos de uma instância especificada. Você pode filtrar os resultados por nome do modelo, tipo e parâmetros de paginação. Forneça o ID da instância como um parâmetro de caminho. Outras condições de filtro são parâmetros de consulta opcionais.

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

list

*Instance

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

Nenhuma

Sintaxe da solicitação

GET /openapi/ha3/instances/{instanceId}/models 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-test

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
name	string	Não	O nome do modelo.	test1
type	string	Não	O tipo de modelo.	text_embedding
pageNumber	integer	Não	O número da página. Valor padrão: 1.	1
pageSize	integer	Não	O número de entradas por página. Valor padrão: 10.	10

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta inclui o ID da solicitação e uma lista de modelos. Cada elemento na lista de modelos contém informações detalhadas do modelo, como nome, tipo, URL e status.
requestId	string	O ID da solicitação.	38b079f1-7846-4226-8c90-3e2644b5c52b
totalCount	integer	O número total de entradas.	14
result	array<object>	A lista de modelos. Para mais informações, consulte Model.
	array<object>	As informações do modelo.
name	string	O nome do modelo.	test
type	string	O tipo de modelo.\n\n- a. Incorporação de texto: text_embedding\n- b. Incorporação esparsa de texto: text_sparse_embedding\n- c. Incorporação de imagem: image_embedding\n- d. Análise de conteúdo de imagem: image_analyze.	text_embedding
url	string	A URL de acesso do serviço de modelo.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	O status do modelo. Valores válidos:\n * ok: O modelo está disponível.\n * forbidden: O modelo está indisponível.	ok
dimension	integer	A dimensão do modelo.	128
content	object	As informações de conteúdo 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 access URL of the model service.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	The HTTP method for accessing the model service. PUT and POST are supported.	POST
request	object	The request configuration information.
header	object	The HTTP header for accessing the model service.
Authorization	string	The authentication information. Format: Bearer access_token.	Bearer OS-v0********6vvs
Content-Type	string	The HTTP request content type.	application/json
urlParams	object	The parameters in the URL. Some model services require parameters to be passed through the URL.
build	object	The parameters passed during index building.	key: value
search	object	The parameters passed during queries.	key: value
requestBody	string	The template string of the request body.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
parameters	object	The parameters that need to be differentiated between the build and search phases in the body. Define them in this parameter.
build	object	The parameters for the index building phase.
input_type	string	The input type.	query
search	object	The parameters for the query phase.
input_type	string	The input type.	document
response	object	Specifies how to parse the result information, described in JSON path format.
embeddings	string	Specifies how to parse the result information, described in JSON path format.	$.result.embeddings[*].embedding
createTime	string	A hora de criação.	2024-05-21 16:05:26
updateTime	string	A hora da última modificação.	2024-05-21 16:05:26

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "38b079f1-7846-4226-8c90-3e2644b5c52b",
  "totalCount": 14,
  "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}\\\"}",
          "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.