SAP Cloud SDK for AI

https://sap.github.io/ai-sdk/
Admin
SAP Cloud SDK for AI is a comprehensive solution for integrating artificial intelligence...
Tokens:221,998
Snippets:2,314
Trust Score:8.3
Update:2 months ago
Show doc for...
Tokens:
Raw
### Template Version Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.TemplateRefByScenarioNameVersion.html

Example value for the version property.

```json
"some version, can be `latest`"
```

--------------------------------

### Example Placeholder Configuration

Source: https://sap.github.io/ai-sdk/api/v2/interfaces/orchestration_src.DocumentGroundingServiceConfig.html

Example value for the output placeholder configuration.

```json
"groundingOutput"
```

--------------------------------

### File Size Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the fileSizeMb property.

```text
"1.5"
```

--------------------------------

### AiDeploymentTimeToLive Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiDeploymentTimeToLive.html

Example of a valid time-to-live string format.

```text
"24H"
```

--------------------------------

### View Location Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the viewLocation property.

```text
"https://example.com/view/123"
```

--------------------------------

### Resource URI Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the resourceUri property.

```text
"https://example.com/resource/123"
```

--------------------------------

### File Suffix Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the fileSuffix property.

```text
".pdf"
```

--------------------------------

### Download Location Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the downloadLocation property.

```text
"https://example.com/download/123"
```

--------------------------------

### Bucket Name Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional bucket parameter.

```text
"mybucket1"
```

--------------------------------

### Scenario Name Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.TemplateRefByScenarioNameVersion.html

Example value for the scenario property.

```json
"some-scenario"
```

--------------------------------

### Template Name Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.TemplateRefByScenarioNameVersion.html

Example value for the name property.

```json
"some-template-name"
```

--------------------------------

### DSetFileCreationResponse Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.DSetFileCreationResponse.html

Example of the message field value returned in a successful file creation response.

```json
"File creation acknowledged"
```

--------------------------------

### Model Name Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.LLMModelDetails.html

Example of a model name string.

```json
"gpt-4o-mini"
```

--------------------------------

### Install SAP Cloud SDK for AI

Source: https://sap.github.io/ai-sdk/docs/python/overview

Commands to install the SDK with various provider support levels.

```bash
pip install "sap-ai-sdk-gen[all]"
```

```bash
pip install sap-ai-sdk-gen
```

```bash
pip install "sap-ai-sdk-gen[google, amazon]"
```

--------------------------------

### Storage Type Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the required storage type.

```text
"S3"
```

--------------------------------

### JSON Configuration File Examples

Source: https://sap.github.io/ai-sdk/docs/python/overview

Examples of JSON configuration files for different authentication methods, including client secret and X.509 certificate-based authentication.

```json
{

  "AICORE_AUTH_URL": "https://***.authentication.sap.hana.ondemand.com/oauth/token",

  "AICORE_CLIENT_ID": "***",

  "AICORE_CLIENT_SECRET": "***",

  "AICORE_RESOURCE_GROUP": "***",

  "AICORE_BASE_URL": "https://api.ai.***.cfapps.sap.hana.ondemand.com/v2"

}
```

```json
{

  "AICORE_AUTH_URL": "https://***.authentication.cert.sap.hana.ondemand.com",

  "AICORE_CLIENT_ID": "***",

  "AICORE_CERT_FILE_PATH": "***/cert.pem",

  "AICORE_KEY_FILE_PATH": "***/key.pem",

  "AICORE_RESOURCE_GROUP": "***",

  "AICORE_BASE_URL": "https://api.ai.***.cfapps.sap.hana.ondemand.com/v2"

}
```

```json
{

  "AICORE_AUTH_URL": "https://***.authentication.cert.sap.hana.ondemand.com",

  "AICORE_CLIENT_ID": "***",

  "AICORE_CERT_STR": "***",

  "AICORE_KEY_STR": "***",

  "AICORE_RESOURCE_GROUP": "***",

  "AICORE_BASE_URL": "https://api.ai.***.cfapps.sap.hana.ondemand.com/v2"

}
```

--------------------------------

### Install Foundation Models Package

Source: https://sap.github.io/ai-sdk/docs/js/foundation-models

Install the package via npm.

```bash
npm install @sap-ai-sdk/foundation-models
```

--------------------------------

### Web URL Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the webUrl property.

```text
"https://example.com/web/123"
```

--------------------------------

### Install Dependencies

Source: https://sap.github.io/ai-sdk/docs/js/tutorials/getting-started-with-agents

Install the required packages for the SAP AI SDK, LangChain, and MCP support.

```bash
npm install @sap-ai-sdk/langchain langchain @langchain/langgraph @langchain/core @langchain/mcp-adapters @modelcontextprotocol/sdk zod
```

--------------------------------

### Path Prefix Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional storage path prefix.

```text
"mp-api"
```

--------------------------------

### Install Prompt Registry Package

Source: https://sap.github.io/ai-sdk/docs/js/ai-core/prompt-registry

Use npm to install the package. It is recommended to use the tilde (~) version range to manage updates effectively.

```bash
npm install @sap-ai-sdk/prompt-registry
```

--------------------------------

