PackagePackagetypeA library you install and call yourself.See every one →What this type is →by SAPby SAPoriginPublished by SAP itself. A visible facet, never an input to a reading — a dormant official plugin reads exactly like a dormant independent one.See every one →

@sap-ai-sdk/orchestration

The Orchestration Service client of SAP's AI SDK, which applies templating, grounding, filtering and masking around a model call rather than in the application.

Facts

Latestv2.17.0ReleasedLast pushLicenceApache-2.0

Where it sits

Lives in
Provides
LLM integrationCAPLLM integrationcapabilityCalling a language model from application code with the tenant, destination and credential handling already solved instead using an SDK call with a hand-rolled key.Prompt managementCAPPrompt managementcapabilityKeeping the prompts an application sends to a model as templates with placeholders, stored and versioned apart from the code that calls them, so a change of wording is not a deployment. What people conflate under it: the template filled at runtime, the registry it lives in, and the orchestration step that fills it.Data maskingCAPData maskingcapabilityReplacing the personal or confidential values in a prompt with placeholders before it leaves for a model, and putting them back in the answer. Anonymisation, where the values are gone for good, and pseudonymisation, where they return, are the two forms; which fields count as sensitive is the application's question, not the module's.Content filteringCAPContent filteringcapabilityChecking what goes into a model and what comes out of it against content rules, and stopping or flagging a request that fails them. Distinct from [data masking](capability:data-masking), which hides values: a filter refuses content.
Designs
Agentic AI & AI AgentsAgentic AI & AI Agentsreference architectureSAP Cloud SDK for AI: type-safe access to the Generative AI Hub, foundation models and AI-specific servicesGenerative AI on SAP BTPGenerative AI on SAP BTPreference architectureSDK client for the orchestration configuration

Who is behind it

SAPSAPOrganisationMaintains this
In the atlas: maintains 137, wrote 14
@SAP
maintainerAnjanPersonContributes to this
In the atlas: contributes to 7
@anjan-poonacha
SAP Cloud SDK BotPersonContributes to this
In the atlas: contributes to 11
@bot-sdk-js
BrigittaK307PersonContributes to this
In the atlas: contributes to 12
@BrigittaK307
Charles DuboisPersonContributes to this
In the atlas: contributes to 5
@CharlesDuboisSAP
Christoph MatthiesPersonContributes to this
In the atlas: contributes to 5
@ChristophMatthies
David KnaackPersonContributes to this
In the atlas: contributes to 13, wrote 1
@davidkna-sap
Deeksha SinhaPersonContributes to this
In the atlas: contributes to 12
@deekshas8
Guilherme DellagustinPersonContributes to this
In the atlas: contributes to 27
@dellagustin-sap
emincihangeriPersonContributes to this
In the atlas: contributes to 12
@emincihangeri
Tian TengPersonContributes to this
In the atlas: contributes to 5
@Herrtian
21 contributors

Before choosing this

Conditions

LicenceSAP Developer License Agreement 3.2 CAP§ 3from LLM integrationCovered SAP materials or a covered CAP customer application are used as training data or to develop or refine an AI model or system.
  • § 3 Artificial Intelligence Training. The agreement prohibits use of the covered materials and customer applications for training artificial-intelligence models or systems.

Calling a model for inference is not automatically AI training. Section 3 matters when the covered material or application participates in training, model development, refinement or the text-and-data-mining uses it names.

SAP Developer License Agreement 3.2 CAP →

What it declares

Every artifact

Type
Package
Origin
By SAP

As a package

Where it runs
does not say
Distributed through
npm

For LLM integration

Supports
Streams the response
Models it reaches
SAP AI Core
property statedstated nonot said

Tasks this contributes to2Beta

Change which model a CAP service callsA CAP service that already calls a language model is pointed at a different one — a newer version, a cheaper one, or a model from another vendor — and the handler that calls it is not rewritten.Also in BTP/BAIP, ABAPCoversclient the model is named in
What it does

Puts the model in one property: the documentation says to choose the LLM by setting name in the promptTemplating.model configuration, and that the harmonised API behind it lets a different foundation model be used without the client code changing, with a switch shown as an example. An optional version and params sit beside the name for a model's own settings.

Remaining work

Keep that configuration outside the handler if the switch is to be a deployment change rather than a release, and make sure the model named is one the bound resource group has a deployment for. The package is ESM-only, which a CommonJS CAP project has to deal with before any of this.

All options on the LLM integration page →
Stream a model's answer out of a CAP serviceA CAP service receives a model's answer in pieces as the model writes it, rather than one payload after the model has finished, so a chat surface can show text appearing instead of a spinner.Shown workingstreaming client
What it does

