@sap-ai-sdk/prompt-registry 1.11.1-20250414013204.0 → 1.11.1-20250415115505.0

package/README.md

@@ -7,12 +7,7 @@ This package incorporates generative AI prompt registry capabilities into your A
 ### Table of Contents
 
 - [Installation](#installation)
-- [Prerequisites](#prerequisites)
-- [Usage](#usage)
-  - [List Prompt Templates](#list-prompt-templates)
-  - [Custom Destination](#custom-destination)
-- [Error Handling](#error-handling)
-- [Local Testing](#local-testing)
+- [Documentation](#documentation)
 - [Support, Feedback, Contribution](#support-feedback-contribution)
 - [License](#license)
 
@@ -22,54 +17,9 @@ This package incorporates generative AI prompt registry capabilities into your A
 $ npm install @sap-ai-sdk/prompt-registry
 ```
 
-## Prerequisites
+## Documentation
 
-- [Enable the AI Core service in SAP BTP](https://help.sap.com/docs/sap-ai-core/sap-ai-core-service-guide/initial-setup).
-- Configure the project with **Node.js v20 or higher** and **native ESM** support.
-
-> **Accessing the AI Core Service via the SDK**
->
-> The SDK automatically retrieves the `AI Core` service credentials and resolves the access token needed for authentication.
->
-> - In Cloud Foundry, it's accessed from the `VCAP_SERVICES` environment variable.
-> - In Kubernetes / Kyma environments, you have to mount the service binding as a secret instead, for more information refer to [this documentation](https://www.npmjs.com/package/@sap/xsenv#usage-in-kubernetes).
-
-## Usage
-
-The example below demonstrate a sample usage of APIs in SAP AI Core prompt registry service.
-
-In addition, you can find more **sample code** [here](https://github.com/SAP/ai-sdk-js/blob/main/sample-code/src/prompt-registry.ts).
-
-### List Prompt Templates
-
-```ts
-const response: PromptTemplateListResponse =
-  await PromptTemplatesApi.listPromptTemplates({
-    scenario: 'test'
-  }).execute();
-```
-
-### Custom Destination
-
-When calling the `execute()` method, it is possible to provide a custom destination.
-For example, when querying deployments targeting a destination with the name `my-destination`, the following code can be used:
-
-```ts
-const response: PromptTemplateListResponse =
-  await PromptTemplatesApi.listPromptTemplates({
-    scenario: 'test'
-  }).execute({
-    destinationName: 'my-destination'
-  });
-```
-
-## Error Handling
-
-For error handling instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#error-handling).
-
-## Local Testing
-
-For local testing instructions, refer to this [section](https://github.com/SAP/ai-sdk-js/blob/main/README.md#local-testing).
+Visit the [SAP Cloud SDK for AI (JavaScript)](https://sap.github.io/ai-sdk/docs/js/overview-cloud-sdk-for-ai-js) documentation portal to learn more about its capabilities and detailed usage.
 
 ## Support, Feedback, Contribution
 

package/dist/index.d.ts

@@ -1,2 +1,3 @@
 export * from './client/prompt-registry/index.js';
+export { promptTemplatePostRequestSchema } from './zod/prompt-template-post-request.zod.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC;AAElD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC"}

package/dist/index.js

@@ -1,2 +1,4 @@
 export * from './client/prompt-registry/index.js';
+// eslint-disable-next-line import/no-internal-modules
+export { promptTemplatePostRequestSchema } from './zod/prompt-template-post-request.zod.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,mCAAmC,CAAC;AAClD,sDAAsD;AACtD,OAAO,EAAE,+BAA+B,EAAE,MAAM,2CAA2C,CAAC"}

package/dist/zod/chat-completion-tool.zod.d.ts

@@ -0,0 +1,40 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const chatCompletionToolSchema: z.ZodObject<{
+    type: z.ZodLiteral<"function">;
+    function: z.ZodObject<{
+        description: z.ZodOptional<z.ZodString>;
+        name: z.ZodString;
+        parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+        strict: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+    }, "strip", z.ZodTypeAny, {
+        name: string;
+        description?: string | undefined;
+        strict?: boolean | null | undefined;
+        parameters?: Record<string, any> | undefined;
+    }, {
+        name: string;
+        description?: string | undefined;
+        strict?: boolean | null | undefined;
+        parameters?: Record<string, any> | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    function: {
+        name: string;
+        description?: string | undefined;
+        strict?: boolean | null | undefined;
+        parameters?: Record<string, any> | undefined;
+    };
+    type: "function";
+}, {
+    function: {
+        name: string;
+        description?: string | undefined;
+        strict?: boolean | null | undefined;
+        parameters?: Record<string, any> | undefined;
+    };
+    type: "function";
+}>;
+//# sourceMappingURL=chat-completion-tool.zod.d.ts.map

package/dist/zod/chat-completion-tool.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-completion-tool.zod.d.ts","sourceRoot":"","sources":["../../src/zod/chat-completion-tool.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;IAEI;AACJ,eAAO,MAAM,wBAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGnC,CAAC"}

package/dist/zod/chat-completion-tool.zod.js

@@ -0,0 +1,11 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+import { functionObjectSchema } from './function-object.zod.js';
+/**
+ * @internal
+ **/
+export const chatCompletionToolSchema = z.object({
+    type: z.literal('function'),
+    function: functionObjectSchema
+});
+//# sourceMappingURL=chat-completion-tool.zod.js.map

package/dist/zod/chat-completion-tool.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat-completion-tool.zod.js","sourceRoot":"","sources":["../../src/zod/chat-completion-tool.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,oBAAoB,EAAE,MAAM,0BAA0B,CAAC;AAEhE;;IAEI;AACJ,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,UAAU,CAAC;IAC3B,QAAQ,EAAE,oBAAoB;CAC/B,CAAC,CAAC"}

package/dist/zod/function-object.zod.d.ts

@@ -0,0 +1,21 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const functionObjectSchema: z.ZodObject<{
+    description: z.ZodOptional<z.ZodString>;
+    name: z.ZodString;
+    parameters: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodAny>>;
+    strict: z.ZodNullable<z.ZodOptional<z.ZodBoolean>>;
+}, "strip", z.ZodTypeAny, {
+    name: string;
+    description?: string | undefined;
+    strict?: boolean | null | undefined;
+    parameters?: Record<string, any> | undefined;
+}, {
+    name: string;
+    description?: string | undefined;
+    strict?: boolean | null | undefined;
+    parameters?: Record<string, any> | undefined;
+}>;
+//# sourceMappingURL=function-object.zod.d.ts.map

package/dist/zod/function-object.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-object.zod.d.ts","sourceRoot":"","sources":["../../src/zod/function-object.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;IAEI;AACJ,eAAO,MAAM,oBAAoB;;;;;;;;;;;;;;;EAK/B,CAAC"}

package/dist/zod/function-object.zod.js

@@ -0,0 +1,13 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+import { functionParametersSchema } from './function-parameters.zod.js';
+/**
+ * @internal
+ **/
+export const functionObjectSchema = z.object({
+    description: z.string().optional(),
+    name: z.string(),
+    parameters: functionParametersSchema.optional(),
+    strict: z.boolean().optional().nullable()
+});
+//# sourceMappingURL=function-object.zod.js.map

package/dist/zod/function-object.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-object.zod.js","sourceRoot":"","sources":["../../src/zod/function-object.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,wBAAwB,EAAE,MAAM,8BAA8B,CAAC;AAExE;;IAEI;AACJ,MAAM,CAAC,MAAM,oBAAoB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC3C,WAAW,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;IAClC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,UAAU,EAAE,wBAAwB,CAAC,QAAQ,EAAE;IAC/C,MAAM,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE;CAC1C,CAAC,CAAC"}

package/dist/zod/function-parameters.zod.d.ts

@@ -0,0 +1,6 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const functionParametersSchema: z.ZodRecord<z.ZodString, z.ZodAny>;
+//# sourceMappingURL=function-parameters.zod.d.ts.map

package/dist/zod/function-parameters.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-parameters.zod.d.ts","sourceRoot":"","sources":["../../src/zod/function-parameters.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;IAEI;AACJ,eAAO,MAAM,wBAAwB,oCAAoB,CAAC"}

package/dist/zod/function-parameters.zod.js

@@ -0,0 +1,7 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export const functionParametersSchema = z.record(z.any());
+//# sourceMappingURL=function-parameters.zod.js.map

package/dist/zod/function-parameters.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"function-parameters.zod.js","sourceRoot":"","sources":["../../src/zod/function-parameters.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;IAEI;AACJ,MAAM,CAAC,MAAM,wBAAwB,GAAG,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC"}

package/dist/zod/image-content.zod.d.ts

@@ -0,0 +1,30 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const imageContentSchema: z.ZodIntersection<z.ZodObject<{
+    type: z.ZodLiteral<"image_url">;
+    image_url: z.ZodObject<{
+        url: z.ZodString;
+        detail: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        detail?: string | undefined;
+    }, {
+        url: string;
+        detail?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    image_url: {
+        url: string;
+        detail?: string | undefined;
+    };
+    type: "image_url";
+}, {
+    image_url: {
+        url: string;
+        detail?: string | undefined;
+    };
+    type: "image_url";
+}>, z.ZodRecord<z.ZodString, z.ZodAny>>;
+//# sourceMappingURL=image-content.zod.d.ts.map

package/dist/zod/image-content.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-content.zod.d.ts","sourceRoot":"","sources":["../../src/zod/image-content.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;IAEI;AACJ,eAAO,MAAM,kBAAkB;;;;;;;;;;;;;;;;;;;;;;;;uCAQN,CAAC"}

package/dist/zod/image-content.zod.js

@@ -0,0 +1,15 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export const imageContentSchema = z
+    .object({
+    type: z.literal('image_url'),
+    image_url: z.object({
+        url: z.string(),
+        detail: z.string().optional()
+    })
+})
+    .and(z.record(z.any()));
+//# sourceMappingURL=image-content.zod.js.map

package/dist/zod/image-content.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"image-content.zod.js","sourceRoot":"","sources":["../../src/zod/image-content.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB;;IAEI;AACJ,MAAM,CAAC,MAAM,kBAAkB,GAAG,CAAC;KAChC,MAAM,CAAC;IACN,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,WAAW,CAAC;IAC5B,SAAS,EAAE,CAAC,CAAC,MAAM,CAAC;QAClB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE;QACf,MAAM,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE;KAC9B,CAAC;CACH,CAAC;KACD,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC"}

package/dist/zod/multi-chat-content.zod.d.ts

@@ -0,0 +1,39 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const multiChatContentSchema: z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+    type: z.ZodLiteral<"image_url">;
+    image_url: z.ZodObject<{
+        url: z.ZodString;
+        detail: z.ZodOptional<z.ZodString>;
+    }, "strip", z.ZodTypeAny, {
+        url: string;
+        detail?: string | undefined;
+    }, {
+        url: string;
+        detail?: string | undefined;
+    }>;
+}, "strip", z.ZodTypeAny, {
+    image_url: {
+        url: string;
+        detail?: string | undefined;
+    };
+    type: "image_url";
+}, {
+    image_url: {
+        url: string;
+        detail?: string | undefined;
+    };
+    type: "image_url";
+}>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodObject<{
+    type: z.ZodLiteral<"text">;
+    text: z.ZodString;
+}, "strip", z.ZodTypeAny, {
+    text: string;
+    type: "text";
+}, {
+    text: string;
+    type: "text";
+}>]>;
+//# sourceMappingURL=multi-chat-content.zod.d.ts.map

package/dist/zod/multi-chat-content.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-chat-content.zod.d.ts","sourceRoot":"","sources":["../../src/zod/multi-chat-content.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAIxB;;IAEI;AACJ,eAAO,MAAM,sBAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAGjC,CAAC"}

package/dist/zod/multi-chat-content.zod.js

@@ -0,0 +1,12 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+import { imageContentSchema } from './image-content.zod.js';
+import { textContentSchema } from './text-content.zod.js';
+/**
+ * @internal
+ **/
+export const multiChatContentSchema = z.union([
+    imageContentSchema,
+    textContentSchema
+]);
+//# sourceMappingURL=multi-chat-content.zod.js.map

package/dist/zod/multi-chat-content.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-chat-content.zod.js","sourceRoot":"","sources":["../../src/zod/multi-chat-content.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,kBAAkB,EAAE,MAAM,wBAAwB,CAAC;AAC5D,OAAO,EAAE,iBAAiB,EAAE,MAAM,uBAAuB,CAAC;AAE1D;;IAEI;AACJ,MAAM,CAAC,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC;IAC5C,kBAAkB;IAClB,iBAAiB;CAClB,CAAC,CAAC"}

package/dist/zod/multi-chat-template.zod.d.ts

@@ -0,0 +1,66 @@
+import { z } from 'zod';
+/**
+ * @internal
+ **/
+export declare const multiChatTemplateSchema: z.ZodObject<{
+    role: z.ZodString;
+    content: z.ZodArray<z.ZodUnion<[z.ZodIntersection<z.ZodObject<{
+        type: z.ZodLiteral<"image_url">;
+        image_url: z.ZodObject<{
+            url: z.ZodString;
+            detail: z.ZodOptional<z.ZodString>;
+        }, "strip", z.ZodTypeAny, {
+            url: string;
+            detail?: string | undefined;
+        }, {
+            url: string;
+            detail?: string | undefined;
+        }>;
+    }, "strip", z.ZodTypeAny, {
+        image_url: {
+            url: string;
+            detail?: string | undefined;
+        };
+        type: "image_url";
+    }, {
+        image_url: {
+            url: string;
+            detail?: string | undefined;
+        };
+        type: "image_url";
+    }>, z.ZodRecord<z.ZodString, z.ZodAny>>, z.ZodObject<{
+        type: z.ZodLiteral<"text">;
+        text: z.ZodString;
+    }, "strip", z.ZodTypeAny, {
+        text: string;
+        type: "text";
+    }, {
+        text: string;
+        type: "text";
+    }>]>, "many">;
+}, "strip", z.ZodTypeAny, {
+    role: string;
+    content: ({
+        text: string;
+        type: "text";
+    } | ({
+        image_url: {
+            url: string;
+            detail?: string | undefined;
+        };
+        type: "image_url";
+    } & Record<string, any>))[];
+}, {
+    role: string;
+    content: ({
+        text: string;
+        type: "text";
+    } | ({
+        image_url: {
+            url: string;
+            detail?: string | undefined;
+        };
+        type: "image_url";
+    } & Record<string, any>))[];
+}>;
+//# sourceMappingURL=multi-chat-template.zod.d.ts.map

package/dist/zod/multi-chat-template.zod.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-chat-template.zod.d.ts","sourceRoot":"","sources":["../../src/zod/multi-chat-template.zod.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAGxB;;IAEI;AACJ,eAAO,MAAM,uBAAuB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAGlC,CAAC"}

package/dist/zod/multi-chat-template.zod.js

@@ -0,0 +1,11 @@
+// Generated by ts-to-zod
+import { z } from 'zod';
+import { multiChatContentSchema } from './multi-chat-content.zod.js';
+/**
+ * @internal
+ **/
+export const multiChatTemplateSchema = z.object({
+    role: z.string(),
+    content: z.array(multiChatContentSchema)
+});
+//# sourceMappingURL=multi-chat-template.zod.js.map

package/dist/zod/multi-chat-template.zod.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"multi-chat-template.zod.js","sourceRoot":"","sources":["../../src/zod/multi-chat-template.zod.ts"],"names":[],"mappings":"AAAA,yBAAyB;AACzB,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EAAE,sBAAsB,EAAE,MAAM,6BAA6B,CAAC;AAErE;;IAEI;AACJ,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC9C,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE;IAChB,OAAO,EAAE,CAAC,CAAC,KAAK,CAAC,sBAAsB,CAAC;CACzC,CAAC,CAAC"}