### Install SAP AI SDK for OpenAI

Source: https://sap.github.io/ai-sdk/docs/js/openai

Install the required packages via npm.

```bash
npm install @sap-ai-sdk/openai openai
```

--------------------------------

### Object Store Name Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the required object store name.

```text
"myobjectstore"
```

--------------------------------

### Region Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional storage server region.

```text
"eu"
```

--------------------------------

### Endpoint URL Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional storage server endpoint.

```text
"www.example.com"
```

--------------------------------

### DPIConfig allowlist example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.DPIConfig.html

Example of an allowlist array containing strings that should not be masked.

```json
[
  "SAP",
  "Joule"
]
```

--------------------------------

### Absolute File Path Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the absoluteFilePath property.

```text
"/sites/team/finance/Q1/report.pdf"
```

--------------------------------

### Model Parameters Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.LLMModelDetails.html

Example of additional parameters configuration for an LLM model.

```json
{  
     *   "max_completion_tokens": 300,  
     *   "temperature": 0.1,  
     *   "frequency_penalty": 0,  
     *   "presence_penalty": 0,  
     *   "n": 2,  
     *   "stream_options": {  
     *     "include_usage": true  
     *   }  
     * }
```

--------------------------------

### Install LangChain and SAP AI SDK packages

Source: https://sap.github.io/ai-sdk/docs/js/langchain

Use these commands to install the necessary dependencies for using LangChain with the SAP AI SDK.

```bash
npm install @sap-ai-sdk/langchain

# Install langchain packages

npm install langchain @langchain/core



# Install SAP Cloud SDK for AI langchain package

npm install @sap-ai-sdk/langchain
```

--------------------------------

### SharePointSite Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.SharePointSite.html

A basic example of a SharePointSite object represented as a string name.

```json
"sharepoint-site-name"
```

--------------------------------

### BckndInternalResourceGroupLabel Key Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndInternalResourceGroupLabel.html

Example value for the key property, demonstrating the required pattern and length constraints.

```text
"internal.ai.sap.com/my-label"  
Max Length: 63.  
Pattern: "^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$".
```

--------------------------------

### AiDeployment ID Pattern Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiDeployment.html

Example of a valid deployment ID string and its regex pattern constraint.

```text
"aa97b177-9383-4934-8543-0f91a7a0283a"  
Pattern: "^[\w.-]{4,64}$".
```

--------------------------------

### AI Core Configuration Example

Source: https://sap.github.io/ai-sdk/docs/java/ai-core/ai-core-deployment

Example JSON structure for an AI Core configuration retrieved from the /configuration endpoint.

```json
{

  "createdAt": "2024-07-03T12:44:08Z",

  "executableId": "azure-openai",

  "id": "12345-123-123-123-123456abcdefg",

  "inputArtifactBindings": [],

  "name": "gpt-4o-mini",

  "parameterBindings": [

    {

      "key": "modelName",

      "value": "gpt-4o-mini"

    },

    {

      "key": "modelVersion",

      "value": "latest"

    }

  ],

  "scenarioId": "foundation-models"

}
```

--------------------------------

### Initialize Document Grounding Clients

Source: https://sap.github.io/ai-sdk/docs/python/examples/document-grounding2

Set up the proxy client and initialize the Pipeline, Vector, and Retrieval API clients.

```python
from gen_ai_hub.proxy import get_proxy_client  

from gen_ai_hub.document_grounding.client import PipelineAPIClient, VectorAPIClient, RetrievalAPIClient  

  

proxy_client = get_proxy_client(proxy_version='gen-ai-hub')  

  

pipelines = PipelineAPIClient(proxy_client)  

vector = VectorAPIClient(proxy_client)  

retrieval = RetrievalAPIClient(proxy_client)
```

--------------------------------

### Initialize Prompt Template Client

Source: https://sap.github.io/ai-sdk/docs/python/examples/prompt-registry

Set up the PromptTemplateClient using a proxy client configured for the gen-ai-hub.

```python
from gen_ai_hub.proxy import get_proxy_client  

from gen_ai_hub.prompt_registry import PromptTemplateClient  

  

proxy_client = get_proxy_client(proxy_version="gen-ai-hub")  

prompt_registry_client = PromptTemplateClient(proxy_client=proxy_client)  
```

--------------------------------

### Example Target Language

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.SAPDocumentTranslationInput.html

Example value for the target_language field.

```json
"en-US"
```

--------------------------------

### Instantiate AI Core Clients

Source: https://sap.github.io/ai-sdk/docs/java/connecting-to-ai-core

Demonstrates how to create specific clients like OpenAiClient, OrchestrationClient, or DeploymentApi using the initialized AiCoreService.

```java
// To create an OpenAiClient:

var openAiDestination = aiCoreService.getInferenceDestination().forModel(OpenAiModel.TEXT_EMBEDDING_3_LARGE);

var client = OpenAiClient.withCustomDestination(openAiDestination);



// To create an OrchestrationClient:

var orchestrationDestination = aiCoreService.getInferenceDestination().forScenario("orchestration");

var client = new OrchestrationClient(orchestrationDestination);



// To create any of the com.sap.ai.sdk.core.client.* classes (e.g. DeploymentApi):

new DeploymentApi(aiCoreService);
```

