/sap-cloud-sdk-ai

name: sap-cloud-sdk-ai
description: |
  Integrates SAP Cloud SDK for AI into JavaScript/TypeScript and Java applications. Use when building applications with SAP AI Core, Generative AI Hub, or Orchestration Service. Covers chat completion, embedding, streaming, function calling, content filtering, data masking, document grounding, prompt registry, and LangChain/Spring AI integration. Supports OpenAI GPT-4o, Llama, Gemini, Amazon Nova, and other foundation models via SAP BTP.
license: GPL-3.0
metadata:
  maintainer: "Eduard Jiglau"
  maintainer_email: "hello@sap-ai-skills.com"
  website: "https://sap-ai-skills.com"
  version: "2.4.1"
  last_verified: "2026-06-15"
  package_evidence: "docs/project/package-evidence/2026-06-15.json"

SAP Cloud SDK for AI

Related Skills

• **sap-cap-capire**: Use for building CAP applications that consume AI services, including event handler patterns and async LLM orchestration
• **sap-ai-core**: Use for AI Core platform setup, orchestration configuration, and model deployment
• **sap-dependency-security**: Hardening guidance for npm package upgrades, lockfile policies, and secure dependency workflows

The official SDK for SAP AI Core, SAP Generative AI Hub, and Orchestration Service. Package versions are verified against public registries; AI Core tenant execution and exact model availability still require target-tenant validation.

When to Use This Skill

Use this skill when:

• Integrating AI/LLM capabilities into SAP BTP applications
• Building chat completion or embedding features
• Using tenant-approved OpenAI, Claude, Gemini, Amazon, Mistral, or other model families via SAP AI Core
• Implementing content filtering, data masking, or document grounding
• Creating agentic workflows with LangChain or Spring AI
• Managing prompts via Prompt Registry
• Deploying AI models on SAP AI Core

Table of Contents

• [Quick Start](#quick-start)
• [Prerequisites](#prerequisites)
• [Connection Setup](#connection-setup)
• [Available Packages](#available-packages)
• [Supported Models](#supported-models)
• [Core Features](#core-features)
• [Bundled Resources](#bundled-resources)

Quick Start

> **Note**: This skill uses SAP Cloud SDK for AI JavaScript v2.11.0+ and Java v1.19.0+ based on public package registry evidence from 2026-06-15. If you're migrating from v1.x, see [V1 to V2 Migration Guide](references/v1-to-v2-migration.md) for breaking changes.

JavaScript/TypeScript

npm install @sap-ai-sdk/orchestration@^2

import { OrchestrationClient } from '@sap-ai-sdk/orchestration';

const client = new OrchestrationClient({
  promptTemplating: {
    model: { name: 'gpt-4o' },
    prompt: [{ role: 'user', content: '{{?question}}' }]
  }
});

const response = await client.chatCompletion({
  placeholderValues: { question: 'What is SAP?' }
});
console.log(response.getContent());

Java

<dependency>
  <groupId>com.sap.ai.sdk</groupId>
  <artifactId>orchestration</artifactId>
  <version>${ai-sdk.version}</version>
</dependency>

var client = new OrchestrationClient();
var config = new OrchestrationModuleConfig()
    .withLlmConfig(OrchestrationAiModel.GPT_4O);
var prompt = new OrchestrationPrompt("What is SAP?");
var result = client.chatCompletion(prompt, config);
System.out.println(result.getContent());

Prerequisites

• **Node.js 20+** (JavaScript) or **Java 17+** (Java)
• **SAP AI Core** service instance (extended or sap-internal plan)
• **Orchestration deployment** in AI Core (default resource group has this)

Connection Setup

BTP Runtime (Cloud Foundry/Kyma)

Bind AI Core service instance to your application. SDK auto-detects via `VCAP_SERVICES` or mounted secrets.

Local Development

Set environment variable:

export AICORE_SERVICE_KEY='{"clientid":"...","clientsecret":"...","url":"...","serviceurls":{"AI_API_URL":"..."}}'

Or use CAP hybrid mode:

# JavaScript
cds bind -2 <AICORE_INSTANCE> && cds-tsx watch --profile hybrid

# Java
cds bind --to aicore --exec mvn spring-boot:run

For detailed connection options, see `references/connecting-to-ai-core.md`

Available Packages

JavaScript/TypeScript

| Package | Purpose | |---------|---------| | `@sap-ai-sdk/orchestration` | Chat completion, filtering, grounding | | `@sap-ai-sdk/foundation-models` | Direct model access (OpenAI) | | `@sap-ai-sdk/langchain` | LangChain integration | | `@sap-ai-sdk/ai-api` | Deployments, artifacts, configurations | | `@sap-ai-sdk/document-grounding` | Pipeline, Vector, Retrieval APIs | | `@sap-ai-sdk/prompt-registry` | Prompt template management |

Java

| Artifact | Purpose | |----------|---------| | `orchestration` | Chat completion, filtering, grounding | | `openai` (foundationmodels) | Direct OpenAI model access | | `core` | Base connectivity | | `document-grounding` | Pipeline, Vector, Retrieval APIs | | `prompt-registry` | Prompt template management |

Supported Models

Model IDs and versions are tenant-specific. Before copying an example into application code, list the target catalog through SAP AI Launchpad Model Library or the AI Core model-list API.

Example Families

• **OpenAI**: GPT-family chat, multimodal, reasoning, and embedding models where entitled
• **Anthropic (AWS)**: Claude-family models where entitled
• **Amazon**: Nova/Titan-family models where entitled
• **Google**: Gemini-family models where entitled
• **Mistral**: Mistral-family models where entitled

Deprecated Models (Use Replacements)

| Deprecated | Use Instead | |------------|-------------| | text-embedding-ada-002 | text-embedding-3-small/large | | gpt-35-turbo (all variants) | gpt-4o-mini | | gpt-4-32k | gpt-4o | | gpt-4 (base) | gpt-4o or gpt-4.1 | | gemini-1.0-pro | gemini-2.0-flash | | gemini-1.5-pro/flash | gemini-2.5-flash | | mistralai--mixtral-8x7b | mistralai--mistral-small-instruct |

Core Features

Chat Completion with Streaming

// JavaScript
const st