@sap-ai-sdk/prompt-registry 2.3.1-20251222013429.0 → 2.4.0

package/dist/client/prompt-registry/schema/template-ref-by-scenario-name-version.d.ts

@@ -0,0 +1,27 @@
+/**
+ * Representation of the 'TemplateRefByScenarioNameVersion' schema.
+ */
+export type TemplateRefByScenarioNameVersion = {
+    /**
+     * Scenario name
+     * @example "some-scenario"
+     */
+    scenario: string;
+    /**
+     * Name of the template
+     * @example "some-template-name"
+     */
+    name: string;
+    /**
+     * Version of the template
+     * @example "some version, can be `latest`"
+     */
+    version: string;
+    /**
+     * Defines the scope that is searched for the referenced template.  'tenant' indicates the template is shared across all resource groups within the tenant,  while 'resource_group' indicates the template is only accessible within the specific resource group.
+     *
+     * Default: "tenant".
+     */
+    scope?: 'resource_group' | 'tenant';
+};
+//# sourceMappingURL=template-ref-by-scenario-name-version.d.ts.map

package/dist/client/prompt-registry/schema/template-ref-by-scenario-name-version.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-ref-by-scenario-name-version.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template-ref-by-scenario-name-version.ts"],"names":[],"mappings":"AAMA;;GAEG;AACH,MAAM,MAAM,gCAAgC,GAAG;IAC7C;;;OAGG;IACH,QAAQ,EAAE,MAAM,CAAC;IACjB;;;OAGG;IACH,IAAI,EAAE,MAAM,CAAC;IACb;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAChB;;;;OAIG;IACH,KAAK,CAAC,EAAE,gBAAgB,GAAG,QAAQ,CAAC;CACrC,CAAC"}

package/dist/client/prompt-registry/schema/template-ref-by-scenario-name-version.js

@@ -0,0 +1,7 @@
+/*
+ * Copyright (c) 2025 SAP SE or an SAP affiliate company. All rights reserved.
+ *
+ * This is a generated file powered by the SAP Cloud SDK for JavaScript.
+ */
+export {};
+//# sourceMappingURL=template-ref-by-scenario-name-version.js.map

package/dist/client/prompt-registry/schema/template-ref-by-scenario-name-version.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-ref-by-scenario-name-version.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template-ref-by-scenario-name-version.ts"],"names":[],"mappings":"AAAA;;;;GAIG"}

package/dist/client/prompt-registry/schema/template-ref.d.ts

@@ -0,0 +1,12 @@
+import type { TemplateRefByID } from './template-ref-by-id.js';
+import type { TemplateRefByScenarioNameVersion } from './template-ref-by-scenario-name-version.js';
+/**
+ * Representation of the 'TemplateRef' schema.
+ */
+export type TemplateRef = {
+    /**
+     * Reference to a template in the prompt registry by ID or by scenario, name and version
+     */
+    template_ref: TemplateRefByID | TemplateRefByScenarioNameVersion;
+};
+//# sourceMappingURL=template-ref.d.ts.map

package/dist/client/prompt-registry/schema/template-ref.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-ref.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template-ref.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,yBAAyB,CAAC;AAC/D,OAAO,KAAK,EAAE,gCAAgC,EAAE,MAAM,4CAA4C,CAAC;AACnG;;GAEG;AACH,MAAM,MAAM,WAAW,GAAG;IACxB;;OAEG;IACH,YAAY,EAAE,eAAe,GAAG,gCAAgC,CAAC;CAClE,CAAC"}

package/dist/client/prompt-registry/schema/template-ref.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=template-ref.js.map

package/dist/client/prompt-registry/schema/template-ref.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"template-ref.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template-ref.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/template.d.ts

@@ -1,7 +1,40 @@
-import type { SingleChatTemplate } from './single-chat-template.js';
-import type { MultiChatTemplate } from './multi-chat-template.js';
+import type { TemplatingChatMessage } from './templating-chat-message.js';
+import type { ResponseFormatText } from './response-format-text.js';
+import type { ResponseFormatJsonObject } from './response-format-json-object.js';
+import type { ResponseFormatJsonSchema } from './response-format-json-schema.js';
+import type { ChatCompletionTool } from './chat-completion-tool.js';
 /**
  * Representation of the 'Template' schema.
+ * @example {
+ *   "template": [
+ *     {
+ *       "role": "user",
+ *       "content": "How can the features of AI in SAP BTP specifically {{'{{?groundingOutput}}'}}, be applied to {{'{{?inputContext}}'}}"
+ *     }
+ *   ],
+ *   "defaults": {
+ *     "inputContext": "The default text that will be used in the template if inputContext is not set"
+ *   }
+ * }
  */
