SAP AI SDK for JavaScript - v2.13.0
    Preparing search index...

    Class OrchestrationEmbeddingClient

    Orchestration embedding client for generating embeddings with optional orchestration modules.

    Index
    constructor
    embed

    • Creates an instance of the orchestration embedding client.

      Parameters

      • config: EmbeddingModuleConfig

        Embedding module configuration.

      • OptionaldeploymentConfig: DeploymentIdConfig | ResourceGroupConfig

        Deployment configuration.

      • Optionaldestination:
            | never
            | Without<HttpDestination> & DestinationFetchOptions & {
                serviceBindingTransformFn?: ServiceBindingTransformFunction;
            } & { destinationName: string; service?: undefined }
            | Without<
                DestinationFetchOptions & {
                    serviceBindingTransformFn?: ServiceBindingTransformFunction;
                } & { destinationName: string; service?: undefined },
            > & Destination & { url: string }

        The destination to use for the request.

        • 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 OrchestrationEmbeddingClient

    • Generate embeddings for the given input.

      Parameters

      • request: EmbeddingRequest

        Embedding request configuration.

      • OptionalrequestConfig: CustomRequestConfig

        Custom request configuration.

      Returns Promise<OrchestrationEmbeddingResponse>

      Promise resolving to embedding response.

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods