mirror of
https://github.com/wassname/openrouter-python-sdk-retry-errors.git
synced 2026-07-29 11:23:49 +08:00
Matt Apperson
5fc522c72f
Auto-generated Python SDK for OpenRouter API, providing comprehensive client library with: - Chat completions and streaming support - Embeddings API - Model and provider information - API key management - Analytics and usage tracking - OAuth authentication flows - Full type hints and error handling
123 lines
7.4 KiB
Markdown
123 lines
7.4 KiB
Markdown
# Embeddings
|
|
(*embeddings*)
|
|
|
|
## Overview
|
|
|
|
Text embedding endpoints
|
|
|
|
### Available Operations
|
|
|
|
* [generate](#generate) - Submit an embedding request
|
|
* [list_models](#list_models) - List all embeddings models
|
|
|
|
## generate
|
|
|
|
Submits an embedding request to the embeddings router
|
|
|
|
### Example Usage
|
|
|
|
<!-- UsageSnippet language="python" operationID="createEmbeddings" method="post" path="/embeddings" -->
|
|
```python
|
|
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": "deny",
|
|
"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` | [models.Input](../../models/input.md) | :heavy_check_mark: | N/A |
|
|
| `model` | *str* | :heavy_check_mark: | N/A |
|
|
| `provider` | [Optional[models.CreateEmbeddingsProvider]](../../models/createembeddingsprovider.md) | :heavy_minus_sign: | N/A |
|
|
| `encoding_format` | [Optional[models.EncodingFormat]](../../models/encodingformat.md) | :heavy_minus_sign: | N/A |
|
|
| `user` | *Optional[str]* | :heavy_minus_sign: | N/A |
|
|
| `retries` | [Optional[utils.RetryConfig]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
|
|
### Response
|
|
|
|
**[models.CreateEmbeddingsResponse](../../models/createembeddingsresponse.md)**
|
|
|
|
### 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
|
|
|
|
<!-- UsageSnippet language="python" operationID="listEmbeddingsModels" method="get" path="/embeddings/models" -->
|
|
```python
|
|
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]](../../models/utils/retryconfig.md) | :heavy_minus_sign: | Configuration to override the default retry behavior of the client. |
|
|
|
|
### Response
|
|
|
|
**[models.ModelsListResponse](../../models/modelslistresponse.md)**
|
|
|
|
### Errors
|
|
|
|
| Error Type | Status Code | Content Type |
|
|
| ---------------------------------- | ---------------------------------- | ---------------------------------- |
|
|
| errors.BadRequestResponseError | 400 | application/json |
|
|
| errors.InternalServerResponseError | 500 | application/json |
|
|
| errors.OpenRouterDefaultError | 4XX, 5XX | \*/\* | |