--------------------------------

### Grounding Output Placeholder Example

Source: https://sap.github.io/ai-sdk/api/v2/interfaces/orchestration_src.GroundingModule.html

Example value for the grounding output placeholder.

```text
'groundingOutput'
```

--------------------------------

### Low-Level Configuration for AzureOpenAI

Source: https://sap.github.io/ai-sdk/docs/js/openai

Shows how to retrieve configuration options for direct instantiation of the AzureOpenAI client.

```javascript
import { AzureOpenAI } from 'openai';

import { createOpenAiConfig } from '@sap-ai-sdk/openai';



const config = await createOpenAiConfig('gpt-5.4');

const client = new AzureOpenAI(config);
```

--------------------------------

### AiDeploymentModificationRequestList JSON Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiDeploymentModificationRequestList.html

Example structure for a list of deployment modification requests. The list must contain between 1 and 100 items.

```json
[
  {
    "id": "aa97b177-9383-4934-8543-0f91a7a0283a",
    "targetStatus": "STOPPED"
  },
  {
    "id": "qweq32131-qwee-1231-8543-0f91a7a2e2e",
    "targetStatus": "DELETED"
  }
]
```

--------------------------------

### Run Orchestration Request

Source: https://sap.github.io/ai-sdk/docs/python/examples/orchestration-service2

Initialize the service with the configuration and execute it with specific placeholder values.

```python
from gen_ai_hub.orchestration_v2 import OrchestrationService  

  

orchestration_service = OrchestrationService(config=config)  

result = orchestration_service.run(placeholder_values={"user_query": "The Orchestration Service is working!"})  

print(result.final_result.choices[0].message.content)  
```

--------------------------------

### DocumentMetadata key example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.DocumentMetadata.html

Example of a metadata key name.

```json
"contentObjectId"
```

--------------------------------

### Install Batch API dependencies

Source: https://sap.github.io/ai-sdk/docs/js/foundation-models/openai/batch

Install the required packages to use the Batch API functionality.

```bash
npm install @sap-ai-sdk/batch-api @sap-ai-sdk/ai-api @sap-ai-sdk/foundation-models
```

--------------------------------

### Install Document Grounding Package

Source: https://sap.github.io/ai-sdk/docs/js/ai-core/document-grounding

Use the tilde version range to manage updates and prevent breaking changes.

```bash
npm install @sap-ai-sdk/document-grounding
```

--------------------------------

### Document Title Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the title property.

```text
"Quarterly Report"
```

--------------------------------

### RTALabel Key Pattern Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.RTALabel.html

Example of a valid key string following the required regex pattern.

```text
"ai.sap.com/scenarioName"  
Pattern: "^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)*ai\.sap\.com\/[\w\.-]+$".
```

--------------------------------

### MIME Type Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the mimeType property.

```text
"application/pdf"
```

--------------------------------

### Destination String Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.GoogleDriveConfigurationStruct.html

Represents the destination name for the configuration.

```text
"destination-name"
```

--------------------------------

### Document ID Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the id property.

```text
"3cba7512-b07a-58e6-a442-c83996a0b3bb"
```

--------------------------------

### BcknddockerRegistryNameComponent Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BcknddockerRegistryNameComponent.html

Example value for the docker registry name component, which must adhere to a 63-character limit and a specific regex pattern.

```text
"mydockeregistry"
```

--------------------------------

### Create ImageItem instances for multimodal input

Source: https://sap.github.io/ai-sdk/docs/python/examples/orchestration-service

Demonstrates initializing ImageItem from URLs, data URLs, and local file paths.

```python
from gen_ai_hub.orchestration.models.multimodal_items import ImageItem  

  

# From URL  

image_from_web = ImageItem(url="https://picsum.photos/id/1/200/300")  

  

# From Data URL  

image_from_data_url = ImageItem(  

    url="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAoAAAAKCAIAAAACUFjqAAAAE0lEQVR4nGP8z4APMOGVZRip0gBBLAETee26JgAAAABJRU5ErkJggg=="  

)  

  

# From local file  

try:  

    image_from_local_file = ImageItem.from_file("path/to/your/local/image.jpeg")  

except FileNotFoundError:  

    print("Error: The specified image file was not found.")
```

--------------------------------

### Create an Orchestration Configuration in Java

Source: https://sap.github.io/ai-sdk/docs/java/ai-core/prompt-registry

Demonstrates how to build an orchestration configuration object and persist it using the OrchestrationConfigClient.

