chore: Create sample CAP app

.changeset/sweet-lies-confess.md

@@ -0,0 +1,5 @@
+---
+'@sap-ai-sdk/sample-cap': patch
+---
+
+[New Functionality] Introduce a new sample application based on SAP CAP framework.

package.json

@@ -28,6 +28,8 @@
  "type-tests": "pnpm -F=@sap-ai-sdk/type-tests",
  "smoke-tests": "pnpm -F=@sap-ai-sdk/smoke-tests",
  "schema-tests": "pnpm -F=@sap-ai-sdk/schema-tests",
+ "sample-code": "pnpm -F=@sap-ai-sdk/sample-code",
+ "sample-cap": "pnpm -F=@sap-ai-sdk/sample-cap",
  "check:public-api": "pnpm -r check:public-api",
  "check:deps": "pnpm -r -F !./tests/smoke-tests -F !./tests/schema-tests exec depcheck --ignores=\"nock,@jest/globals\" --quiet"
  },
@@ -44,6 +46,8 @@
  "@sap-cloud-sdk/http-client": "^3.21.0",
  "@sap-cloud-sdk/openapi-generator": "^3.21.0",
  "@sap-cloud-sdk/util": "^3.21.0",
+ "@cap-js/cds-types": "^0.6",
+ "tsx": "^4.19.1",
  "@types/jest": "^29.5.13",
  "@types/jsonwebtoken": "^9.0.7",
  "@types/mock-fs": "^4.13.4",

pnpm-workspace.yaml

@@ -1,12 +1,12 @@
 packages:
- # all packages in direct subdirs of packages/
  - 'packages/ai-api'
- - 'packages/foundation-models'
- - 'packages/orchestration'
  - 'packages/core'
+ - 'packages/foundation-models'
  - 'packages/langchain'
+ - 'packages/orchestration'
+ - 'sample-cap'
  - 'sample-code'
  - 'tests/e2e-tests'
- - 'tests/type-tests'
- - 'tests/smoke-tests'
  - 'tests/schema-tests'
+ - 'tests/smoke-tests'
+ - 'tests/type-tests'

sample-cap/.gitignore

@@ -0,0 +1,36 @@
+# CAP
+_out
+*.db
+*.sqlite
+connection.properties
+default-*.json
+.cdsrc-private.json
+gen/
+node_modules/
+target/
+
+# Web IDE, App Studio
+.che/
+.gen/
+
+# MTA
+*_mta_build_tmp
+*.mtar
+mta_archives/
+
+# Other
+.DS_Store
+*.orig
+*.log
+
+*.iml
+*.flattened-pom.xml
+
+# IDEs
+.vscode
+.idea
+
+# @cap-js/cds-typer
+@cds-models
+
+.cdsrc-private.json

sample-cap/README.md

