Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type AzureContentSafetyInput = {
sexual?: AzureThreshold;
violence?: AzureThreshold;
/**
* A flag to use prompt shield
* Filter prompts for harmful content such as jailbreaks and prompt injections.
*/
prompt_shield?: boolean;
};
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,8 @@ export type AzureContentSafetyOutput = {
self_harm?: AzureThreshold;
sexual?: AzureThreshold;
violence?: AzureThreshold;
/**
* Detect protected code content from known GitHub repositories. The scan includes software libraries, source code, algorithms, and other proprietary programming content.
*/
protected_material_code?: boolean;
};
Original file line number Diff line number Diff line change
Expand Up @@ -3,22 +3,13 @@
*
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/
import type { OrchestrationConfig } from './orchestration-config.js';
import type { ChatMessages } from './chat-messages.js';
import type { CompletionRequestConfiguration } from './completion-request-configuration.js';
import type { CompletionRequestConfigurationReferenceById } from './completion-request-configuration-reference-by-id.js';
import type { CompletionRequestConfigurationReferenceByNameScenarioVersion } from './completion-request-configuration-reference-by-name-scenario-version.js';
/**
* Representation of the 'CompletionPostRequest' schema.
*/
export type CompletionPostRequest = {
config: OrchestrationConfig;
/**
* @example {
* "groundingInput": "What is SAP Joule?",
* "inputContext": "optimizing supply chain management"
* }
*/
placeholder_values?: Record<string, string>;
/**
* History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message
*/
messages_history?: ChatMessages;
};
export type CompletionPostRequest =
| CompletionRequestConfiguration
| CompletionRequestConfigurationReferenceById
| CompletionRequestConfigurationReferenceByNameScenarioVersion;
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/
import type { ModuleResultsStreaming } from './module-results-streaming.js';
import type { LLMModuleResultStreaming } from './llm-module-result-streaming.js';
import type { ErrorStreaming } from './error-streaming.js';
/**
* Representation of the 'CompletionPostResponseStreaming' schema.
*/
Expand All @@ -15,4 +16,8 @@ export type CompletionPostResponseStreaming = {
request_id: string;
intermediate_results?: ModuleResultsStreaming;
final_result?: LLMModuleResultStreaming;
/**
* List of errors encountered during processing for unsuccessful modules configurations
*/
intermediate_failures?: ErrorStreaming[];
} & Record<string, any>;
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
*/
import type { ModuleResults } from './module-results.js';
import type { LlmModuleResult } from './llm-module-result.js';
import type { Error } from './error.js';
/**
* Representation of the 'CompletionPostResponse' schema.
*/
Expand All @@ -16,4 +17,8 @@ export type CompletionPostResponse = {
request_id: string;
intermediate_results: ModuleResults;
final_result: LlmModuleResult;
/**
* List of errors encountered during processing for unsuccessful modules configurations
*/
intermediate_failures?: Error[];
} & Record<string, any>;
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/*
* 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.
*/