```java
import com.sap.ai.sdk.prompt.registry.OrchestrationConfigClient;  

import com.sap.ai.sdk.prompt.registry.model.LLMModelDetails;  

import com.sap.ai.sdk.prompt.registry.model.OrchestrationConfigPostRequest;  

import com.sap.ai.sdk.prompt.registry.model.OrchestrationConfigPostResponse;  

import com.sap.ai.sdk.prompt.registry.model.PartialModuleConfigs;  

import com.sap.ai.sdk.prompt.registry.model.PromptRegistryOrchestrationConfig;  

import com.sap.ai.sdk.prompt.registry.model.PromptRegistryOrchestrationConfigModules;  

import com.sap.ai.sdk.prompt.registry.model.PartialPromptTemplatingModuleConfig;  

import com.sap.ai.sdk.prompt.registry.model.Template;  

import com.sap.ai.sdk.prompt.registry.model.UserChatMessage;  

import com.sap.ai.sdk.prompt.registry.model.UserChatMessageContent;  

  

var orchConfigClient = new OrchestrationConfigClient();  

// build PromptRegistryOrchestrationConfig  

var message =  

    UserChatMessage.create()  

        .content(new UserChatMessageContent.InnerString("message"))  

        .role(UserChatMessage.RoleEnum.USER);  

var promptTemplating =  

    PartialPromptTemplatingModuleConfig.create()  

        .model(LLMModelDetails.create().name("model-name"))  

        .prompt(Template.create().template(message));  

var orchestrationConfig =  

    PromptRegistryOrchestrationConfig.create()  

        .modules(  

            PromptRegistryOrchestrationConfigModules.createInnerPartialModuleConfigs(  

                PartialModuleConfigs.create().promptTemplating(promptTemplating)));  

// use the config  

var postRequest =  

      OrchestrationConfigPostRequest.create()  

          .name("name")  

          .version("0.0.1")  

          .scenario("scenario")  

          .spec(orchestrationConfig);  

OrchestrationConfigPostResponse response = orchConfigClient.createUpdateOrchestrationConfig(postRequest);
```

--------------------------------

### Document ETag Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the documentEtag property.

```text
"abc123etag"
```

--------------------------------

### TrckLabelName Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.TrckLabelName.html

Example of a valid TrckLabelName string value.

```text
"metrics.ai.sap.com/Artifact.name"
```

--------------------------------

### Initialize Orchestration Client

Source: https://sap.github.io/ai-sdk/docs/js/getting-started

Configure the client with the target LLM model and a prompt template containing placeholders.

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



const orchestrationClient = new OrchestrationClient({

  promptTemplating: {

    model: {

      name: 'gpt-5'

    },

    prompt: {

      template: [

        { role: 'user', content: 'Answer the question: {{?question}}' }

      ]

    }

  }

});
```

--------------------------------

### AiConfigurationCreationResponseMessage Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiConfigurationCreationResponseMessage.html

Represents the string message returned after a configuration is created.

```text
"Configuration created"
```

--------------------------------

### BckndArgoCDRepositoryCreationResponseMessage Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndArgoCDRepositoryCreationResponseMessage.html

Example usage of the BckndArgoCDRepositoryCreationResponseMessage type alias.

```json
"Repository has been on-boarded"
```

--------------------------------

### AiDeploymentStatus Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiDeploymentStatus.html

Represents a completed deployment status.

```typescript
"COMPLETED"
```

--------------------------------

### Example items configuration

Source: https://sap.github.io/ai-sdk/api/v2/interfaces/orchestration_src.DocumentTranslationApplyToSelector.html

An array of placeholders or roles to which translation should be applied.

```json
[  
  "groundingInput",  
  "inputContext"  
]
```

--------------------------------

### DSetUrl Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.DSetUrl.html

Represents a URL string formatted for the DSetUrl schema.

```text
"https://download.example.com/test/file.bin"
```

--------------------------------

### AiArtifactUrl Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiArtifactUrl.html

Example of a valid AiArtifactUrl string value.

```text
"https://example.com/some_path"
```

--------------------------------

### Resource Type Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocument.html

Represents the type of the resource, such as a folder or document.

```json
"FOLDER"
```

--------------------------------

### Install AI API package

Source: https://sap.github.io/ai-sdk/docs/js/ai-core/ai-api

Use the tilde version range to ensure compatibility and manage updates effectively.

```bash
npm install @sap-ai-sdk/ai-api
```

--------------------------------

### Tool Role Example

Source: https://sap.github.io/ai-sdk/api/v2/types/orchestration_src.ToolChatMessage.html

Example value for the role property in a ToolChatMessage.

```json
"tool"
```

--------------------------------

### Install the RPT SDK

Source: https://sap.github.io/ai-sdk/docs/js/rpt

Command to add the package to your project dependencies.

```bash
npm install @sap-ai-sdk/rpt
```

--------------------------------

### ManualPipelineTrigger metadataOnly example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ManualPipelineTrigger.html

Example value for the optional metadataOnly property.

```typescript
true
```

--------------------------------

### MetaAPIVersion URL example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.MetaAPIVersion.html

Example value for the optional URL field.

```json
"https://api.example.com/v1"
```

--------------------------------

### MetaAPIVersion description example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.MetaAPIVersion.html

Example value for the optional description field.

```json
"Example API"
```

--------------------------------

### Initialize Orchestration Config Client

Source: https://sap.github.io/ai-sdk/docs/python/examples/prompt-registry

Set up the OrchestrationConfigClient to manage orchestration configurations.

```python
from gen_ai_hub.proxy import get_proxy_client  

from gen_ai_hub.prompt_registry import OrchestrationConfigClient  

  

proxy_client = get_proxy_client(proxy_version="gen-ai-hub")  

