CreateAzureOpenAiEmbeddings 2025.3.28.13-SNAPSHOT¶
BUNDLE¶
com.snowflake.openflow.runtime | runtime-openai-nar
DESCRIPTION¶
Uses Azure OpenAI to create embeddings for text. The input text can be provided as a single FlowFile or as a record-oriented FlowFile.
INPUT REQUIREMENT¶
Supports Sensitive Dynamic Properties¶
false
PROPERTIES¶
Property |
Description |
|---|---|
API Key |
The API Key for authenticating to Azure OpenAI |
Deployment Name |
The name of the OpenAI model deployment to use for creating embeddings |
Dimensions |
The number of dimensions to request the resulting output embeddings have. This is only supported in text-embedding-3 and later models. |
Embeddings Record Path |
The path to the field in the record where the embeddings are to be written. |
Max Batch Size |
The maximum number of records to include in each batch sent to OpenAI |
OpenAI Service Name |
The name of the OpenAI service to use |
Record Reader |
The record reader to use for reading record-oriented data. If the incoming data is to be treated as plaintext, this property should be left unset. |
Record Writer |
The Record Writer to use for writing the output |
Text Record Path |
The path to the field in the record that contains the text to be embedded. If the incoming data is to be treated as plaintext, this property should be left unset. |
User |
An identifier for the remote user on whose behalf the request is being made; OpenAI uses this to detect and prevent abuse. |
Web Client Service |
The Web Client Service to use for communicating with OpenAI |
RELATIONSHIPS¶
NAME |
DESCRIPTION |
|---|---|
failure |
The original FlowFile will be routed to this relationship if the embeddings could not be created |
success |
The embeddings will be routed to this relationship |
WRITES ATTRIBUTES¶
NAME |
DESCRIPTION |
|---|---|
record.count |
The number of records written to the output |
mime.type |
The MIME type of the output data, based on the chosen Record Writer |
USE CASES¶
Create embeddings for text using Azure OpenAI’s Embeddings |