Streams over server-sent events: the documentation states that the OrchestrationClient supports streaming responses for chat completion based on that standard, that stream() returns a stream of chunk responses, and that a streaming request can be aborted with the AbortController API. toContentStream() yields the delta text, getToolCalls() reads the tool calls at the end of a stream, and the orchestration service offers its own streaming options beside the model's, such as a maximum number of characters per chunk.

Remaining work

Carry the chunks to the client, which is the application's own endpoint and not in this package, and decide what a half-written answer does to a handler that was going to validate the whole one. The package is ESM-only, which a CommonJS CAP project has to deal with first.

All options on the LLM integration page →

Connections5

@sap-ai-sdk/orchestration connections@sap-ai-sdk/orchestrationPROVIDES→ provides4provides stated Configures the orchestration service's input and output content filters from the client, with builders for the available filters. Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completion Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completionContent filteringprovides stated Carries the orchestration service's data masking module into a Node.js or CAP service, configured per call and per fallback configuration. Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completion Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completionData maskingprovides stated The Orchestration Service client: templating, grounding, filtering and masking around a model call. Which model answers is the `name` property of the `promptTemplating.model` configuration, and the documentation states that the harmonised API behind it lets a different foundation model be used without the client code changing. `stream()` returns the chunks as server-sent events, with an `AbortController` to stop one. SAP/ai-sdk-js — README: https://github.com/SAP/ai-sdk-js#readme Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript), model choice: https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completion Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript), streaming: https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completionLLM integrationprovides stated Fills a prompt template at call time through the orchestration service's promptTemplating module, the one module every orchestration call configures. Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completion Orchestration Chat Completion — SAP Cloud SDK for AI (JavaScript): https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completionPrompt managementUSED BY← optionally used by1optionally used by derived If: The backend half is installed: the README calls the package an optional peer dependency so that a frontend-only install stays lean, and says a backend project installs it explicitly. The client the plugin's AIService calls SAP AI Core's Orchestration Service through. Through: inverted from its requires edge lemaiwo/ui5-ai-features — ui5-cap-ai-features README, optional peer: https://raw.githubusercontent.com/lemaiwo/ui5-ai-features/main/ui5-cap-ai-features/README.md lemaiwo/ui5-ai-features — ui5-cap-ai-features README: https://raw.githubusercontent.com/lemaiwo/ui5-ai-features/main/ui5-cap-ai-features/README.mdui5-cap-ai-featuresif

Install

npm add @sap-ai-sdk/orchestration

Derived from the package name. No recipe recorded; the README has the configuration.

Learn more1

Readings
  1. What an AI infra engineer sees when opening SAP's AI stack (1/3): the model gatewayamishkush, SAP Community
What changed
  1. v2.0.0

    Orchestration v2 merges the llm and templating modules into a single promptTemplating module.

    Makes stale:

    Client configurations with separate llm and templating blocks.

README

quoted from SAP/ai-sdk-js under Apache-2.0, read
SAP/ai-sdk-js/packages/orchestration/README.mdOn GitHub

@sap-ai-sdk/orchestration

SAP Cloud SDK for AI is the official Software Development Kit (SDK) for SAP AI Core, SAP Generative AI Hub, and Orchestration Service.

This package incorporates generative AI orchestration capabilities into your AI activities in SAP AI Core and SAP AI Launchpad.

Table of Contents

Installation

npm install @sap-ai-sdk/orchestration

Documentation

Visit the SAP Cloud SDK for AI (JavaScript) documentation portal to learn more about its capabilities and detailed usage.

Support, Feedback, Contribution

Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.

License

The SAP Cloud SDK for AI is released under the Apache License Version 2.0.

Apache-2.0, read

History

Latest

v2.17.0

Features 3, Fixes 2

Notes
Minor Changes
  • [feat] Update generated client to latest spec (rel-1.13.2). Add optional provider_specific_fields property to LlmChoice and LlmChoiceStreaming response types.

  • [compat] LlamaGuard38B and LlamaGuard38BFilterConfig are now marked as deprecated and will be removed on 2027-09-20. Migrate usages before that date.

  • [feat] Update the generated client to spec v1.23. Adds the IBM Granite Guardian 4.1 content filter. Adds input filter target selectors. Adds the drop_unsupported_params option on LLMModelDetails.

