Azure OpenAI Embeddings

​

Node Details

• Name: AzureOpenAIEmbedding_Embeddings
• Type: AzureOpenAIEmbeddings
• Version: 1.0
• Category: Embeddings

​

Base Classes

• AzureOpenAIEmbeddings
• OpenAIEmbeddings (and its base classes)

​

Parameters

​

Credential (Required)

The node requires an Azure OpenAI API credential with the following parameters:

• Azure OpenAI API Key
• Azure OpenAI API Instance Name
• Azure OpenAI API Deployment Name
• Azure OpenAI API Version

​

Inputs

1. Batch Size (optional)

   • Type: number
   • Default: 100
   • Description: The number of texts to process in one API call

2. Timeout (optional)

   • Type: number
   • Description: Maximum time (in milliseconds) to wait for the API response

3. BasePath (optional)

   • Type: string
   • Description: The base URL for Azure OpenAI API endpoints

​

Initialization

The node initializes an OpenAIEmbeddings instance with the provided credentials and parameters. It configures:

• Azure OpenAI API credentials
• Batch size (if provided)
• Timeout (if provided)
• Azure OpenAI base path (if provided)

​

Usage

This node is typically used in workflows where text needs to be converted into numerical vector representations. These embeddings can then be used for:

• Semantic search
• Text classification
• Clustering
• Measuring text similarity
• Other NLP tasks that benefit from dense vector representations of text

​

Output

The node returns an initialized OpenAIEmbeddings model, which can be used to generate embeddings for input text in subsequent processing steps.

​

Note

This node is specifically designed for use with Azure OpenAI services, as opposed to the standard OpenAI API. It requires appropriate Azure OpenAI credentials and configurations to function correctly.