> ## Documentation Index
> Fetch the complete documentation index at: https://docs.acedata.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# Solicitud y uso de la API de OpenAI Embeddings

> OpenAI generation API guide - Ace Data Cloud

Servicio de vectores de palabras de OpenAI, utilizado para generar resultados de vectores de palabras que representan el texto de entrada.

Este documento presenta principalmente el proceso de uso de las operaciones de la API de OpenAI Embeddings; con ella podemos crear vectores de incrustación que representan el texto de entrada。。

## Proceso de solicitud

Para usar la API de OpenAI Embeddings, primero obtenga su API Token en la [consola de Ace Data Cloud](https://platform.acedata.cloud/console/applications) y guárdelo como respaldo.

![](https://cdn.acedata.cloud/dvc3cg.jpg)

Si aún no ha iniciado sesión o no se ha registrado, será redirigido automáticamente a la página de inicio de sesión para invitarle a registrarse e iniciar sesión; al finalizar, regresará automáticamente a la página actual.

**Un API Token permite invocar todos los servicios de la plataforma, sin necesidad de solicitar uno por separado para cada servicio.** La primera solicitud incluye crédito gratuito, que permite una experiencia gratuita; cuando el crédito sea insuficiente, puede recargar saldo general en la [consola](https://platform.acedata.cloud/console/coin).

> 📘 Documentación completa: [OpenAI Embeddings API →](https://platform.acedata.cloud/documents/openai-embeddings)

## Uso básico

A continuación, puede completar el contenido correspondiente en la interfaz, como se muestra en la imagen:

<p>
  <img src="https://cdn.acedata.cloud/4qtbvr.png" width="500" className="m-auto" />
</p>

Al usar esta interfaz por primera vez, necesitamos completar al menos tres contenidos: uno es `authorization`, que puede seleccionarse directamente en la lista desplegable. Otro parámetro es `model`; `model` corresponde a la categoría de modelo del sitio web oficial de OpenAI que elegimos utilizar; los modelos actualmente disponibles son `text-embedding-3-small` y `text-embedding-3-large`. `text-embedding-ada-002` ha dejado de ofrecerse; si los índices vectoriales existentes utilizan este modelo antiguo, no pueden mezclar directamente los vectores de los nuevos modelos y es necesario reconstruir el índice. El último parámetro es `input`; `input` es el texto de vectores de palabras que necesitamos convertir.

Al mismo tiempo, puede observar que a la derecha se genera el código de llamada correspondiente; puede copiar el código y ejecutarlo directamente, o también puede hacer clic directamente en el botón «Try» para realizar pruebas.

Parámetros opcionales:

* `dimensions`: recorta las dimensiones del vector; por defecto, genera las dimensiones completas.
* `encoding_format`: formato de retorno; puede ser `float` o `base64`.

<p>
  <img src="https://cdn.acedata.cloud/gqulm9.png" width="500" className="m-auto" />
</p>

Código de llamada de ejemplo en Python:

```python theme={null}
import requests

url = "https://api.acedata.cloud/openai/embeddings"

headers = {
    "accept": "application/json",
    "authorization": "Bearer {token}",
    "content-type": "application/json"
}

payload = {
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-3-small",
    "encoding_format": "float"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

Después de la llamada, observamos que el resultado devuelto es el siguiente:

```json theme={null}
{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "index": 0,
      "embedding": [
        0.0022756963,
        -0.009305916,
        0.015742613,
        -0.0077253063,
        -0.0047450014,
        0.014917395,
        -0.009807394,
        -0.038264707,
        -0.0069127847,
        -0.028590616,
        0.025251659,
        ....
        -0.014079482,
        -0.015425222,
        0.0040753055,
        0.002727979,
        -0.03138366,
        0.041159317,
        -0.017608874,
        -0.018637223,
        0.014587308,
        0.010486611,
        -0.015387135,
        -0.019424353,
        -0.002800979
      ]
    }
  ],
  "model": "text-embedding-3-small",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}
```

El resultado devuelto contiene varios campos, que se presentan a continuación:

* `model`, el modelo utilizado esta vez para convertir el texto en vectores de palabras.
* `usage`, la información de tokens utilizada esta vez para convertir el texto en vectores de palabras.
* `data`, el resultado de los vectores de palabras después de la conversión del texto.

Entre ellos, `data` contiene la información específica de los vectores de palabras correspondientes al texto, y su `embedding` es el resultado específico de los vectores de palabras generados.

## Manejo de errores

Al invocar la API, si se produce un error, la API devolverá el código y la información de error correspondientes. Por ejemplo:

* `400 token_mismatched`: Solicitud incorrecta, posiblemente debido a parámetros faltantes o no válidos.
* `400 api_not_implemented`: Solicitud incorrecta, posiblemente debido a parámetros faltantes o no válidos.
* `401 invalid_token`: No autorizado, token de autorización no válido o faltante.
* `429 too_many_requests`: Demasiadas solicitudes, ha excedido el límite de velocidad.
* `500 api_error`: Error interno del servidor, algo salió mal en el servidor.

### Ejemplo de respuesta de error

```json theme={null}
{
  "success": false,
  "error": {
    "code": "api_error",
    "message": "fetch failed"
  },
  "trace_id": "2cf86e86-22a4-46e1-ac2f-032c0f2a4e89"
}
```

## Conclusión

A través de este documento, ya ha comprendido cómo utilizar la API de OpenAI Embeddings para usar fácilmente la función oficial de OpenAI de generación de vectores de palabras. Esperamos que este documento pueda ayudarle a conectar y utilizar mejor esta API. Si tiene alguna pregunta, no dude en contactar a nuestro equipo de soporte técnico.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.