OpenAI Embeddings
OpenAI embedding components provide access to OpenAI's text embedding models for converting text into numerical vectors.
OpenAI Embeddings
This component is used to load embedding models from OpenAI.
Inputs
OpenAI API Key
String
The API key to use for accessing the OpenAI API
Default Headers
Dict
Default headers for the HTTP requests
Default Query
NestedDict
Default query parameters for the HTTP requests
Allowed Special
List
Special tokens allowed for processing (default: []
)
Disallowed Special
List
Special tokens disallowed for processing (default: ["all"]
)
Chunk Size
Integer
Chunk size for processing (default: 1000
)
Client
Any
HTTP client for making requests
Deployment
String
Deployment name for the model (default: text-embedding-3-small
)
Embedding Context Length
Integer
Length of embedding context (default: 8191
)
Max Retries
Integer
Maximum number of retries for failed requests (default: 6
)
Model
String
Name of the model to use (default: text-embedding-3-small
)
Model Kwargs
NestedDict
Additional keyword arguments for the model
OpenAI API Base
String
Base URL of the OpenAI API
OpenAI API Type
String
Type of the OpenAI API
OpenAI API Version
String
Version of the OpenAI API
OpenAI Organization
String
Organization associated with the API key
OpenAI Proxy
String
Proxy server for the requests
Request Timeout
Float
Timeout for the HTTP requests
Show Progress Bar
Boolean
Whether to show a progress bar for processing (default: False
)
Skip Empty
Boolean
Whether to skip empty inputs (default: False
)
TikToken Enable
Boolean
Whether to enable TikToken (default: True
)
TikToken Model Name
String
Name of the TikToken model
Outputs
embeddings
Embeddings
An instance for generating embeddings using OpenAI
Azure OpenAI Embeddings
This component generates embeddings using Azure OpenAI models.
Inputs
Model
String
Name of the model to use (default: text-embedding-3-small
)
Azure Endpoint
String
Your Azure endpoint, including the resource. Example: https://example-resource.azure.openai.com/
Deployment Name
String
The name of the deployment
API Version
String
The API version to use, options include various dates
API Key
String
The API key to access the Azure OpenAI service
Outputs
embeddings
Embeddings
An instance for generating embeddings using Azure OpenAI
Usage Notes
State-of-the-art: OpenAI's embedding models offer excellent performance for semantic search and similarity tasks
Large Context: Support for large context windows allows processing of lengthy documents
Multiple Models: Different embedding models optimized for various use cases
Enterprise Ready: Azure OpenAI provides enterprise-grade deployment options
Last updated