Naar inhoud springen
API-referentie
API-referentie

OpenAI Embeddings

Stuur een verzoek via de OpenAI-compatibele Embeddings-bewerking van RunAPI.

Markdown bekijken
01

Overzicht

Gebruik RunAPI's OpenAI-compatibele Embeddings-bewerking met een compatibel model en de verzoek- en antwoordstructuren van het protocol.

Snelstart

  1. Maak een API-sleutel aan en stel deze in als RUNAPI_API_KEY.
  2. Kies een compatibel model en stuur de gedocumenteerde padparameters en JSON-body.
  3. Lees de JSON-respons of server-sent events die voor deze bewerking worden weergegeven, en handel protocollfouten af.

Eindpunt

POST /v1/embeddings
Basis-URL
https://runapi.ai
Contractversie
v1
Voorkeursauthenticatie
Authorization: Bearer YOUR_API_TOKEN
02

Authenticatiedragers

RunAPI accepteert elke hieronder vermelde carrier. Gegenereerde voorbeelden gebruiken de voorkeurskoptekst van het protocol.

header - Voorkeur
Authorization: Bearer YOUR_API_TOKEN
header
x-api-key: YOUR_API_TOKEN
header
x-goog-api-key: YOUR_API_TOKEN
query
?key=YOUR_API_TOKEN
03

Compatibele modellen

Open een modelpagina voor actuele prijzen, snelheidslimieten en details over commercieel gebruik.

Toon 3 compatibele modellen
04

Verzoekcontract

JSON-body

Alleen velden met zowel openbaar protocol als bewijs van RunAPI-ondersteuning worden vermeld. Aanvullende JSON-bodyvelden worden doorgegeven.

JSON-body4 velden
dimensionsinteger
Optioneel

Gevraagde uitvoer vectordimensies voor modellen die dit ondersteunen.

encoding_formatstring
Optioneel

Indeling voor geretourneerde inbeddingsvectoren.

input["string", "array"]
Verplicht

Tekst of token-arrays om in te bedden.

modelstring
Verplicht

RunAPI embedding-modelidentificator.

Verzoekvoorbeeld

JSON 
{
  "input": "The quick brown fox.",
  "model": "text-embedding-3-small"
}
05

Synchroon antwoord

HTTP 200

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "data": {
      "type": "array"
    },
    "model": {
      "type": "string"
    },
    "object": {
      "const": "list",
      "type": "string"
    },
    "usage": {
      "additionalProperties": true,
      "properties": {
        "prompt_tokens": {
          "type": "integer"
        },
        "total_tokens": {
          "type": "integer"
        }
      },
      "required": [
        "prompt_tokens",
        "total_tokens"
      ],
      "type": "object"
    }
  },
  "required": [
    "object",
    "data",
    "model",
    "usage"
  ],
  "type": "object"
}

Voorbeeld

JSON 
{
  "data": [
    {
      "embedding": [
        0.0023,
        -0.0093,
        0.0151
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model": "text-embedding-3-small",
  "object": "list",
  "usage": {
    "prompt_tokens": 5,
    "total_tokens": 5
  }
}
06

Protocolfout: invalid_request

HTTP 400

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "error": {
      "additionalProperties": true,
      "properties": {
        "code": {
          "type": [
            "string",
            "null"
          ]
        },
        "message": {
          "type": "string"
        },
        "param": {
          "type": [
            "string",
            "null"
          ]
        },
        "type": {
          "type": "string"
        }
      },
      "required": [
        "message",
        "type"
      ],
      "type": "object"
    }
  },
  "required": [
    "error"
  ],
  "type": "object"
}

Voorbeeld

JSON 
{
  "error": {
    "code": null,
    "message": "input is required",
    "param": "input",
    "type": "invalid_request_error"
  }
}
07

Gebruik

Schema

JSON 
{
  "additionalProperties": true,
  "properties": {
    "prompt_tokens": {
      "type": "integer"
    },
    "total_tokens": {
      "type": "integer"
    }
  },
  "required": [
    "prompt_tokens",
    "total_tokens"
  ],
  "type": "object"
}

Voorbeeld

JSON 
{
  "prompt_tokens": 5,
  "total_tokens": 5
}
08

Gegenereerde codevoorbeelden

Elk cURL-, JavaScript- en Python-voorbeeld verstuurt de gevalideerde aanvraag uit dit contract zonder dat een protocolspecifieke SDK vereist is.

Installeren

Shell 
pip install requests
PYTHON 
import requests

response = requests.post(
    "https://runapi.ai/v1/embeddings",
    headers={"Authorization": "Bearer YOUR_API_TOKEN", "Content-Type": "application/json"},
    json={"model": "text-embedding-3-small", "input": "The quick brown fox."}
)
response.raise_for_status()
print(response.json())