/**
* Representation of the 'CompletionRequestConfigurationReferenceByIdConfigRef' schema.
*/
export type CompletionRequestConfigurationReferenceByIdConfigRef = {
/**
* @example "f47ac10b-58cc-4372-a567-0e02b2c3d479"
*/
id: string;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* 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.
*/
import type { CompletionRequestConfigurationReferenceByIdConfigRef } from './completion-request-configuration-reference-by-id-config-ref.js';
import type { ChatMessages } from './chat-messages.js';
/**
* Representation of the 'CompletionRequestConfigurationReferenceById' schema.
*/
export type CompletionRequestConfigurationReferenceById = {
config_ref: CompletionRequestConfigurationReferenceByIdConfigRef;
/**
* @example {
* "groundingInput": "What is SAP Joule?",
* "inputContext": "optimizing supply chain management"
* }
*/
placeholder_values?: Record<string, string>;
/**
* History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message
*/
messages_history?: ChatMessages;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
/*
* 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.
*/

/**
* Representation of the 'CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef' schema.
*/
export type CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef =
{
scenario: string;
name: string;
version: string;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* 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.
*/
import type { CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef } from './completion-request-configuration-reference-by-name-scenario-version-config-ref.js';
import type { ChatMessages } from './chat-messages.js';
/**
* Representation of the 'CompletionRequestConfigurationReferenceByNameScenarioVersion' schema.
*/
export type CompletionRequestConfigurationReferenceByNameScenarioVersion = {
config_ref: CompletionRequestConfigurationReferenceByNameScenarioVersionConfigRef;
/**
* @example {
* "groundingInput": "What is SAP Joule?",
* "inputContext": "optimizing supply chain management"
* }
*/
placeholder_values?: Record<string, string>;
/**
* History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message
*/
messages_history?: ChatMessages;
};
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
* 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.
*/
import type { OrchestrationConfig } from './orchestration-config.js';
import type { ChatMessages } from './chat-messages.js';
/**
* Representation of the 'CompletionRequestConfiguration' schema.
*/
export type CompletionRequestConfiguration = {
config: OrchestrationConfig;
/**
* @example {
* "groundingInput": "What is SAP Joule?",
* "inputContext": "optimizing supply chain management"
* }
*/
placeholder_values?: Record<string, string>;
/**
* History of chat messages. Can be used to provide system and assistant messages to set the context of the conversation. Will be merged with the template message
*/
messages_history?: ChatMessages;
};
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,17 @@ export type EmbeddingsModelDetails = {
*/
version?: string;
params?: EmbeddingsModelParams;
/**
* Timeout for the Embeddings request in seconds. This parameter is currently ignored for Vertex AI models.
* Default: 600.
* Maximum: 600.
* Minimum: 1.
*/
timeout?: number;
/**
* Maximum number of retries for the Embeddings request. This parameter is currently ignored for Vertex AI models.
* Default: 2.
* Maximum: 5.
*/
max_retries?: number;
};
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ import type { EmbeddingsResponse } from './embeddings-response.js';
export type EmbeddingsPostResponse = {
request_id: string;
intermediate_results?: ModuleResultsBase;
final_result?: EmbeddingsResponse;
final_result: EmbeddingsResponse;
};
11 changes: 11 additions & 0 deletions packages/orchestration/src/client/api/schema/error-list.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*
* 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.
*/
import type { Error } from './error.js';
/**
* Representation of the 'ErrorList' schema.
* Min Items: 1.
*/
export type ErrorList = Error[];
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/
import type { ErrorStreaming } from './error-streaming.js';
import type { ErrorStreamingList } from './error-streaming-list.js';
/**
* Representation of the 'ErrorResponseStreaming' schema.
*/
export type ErrorResponseStreaming = {
error: ErrorStreaming;
error: ErrorStreaming | ErrorStreamingList;
} & Record<string, any>;
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,10 @@
* This is a generated file powered by the SAP Cloud SDK for JavaScript.
*/
import type { Error } from './error.js';
import type { ErrorList } from './error-list.js';
/**
* Representation of the 'ErrorResponse' schema.
*/
export type ErrorResponse = {
error: Error;
error: Error | ErrorList;
} & Record<string, any>;
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
/*
* 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.
*/
import type { ErrorStreaming } from './error-streaming.js';
/**
* Representation of the 'ErrorStreamingList' schema.
* Min Items: 1.
*/
export type ErrorStreamingList = ErrorStreaming[];
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@ export type ErrorStreaming = {
*/
location: string;
intermediate_results?: ModuleResultsStreaming;
/**
* HTTP headers returned from the failed request attempt
*/
headers?: Record<string, string>;
} & Record<string, any>;
4 changes: 4 additions & 0 deletions packages/orchestration/src/client/api/schema/error.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,4 +26,8 @@ export type Error = {
*/
location: string;
intermediate_results?: ModuleResults;
/**
* HTTP headers returned from the failed request attempt
*/
headers?: Record<string, string>;
} & Record<string, any>;
14 changes: 13 additions & 1 deletion packages/orchestration/src/client/api/schema/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,11 +39,13 @@ export * from './completion-post-response.js';
export * from './completion-post-response-streaming.js';
export * from './orchestration-config.js';
export * from './module-configs.js';
export * from './module-configs-list.js';
export * from './module-results-base.js';
export * from './module-results.js';
export * from './module-results-streaming.js';
export * from './global-stream-options.js';
export * from './generic-module-result.js';
export * from './input-translation-module-result.js';
export * from './llm-module-result.js';
export * from './llm-module-result-streaming.js';
export * from './llm-choice.js';
Expand Down Expand Up @@ -93,10 +95,20 @@ export * from './key-value-list-pair.js';
export * from './search-document-key-value-list-pair.js';
export * from './search-select-option-enum.js';
export * from './translation-module-config.js';
export * from './sap-document-translation.js';
export * from './sap-document-translation-input.js';
export * from './sap-document-translation-output.js';
export * from './sap-document-translation-output-target-language.js';
export * from './sap-document-translation-apply-to-selector.js';
export * from './error.js';
export * from './error-list.js';
export * from './error-streaming.js';
export * from './error-streaming-list.js';
export * from './error-response.js';
export * from './error-response-streaming.js';
export * from './chat-completion-token-logprob.js';
export * from './choice-logprobs.js';
export * from './completion-request-configuration.js';
export * from './completion-request-configuration-reference-by-id.js';
export * from './completion-request-configuration-reference-by-id-config-ref.js';
export * from './completion-request-configuration-reference-by-name-scenario-version.js';
export * from './completion-request-configuration-reference-by-name-scenario-version-config-ref.js';
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
/*
* 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.
*/

/**
* Input Translation module result
*/
export type InputTranslationModuleResult = {
/**
* Status message describing the translation operation outcome.
* @example "Translated successfully placeholders 'issue_title', 'issue_description'."
*/
message: string;
data?: {
/**
* @deprecated
* @example "[{'role': 'user', 'content': 'translated content'}, ...]"
*/
translated_template?: string;
/**
* @example {
* "user": [
* "translated user content",
* "another translated user content"
* ],
* "system": [
* "translated system message"
* ]
* }
*/
translated_template_roles?: Record<string, string[]>;
/**
* @example {
* "groundingInput": "translated grounding input",
* "inputContext": "translated input context"
* }
*/
translated_placeholders?: Record<string, string>;
};
};
18 changes: 16 additions & 2 deletions packages/orchestration/src/client/api/schema/llm-model-details.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
*/

/**
* Representation of the 'LLMModelDetails' schema.
* The model and parameters to be used for the prompt templating. This is the model that will be used to generate the response.
*
*/
export type LLMModelDetails = {
/**
Expand All @@ -21,7 +22,7 @@ export type LLMModelDetails = {
/**
* Additional parameters for the model. Default values are used for mandatory parameters.
* @example {
* "max_tokens": 300,
* "max_completion_tokens": 300,
* "temperature": 0.1,
* "frequency_penalty": 0,
* "presence_penalty": 0,
Expand All @@ -32,4 +33,17 @@ export type LLMModelDetails = {
* }
*/
params?: Record<string, any>;
/**
* Timeout for the LLM request in seconds. This parameter is currently ignored for Vertex AI models.
* Default: 600.
* Maximum: 600.
* Minimum: 1.
*/
timeout?: number;
/**
* Maximum number of retries for the LLM request. This parameter is currently ignored for Vertex AI models.
* Default: 2.
* Maximum: 5.
*/
max_retries?: number;
};
Loading
Loading