@sap-ai-sdk/orchestration 1.8.1-20250217013122.0 → 1.8.1-20250218013110.0

package/README.md

@@ -109,7 +109,6 @@ Optionally, define `model_version` (default: `latest`) and `model_params` for cu
 
 Use the orchestration client with templating to pass a prompt containing placeholders that will be replaced with input parameters during a chat completion request.
 This allows for variations in the prompt based on the input parameters.
-Set custom request configuration when calling `chatCompletion` function.
 
 ```ts
 import { OrchestrationClient } from '@sap-ai-sdk/orchestration';
@@ -131,26 +130,68 @@ const response = await orchestrationClient.chatCompletion({
 });
 
 const responseContent = response.getContent();
+const finishReason = response.getFinishReason();
+const tokenUsage = response.getTokenUsage();
 ```
 
-`getContent()` is a convenience method that parses the response and returns the model's output as a string.
+You can use the following convenience methods for handling chat completion responses:
+
+- `getContent()` parses the response and returns the model's output as a string.
+- `getFinishReason()` retrieves the `finish_reason` explaining why chat completion request stopped.
+- `getTokenUsage()` provides token usage details, including `total_tokens`, `prompt_tokens`, and `completion_tokens`.
+
+#### Structured Outputs
+
+Setting `response_format` under `templating` guarantees that the model's output aligns with the schema type specified by developers.
+It is useful when the model is not calling a tool, but rather, responding to the user in a structured way.
 
-To retrieve the `finish_reason` for stopping the chat completion request, use the convenience method `getFinishReason()`:
+The example below demonstrates how to use `response_format` to return a JSON Schema, with `strict: true` ensuring the outputs conform precisely to the schema.
 
 ```ts
-const finishReason = response.getFinishReason();
+templating: {
+    template: [
+      { role: 'user', content: 'What is the capital of {{?country}}?' }
+    ],
+    response_format: {
+        type: 'json_schema',
+        json_schema: {
+          name: 'capital_response',
+          strict: true,
+          schema: {
+            type: 'object',
+            properties: {
+              country_name: {
+                type: "string",
+                description: "The name of the country provided by the user."
+              },
+              capital: {
+                type: "string",
+                description: "The capital city of the country."
+              }
+            },
+            required: ["country_name", "capital"]
+          }
+        }
+      }
+  }
 ```
 
-Use the `getTokenUsage()` convenience method to retrieve the token usage details of the chat completion request:
+You can also initialize `json_schema` using a Zod schema, as shown below:
 
 ```ts
-const tokenUsage = response.getTokenUsage();
-
-console.log(
-  `Total tokens consumed by the request: ${tokenUsage.total_tokens}\n` +
-    `Input prompt tokens consumed: ${tokenUsage.prompt_tokens}\n` +
-    `Output text completion tokens consumed: ${tokenUsage.completion_tokens}\n`
-);
+const countryCapitalSchema = z.object({
+    country_name: z.string(),
+    capital: z.string()
+  }).strict();
+
+response_format: {
+  type: 'json_schema',
+  json_schema: {
+    name: 'capital_response',
+    strict: true,
+    schema: zodToJsonSchema(countryCapitalSchema)
+  }
+}
 ```
 
 ### Prompt Registry

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@sap-ai-sdk/orchestration",
-  "version": "1.8.1-20250217013122.0",
+  "version": "1.8.1-20250218013110.0",
   "description": "",
   "license": "Apache-2.0",
   "keywords": [
@@ -21,8 +21,8 @@
   ],
   "dependencies": {
     "@sap-cloud-sdk/util": "^3.26.0",
-    "@sap-ai-sdk/core": "^1.8.1-20250217013122.0",
-    "@sap-ai-sdk/ai-api": "^1.8.1-20250217013122.0"
+    "@sap-ai-sdk/core": "^1.8.1-20250218013110.0",
+    "@sap-ai-sdk/ai-api": "^1.8.1-20250218013110.0"
   },
   "devDependencies": {
     "@sap-cloud-sdk/http-client": "^3.26.0",