Class AzureOpenAiEmbeddingClient

Azure OpenAI client for embeddings.

Index

Constructors

Methods

Constructors

constructor

new AzureOpenAiEmbeddingClient(
modelDeployment: ModelDeployment<AzureOpenAiEmbeddingModel>,
destination?: HttpDestinationOrFetchOptions,
): AzureOpenAiEmbeddingClient
Creates an instance of the Azure OpenAI embedding client.
Parameters
- modelDeployment: ModelDeployment<AzureOpenAiEmbeddingModel>
  This configuration is used to retrieve a deployment. Depending on the configuration use either the given deployment ID or the model name to retrieve matching deployments. If model and deployment ID are given, the model is verified against the deployment.
- Optionaldestination: HttpDestinationOrFetchOptions
  The destination to use for the request.
Returns AzureOpenAiEmbeddingClient
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-embedding-client.d.ts:18

Methods

run

run(
request: AzureOpenAiEmbeddingParameters,
requestConfig?: CustomRequestConfig,
): Promise<AzureOpenAiEmbeddingResponse>
Creates an embedding vector representing the given text.
Parameters
- request: AzureOpenAiEmbeddingParameters
  Request containing embedding input parameters.
- OptionalrequestConfig: CustomRequestConfig
  The request configuration.
Returns Promise<AzureOpenAiEmbeddingResponse>
The completion result.
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-embedding-client.d.ts:25