Patch Changes
  • [fix] Preserve prompt_tokens_details and completion_tokens_details in streamed token usage to fix missing cache and reasoning token details in OrchestrationStreamResponse.getTokenUsage() and getIntermediateResults().

  • [fix] Fix missing prompt template or messages not being detected when no prompt is configured.

  1. v2.16.0

    Fixes 4

    Notes
    Patch Changes
    • Updated dependencies [0da56e2]
    • Updated dependencies [3483acb]
    • Updated dependencies [94b36e5]
    • Updated dependencies [4b2c014]
      • @sap-ai-sdk/core@2.16.0
      • @sap-ai-sdk/ai-api@2.16.0
      • @sap-ai-sdk/prompt-registry@2.16.0
  2. v2.15.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • b61cb53: [compat] Deprecate OrchestrationConfigRef — use OrchestrationConfigRefById or OrchestrationConfigRefByName instead.
    • b61cb53: [feat] Split OrchestrationConfigRef into OrchestrationConfigRefById and OrchestrationConfigRefByName.
    Patch Changes
    • Updated dependencies [a5407c8]
      • @sap-ai-sdk/core@2.15.0
      • @sap-ai-sdk/ai-api@2.15.0
      • @sap-ai-sdk/prompt-registry@2.15.0
  3. v2.14.0

    Features 3, Fixes 3

    Notes
    Minor Changes
    • b986b70: [feat] Add reasoning content support to the Orchestration client. reasoning_content fields were added on response, streaming delta, and assistant message types. The getReasoningContent() and getDeltaReasoningContent() convenience functions return the reasoning text from model responses.
    • b986b70: [feat] Added overrideConfig field to OrchestrationConfigRef to pass a PartialOrchestrationConfig that overrides parts of the stored orchestration configuration at request time. Streaming via .stream() now automatically sets stream.enabled = true in the partial configuration override, so clients using a stored orchestration configuration reference no longer require streaming to be pre-configured in the stored configuration.
    • cca7edd: [feat] Add GcpVertexAiEmbeddingModel type with gemini-embedding to @sap-ai-sdk/core. Add GcpVertexAiEmbeddingModel to the EmbeddingModel union in @sap-ai-sdk/orchestration.
    Patch Changes
    • Updated dependencies [cca7edd]
    • Updated dependencies [a268597]
    • Updated dependencies [cca7edd]
      • @sap-ai-sdk/core@2.14.0
      • @sap-ai-sdk/prompt-registry@2.14.0
      • @sap-ai-sdk/ai-api@2.14.0
  4. v2.13.0

    Fixes 4

    Notes
    Patch Changes
    • Updated dependencies [11baf52]
    • Updated dependencies [cb8ffe7]
    • Updated dependencies [a8c9b29]
    • Updated dependencies [6542a2a]
      • @sap-ai-sdk/core@2.13.0
      • @sap-ai-sdk/ai-api@2.13.0
      • @sap-ai-sdk/prompt-registry@2.13.0
  5. v2.12.0

    Fixes 4

    Notes
    Patch Changes
    • Updated dependencies [0f10482]
    • Updated dependencies [e944aa1]
    • Updated dependencies [d946bcb]
    • Updated dependencies [2faf4a8]
      • @sap-ai-sdk/core@2.12.0
      • @sap-ai-sdk/prompt-registry@2.12.0
      • @sap-ai-sdk/ai-api@2.12.0
  6. v2.11.0

    Features 1, Fixes 4

    Notes
    Minor Changes
    • f72bb58: [feat] Update orchestration specification to v0.131.3
    Patch Changes
    • cbcefb9: [fix] Route messages to messages_history when using an orchestration config reference or prompt template reference.
    • 7db7237: [Fixed Issue] Disallow providing both orchestration config reference and config object at the same time.
    • Updated dependencies [c8c0e41]
    • Updated dependencies [75bb9a9]
      • @sap-ai-sdk/core@2.11.0
      • @sap-ai-sdk/ai-api@2.11.0
      • @sap-ai-sdk/prompt-registry@2.11.0
  7. v2.10.0

    Features 1, Fixes 5

    Notes
    Minor Changes
    • cf767a9: [feat] Update orchestration specification to 0.115.19. Multiple embedding output formats are not yet supported in the orchestration embedding client.
    Patch Changes
    • Updated dependencies [dce18df]
    • Updated dependencies [8cb466a]
    • Updated dependencies [cc9e80c]
    • Updated dependencies [cc9e80c]
    • Updated dependencies [cc9e80c]
      • @sap-ai-sdk/prompt-registry@2.10.0
      • @sap-ai-sdk/core@2.10.0
      • @sap-ai-sdk/ai-api@2.10.0
  8. v2.9.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • 8de0013: [feat] Add getCitations() method to retrieve source citations from models like Perplexity Sonar.
    • b822da9: [Improvement] Support file input for user messages. File inputs have a type of file and include a file_data field with a URL such as a HTTP URL or a data URL. Local files must be provided as data:MEDIATYPE;base64,DATA with a non-empty media type and valid base64 content. Availability of different file types depends on the capabilities of the underlying model and tools. GPT-models do not support file inputs with the orchestration API at this time.
    Patch Changes
    • Updated dependencies [cd3d8ed]
      • @sap-ai-sdk/core@2.9.0
      • @sap-ai-sdk/ai-api@2.9.0
      • @sap-ai-sdk/prompt-registry@2.9.0
  9. v2.8.0

    Features 2, Fixes 3

    Notes
    Minor Changes
    • 3d12d4c: [feat] Support streaming with orchestration prompt module fallback.
    • 5501e7c: [feat] Support orchestration prompt module fallback for non-streaming requests When constructing an OrchestrationClient it is now possible to provide a list of module configurations to support module fallback.
    Patch Changes
    • @sap-ai-sdk/ai-api@2.8.0
    • @sap-ai-sdk/core@2.8.0
    • @sap-ai-sdk/prompt-registry@2.8.0
  10. v2.7.0

    Features 3, Fixes 6

    Notes
    Minor Changes
    • 6b49479: [feat] Add rawResponse property to OrchestrationStreamResponse. The new property exposes the raw HTTP response from the orchestration service for advanced use cases.
    • 6b49479: [feat] Add getRequestId() method to OrchestrationResponse, OrchestrationStreamResponse and OrchestrationEmbeddingResponse. The new method allows retrieving the request ID from the orchestration service responses, which can be useful for debugging and tracking requests.
    • 6b49479: [compat] Support for constructing an OrchestrationStreamResponse without an HttpResponse has been deprecated, and will be removed in the next major release. Code directly instantiating this class should be updated to provide an HttpResponse object as the first parameter to allow reading from raw HTTP response.
    Patch Changes
    • Updated dependencies [b11b00c]
    • Updated dependencies [8616d5e]
    • Updated dependencies [56e9c3f]
    • Updated dependencies [8616d5e]
    • Updated dependencies [b12626b]
    • Updated dependencies [8616d5e]
      • @sap-ai-sdk/core@2.7.0
      • @sap-ai-sdk/ai-api@2.7.0
      • @sap-ai-sdk/prompt-registry@2.7.0
  11. v2.6.0

    Features 1, Fixes 3

    Notes
    Minor Changes
    • f3b6dc5: [Fixed Issue] Export isConfigReference() method as a value instead of type-only export. This function can now be imported and used at runtime to check if a configuration is an orchestration configuration reference type.
    Patch Changes
    • @sap-ai-sdk/ai-api@2.6.0
    • @sap-ai-sdk/core@2.6.0
    • @sap-ai-sdk/prompt-registry@2.6.0
  12. v2.5.0

    Features 1, Fixes 3

    Notes
    Minor Changes
    • 2f19a40: [New Functionality] Add support for orchestration configuration references in the orchestration client.
    Patch Changes
    • @sap-ai-sdk/ai-api@2.5.0
    • @sap-ai-sdk/core@2.5.0
    • @sap-ai-sdk/prompt-registry@2.5.0
  13. v2.4.0

    Features 1, Fixes 3

    Notes
    Minor Changes
    • aa097da: [New Functionality] Added support for applyTo and translateMessagesHistory in order to enable selective input translation and automatic inference of target language for output translation parameters.
    Patch Changes
    • Updated dependencies [2e1d2c2]
    • Updated dependencies [a3cbc6e]
    • Updated dependencies [a3cbc6e]
      • @sap-ai-sdk/core@2.4.0
      • @sap-ai-sdk/prompt-registry@2.4.0
      • @sap-ai-sdk/ai-api@2.4.0
  14. v2.3.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • 7c9605d: [Compatibility Note] zod was upgraded to v4
    • 485e21b: [New Functionality] Added support for protected_material_code property to buildAzureContentSafetyFilter() function for output filter configuration to allow detecting protected code content from known github repositories.
    Patch Changes
    • Updated dependencies [7c9605d]
      • @sap-ai-sdk/prompt-registry@2.3.0
      • @sap-ai-sdk/ai-api@2.3.0
      • @sap-ai-sdk/core@2.3.0
  15. v2.2.0

    Features 2, Fixes 4

    Notes
    Minor Changes
    • 6100bca: [Improvement] Add cohere--command-a-reasoning, mistralai--mistral-medium-instruct and perplexity-ai sonar and sonar-pro to model list
    • 347eac1: [New Functionality] Introduce orchestration embedding client for consuming embedding feature of the orchestration service.
    Patch Changes
    • Updated dependencies [6100bca]
    • Updated dependencies [5225275]
    • Updated dependencies [347eac1]
    • Updated dependencies [58464e9]
      • @sap-ai-sdk/core@2.2.0
      • @sap-ai-sdk/ai-api@2.2.0
      • @sap-ai-sdk/prompt-registry@2.2.0
  16. v2.1.0

    Fixes 2

    Notes
    Patch Changes
    • 0cf7d80: [Fixed Issue] Fix JSDoc example of buildAzureContentSafetyFilter() function.
    • Updated dependencies [0cf7d80]
      • @sap-ai-sdk/core@2.1.0
      • @sap-ai-sdk/ai-api@2.1.0
      • @sap-ai-sdk/prompt-registry@2.1.0
  17. v2.0.0dated in the atlas

    Breaking 8, Features 3, Fixes 3

    Notes
    Major Changes
    • 740ba78: [Compatibility Note] buildTranslationConfig() function now requires type parameter to distinguish between input and output translation configuration.
    • 4c00c27: [Compatibility Note] Change stream method parameter from AbortController to AbortSignal. The stream() method now accepts an AbortSignal instead of an AbortController as the second parameter in both Azure OpenAI and Orchestration clients.
    • 740ba78: [Compatibility Note] buildLlamaGuardFilter() function has been renamed to buildLlamaGuard38BFilter(). It now requires a type parameter to distinguish between input and output filter configurations, and accepts filter categories as an array.
    • 5c52cb6: [Compatibility Note] Move generated types to internal exports while keeping frequently used types in main exports.
      • Generated types are no longer exported from @sap-ai-sdk/orchestration and must be imported from @sap-ai-sdk/orchestration/internal.js instead.
      • Frequently used types (ChatMessage, SystemChatMessage, UserChatMessage, AssistantChatMessage, ToolChatMessage, DeveloperChatMessage, ChatCompletionTool, FunctionObject) remain available from main package exports.
    • 5c52cb6: [Compatibility Note] Response object data property is renamed to _data. Use getter methods like getContent(), getTokenUsage(), getAssistantMessage() instead of direct data access.
    • 997e8ec: [Compatibility Note] buildAzureContentSafetyFilter() function now requires type parameter to distinguish between input and output filter configuration.
    • 997e8ec: [New Functionality] Add prompt_shield property to buildAzureContentSafetyFilter() function for input filter configuration to allow enabling prompt attack detection.
    • 86e6370: [Compatibility Note] Major breaking changes for orchestration v2:
      • Consolidate llm and templating modules into a single promptTemplating module.
      • The llm.model_name property is now promptTemplating.model.name and llm.model_params is now promptTemplating.model.params.
      • The templating.template property is now promptTemplating.prompt.template.
      • Rename inputParams parameter to placeholderValues in orchestration client methods.
      • Update response property names from orchestration_result to final_result and module_results to intermediate_results.
      • Replace top-level stream property with streamOptions.enabled and update streaming module options from llm to promptTemplating.
      • Update grounding configuration to use placeholders.input and placeholders.output instead of separate input_params and output_param.
      • Update Azure content filter property names to lowercase with underscores: Hate to hate, SelfHarm to self_harm, Sexual to sexual, and Violence to violence.
      • Remove deprecated buildAzureContentFilter() function and use buildAzureContentSafetyFilter() instead.
    Minor Changes
    • 5c52cb6: [New Functionality] Add getIntermediateResults() method to OrchestrationResponse, OrchestrationStreamResponse, OrchestrationStreamChunkResponse classes for accessing intermediate processing results from orchestration modules.
    • 0a418d0: [feat] Add deploymentId as the optional parameter for OrchestrationClient initialization.
    • 5c52cb6: [New Functionality] Add findChoiceByIndex() method to find specific choices by index in streaming responses.
    Patch Changes
    • Updated dependencies [500c0dd]
    • Updated dependencies [9e1c43a]
    • Updated dependencies [14745de]
      • @sap-ai-sdk/core@2.0.0
      • @sap-ai-sdk/ai-api@2.0.0
      • @sap-ai-sdk/prompt-registry@2.0.0
  18. v1.17.0

    Features 2, Fixes 3

    Notes
    Minor Changes
    • fab35bc: [Improvement] Add support for standard and custom DPI entities in buildDpiMaskingProvider() function. Allow configuration of masking strategies via replacement_strategy for both entity types.
    • 225f40c: [Improvement] Add utility functions getContent(), getRefusal(), getAllMessages(), getAssistantMessage(), and getResponse() to stream response.
    Patch Changes
    • @sap-ai-sdk/ai-api@1.17.0
    • @sap-ai-sdk/core@1.17.0
    • @sap-ai-sdk/prompt-registry@1.17.0
  19. v1.16.0

    Fixes 3

    Notes
    Patch Changes
    • 9a0d6f7: [Fixed Issue] The role property of the ResponseChatMessage type is now mandatory as it is always returned.
    • 9a0d6f7: [Compatibility Note] The type of logprobs in the response is corrected as a result of a bug fix from the Orchestration service.
    • 9a0d6f7: [Compatibility Note] The ModuleResults and LlmModuleResult types are now only meant to be used for the non-streaming case. Previously, they represented both streaming and non-streaming response. For streaming, use ModuleResultsStreaming and LlmModuleResultStreaming types instead.
      • @sap-ai-sdk/ai-api@1.16.0
      • @sap-ai-sdk/core@1.16.0
      • @sap-ai-sdk/prompt-registry@1.16.0
  20. v1.15.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [5307dd0]
      • @sap-ai-sdk/core@1.15.0
      • @sap-ai-sdk/ai-api@1.15.0
      • @sap-ai-sdk/prompt-registry@1.15.0
  21. v1.14.0

    Features 6, Fixes 1

    Notes
    Minor Changes
    • fa1e3fe: [New Functionality] Support streaming in LangChain orchestration client.
    • fa1e3fe: [New Functionality] Introduce convenience functions getAllMessages(), getAssistantMessage(), getToolCalls() and getRefusal() for orchestration.
    • fa1e3fe: [New Functionality] Introduce support for tool calls, for both streaming and regular invocation.
    • fa1e3fe: [Improvement] Make templating and templating.template properties optional in the Prompt type and introduce a new messages property to allow sending messages directly without requiring a template. This enables users to reuse the same client instance without re-initialization by passing updated messages at runtime.
    • fa1e3fe: [Compatibility Note] Since ChatMessage type is now one of the many specific types such as SystemChatMessage and UserChatMessage with predefined roles in the orchestration service specification, always define type when creating objects of type OrchestrationModuleConfig and TemplatingModuleConfig to avoid role being any string.
    • c62253f: [New Functionality] Add support for orchestration translation module. Implement buildTranslationConfig() convenience function to build translation config.
    Patch Changes
    • fa1e3fe: [New Functionality] Support document grounding with SharePoint and S3 data repositories.
      • @sap-ai-sdk/ai-api@1.14.0
      • @sap-ai-sdk/core@1.14.0
      • @sap-ai-sdk/prompt-registry@1.14.0
  22. v1.13.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [a6ba3af]
      • @sap-ai-sdk/core@1.13.0
      • @sap-ai-sdk/ai-api@1.13.0
      • @sap-ai-sdk/prompt-registry@1.13.0
  23. v1.12.0

    Features 1, Fixes 3

    Notes
    Minor Changes
    • 5360c8c: [New Functionality] Add support for passing a YAML specification as a string to the templating property in OrchestrationModuleConfig.
    Patch Changes
    • @sap-ai-sdk/ai-api@1.12.0
    • @sap-ai-sdk/core@1.12.0
    • @sap-ai-sdk/prompt-registry@1.12.0
  24. v1.11.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • a8d05b0: [New Functionality] Introduce buildDpiMaskingProvider() convenience function to build masking provider SAP Data Privacy Integration.
    • 264c5b0: [New Functionality] Support setting metadata_params property in buildDocumentGroundingConfig() convenience function.
    Patch Changes
    • Updated dependencies [627a152]
      • @sap-ai-sdk/core@1.11.0
      • @sap-ai-sdk/ai-api@1.11.0
  25. v1.10.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [6f28f47]
      • @sap-ai-sdk/core@1.10.0
      • @sap-ai-sdk/ai-api@1.10.0
  26. v1.9.0

    Features 1, Fixes 2

    Notes
    Minor Changes
    • bc51f59: [New Functionality] Introduce buildLlamaGuardFilter() convenience function to build Llama guard filters.
    Patch Changes
    • 84175fb: [Improvement] Update Orchestration to 2502b Release
    • Updated dependencies [bfed500]
      • @sap-ai-sdk/ai-api@1.9.0
      • @sap-ai-sdk/core@1.9.0
  27. v1.8.0

    Features 5, Fixes 2

    Notes
    Minor Changes
    • 54a9044: [Compatibility Note] Deprecate buildAzureContentFilter() function. Use buildAzureContentSafetyFilter() function instead.
    • 09b0d2d: [Fixed Issue] Consider destination when resolving deployment ids.
    • 16d97ab: [New Functionality] Support configuring data masking for grounding inputs.
    • 5c248a1: [New Functionality] Support using prompt registry with orchestration client.
    • 2c76a1f: [Compatibility Note] Update Orchestration to 2502a Release
    Patch Changes
    • Updated dependencies [09b0d2d]
    • Updated dependencies [1731104]
      • @sap-ai-sdk/ai-api@1.8.0
      • @sap-ai-sdk/core@1.8.0
  28. v1.7.0

    Features 3, Fixes 2

    Notes
    Minor Changes
    • 0a62553: [Compatibility Note] Update AI API to the 2501a release. As part of this change, the modelsGet method of ScenarioAPI has been renamed to scenarioQueryModels.
    • f08ac2e: [New Functionality] Support using help.sap.com as data repository type in the grounding module.
    • bdaae7e: [Fixed Issue] Fix logging bug when using streaming with JSON client. [New Functionality] Add streaming option in the OrchestrationModuleConfig type to set global streaming options.
    Patch Changes
    • @sap-ai-sdk/ai-api@1.7.0
    • @sap-ai-sdk/core@1.7.0
  29. v1.6.0

    Features 4, Fixes 2

    Notes
    Minor Changes
    • 1da2caa: [New Functionality] Support image recognition for orchestration service.
    • d836abf: [New Functionality] Add support for streaming in the orchestration client.
    • 1476584: [Improvement] Make model_params property in the LlmModuleConfig optional and refine the type definition to also include known properties.
    • a039890: [Improvement] Add buildDocumentGroundingConfig() convenience function to create document grounding configuration in the Orchestration client.
    Patch Changes
    • @sap-ai-sdk/ai-api@1.6.0
    • @sap-ai-sdk/core@1.6.0
  30. v1.5.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • 17a1eea: [New Functionality] Add support for using a JSON configuration obtained from AI Launchpad to consume orchestration service.
    • b4a5506: [New Functionality] Add support for providing custom destination for AI Core besides using environment variable and service binding.
    Patch Changes
    • Updated dependencies [b4a5506]
      • @sap-ai-sdk/ai-api@1.5.0
      • @sap-ai-sdk/core@1.5.0
  31. v1.4.0

    Features 1, Fixes 2

    Notes
    Minor Changes
    • d79cee8: [New Functionality] Add support for grounding capabilities of the orchestration service.
    Patch Changes
    • @sap-ai-sdk/ai-api@1.4.0
    • @sap-ai-sdk/core@1.4.0
  32. v1.3.0

    Features 2, Fixes 1

    Notes
    Minor Changes
    • bf17e17: [Fixed Issue] Fix input and output filters to disallow additional properties as part of the filter config.

      [Compatibility Note] FilteringConfig type has been renamed to InputFilteringConfig and OutputFilteringConfig for future extensibility.

    • 6fe32b8: [Compatibility Note] Switch some of the orchestration interfaces to types, as they were introduced by accident.

      [Compatibility Note] Remove grounding key from the type ModuleResults.

    Patch Changes
    • 91df549: [Fixed Issue] Get choice via index by comparing the index property instead of using array index.
      • @sap-ai-sdk/ai-api@1.3.0
      • @sap-ai-sdk/core@1.3.0
  33. v1.2.0

    Fixes 2

    Notes
    Patch Changes
    • @sap-ai-sdk/ai-api@1.2.0
    • @sap-ai-sdk/core@1.2.0
  34. v1.1.0

    Features 2, Fixes 6

    Notes
    Minor Changes
    • a1105d9: [New Functionality] Add support for the data masking capabilities of the orchestration service.
    • 771f986: [Fixed Issue] Fix sending the correct resource group headers when custom resource group is set.
    Patch Changes
    • 506a1e4: [Fixed Issue] Fix missing and unused dependencies.
    • Updated dependencies [506a1e4]
    • Updated dependencies [5bd2e4d]
    • Updated dependencies [5bd2e4d]
    • Updated dependencies [771f986]
    • Updated dependencies [5bd2e4d]
      • @sap-ai-sdk/ai-api@1.1.0
      • @sap-ai-sdk/core@1.1.0
  35. v1.0.0

    Breaking 1, Fixes 1

    Notes
    Major Changes
    • ba9133b: [New Functionality] Introduce orchestration client for consuming the following features of the orchestration service:
      • harmonized LLM access via orchestration
      • client side prompt templates
      • content filtering
    Patch Changes
    • Updated dependencies [ba9133b]
      • @sap-ai-sdk/ai-api@1.0.0
      • @sap-ai-sdk/core@1.0.0
  36. v0.1.0

    Fixes 1

    Notes
    Patch Changes
    • Updated dependencies [4d5edc7]
      • @sap-ai-sdk/core@0.1.0
      • @sap-ai-sdk/ai-api@0.1.0