prompt_registry_client = OrchestrationConfigClient(proxy_client=proxy_client)  
```

--------------------------------

### Grounding via SAP Help

Source: https://sap.github.io/ai-sdk/docs/python/examples/document-grounding

Configures document grounding using the SAP Help repository and executes the orchestration run.

```python
filters = [DocumentGroundingFilter(id="SAPHelp", data_repository_type=DataRepositoryType.URL.value)]  

  
grounding_config = GroundingModule(  

    type=GroundingType.DOCUMENT_GROUNDING_SERVICE.value,  

    config=DocumentGrounding(  

        input_params=["product"],  

        output_param="grounding_response",  

        filters=filters  

    )  

)  

  
config = OrchestrationConfig(template=prompt, llm=llm, grounding=grounding_config)  

response = orchestration_service.run(config=config, template_values=[TemplateValue("product", "Generative AI Hub")])  

print(response.orchestration_result.choices[0].message.content)
```

--------------------------------

### Prompt Registry Instance-level Metering

Source: https://sap.github.io/ai-sdk/docs/python/examples/metering

Initializes the PromptTemplateClient with a proxy client configured for instance-level metering.

```python
from gen_ai_hub.prompt_registry import PromptTemplateClient  

  

client = PromptTemplateClient(proxy_client=proxy_client)  

templates = client.get_prompt_templates(scenario='my-scenario')  

print(f"Found {templates.count} templates")  
```

--------------------------------

### Initialize Agent Clients

Source: https://sap.github.io/ai-sdk/docs/js/tutorials/getting-started-with-agents

Configure tools and models using either Azure OpenAI or Orchestration clients.

```javascript
// Define the tools for the agent to use  

const tools = [...(await mcpClient.getTools()), getRestaurantsTool];  

const toolNode = new ToolNode(tools);  

  

// Create a model  

const model = new AzureOpenAiChatClient({  

  modelName: 'gpt-5-mini',  

  maxRetries: 0  

});  

  

// create a model with access to the tools  

const modelWithTools = model.bindTools(tools);
```

```javascript
// Define the tools for the agent to use  

const tools = [...(await mcpClient.getTools()), getRestaurantsTool];  

const toolNode = new ToolNode(tools);  

  

// Create a model  

const model = new OrchestrationClient({  

  promptTemplating: {  

    model: {  

      name: 'anthropic--claude-4.5-haiku',  

      params: {  

        temperature: 0.7  

      }  

    }  

  }  

});  

  

// create a model with access to the tools  

const modelWithTools = model.bindTools(tools);
```

--------------------------------

### Example type value

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.SAPDocumentTranslationOutput.html

Example of the literal string value for the type property.

```json
"sap_document_translation"
```

--------------------------------

### MetadataConfigurationResponse enumerationStatus Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.MetadataConfigurationResponse.html

Example value for the enumerationStatus property within the MetadataConfigurationResponse.

```json
"IN_PROGRESS"
```

--------------------------------

### GetPipelineExecutions Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.GetPipelineExecutions.html

Example usage of the count property within the GetPipelineExecutions schema.

```typescript
2
```

--------------------------------

### DocumentMetadata matchMode example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.DocumentMetadata.html

Example of a match mode value for the metadata key.

```json
"ANY"
```

--------------------------------

### Initialize Client with Tools

Source: https://sap.github.io/ai-sdk/docs/js/orchestration/chat-completion

Configure the OrchestrationClient with tool definitions to enable function calling capabilities.

```typescript
const client = new OrchestrationClient({

  promptTemplating: {

    model: {

      name: 'gpt-5'

    },

    prompt: {

      tools: [convertTemperatureTool]

    }

  }

});



const response = await client.chatCompletion({

  messages: [

    { role: 'user', content: 'Convert 20 degrees Celsius to Fahrenheit.' }

  ]

});
```

--------------------------------

### MetaAPIVersion versionId example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.MetaAPIVersion.html

Example value for the optional version identifier field.

```json
"v1"
```

--------------------------------

### Use HTTPS Flag Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional HTTPS flag.

```text
"1"
```

--------------------------------

### AiDeploymentCreationResponseMessage Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiDeploymentCreationResponseMessage.html

Represents a typical string message returned by the deployment creation response.

```typescript
"Deployment scheduled"
```

--------------------------------

### constructor

Source: https://sap.github.io/ai-sdk/api/v2/classes/foundation-models_src.AzureOpenAiChatClient.html

Creates an instance of the Azure OpenAI chat client.

```APIDOC
## constructor

### Description
Creates an instance of the Azure OpenAI chat client.

### Parameters
- **modelDeployment** (ModelDeployment<AzureOpenAiChatModel>) - Required - Configuration used to retrieve a deployment.
- **destination** (Destination) - Optional - The destination to use for the request.
```

--------------------------------

### AiVersionDescription Usage Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiVersionDescription.html

Example of a valid string value for the AiVersionDescription type.

```text
"This is version v1"
```

--------------------------------

### Configure AzureContentFilter

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/orchestration/AzureContentFilter.html

Demonstrates how to instantiate and configure the AzureContentFilter with specific safety thresholds.

```java
 AzureContentFilter filter = new AzureContentFilter()
     .hate(AzureFilterThreshold.ALLOW_SAFE)
     .selfHarm(AzureFilterThreshold.ALLOW_SAFE_LOW);