-export type Template = SingleChatTemplate | MultiChatTemplate;
+export type Template = {
+    /**
+     * A chat message array to be formatted with values from placeholder_values. Both role and content can be templated. If messages_history is provided, the templated messages will be appended.
+     */
+    template: TemplatingChatMessage;
+    /**
+     * Optional default values for the template. If a parameter has no default it is required.
+     */
+    defaults?: Record<string, string>;
+    /**
+     * Response format that the model output should adhere to. This is the same as the OpenAI definition.
+     *
+     */
+    response_format?: ResponseFormatText | ResponseFormatJsonObject | ResponseFormatJsonSchema;
+    /**
+     * A list of tools the model may call. Used to provide a list of functions the model may generate JSON inputs for. This is the same as the OpenAI definition.
+     *
+     */
+    tools?: ChatCompletionTool[];
+};
 //# sourceMappingURL=template.d.ts.map

package/dist/client/prompt-registry/schema/template.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAClE;;GAEG;AACH,MAAM,MAAM,QAAQ,GAAG,kBAAkB,GAAG,iBAAiB,CAAC"}
+{"version":3,"file":"template.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/template.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,KAAK,EAAE,wBAAwB,EAAE,MAAM,kCAAkC,CAAC;AACjF,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE;;;;;;;;;;;;;GAaG;AACH,MAAM,MAAM,QAAQ,GAAG;IACrB;;OAEG;IACH,QAAQ,EAAE,qBAAqB,CAAC;IAChC;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAClC;;;OAGG;IACH,eAAe,CAAC,EACZ,kBAAkB,GAClB,wBAAwB,GACxB,wBAAwB,CAAC;IAC7B;;;OAGG;IACH,KAAK,CAAC,EAAE,kBAAkB,EAAE,CAAC;CAC9B,CAAC"}

package/dist/client/prompt-registry/schema/templating-chat-message.d.ts

@@ -0,0 +1,7 @@
+import type { ChatMessage } from './chat-message.js';
+/**
+ * Representation of the 'TemplatingChatMessage' schema.
+ * Min Items: 1.
+ */
+export type TemplatingChatMessage = ChatMessage[];
+//# sourceMappingURL=templating-chat-message.d.ts.map

package/dist/client/prompt-registry/schema/templating-chat-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"templating-chat-message.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/templating-chat-message.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AACrD;;;GAGG;AACH,MAAM,MAAM,qBAAqB,GAAG,WAAW,EAAE,CAAC"}

package/dist/client/prompt-registry/schema/templating-chat-message.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=templating-chat-message.js.map

package/dist/client/prompt-registry/schema/templating-chat-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"templating-chat-message.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/templating-chat-message.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/tool-chat-message.d.ts

@@ -0,0 +1,13 @@
+import type { ChatMessageContent } from './chat-message-content.js';
+/**
+ * Representation of the 'ToolChatMessage' schema.
+ */
+export type ToolChatMessage = {
+    /**
+     * @example "tool"
+     */
+    role: 'tool';
+    tool_call_id: string;
+    content: ChatMessageContent;
+};
+//# sourceMappingURL=tool-chat-message.d.ts.map

package/dist/client/prompt-registry/schema/tool-chat-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-chat-message.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/tool-chat-message.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AACpE;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IACb,YAAY,EAAE,MAAM,CAAC;IACrB,OAAO,EAAE,kBAAkB,CAAC;CAC7B,CAAC"}

package/dist/client/prompt-registry/schema/tool-chat-message.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=tool-chat-message.js.map

package/dist/client/prompt-registry/schema/tool-chat-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tool-chat-message.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/tool-chat-message.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/translation-module-config.d.ts

