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

Cria 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:CreateModel

create

*Instance

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

Nenhuma

Sintaxe da solicitação

POST /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-pl32rf0****

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
dryRun	string	Não	Especifica se deve ser realizado apenas um dry run. Valor padrão: false.	true
body	object	Não	O corpo da solicitação.
name	string	Sim	O nome do modelo.	test
content	object	Não	Os detalhes do modelo.
modelType	string	Não	O tipo de modelo. a. Embedding de texto: text_embedding b. Embedding esparso de texto: text_sparse_embedding c. Embedding de imagem: image_embedding d. Análise de conteúdo de imagem: image_analyze	text_embedding
dimension	integer	Não	A dimensão do modelo. Este parâmetro é obrigatório se modelType for text_embedding ou image_embedding.	128
url	string	Não	O endpoint do serviço de modelo.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	Não	O método HTTP para acessar o serviço de modelo. Métodos suportados: PUT e POST.	POST
request	object	Não	O corpo da solicitação do modelo.
header	object	Não	The HTTP header for accessing 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
urlParams	object	Não	The parameters in the URL. Some model services require that parameters are passed in the URL.
build	object	Não	The parameters passed during index building.	key: value
search	object	Não	The parameters passed during a query.	key: value
parameters	object	Não	If the parameters in the request body are different for the build and search phases, define them in this parameter.
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}\"}
response	object	Não	A configuração para analisar a resposta. Use o formato JSONPath.
embeddings	string	Não	The JSONPath expression to extract embeddings from the response.	$.result.embeddings[*].embedding

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
requestId	string	O ID da solicitação.	022F36C7-9FB4-5D67-BEBC-3D14B0984463

Exemplos

Resposta de sucesso

JSON formato

{
  "requestId": "022F36C7-9FB4-5D67-BEBC-3D14B0984463"
}

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.