26,025downloads per week, npm
Weekly downloads for @sap-ai-sdk/orchestration26 complete calendar weeks from 2026-04-27 to 2026-10-25; the latest total is 26025.27 Apr – 3 May: 26,3434 May – 10 May: 27,84511 May – 17 May: 33,68318 May – 24 May: 30,77225 May – 31 May: 33,7721 Jun – 7 Jun: 57,8628 Jun – 14 Jun: 94,92415 Jun – 21 Jun: 62,57022 Jun – 28 Jun: 70,29929 Jun – 5 Jul: 65,8556 Jul – 12 Jul: 66,06513 Jul – 19 Jul: 209,47620 Jul – 26 Jul: 120,49127 Jul – 2 Aug: 169,4493 Aug – 9 Aug: 139,40910 Aug – 16 Aug: 129,30317 Aug – 23 Aug: 168,89424 Aug – 30 Aug: 158,97731 Aug – 6 Sept: 116,2847 Sept – 13 Sept: 112,17614 Sept – 20 Sept: 113,49721 Sept – 27 Sept: 149,84128 Sept – 4 Oct: 199,9715 Oct – 11 Oct: 132,13112 Oct – 18 Oct: 72,35519 Oct – 25 Oct: 26,025

Others providing22

LLM integration
  1. llm_clientABAP client with one interface to chat-completion LLM APIsfrom ABAP
  2. abap-agent-runtimeABAP-native MCP endpoint that drives opted-in abap2UI5 appsfrom ABAP
  3. abap_btocs_ollamaB-Tocs ABAP SDK plugin connecting to Ollama modelsfrom ABAP
  4. SAP AI CoreAI runtime on BTP with the Generative AI Hubfrom BTP/BAIP
  5. cap-java/cds-aiBridge from CAP Java to SAP AI Core, with Fiori field recommendationsfrom CAP
  6. @cap-js/aiValue-help recommendations and SAP AI Core as a CAP servicefrom CAP
  7. cap-llm-pluginGenerative AI in CAP with fields anonymised through SAP HANAfrom CAP
  8. @geertjanklaps/cds-toon-ai-protocol-adapterProtocol adapter serving CAP data as TOON instead of JSONfrom CAP
  9. abap-sdk-nwas-xABAP client library for IBM watsonx.ai APIsfrom ABAP
  10. @jerome-benoit/sap-ai-providerVercel AI SDK provider for SAP AI Corefrom CAP
  11. ui5-cap-ai-featuresCDS plugin and UI5 controls for AI text features via SAP AI Corefrom CAP
  12. Microsoft AI SDK for SAPABAP library for calling Azure OpenAI and OpenAIfrom ABAP
  13. zllmABAP framework for chaining and orchestrating LLM callsfrom ABAP
  14. ABAP AI SDKSAP reuse library for calling large language models from ABAPfrom ABAP
  15. @sap-ai-sdk/ai-apiAI Core control plane API surface of SAP's AI SDKfrom CAP
  16. @sap-ai-sdk/coreShared internals of SAP's AI SDKfrom CAP
  17. @sap-ai-sdk/foundation-modelsClient for foundation models via SAP AI Core and Generative AI Hubfrom CAP
  18. @sap-ai-sdk/prompt-registryClient for prompts kept in SAP's prompt registryfrom CAP
  19. @saptarishi/cds-plugin-llmCAP service kind putting eleven model providers behind one APIfrom CAP
  20. @shahid.la/cds-db-nlquery-mcpMCP server answering plain-English questions against a CDS schemafrom CAP
  21. @ui5/webcomponentsSAP's UI elements as standard custom elementsfrom UI5
  22. abap-sdk-nwasAn ABAP client library for IBM Watson's Discovery, Language Translator, Natural Language Understanding, Speech to Text, Text to Speech and Assistant services, installed through abapGit.from ABAP
