Whatever message this page gives is out now! Go check it out!

OpenAI embedding configuration options

Last update:
May 18, 2026
Field
Description
Provider
OpenAI. The selected embedding model provider for this configuration.
API key
Required. API key for the OpenAI API. If your product allows runtime injection, follow your admin guide for leaving this blank. Stored keys must be protected like any other secret.
Model name
Required. Embedding model id (for example text-embedding-3-small, text-embedding-3-large, or text-embedding-ada-002). Use the exact id your account and API version support.
Base URL
Optional. Overrides the default OpenAI API base URL. Leave blank to use the standard endpoint unless you use a proxy or compatible gateway.
Dimension
Optional. Desired embedding vector length when the model supports multiple output dimensions (for example some text-embedding-3-* models). Leave blank to use the model default. Must be valid for the chosen model.
Organization ID
Optional. OpenAI organization id for usage and access scoping. Leave blank if you do not use organizations.
Project ID
Optional. OpenAI project id when your workflow uses project-scoped keys or reporting. Leave blank if not used.
User
Optional. End-user or caller identifier OpenAI accepts for abuse monitoring and analytics (stable id per end user where policy allows). Leave blank if not required.
Batch size
Optional. Maximum number of texts to send per embedding API call. Larger batches can improve throughput but hit payload and rate limits; leave blank to use the product or model default.
Max retries
Optional. Number of times to retry a failed request after errors such as rate limits or transient network failures. Default is often 3 when not set.
Timeout (ms)
Optional. Maximum wait time for a single request, in milliseconds. Default is often 60000 (60 seconds) when not set. Increase for large batches or slow networks.
Log API requests
When enabled, request details are written to logs. May include text sent for embedding—use only while debugging and disable afterward.
Log API responses
When enabled, response details are written to logs. May include vectors and metadata—use only while debugging and disable afterward.
---

Azure OpenAI

Field
Description
Provider
Azure OpenAI. The selected embedding model provider for this configuration.
API key
Required. Key for your Azure OpenAI resource (from the Azure portal or your secret store). Stored keys must be protected.
Deployment name
Required. Name of the embedding deployment in Azure OpenAI (Azure AI Foundry / Studio). Must match a deployment that uses an embedding-capable model.
Base URL
Required. Endpoint URL for the Azure OpenAI resource, typically https://<resource-name>.openai.azure.com/ (or the path your gateway uses).
Dimension
Optional. Output embedding size when the deployed model supports configurable dimensions. Leave blank to use the deployment default.
Max retries
Optional. Retries for failed requests. Default is often 3 when not set.
Timeout (ms)
Optional. Request timeout in milliseconds. Default is often 60000 when not set.
Log API requests
When enabled, logs request details; embedding inputs may be sensitive—use short-term for troubleshooting only.
Log API responses
When enabled, logs response details; disable when finished debugging.
---

Share this page

Was this page helpful?
We're glad. Tell us how this page helped.
We're sorry. Can you tell us what didn't work for you?
Thank you for your feedback. Your response will help improve this page.

On this page