```

--------------------------------

### Initialize Orchestration Client

Source: https://sap.github.io/ai-sdk/docs/java/getting-started

Create an instance of the OrchestrationClient to begin interacting with the service.

```java
var client = new OrchestrationClient();
```

--------------------------------

### Grounding Service Type Example

Source: https://sap.github.io/ai-sdk/api/v2/interfaces/orchestration_src.GroundingModule.html

Example value for the grounding service type.

```text
'document_grounding_service'
```

--------------------------------

### Initialize with Custom Destination

Source: https://sap.github.io/ai-sdk/docs/js/langchain/orchestration

Initializes the client with specific LangChain options, deployment configuration, and a custom destination name.

```typescript
const client = new OrchestrationClient(

  orchestrationConfig,

  langchainOptions,

  deploymentConfig,

  { destinationName: 'my-destination' }

);
```

--------------------------------

### DPIMethodConstant Value Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.DPIMethodConstant.html

Example of a string value used for the constant replacement method.

```text
"NAME_REDACTED"
```

--------------------------------

### create

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/core/client/DeploymentApi.html

Create a new deployment using the configuration specified by configurationId.

```APIDOC
## create(String aiResourceGroup, AiDeploymentCreationRequest aiDeploymentCreationRequest)

### Description
Create a deployment using the configuration specified by configurationId after synchronously checking the correctness of the configuration.

### Parameters
- **aiResourceGroup** (String) - Required - Specify a resource group id
- **aiDeploymentCreationRequest** (AiDeploymentCreationRequest) - Required - The value for the parameter aiDeploymentCreationRequest

### Returns
- **AiDeploymentCreationResponse** - The deployment creation response

### Throws
- **OpenApiRequestException** - if an error occurs while attempting to invoke the API
```

--------------------------------

### MetaVersion Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.MetaVersion.html

Represents a valid semantic version string following the specified regex pattern.

```text
"1.2.3"
```

--------------------------------

### Created Timestamp Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.ConfigurationDocumentFullDetails.html

Example value for the createdTimestamp property in RFC 3339 format.

```text
"2025-08-28T06:15:30Z"
```

--------------------------------

### TrckLabel Example Value

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.TrckLabel.html

Example of a string value for a TrckLabel, noting length constraints.

```text
"sk_learn_random_forest_model"  
Max Length: 256.  
Min Length: 1.
```

--------------------------------

### Create Prompt Template with Tenant Scope

Source: https://sap.github.io/ai-sdk/docs/java/ai-core/prompt-registry

Define a reusable prompt template with placeholders and default values using the PromptClient.

```java
PromptClient client = new PromptClient();  

  

var spec =  

    PromptTemplateSpec.create()  

        .template(  

            SingleChatTemplate.create()  

                .role("system")  

                .content(  

                    "You classify input text into the two following categories: {{?categories}}"),  

            SingleChatTemplate.create().role("user").content("{{?inputExample}}"))  

        .defaults(Map.of("categories", "Finance, Tech, Sports"));  

  

var template = PromptTemplatePostRequest.create()  

    .name("template-name")  

    .version("0.0.1")  

    .scenario("categorization")  

    .spec(spec);  

  

PromptTemplatePostResponse response = client.createUpdatePromptTemplate(template);
```

--------------------------------

### TrckCustomInfoObject Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.TrckCustomInfoObject.html

Example structure of a TrckCustomInfoObject containing a name and a JSON-formatted string value.

```json
{
 *   "name": "Confusion Matrix",
 *   "value": "[{'Predicted': 'False',  'Actual': 'False','value': 34},{'Predicted': 'False','Actual': 'True',  'value': 124}, {'Predicted': 'True','Actual': 'False','value': 165},{  'Predicted': 'True','Actual': 'True','value': 36}]"
 * }
```

--------------------------------

### Parse and Execute Prompt Template

Source: https://sap.github.io/ai-sdk/docs/java/ai-core/prompt-registry

Demonstrates initializing the ChatClient with memory advisors and executing a prompt template retrieved by ID.

```java
OpenAiClient openAiClient = OpenAiClient.forModel(OpenAiModel.GPT_4O_MINI);  

ChatModel client = new OpenAiChatModel(openAiClient);  

  

var repository = new InMemoryChatMemoryRepository();  

var memory = MessageWindowChatMemory.builder().chatMemoryRepository(repository).build();  

var advisor = MessageChatMemoryAdvisor.builder(memory).build();  

var cl = ChatClient.builder(client).defaultAdvisors(advisor).build();  

  

var promptResponse =  

    new PromptClient()  

        .parsePromptTemplateById(  

            UUID.fromString("template id"),  

            "template_name",  

            "resource-group",// usually "default"  

            false,  

            PromptTemplateSubstitutionRequest.create()  

                .inputParams(Map.of("parameter1", "value1")));  

  

List<Message> messages = SpringAiConverter.promptTemplateToMessages(promptResponse);  