@@ -0,0 +1,16 @@
+import type { SAPDocumentTranslationInput } from './sap-document-translation-input.js';
+import type { SAPDocumentTranslationOutput } from './sap-document-translation-output.js';
+/**
+ * Configuration for translation module
+ */
+export type TranslationModuleConfig = {
+    /**
+     * Configuration for input translation
+     */
+    input?: SAPDocumentTranslationInput;
+    /**
+     * Configuration for output translation
+     */
+    output?: SAPDocumentTranslationOutput;
+};
+//# sourceMappingURL=translation-module-config.d.ts.map

package/dist/client/prompt-registry/schema/translation-module-config.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation-module-config.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/translation-module-config.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,2BAA2B,EAAE,MAAM,qCAAqC,CAAC;AACvF,OAAO,KAAK,EAAE,4BAA4B,EAAE,MAAM,sCAAsC,CAAC;AACzF;;GAEG;AACH,MAAM,MAAM,uBAAuB,GAAG;IACpC;;OAEG;IACH,KAAK,CAAC,EAAE,2BAA2B,CAAC;IACpC;;OAEG;IACH,MAAM,CAAC,EAAE,4BAA4B,CAAC;CACvC,CAAC"}

package/dist/client/prompt-registry/schema/translation-module-config.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=translation-module-config.js.map

package/dist/client/prompt-registry/schema/translation-module-config.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"translation-module-config.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/translation-module-config.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/user-chat-message-content-item.d.ts

@@ -0,0 +1,10 @@
+import type { ImageContentUrl } from './image-content-url.js';
+/**
+ * Representation of the 'UserChatMessageContentItem' schema.
+ */
+export type UserChatMessageContentItem = {
+    type: 'text' | 'image_url';
+    text?: string;
+    image_url?: ImageContentUrl;
+};
+//# sourceMappingURL=user-chat-message-content-item.d.ts.map

package/dist/client/prompt-registry/schema/user-chat-message-content-item.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message-content-item.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message-content-item.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAC;AAC9D;;GAEG;AACH,MAAM,MAAM,0BAA0B,GAAG;IACvC,IAAI,EAAE,MAAM,GAAG,WAAW,CAAC;IAC3B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,CAAC,EAAE,eAAe,CAAC;CAC7B,CAAC"}

package/dist/client/prompt-registry/schema/user-chat-message-content-item.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-chat-message-content-item.js.map

package/dist/client/prompt-registry/schema/user-chat-message-content-item.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message-content-item.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message-content-item.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/user-chat-message-content.d.ts

@@ -0,0 +1,6 @@
+import type { UserChatMessageContentItem } from './user-chat-message-content-item.js';
+/**
+ * Representation of the 'UserChatMessageContent' schema.
+ */
+export type UserChatMessageContent = string | UserChatMessageContentItem[];
+//# sourceMappingURL=user-chat-message-content.d.ts.map

package/dist/client/prompt-registry/schema/user-chat-message-content.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message-content.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message-content.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,qCAAqC,CAAC;AACtF;;GAEG;AACH,MAAM,MAAM,sBAAsB,GAAG,MAAM,GAAG,0BAA0B,EAAE,CAAC"}

package/dist/client/prompt-registry/schema/user-chat-message-content.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-chat-message-content.js.map

package/dist/client/prompt-registry/schema/user-chat-message-content.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message-content.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message-content.ts"],"names":[],"mappings":""}

package/dist/client/prompt-registry/schema/user-chat-message.d.ts

@@ -0,0 +1,9 @@
+import type { UserChatMessageContent } from './user-chat-message-content.js';
+/**
+ * Representation of the 'UserChatMessage' schema.
+ */
+export type UserChatMessage = {
+    content: UserChatMessageContent;
+    role: 'user';
+};
+//# sourceMappingURL=user-chat-message.d.ts.map

package/dist/client/prompt-registry/schema/user-chat-message.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message.d.ts","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,sBAAsB,EAAE,MAAM,gCAAgC,CAAC;AAC7E;;GAEG;AACH,MAAM,MAAM,eAAe,GAAG;IAC5B,OAAO,EAAE,sBAAsB,CAAC;IAChC,IAAI,EAAE,MAAM,CAAC;CACd,CAAC"}

package/dist/client/prompt-registry/schema/user-chat-message.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=user-chat-message.js.map

package/dist/client/prompt-registry/schema/user-chat-message.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"user-chat-message.js","sourceRoot":"","sources":["../../../../src/client/prompt-registry/schema/user-chat-message.ts"],"names":[],"mappings":""}