Class AzureOpenAiEmbeddingClient

Azure OpenAI client for embeddings.

Index

Constructors

constructor

Methods

run

Constructors

constructor

new AzureOpenAiEmbeddingClient(
    modelDeployment: ModelDeployment<AzureOpenAiEmbeddingModel>,
    destination?:
        | never
        | Without<HttpDestination> & DestinationFetchOptions & {
            serviceBindingTransformFn?: ServiceBindingTransformFunction;
        } & { destinationName: string; service?: undefined }
        | Without<
            DestinationFetchOptions & {
                serviceBindingTransformFn?: ServiceBindingTransformFunction;
            } & { destinationName: string; service?: undefined },
        > & Destination & { url: string },
): 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:
      | never
      | Without<HttpDestination> & DestinationFetchOptions & {
          serviceBindingTransformFn?: ServiceBindingTransformFunction;
      } & { destinationName: string; service?: undefined }
      | Without<
          DestinationFetchOptions & {
              serviceBindingTransformFn?: ServiceBindingTransformFunction;
          } & { destinationName: string; service?: undefined },
      > & Destination & { url: string }
  - never
  - Without<HttpDestination> & DestinationFetchOptions & {
    serviceBindingTransformFn?: ServiceBindingTransformFunction;
    } & { destinationName: string; service?: undefined }
    OptionalserviceBindingTransformFn?: ServiceBindingTransformFunction
    Custom transformation function to control how a Destination is built from the given Service.
    
    destinationName: string
    The name of the destination to retrieve from service bindings.
    
    Optionalservice?: undefined
  - Without<
        DestinationFetchOptions & {
            serviceBindingTransformFn?: ServiceBindingTransformFunction;
        } & { destinationName: string; service?: undefined },
    > & Destination & { url: string }
Returns AzureOpenAiEmbeddingClient
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-embedding-client.d.ts:17

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.

Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
- Defined in packages/foundation-models/dist/azure-openai/azure-openai-embedding-client.d.ts:24

Class AzureOpenAiEmbeddingClient

Index

Constructors

Methods

Constructors

constructor

Parameters

`Optional`serviceBindingTransformFn?: ServiceBindingTransformFunction

destinationName: string

`Optional`service?: undefined

Returns AzureOpenAiEmbeddingClient

Methods

run

Parameters

Returns Promise<AzureOpenAiEmbeddingResponse>

Settings

On This Page

Class AzureOpenAiEmbeddingClient

Index

Constructors

Methods

Constructors

constructor

Parameters

OptionalserviceBindingTransformFn?: ServiceBindingTransformFunction

destinationName: string

Optionalservice?: undefined

Returns AzureOpenAiEmbeddingClient

Methods

run

Parameters

Returns Promise<AzureOpenAiEmbeddingResponse>

Settings

On This Page

`Optional`serviceBindingTransformFn?: ServiceBindingTransformFunction

`Optional`service?: undefined