Files
openrouter-python-sdk-retry…/docs/sdks/embeddings/README.md
T

8.4 KiB
Raw Blame History

Embeddings

(embeddings)

Overview

Text embedding endpoints

Available Operations

generate

Submits an embedding request to the embeddings router

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.embeddings.generate(input="<value>", model="Taurus", provider={
        "data_collection": "allow",
        "zdr": True,
        "enforce_distillable_text": True,
        "order": [
            "OpenAI",
        ],
        "only": [
            "OpenAI",
        ],
        "ignore": [
            "OpenAI",
        ],
        "quantizations": [
            "fp16",
        ],
        "sort": "price",
    })

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
input operations.InputUnion ✔️ N/A
model str ✔️ N/A
encoding_format Optional[operations.EncodingFormat] N/A
dimensions Optional[int] N/A
user Optional[str] N/A
provider Optional[operations.CreateEmbeddingsProvider] N/A
input_type Optional[str] N/A
retries Optional[utils.RetryConfig] Configuration to override the default retry behavior of the client.

Response

operations.CreateEmbeddingsResponse

Errors

Error Type Status Code Content Type
errors.BadRequestResponseError 400 application/json
errors.UnauthorizedResponseError 401 application/json
errors.PaymentRequiredResponseError 402 application/json
errors.NotFoundResponseError 404 application/json
errors.TooManyRequestsResponseError 429 application/json
errors.InternalServerResponseError 500 application/json
errors.BadGatewayResponseError 502 application/json
errors.ServiceUnavailableResponseError 503 application/json
errors.EdgeNetworkTimeoutResponseError 524 application/json
errors.ProviderOverloadedResponseError 529 application/json
errors.OpenRouterDefaultError 4XX, 5XX */*

list_models

Returns a list of all available embeddings models and their properties

Example Usage

from openrouter import OpenRouter
import os


with OpenRouter(
    api_key=os.getenv("OPENROUTER_API_KEY", ""),
) as open_router:

    res = open_router.embeddings.list_models()

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
retries Optional[utils.RetryConfig] Configuration to override the default retry behavior of the client.

Response

components.ModelsListResponse

Errors

Error Type Status Code Content Type
errors.BadRequestResponseError 400 application/json
errors.InternalServerResponseError 500 application/json
errors.OpenRouterDefaultError 4XX, 5XX */*