Prompt management
  1. SAP AI CoreAI runtime on BTP with the Generative AI Hubfrom BTP/BAIP
  2. @sap-ai-sdk/prompt-registryClient for prompts kept in SAP's prompt registryfrom CAP
  3. @saptarishi/cds-plugin-llmCAP service kind putting eleven model providers behind one APIfrom CAP
Data masking
  1. SAP AI CoreAI runtime on BTP with the Generative AI Hubfrom BTP/BAIP
  2. cap-llm-pluginGenerative AI in CAP with fields anonymised through SAP HANAfrom CAP
Content filtering
  1. SAP AI CoreAI runtime on BTP with the Generative AI Hubfrom BTP/BAIP

Details

Sources5
npm registrydiscovered herechecked
The discovery passdiscovered herechecked
npm registry, @sap-ai-sdk/orchestrationversion, releases, installschecked
github.com/https://github.com/SAP/ai-sdk-jstree, pushes, contributors, CIchecked
packages/orchestration/README.mdquoted, and what the entry declareschecked

Sources are graph entities: the same page may back several entries, and an unreachable source flags every row that rests on it.

Compatibility and provenance
latestv2.17.0
first release
releases and cadence786, ~0d median
discovered vianpm registry, The discovery pass
first seen in the atlas
ecosystem and domaincap, ai-and-agents
Contributors21
History in the atlas5
  1. the model choice and the stream method named, two further sources, and both properties the capability declares
  2. capability:llm-integration, capability:prompt-management, capability:data-masking, capability:content-filtering
  3. Typed cds-plugin by placement, which defaults every candidate to that. It is not one.
  4. The Orchestration Service client — templating, grounding, filtering and masking applied around a model call rather than in the application.
  5. First seen.
For your agent
Ref
artifact:sap-ai-sdk-orchestration
JSON
/artifacts/sap-ai-sdk-orchestration.json
MCP
Connecting an agent