OpenSearch:Servicio de reducción de dimensionalidad vectorial

Requisitos previos

• Obtenga las credenciales de autenticación

  La plataforma abierta AI Search requiere una clave de API para la autenticación. Para obtener instrucciones, consulte Get an API key.

• Obtenga el endpoint del servicio

  Puede invocar el servicio mediante la red pública o una VPC. Para más detalles, consulte Get the service endpoint.

Formato de solicitud

Instrucciones generales

• El cuerpo de la solicitud no debe exceder los 8 MB.

Método de solicitud HTTP

POST

URL

{host}/v3/openapi/workspaces/{workspace_name}/embedding-tuning/{service_id}

• host: El endpoint del servicio. Puede invocar la API mediante la red pública o una VPC. Para más detalles, consulte Obtain a service endpoint. Para obtener el endpoint, inicie sesión en la consola de la plataforma abierta AI Search. En el panel de navegación izquierdo, haga clic en API Keys. En la sección Access domain name, copie el nombre de dominio correspondiente al valor {host}. Use el dominio público para acceder mediante la red pública y el dominio privado para acceder mediante VPC en las regiones China (Shanghai), China (Hangzhou), China (Shenzhen), China (Beijing), China (Zhangjiakou) y China (Qingdao). Haga clic en Create API Key para generar una nueva clave.

• workspace_name: El nombre de su espacio de trabajo, por ejemplo, default.

• service_id: El ID del servicio integrado, como ops-embedding-dim-reduction-001.

Parámetros de solicitud

Parámetros de encabezado

Autenticación mediante clave de API

Parámetros del cuerpo

Parámetros de respuesta

Ejemplo de solicitud con curl

curl --location 'http://****-hangzhou.opensearch.aliyuncs.com/v3/openapi/workspaces/default/embedding-tuning/ops-embedding-dim-reduction-001/' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data '{  
  "input": [
    [0.111,0.222,0.333],
    [0.121,0.221,0.331]
  ],
  "parameters":{
    "output_dimension": "512",
    "model_name" : "xxxx"
  }
}'

Ejemplos de respuesta

Ejemplo de respuesta exitosa

{
  "request_id": "450fcb80-f796-46c1-8d69-e1e86d29aa9f",
  "latency": 564.903929,
  "usage": {
    "doc_count": 2
  },
  "result": {
    "output":[
      [0.111,0.222,0.333],
      [0.121,0.221,0.331]
    ]
  }
}

Ejemplo de respuesta de error

Si una solicitud falla, la respuesta incluye un code y un message que describen el error.

{
    "request_id": "590A7EB8-AA84-****-AF31-8C35DC965972",
    "latency": 0.0,
    "code": "InvalidParameter",
    "http_code": 400,
    "message": "document.file_name required"
}

Códigos de estado

Para consultar la lista completa de códigos de error, consulte Status codes.