CreateModel - OpenSearch - Centro de documentación de Alibaba Cloud

Crea un modelo.

Pruébelo ahora

Pruebe esta API en OpenAPI Explorer sin necesidad de firma manual. Las llamadas exitosas generan automáticamente código SDK acorde a sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Test

Autorización de RAM

La siguiente tabla describe la autorización necesaria para invocar esta API. Puede definirla en una directiva de Resource Access Management (RAM). A continuación, se detallan las columnas de la tabla:

Action: Estas acciones se utilizan en el elemento Action de las declaraciones de directivas de permisos de RAM para otorgar permisos que permitan realizar la operación.
API: La API que debe invocarse para llevar a cabo la acción.
Nivel de acceso: Nivel de acceso predefinido que se concede para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: Tipo de recurso que admite autorización para ejecutar la acción. Indica si la acción es compatible con permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción; de lo contrario, la directiva no surtirá efecto.
- En las API con permisos a nivel de recurso, los tipos de recursos obligatorios se marcan con un asterisco (*). Especifique el Alibaba Cloud Resource Name (ARN) correspondiente en el elemento Resource de la directiva.
- Para las API sin permisos a nivel de recurso, se muestra All Resources. Utilice un asterisco (*) en el elemento Resource de la directiva.
Clave de condición: Claves de condición definidas por el servicio. Permiten un control granular y se aplican ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de common condition keys aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Acciones dependientes necesarias para ejecutar la acción principal. Para completar la operación, el usuario de RAM o el rol de RAM debe contar con permisos para realizar todas las acciones dependientes.

Action

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

searchengine:CreateModel

create

*Instance

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

Ninguna

Sintaxis de la solicitud

POST /openapi/ha3/instances/{instanceId}/models HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
instanceId	string	Sí	El ID de la instancia.	ha-cn-pl32rf0****

Parámetros de la solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
dryRun	string	No	Especifica si se debe realizar solo una ejecución de prueba. El valor predeterminado es false.	true
body	object	No	El cuerpo de la solicitud.
name	string	Sí	El nombre del modelo.	test
content	object	No	Los detalles del modelo.
modelType	string	No	El tipo de modelo. a. Incrustación de texto: text_embedding b. Incrustación dispersa de texto: text_sparse_embedding c. Incrustación de imagen: image_embedding d. Análisis de contenido de imagen: image_analyze	text_embedding
dimension	integer	No	La dimensión del modelo. Este parámetro es obligatorio si `modelType` es `text_embedding` o `image_embedding`.	128
url	string	No	El endpoint del servicio de modelo.	http://***.platform-cn-shanghai.opensearch.aliyuncs.com/v3/openapi/workspaces/default/text-embedding/ops-text-embedding-001
method	string	No	El método HTTP para acceder al servicio de modelo. Métodos admitidos: PUT y POST.	POST
request	object	No	El cuerpo de la solicitud del modelo.
header	object	No	El encabezado HTTP para acceder al servicio de modelo.
Authorization	string	No	La información de autenticación. Formato: Bearer access_token.	Bearer OS-v0********6vvs
Content-Type	string	No	El tipo de contenido de la solicitud HTTP.	application/json
urlParams	object	No	Los parámetros en la URL. Algunos servicios de modelo requieren que los parámetros se pasen en la URL.
build	object	No	Los parámetros que se pasan durante la creación del índice.	key: value
search	object	No	Los parámetros que se pasan durante una consulta.	key: value
parameters	object	No	Si los parámetros en el cuerpo de la solicitud son diferentes para las fases de creación y consulta, defínalos en este parámetro.
build	object	No	Los parámetros para la fase de creación del índice.
input_type	string	No	El tipo de entrada.	query
search	object	No	Los parámetros para la fase de consulta.
input_type	string	No	El tipo de entrada.	document
requestBody	string	No	La cadena de plantilla para el cuerpo de la solicitud.	{\"input\": [\"%{input}\"], \"input_type\": \"%{input_type}\"}
response	object	No	La configuración para analizar la respuesta. Utilice el formato JSONPath.
embeddings	string	No	La expresión JSONPath para extraer las incrustaciones de la respuesta.	$.result.embeddings[*].embedding

Elementos de la respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta.
requestId	string	El ID de la solicitud.	022F36C7-9FB4-5D67-BEBC-3D14B0984463

Ejemplos

Respuesta exitosa

JSON Formato

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

Códigos de error

Consulte Códigos de error para ver la lista completa.

Notas de la versión

Consulte Notas de la versión para ver la lista completa.