@@ -0,0 +1,85 @@
+# Sample CAP Application with SAP Cloud SDK for AI
+
+Sample CAP application written in TypeScript to demonstrate the usage of SAP Cloud SDK for AI.
+
+### Table of Contents
+
+- [Local Deployment](#local-deployment)
+- [Usage](#usage)
+ - [`ai-api`](#ai-api)
+ - [Deployment API](#deployment-api)
+ - [`foundation-models`](#foundation-models)
+ - [Azure OpenAI Chat Completion](#azure-openai-chat-completion)
+ - [`orchestration`](#orchestration)
+ - [Chat Completions with Templating](#chat-completions-with-templating)
+
+## Local Deployment
+
+1. Build the application with `pnpm install`.
+
+2. Login using `cf login -a API_ENDPOINT -o ORG -s SPACE`.
+
+3. Bind the application to your AI Core instance:
+
+ ```bash
+ cds bind -2 AI_CORE_INSTANCE_NAME
+ ```
+
+4. Run the application with the binding:
+
+ ```bash
+ pnpm watch:hybrid
+ ```
+
+## Usage
+
+### `ai-api`
+
+#### Deployment API
+
+```bash
+curl --request GET \
+ --url 'http://localhost:4004/odata/v4/ai-api/getDeployments'
+```
+
+### `foundation-models`
+
+#### Azure OpenAI Chat Completion
+
+```bash
+curl --request POST \
+ --url 'http://localhost:4004/odata/v4/azure-openai/chatCompletion' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "messages": [
+ {
+ "role": "user",
+ "content": "Hello, how are you?"
+ }
+ ]
+}'
+```
+
+### `orchestration`
+
+#### Chat Completions with Templating
+
+```bash
+curl --request POST \
+ --url 'http://localhost:4004/odata/v4/orchestration/chatCompletion' \
+ --header 'Content-Type: application/json' \
+ --data '{
+ "template": [
+ {
+ "role": "user",
+ "content": "What is the capital of {{?country}}"
+ }
+ ],
+ "inputParams": [
+ {
+ "name": "country",
+ "value": "France"
+ }
+ ]
+}'
+```

sample-cap/eslint.config.mjs

@@ -0,0 +1,2 @@
+import cds from '@sap/cds/eslint.config.mjs';
+export default [...cds.recommended];

sample-cap/jsconfig.json

@@ -0,0 +1,8 @@
+{
+ "compilerOptions": {
+ "moduleResolution": "nodenext",
+ "paths": {
+ "#cds-models/*": ["./@cds-models/*"]
+ }
+ }
+}

sample-cap/package.json

@@ -0,0 +1,25 @@
+{
+ "type": "module",
+ "name": "@sap-ai-sdk/sample-cap",
+ "version": "1.0.0",
+ "description": "Sample CAP application with Cloud SDK for AI.",
+ "repository": "https://github.com/sap/ai-sdk-js",
+ "license": "UNLICENSED",
+ "private": true,
+ "dependencies": {
+ "@sap/cds": "^8",
+ "express": "^4",
+ "@sap-ai-sdk/ai-api": "workspace:^",
+ "@sap-ai-sdk/foundation-models": "workspace:^",
+ "@sap-ai-sdk/orchestration": "workspace:^"
+ },
+ "scripts": {
+ "watch": "cds-tsx watch",
+ "watch:hybrid": "cds-tsx watch --profile hybrid",
+ "lint": "eslint . && prettier . --config ../.prettierrc --ignore-path ../.prettierignore -c",
+ "lint:fix": "eslint . --fix && prettier . --config ../.prettierrc --ignore-path ../.prettierignore -w --log-level error"
+ },
+ "imports": {
+ "#cds-models/*": "./@cds-models/*/index.js"
+ }
+}

sample-cap/srv/ai-api/ai-api-service.cds

@@ -0,0 +1,5 @@
+@path: 'ai-api'
+service AiApiService {
+ // Technically, it should return an array of AiDeployment entity if we define it in the model.
+ action getDeployments() returns array of String;
+}

sample-cap/srv/ai-api/ai-api-service.ts

@@ -0,0 +1,11 @@
+import { DeploymentApi } from '@sap-ai-sdk/ai-api';
+
+export default class AiApiService {
+ async getDeployments() {
+ const response = await DeploymentApi.deploymentQuery(
+ {},
+ { 'AI-Resource-Group': 'default' }
+ ).execute();
+ return response.resources;
+ }
+}

sample-cap/srv/foundation-models/azure-openai-service.cds

@@ -0,0 +1,9 @@
+@path: 'azure-openai'
+service AzureOpenAiService {
+ action chatCompletion(messages : array of Message) returns String;
+}
+
+type Message {
+ role : String;
+ content : String;
+}

sample-cap/srv/foundation-models/azure-openai-service.ts

@@ -0,0 +1,12 @@
+import { Request } from '@sap/cds';
+import { AzureOpenAiChatClient } from '@sap-ai-sdk/foundation-models';
+
+export default class AzureOpenAiService {
+ async chatCompletion(req: Request) {
+ const { messages } = req.data;
+ const response = await new AzureOpenAiChatClient('gpt-35-turbo').run({
+ messages
+ });
+ return response.getContent();
+ }
+}

sample-cap/srv/index.cds

@@ -0,0 +1,3 @@
+using from './foundation-models/azure-openai-service';
+using from './ai-api/ai-api-service';
+using from './orchestration/orchestration-service';

sample-cap/srv/orchestration/orchestration-service.cds

@@ -0,0 +1,14 @@
+@path: 'orchestration'
+service OrchestrationService {
+ action chatCompletion(template : array of Template, inputParams : array of InputParam) returns String;
+}
+
+type Template {
+ role : String;
+ content : String;
+}
+
+type InputParam {
+ name : String;
+ value : String;
+}

sample-cap/srv/orchestration/orchestration-service.ts

@@ -0,0 +1,51 @@
+import { Request } from '@sap/cds';
+import { OrchestrationClient } from '@sap-ai-sdk/orchestration';
+
+export default class OrchestrationService {
+ async chatCompletion(req: Request) {
+ const { template, inputParams } = req.data;
+ const llm = {
+ model_name: 'gpt-4-32k',
+ model_params: {}
+ };
+ const templating = { template };
+
+ const response = await new OrchestrationClient({
+ llm,
+ templating
+ }).chatCompletion({
+ inputParams: mapInputParams(inputParams)
+ });
+
+ return response.getContent();
+ }
+}
+
+/**
+ * Map input parameters since CAP does not support dynamic object keys.
+ *
+ * For example:
+ *
+ * ```ts
+ * inputParams: [{
+ * name: 'param1',
+ * value: 'value1'
+ * }]
+ * ```
+ * =>
+ * ```ts
+ * mappedInputParams: {
+ * param1: 'value1'
+ * }
+ * ```
+ * @param inputParams - Array of `InputParam` entity.
+ * @returns Mapped input parameters for AI Core.
+ */
+function mapInputParams(
+ inputParams: { name: string; value: string }[]
+): Record<string, string> {
+ return inputParams.reduce(
+ (acc, { name, value }) => ({ ...acc, [name]: value }),
+ {} as Record<string, string>
+ );
+}