var prompt = new Prompt(messages);  

  

Generation response = cl.prompt(prompt).call().chatResponse().getResult();
```

--------------------------------

### Verify SSL Flag Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndobjectStoreSecretWithSensitiveDataRequestForPostCall.html

Example value for the optional SSL verification flag.

```text
"0"
```

--------------------------------

### Example Assistant Output

Source: https://sap.github.io/ai-sdk/docs/js/tutorials/getting-started-with-agents

Sample output generated by the assistant after processing the itinerary request.

```text
Assistant: Here's a 3-item itinerary for your visit to Paris:  

  

1. **Morning: Explore the Louvre Museum**  

   - Start your day by visiting the world-renowned Louvre Museum. Take your time to explore its vast collection of art and history.  

   - Weather: 22°C, Mild and pleasant – perfect for a stroll through the museum and its gardens.  

  

2. **Afternoon: Lunch at Le Comptoir du Relais**  

   - Enjoy a delicious lunch at Le Comptoir du Relais, a popular Parisian restaurant known for its authentic French cuisine.  

   - After lunch, you can take a leisurely walk around the nearby Saint-Germain-des-Prés area, soaking in the Parisian ambiance.  

  

3. **Evening: Dinner at L'As du Fallafel**  

   - Head to L'As du Fallafel for dinner, where you can savor some of the best falafel in the city. It's a unique spot that offers a taste of multicultural Paris.  

   - You can conclude your evening with a walk in the vibrant Marais district, where the restaurant is located.  

  

Would you like to make any changes to this itinerary or add something else?
```

--------------------------------

### Cron Expression Example

Source: https://sap.github.io/ai-sdk/api/v2/types/document-grounding_src.MetadataConfigurationStruct.html

Example of a valid cron expression string for scheduling pipeline execution.

```json
"0 */20 * * *"
```

--------------------------------

### Date-time format example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.RTAExecution.html

Example of the ISO 8601 date-time string format used for timestamps.

```text
"2017-09-15T12:01:06Z"
```

--------------------------------

### Initialize BatchService

Source: https://sap.github.io/ai-sdk/docs/python/examples/batch-service

Instantiate the BatchService client. An optional proxy client can be provided if required by your environment.

```python
from gen_ai_hub.batch_service import BatchService  

  

batch_service = BatchService()  

  

# Or with an explicit proxy client:  

# from gen_ai_hub.proxy import get_proxy_client  

# batch_service = BatchService(proxy_client=get_proxy_client('gen-ai-hub'))  
```

--------------------------------

### MetaCapabilities Runtime Identifier Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.MetaCapabilities.html

Example value for the runtimeIdentifier property within the MetaCapabilities object.

```json
"aicore"
```

--------------------------------

### Initialize EvaluationClient

Source: https://sap.github.io/ai-sdk/docs/python/examples/evaluations

Initializes the client using environment variables or the from_env helper method.

```python
from gen_ai_hub.evaluations import EvaluationClient  

from dotenv import load_dotenv  

import os  

  

load_dotenv(override=True)  

  

client = EvaluationClient(  

    base_url=os.getenv("AICORE_BASE_URL"),  

    auth_url=os.getenv("AICORE_AUTH_URL"),  

    client_id=os.getenv("AICORE_CLIENT_ID"),  

    client_secret=os.getenv("AICORE_CLIENT_SECRET"),  

    resource_group=os.getenv("AICORE_RESOURCE_GROUP"),  

    aws_access_key_id=os.getenv("AWS_ACCESS_KEY_ID"),  

    aws_secret_access_key=os.getenv("AWS_SECRET_ACCESS_KEY"),  

    orchestration_url=os.getenv("ORCHESTRATION_URL")  

)  

  

# Alternative initialization from environment  

# client = EvaluationClient.from_env()  
```

--------------------------------

### create

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/core/client/ConfigurationApi.html

Creates a new configuration linked to a specific scenario and executable.

```APIDOC
## create

### Description
Create a new configuration linked to a specific scenario and executable for use in an execution or deployment.

### Parameters
- **aiResourceGroup** (String) - Required - Specify a resource group id
- **aiConfigurationBaseData** (AiConfigurationBaseData) - Required - The value for the parameter aiConfigurationBaseData

### Returns
- **AiConfigurationCreationResponse** - The created configuration

### Throws
- **com.sap.cloud.sdk.services.openapi.apache.core.OpenApiRequestException** - if an error occurs while attempting to invoke the API
```

--------------------------------

### getAll

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/core/client/RepositoryApi.html

Retrieves a list of all GitOps repositories for a tenant.

```APIDOC
## getAll

### Description
Retrieve a list of all GitOps repositories for a tenant.

### Method
SDK Method

### Parameters
- **authorization** (String) - Optional - Authorization bearer token containing a JWT token.
- **$top** (Integer) - Optional - Number of results to display.
- **$skip** (Integer) - Optional - Number of results to be skipped from the ordered list of results.
- **$count** (Boolean) - Optional - When set to false, the response contains a count of the items present in the response. When set to true, the response contains a count of all the items present on the server.

