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

Modifica os detalhes e o status de um modelo.

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

update

*Instance

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

Nenhuma

Sintaxe da solicitação

PUT /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
dryRun	string	Não	Especifica se deve ser realizada apenas uma verificação. O valor padrão é false.	true
body	object	Não	O corpo da solicitação.
content	object	Não	Os detalhes do modelo.
method	string	Não	O método HTTP para acessar o serviço do modelo. Valores válidos: PUT e POST.	POST
modelType	string	Não	O tipo do modelo. Text embedding: text_embedding Text sparse embedding: text_sparse_embedding Image embedding: image_embedding Image content parsing: image_analyze	text_embedding
dimension	integer	Não	A dimensão do modelo.	128
request	object	Não	O corpo da solicitação do modelo.
header	object	Não	The HTTP header to access the model service.
Authorization	string	Não	The authentication information. Format: Bearer access_token	Bearer OS-v0********6vvs
Content-Type	string	Não	The content type of the HTTP request.	application/json
parameters	object	Não	Specifies parameters that are different for the build and search phases.
build	object	Não	The parameters for the index building phase.
input_type	string	Não	The input type.	query
search	object	Não	The parameters for the query phase.
input_type	string	Não	The input type.	document
requestBody	string	Não	The template string for the request body.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
urlParams	object	Não	The parameters in the URL. Some model services require parameters to be passed in the URL.
build	object	Não	The parameters for the index building phase.	key: value
search	object	Não	The parameters for the query phase.	key: value
response	object	Não	A expressão JSONPath usada para analisar o resultado.
embeddings	string	Não	The JSONPath expression used to parse the embeddings from the result.	$.result.embeddings[*].embedding
url	string	Não	O endpoint do serviço do modelo.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
status	string	Não	O status do modelo. ok: O modelo está ativo. forbidden: O modelo está indisponível.	ok

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	O esquema de resposta.
requestId	string	O ID da solicitação.	D39EE0F1-D7EF-5F46-B781-6BF4185308B0

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "D39EE0F1-D7EF-5F46-B781-6BF4185308B0"
}

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.