### Returns
- **BckndArgoCDRepositoryDataResponse** - The list of GitOps repositories.
```

--------------------------------

### Create a Basic Agent

Source: https://sap.github.io/ai-sdk/docs/js/langchain/openai

Initializes an agent using the Azure OpenAI chat client and LangChain's agent framework.

```typescript
import { createAgent } from 'langchain';

import { AzureOpenAiChatClient } from '@sap-ai-sdk/langchain';



const model = new AzureOpenAiChatClient({ modelName: 'gpt-5' });



const agent = createAgent({

  model,

  tools: []

});



const agentInputs = {

  messages: [{ role: 'user', content: 'What is SAP?' }]

};



const result = await agent.invoke(agentInputs);
```

--------------------------------

### LlamaGuard 3 8B Filter Type Example

Source: https://sap.github.io/ai-sdk/api/v2/types/prompt-registry_src.LlamaGuard38BFilterConfig.html

Example value for the filter provider type property.

```json
"llama_guard_3_8b"
```

--------------------------------

### TrckMetricName Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.TrckMetricName.html

Example value for the TrckMetricName type alias, showing the allowed pattern and length constraints.

```text
"Error Rate"  
Max Length: 256.  
Pattern: "[\w-]{1,64}".
```

--------------------------------

### create(BckndArgoCDRepositoryData bckndArgoCDRepositoryData, String authorization)

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/core/client/RepositoryApi.html

On-boards a new GitOps repository to the AI Core service.

```APIDOC
## create

### Description
On-board a new GitOps repository as specified in the content payload.

### Parameters
- **bckndArgoCDRepositoryData** (BckndArgoCDRepositoryData) - Required - The repository data to be on-boarded.
- **authorization** (String) - Optional - Authorization bearer token containing a JWT token.

### Returns
- **BckndArgoCDRepositoryCreationResponse** - The response object containing details of the created repository.

### Errors
- **200** - The repository has been on-boarded
- **409** - The provided repository already exists
- **400** - The request was malformed
- **0** - HTTP status codes 401, 403 or 500
```

--------------------------------

### OpenAiClient.withCustomDestination

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/foundationmodels/openai/OpenAiClient.html

Creates a new OpenAI client with a custom destination.

```APIDOC
## OpenAiClient.withCustomDestination(Destination destination)

### Description
Create a new OpenAI client with a custom destination, allowing for a custom resource group or otherwise custom destination. The destination needs to be configured with a URL pointing to an OpenAI model deployment.

### Parameters
- **destination** (Destination) - Required - The specific HttpDestination to use.

### Returns
- **OpenAiClient** - A new OpenAI client instance.
```

--------------------------------

### Preprocess, embed, and store documents

Source: https://sap.github.io/ai-sdk/docs/js/langchain/openai

Demonstrates the workflow of splitting documents, initializing the embedding client, and creating a vector store for retrieval.

```typescript
// Create a text splitter and split the document

const textSplitter = new RecursiveCharacterTextSplitter({

  chunkSize: 2000,

  chunkOverlap: 200

});

const splits = await textSplitter.splitDocuments(docs);



// Initialize the embedding client

const embeddingClient = new AzureOpenAiEmbeddingClient({

  modelName: 'text-embedding-3-small'

});



// Create a vector store from the document

const vectorStore = await MemoryVectorStore.fromDocuments(

  splits,

  embeddingClient

);



// Create a retriever for the vector store

const retriever = vectorStore.asRetriever();
```

--------------------------------

### Configure OpenAiClient with a custom destination

Source: https://sap.github.io/ai-sdk/java-api/v1/com/sap/ai/sdk/foundationmodels/openai/OpenAiClient.html

Demonstrates how to initialize an OpenAiClient using a specific inference destination retrieved from the AiCoreService.

```java
 var destination = new AiCoreService().getInferenceDestination("custom-rg").forModel(GPT_4O);
 OpenAiClient.withCustomDestination(destination);
```

--------------------------------

### BckndInternalResourceGroupAnnotation Key Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.BckndInternalResourceGroupAnnotation.html

Example of a valid key string for the BckndInternalResourceGroupAnnotation, adhering to the specified pattern and length constraints.

```text
"internal.ai.sap.com/my-annotation"  
Max Length: 63.  
Pattern: "^internal.ai.sap.com/(([A-Za-z0-9][-A-Za-z0-9_.]*)?[A-Za-z0-9]){1,43}$".
```

--------------------------------

### AiScenarioLabelKey Example

Source: https://sap.github.io/ai-sdk/api/v2/types/ai-api_src.AiScenarioLabelKey.html

Example value for the AiScenarioLabelKey type, which must adhere to the specified regex pattern and length constraints.

```text
"scenarios.ai.sap.com/s4hana-version"
```

--------------------------------

### OpenAiClient.withSystemPrompt

Source: https://sap.github.io/ai-sdk/java-api/v1/index-all.html

Adds a system prompt to the OpenAI client configuration.

```APIDOC
## withSystemPrompt(String)

### Description
Add a system prompt before user prompts.

### Parameters
- **prompt** (String) - Required - The system prompt text.
```
Tokens:
Raw