Request builder for OpenAPI requests.
+Request builder for OpenAPI requests.
Type of the response for the request.
-Skip fetching csrf token for this request, which is typically useful when the csrf token is not required.
The request builder itself, to facilitate method chaining.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Server-Sent Event decoder.
+Server-Sent Event decoder.
Decode the line into structured server sent event.
Line to decode.
Server sent event if the line is empty meaning the end of the received event, or null if there are more lines to come.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Stream implemented as an async iterable.
-Stream implemented as an async iterable.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Protected StatictransformProtected StatictransformAzure OpenAI client for chat completion.
+Azure OpenAI client for chat completion.
OptionalrequestConfig: CustomRequestConfigThe request configuration.
A response containing the chat completion stream.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI chat completion response.
+Azure OpenAI chat completion response.
OptionalchoiceIndex: numberThe index of the choice to parse.
The message tool calls.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Chat completion stream containing post-processing functions.
-Chat completion stream containing post-processing functions.
+Chat completion stream.
OptionalchoiceIndex: numberThe index of the choice to parse.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Static_Static_Static_Protected StatictransformStatic_Static_Static_Protected StatictransformAzure OpenAI chat completion stream chunk response.
+Azure OpenAI chat completion stream chunk response.
Usage of tokens in the chunk response.
Token usage.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI chat completion stream response.
+Azure OpenAI chat completion stream response.
OptionalchoiceIndex: numberThe index of the choice to get the tool calls for.
The tool calls for the specified choice index.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI client for embeddings.
+Azure OpenAI client for embeddings.
Creates an instance of the Azure OpenAI embedding client.
@@ -10,4 +10,4 @@OptionalrequestConfig: CustomRequestConfigThe request configuration.
The completion result.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI embedding response.
+Azure OpenAI embedding response.
Gets the request ID from the response headers.
The request ID, or undefined if the header is not present.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
LangChain chat client for Azure OpenAI consumption on SAP BTP.
-LangChain chat client for Azure OpenAI consumption on SAP BTP.
+Implemented as a static method to support loading logic.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
LangChain embedding client for Azure OpenAI consumption on SAP BTP.
-LangChain embedding client for Azure OpenAI consumption on SAP BTP.
+Input string to embed.
Embedding.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The Orchestration client.
-The Orchestration client.
+Implemented as a static method to support loading logic.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
An AI Message Chunk containing intermediate results and request ID.
-An AI Message Chunk containing intermediate results and request ID.
+Type guard to check if an object is an AIMessageChunk. When called with unknown, returns base AIMessageChunk type
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Staticlc_Staticlc_Get the orchestration client.
-Get the orchestration client.
+Creates an instance of the orchestration client.
-Orchestration configuration. Can be:
+Creates an instance of the orchestration client.
+Orchestration configuration. Can be:
OrchestrationModuleConfig object for inline configurationOrchestrationModuleConfigList array for module fallback (tries each config in order until one succeeds)Optionaldestination: The destination to use for the request.
OptionalserviceBindingTransformFn?: ServiceBindingTransformFunctionCustom transformation function to control how a Destination is built from the given Service.
The name of the destination to retrieve from service bindings.
-Optionalservice?: undefinedSend a chat completion request to the orchestration service.
+Optionalservice?: undefinedSend a chat completion request to the orchestration service.
Optionalrequest: ChatCompletionRequestRequest containing messages, placeholder values, and message history.
OptionalrequestConfig: Pick<Additional request configuration. Use requestConfig.headers to pass service-specific headers:
AI-Object-Store-Secret-Name: Name of the object store secret used by the feedback service.The orchestration service response.
-Create a streaming chat completion request to the orchestration service.
+Create a streaming chat completion request to the orchestration service.
Optionalrequest: ChatCompletionRequestRequest containing messages, placeholder values, and message history.
Optionalsignal: AbortSignalAn abort signal to cancel the request.
Optionaloptions: StreamOptionsStreaming options, e.g., for input/output filtering.
@@ -31,4 +31,4 @@The orchestration stream response.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration embedding client for generating embeddings with optional orchestration modules.
+Orchestration embedding client for generating embeddings with optional orchestration modules.
Creates an instance of the orchestration embedding client.
@@ -12,4 +12,4 @@OptionalrequestConfig: CustomRequestConfigCustom request configuration.
Promise resolving to embedding response.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response wrapper for orchestration embedding requests.
+Representation of an orchestration response.
+Representation of an orchestration response.
OptionalchoiceIndex: numberThe index of the choice to parse.
The message tool calls.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration stream containing post-processing functions.
-Orchestration stream containing post-processing functions.
+Static_InternalTransform a stream of chunks into a stream of content strings.
Orchestration stream.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Static_Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>Static_Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>Protected StatictransformStatic_Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>Static_Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>Protected StatictransformOrchestration stream chunk response.
+Orchestration stream chunk response.
Usage of tokens in the chunk response.
Token usage.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration stream response.
+Orchestration stream response.
OptionalchoiceIndex: numberThe index of the choice to parse.
The message tool calls.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ExperimentalRepresentation of an RPT client to make predictions. +
ExperimentalRepresentation of an RPT client to make predictions. This class is experimental and may change at any time without prior notice.
OptionalrequestConfig: RptRequestOptionsCustom request configuration.
Prediction response.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Query the AI Core service for a deployment that matches the given criteria. +
Query the AI Core service for a deployment that matches the given criteria. If more than one deployment matches the criteria, the first one's URL is returned.
The options for the deployment resolution.
A promise of the deployment URL, if a deployment was found, fails otherwise.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Executes a request to the AI Core service.
+Executes a request to the AI Core service.
The options to call an endpoint.
The input parameters for the request.
OptionalrequestConfig: CustomRequestConfigThe request configuration.
@@ -7,4 +7,4 @@The name of the destination to retrieve from service bindings.
Optionalservice?: undefinedThe HttpResponse from the AI Core service.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Returns a destination object.
+Returns a destination object.
Optionaldestination: The destination to use for the request.
OptionalserviceBindingTransformFn?: ServiceBindingTransformFunctionCustom transformation function to control how a Destination is built from the given Service.
The name of the destination to retrieve from service bindings.
Optionalservice?: undefinedThe destination object.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to build Azure content filter.
+Convenience function to build Azure content filter.
Type of the filter, either 'input' or 'output'.
Optionalconfig: AzureContentSafetyFilterParameters<T>Configuration for Azure content safety filter.
If skipped, the default configuration of ALLOW_SAFE_LOW is used for all filter categories.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to create Document Grounding configuration.
+Convenience function to create Document Grounding configuration.
Configuration for the document grounding service.
An object with the full grounding configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to create masking provider SAP Data Privacy Integration.
+Convenience function to create masking provider SAP Data Privacy Integration.
Configuration for the masking provider SAP Data Privacy Integration.
An object with the masking provider configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to build Llama Guard 3 8B filter.
+Convenience function to build Llama Guard 3 8B filter.
Type of the filter, either input or output.
Categories to be enabled for filtering. Provide at least one category.
Llama Guard 3 8B filter configuration.
@@ -6,4 +6,4 @@Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Convenience function to build a document translation configuration for orchestration service.
+Convenience function to build a document translation configuration for orchestration service.
Type of the translation configuration, either input or output.
Config for SAP Document Translation service. The target language is mandatory, while source language will be auto-detected if not provided. @@ -14,4 +14,4 @@
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Type guard to check if config is a config reference.
+Type guard to check if config is a config reference.
The config to check.
Type predicate indicating whether the config is a config reference.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Type guard to check if config is a valid list of orchestration module configs.
+Type guard to check if config is a valid list of orchestration module configs.
The config to check.
True if config is a non-empty array with valid OrchestrationModuleConfig elements.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The SAP Cloud SDK for AI consists of multiple libraries to enable you to integrate AI capabilities into your applications on SAP Business Technology Platform.
+The SAP Cloud SDK for AI consists of multiple libraries to enable you to integrate AI capabilities into your applications on SAP Business Technology Platform.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The deployment configuration when using a deployment ID.
+The deployment configuration when using a deployment ID.
The model deployment configuration when using a model.
+The model deployment configuration when using a model.
String literal type representing the name of the model.
The deployment configuration when using a resource group.
+The deployment configuration when using a resource group.
The options to call an endpoint.
+Input parameters for Azure content safety input filter.
-Input parameters for Azure content safety input filter.
+OptionalsexualThe filter category for sexual content.
OptionalviolenceThe filter category for violence content.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output Parameters for Azure content safety output filter.
-Output Parameters for Azure content safety output filter.
+OptionalsexualThe filter category for sexual content.
OptionalviolenceThe filter category for violence content.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Base stream options without per-config overrides.
+Base stream options without per-config overrides.
OptionaloverridesPlease use StreamOptionsWithOverrides if you want to specify per-config stream options for module fallback.
OptionalpromptLLM specific stream options.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Chat completion request configuration.
+Chat completion request configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents the configuration for the Document Grounding Service.
+Represents the configuration for the Document Grounding Service.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Configuration selector for applying translation to specific placeholders or message roles.
+Configuration selector for applying translation to specific placeholders or message roles.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding module configuration.
+Embedding request configuration.
+Embedding request configuration.
Representation of the FilteringModuleConfig schema.
Representation of the FilteringModuleConfig schema.
Representation of the GroundingModuleConfig schema.
Representation of the MaskingModuleConfig schema.
Representation of the MaskingModuleConfig schema.
Orchestration module configuration.
+Orchestration module configuration.
Service-specific headers for orchestration requests.
+Service-specific headers for orchestration requests.
OptionalAI-Name of the object store secret used by the feedback service.
OptionalAI-Use the deploymentConfig constructor parameter to set the resource group instead.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Prompt templating module configuration.
+Prompt templating module configuration.
Request options for orchestration.
+Request options for orchestration.
Custom options for how requests to the RPT service endpoint are performed.
-Custom options for how requests to the RPT service endpoint are performed.
+OptionalsignalAn AbortSignal to cancel the request.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiApiError' schema.
+Representation of the 'AiApiError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiApiErrorWithId' schema.
+Representation of the 'AiApiErrorWithId' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Base data of the artifact; this is the data that can be provided when the artifact is created; name and kind are required because they constitute important semantic filtering criteria for use in training / inference executables (name is a semantic handle of the artifact within a scenario and kind specifies the type of usage, e.g. you would only want to allow models in the model operator).
Base data of the artifact; this is the data that can be provided when the artifact is created; name and kind are required because they constitute important semantic filtering criteria for use in training / inference executables (name is a semantic handle of the artifact within a scenario and kind specifies the type of usage, e.g. you would only want to allow models in the model operator).
OptionalconfigurationId?: AiConfigurationIdTimestamp of resource creation Format: "date-time".
Optionaldescription?: AiArtifactDescriptionOptionalexecutionId?: AiExecutionIdKind of the artifact, i.e. model or dataset
Optionallabels?: AiLabelListTimestamp of latest resource modification Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalscenario?: AiScenario | any | nullOptionalscenario?: AiScenario | any | nullRequired for execution +
Required for execution Result of activation
Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactArgumentBindingList' schema. +
Representation of the 'AiArtifactArgumentBindingList' schema. Max Items: 1000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactArray' schema.
+Representation of the 'AiArtifactArray' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactCreationResponse' schema.
+Representation of the 'AiArtifactCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Description of the artifact +
Description of the artifact Max Length: 5000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactList' schema.
+Representation of the 'AiArtifactList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name of the artifact +
Name of the artifact Max Length: 256. Pattern: "^[\w\s.!?,;:\\{}<>"'=+*/\\^&%@~$#|-]*$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Base data of the artifact; this is the data that can be provided when the artifact is created; name and kind are required because they constitute important semantic filtering criteria for use in training / inference executables (name is a semantic handle of the artifact within a scenario and kind specifies the type of usage, e.g. you would only want to allow models in the model operator).
Base data of the artifact; this is the data that can be provided when the artifact is created; name and kind are required because they constitute important semantic filtering criteria for use in training / inference executables (name is a semantic handle of the artifact within a scenario and kind specifies the type of usage, e.g. you would only want to allow models in the model operator).
Optionaldescription?: AiArtifactDescriptionKind of the artifact, i.e. model or dataset
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionallabels?: AiLabelListOptionallabels?: AiLabelListReference to the location of the artifact.
+backend-specific details of the deployment
+backend-specific details of the deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiConfiguration' schema.
+Representation of the 'AiConfiguration' schema.
Timestamp of resource creation Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalinputArtifactBindings?: AiArtifactArgumentBindingListOptionalparameterBindings?: AiParameterArgumentBindingListOptionalscenario?: AiScenario | any | nullOptionalinputArtifactBindings?: AiArtifactArgumentBindingListOptionalparameterBindings?: AiParameterArgumentBindingListOptionalscenario?: AiScenario | any | nullRepresentation of the 'AiConfigurationBaseData' schema.
+Representation of the 'AiConfigurationBaseData' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiConfigurationCreationResponse' schema.
+Representation of the 'AiConfigurationCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ID of the configuration
+Representation of the 'AiConfigurationList' schema.
+Representation of the 'AiConfigurationList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name of the configuration +
Name of the configuration Max Length: 256. Pattern: "^[\w\s.!?,;:\\{}<>"'=+*/\\^&%@~$#|-]*$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Detailed data about a deployment
+Detailed data about a deployment
OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED Format: "date-time".
OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation @@ -16,4 +16,4 @@ Format: "date-time".
OptionaltargetStatus?: "RUNNING" | "STOPPED" | "DELETED"Deployment target status
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalttl?: AiDeploymentTimeToLiveOptionalttl?: AiDeploymentTimeToLiveRequest object for changing the target status of multiple deployments
+Request object for changing the target status of multiple deployments
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response object with array of deployments
+Response object with array of deployments
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object for creating an execution or an deployment
+Request object for creating an execution or an deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentCreationResponse' schema.
+Representation of the 'AiDeploymentCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentDeletionResponse' schema.
+Representation of the 'AiDeploymentDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Detail information about a deployment (including predefined sections: scaling and resources).
+
Detail information about a deployment (including predefined sections: scaling and resources).
JSON String representation of this object is limited to 5000 characters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentList' schema.
+Representation of the 'AiDeploymentList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object for changing the target status of a deployment (currently only STOPPED is supported)
+Request object for changing the target status of a deployment (currently only STOPPED is supported)
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentModificationRequestList' schema.
+Representation of the 'AiDeploymentModificationRequestList' schema.
Request object for changing the target status of a deployment ( STOPPED and DELETED are supported)
+Request object for changing the target status of a deployment ( STOPPED and DELETED are supported)
Deployment target status
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentModificationResponse' schema.
+Representation of the 'AiDeploymentModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentModificationResponseList' schema.
+Representation of the 'AiDeploymentModificationResponseList' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Detail properties of the deployment
+Detail properties of the deployment
OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED Format: "date-time".
OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation @@ -16,4 +16,4 @@ Format: "date-time".
OptionaltargetStatus?: "RUNNING" | "STOPPED" | "DELETED"Deployment target status
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalttl?: AiDeploymentTimeToLiveOptionalttl?: AiDeploymentTimeToLiveDeployment status
+Current status details of the deployment
+Current status details of the deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Deployment status message +
Deployment status message Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Time to live for a deployment. Its value can be either null or a number followed by the unit (any of following values, minutes(m|M), hours(h|H) or days(d|D))
+Time to live for a deployment. Its value can be either null or a number followed by the unit (any of following values, minutes(m|M), hours(h|H) or days(d|D))
Consumption URL of the deployment +
Consumption URL of the deployment Format: "url".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object for creating an execution or an deployment
+Request object for creating an execution or an deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
An ML executable consists of a set of ML tasks, flows between tasks, dependencies between tasks, models (or model versions?).
+An ML executable consists of a set of ML tasks, flows between tasks, dependencies between tasks, models (or model versions?).
Timestamp of resource creation Format: "date-time".
Whether this executable is deployable
@@ -7,4 +7,4 @@ Format: "date-time".Name of the executable
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaloutputArtifacts?: AiExecutableArtifactListOptionalparameters?: AiExecutableParameterListOptionalscenarioId?: AiScenarioIdOptionaloutputArtifacts?: AiExecutableArtifactListOptionalparameters?: AiExecutableParameterListOptionalscenarioId?: AiScenarioIdRepresentation of the 'AiExecutableArtifact' schema.
+Representation of the 'AiExecutableArtifact' schema.
Optionaldescription?: stringDescription of the signature argument
Optionalkind?: stringArtifact kind (model, dataset, other)
Optionallabels?: AiLabelListName of the executable input artifacts
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Executable parameters
+Executable parameters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutableList' schema.
+Representation of the 'AiExecutableList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutableParameter' schema.
+Representation of the 'AiExecutableParameter' schema.
Optionaldefault?: stringDefault value of the signature argument
Optionaldescription?: stringDescription of the signature argument
Name of the executable parameter
Optionaltype?: "string"Type of the executable parameter
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Executable parameters
+Executable parameters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution that may generate artifacts
+Execution that may generate artifacts
OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED Format: "date-time".
OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation @@ -14,4 +14,4 @@
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object to change status of multiple executions
+Request object to change status of multiple executions
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response object with array of executions and its status
+Response object with array of executions and its status
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionCreationResponse' schema.
+Representation of the 'AiExecutionCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionDeletionResponse' schema.
+Representation of the 'AiExecutionDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionList' schema.
+Representation of the 'AiExecutionList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object for changing the target status of an execution (currently only STOPPED is supported)
+Request object for changing the target status of an execution (currently only STOPPED is supported)
Desired target status of the execution (currently only STOPPED is supported)
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionModificationRequestList' schema.
+Representation of the 'AiExecutionModificationRequestList' schema.
Request object for changing the target status of an execution (currently STOPPED and DELETED are supported)
+Request object for changing the target status of an execution (currently STOPPED and DELETED are supported)
Desired target status of the execution (currently STOPPED and DELETED are supported)
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionModificationResponse' schema.
+Representation of the 'AiExecutionModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionModificationResponseList' schema.
+Representation of the 'AiExecutionModificationResponseList' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Execution that may generate artifacts
+Execution that may generate artifacts
OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED Format: "date-time".
OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation @@ -14,4 +14,4 @@
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Data about execution schedule
+Data about execution schedule
Timestamp of resource creation Format: "date-time".
Optionalend?: stringTimestamp, defining when the executions should stop running @@ -10,4 +10,4 @@
Optionalstart?: stringTimestamp, defining when the executions should start running periodically, defaults to now Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalstatus?: AiExecutionScheduleStatusOptionalstatus?: AiExecutionScheduleStatusStart and end an execution schedule.
+Start and end an execution schedule.
Optionalend?: stringTimestamp, defining when the executions should stop running Format: "date-time".
Name of the execution schedule @@ -6,4 +6,4 @@
Optionalstart?: stringTimestamp, defining when the executions should start running periodically, defaults to now Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionScheduleCreationResponse' schema.
+Representation of the 'AiExecutionScheduleCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'AiExecutionScheduleDeletionResponse' schema.
+Representation of the 'AiExecutionScheduleDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+ID of the execution schedule
+Representation of the 'AiExecutionScheduleList' schema.
+Representation of the 'AiExecutionScheduleList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request object for changing the execution schedule
+Request object for changing the execution schedule
OptionalconfigurationId?: AiConfigurationIdOptionalcron?: AiCronOptionalend?: stringTimestamp, defining when the executions should stop running Format: "date-time".
Optionalstart?: stringTimestamp, defining when the executions should start running periodically, defaults to now Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalstatus?: AiExecutionScheduleStatusOptionalstatus?: AiExecutionScheduleStatusRepresentation of the 'AiExecutionScheduleModificationResponse' schema.
+Representation of the 'AiExecutionScheduleModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Execution status
+Current status details of the execution
+Current status details of the execution
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution status message +
Execution status message Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLabel' schema.
+Representation of the 'AiLabel' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLabelKey' schema.
+Representation of the 'AiLabelValue' schema. +
Representation of the 'AiLabelValue' schema. Max Length: 5000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLogCommonData' schema.
+Representation of the 'AiLogCommonData' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLogCommonResult' schema.
+Representation of the 'AiLogCommonResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Common log record.
+Common log record.
Representation of the 'AiModelBaseData' schema.
+Representation of the 'AiModelBaseData' schema.
OptionalaccessType?: stringAccess type of the model
OptionalallowedScenarios?: (List of scenarioId:executableId pair where the model supported
Description of the model and its capabilities
@@ -6,4 +6,4 @@Name of the model
Optionalprovider?: stringProvider of the model
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiModelList' schema.
+Representation of the 'AiModelList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Model version information including whether it is latest version, its deprecation status and optional retirement date
+Model version information including whether it is latest version, its deprecation status and optional retirement date
Optionalcapabilities?: string[]List of capabilities supported by the model
OptionalcontextLength?: numberContext length of the model
Optionalcost?: Record<string, string>[]List of costs associated with the model
@@ -12,4 +12,4 @@OptionalstreamingSupported?: booleanStreaming support status of the model
OptionalsuggestedReplacements?: string[]List of suggested replacements for the model
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
List of model versions that the model object has
+List of model versions that the model object has
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Required for execution +
Required for execution Result of activation
Max Length: 256.
Max Length: 5000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiParameterArgumentBindingList' schema. +
Representation of the 'AiParameterArgumentBindingList' schema. Max Items: 1000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Resources details of a deployment
+Resources details of a deployment
Scaling details of a deployment
+Scaling details of a deployment
An ML Scenario consists of a number of executables. E.g., there can be one or several training executables, an inference (deployment) executable. An ML Scenario is versioned.
+An ML Scenario consists of a number of executables. E.g., there can be one or several training executables, an inference (deployment) executable. An ML Scenario is versioned.
Timestamp of resource creation Format: "date-time".
Optionaldescription?: stringDescription of the scenario @@ -8,4 +8,4 @@
Name of the scenario Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiScenarioLabel' schema.
+Representation of the 'AiScenarioLabel' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiScenarioLabelKey' schema.
+Representation of the 'AiScenarioLabelKey' schema.
Arbitrary labels as meta information
+Arbitrary labels as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiScenarioList' schema.
+Representation of the 'AiScenarioList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiUrl' schema. +
Representation of the 'AiUrl' schema. Format: "url".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiVersion' schema.
+Representation of the 'AiVersion' schema.
Timestamp of resource creation Format: "date-time".
Optionaldescription?: AiVersionDescriptionTimestamp of latest resource modification Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalscenarioId?: AiScenarioIdOptionalscenarioId?: AiScenarioIdVersion ID
+Version ID
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiVersionList' schema.
+Representation of the 'AiVersionList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
list of applications
+list of applications
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationBaseData' schema.
+Representation of the 'BckndArgoCDApplicationBaseData' schema.
path within the repository to synchronise
URL of the repository to synchronise
revision to synchronise
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationCreationResponse' schema.
+Representation of the 'BckndArgoCDApplicationCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndArgoCDApplicationDataRepoName' schema.
+Representation of the 'BckndArgoCDApplicationDataRepoName' schema.
OptionalapplicationName?: stringArgoCD application name in the request body Max Length: 54. Min Length: 3. @@ -7,4 +7,4 @@
Name of the repository to synchronise
revision to synchronise
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationDataRequest' schema.
+Representation of the 'BckndArgoCDApplicationDataRequest' schema.
OptionalapplicationName?: stringArgoCD application name in the request body Max Length: 54. Min Length: 3. @@ -7,4 +7,4 @@
URL of the repository to synchronise
revision to synchronise
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationDataResponse' schema.
+Representation of the 'BckndArgoCDApplicationDataResponse' schema.
OptionalapplicationName?: stringArgoCD application name in the response body Max Length: 63. Min Length: 3. @@ -7,4 +7,4 @@
URL of the repository to synchronise
revision to synchronise
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationDeletionResponse' schema.
+Representation of the 'BckndArgoCDApplicationDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndArgoCDApplicationModificationResponse' schema.
+Representation of the 'BckndArgoCDApplicationModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndArgoCDApplicationRefreshResponse' schema.
+Representation of the 'BckndArgoCDApplicationRefreshResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+ArgoCD application definition and status
+ArgoCD application definition and status
OptionalhealthStatus?: stringArgoCD application health status
Optionalmessage?: stringArgoCD application health status message
OptionalreconciledAt?: stringGet timestamp information related to the sync state of the ArgoCD application
@@ -9,4 +9,4 @@OptionalsyncStartedAt?: stringGet timestamp information related to the sync state of the ArgoCD application
OptionalsyncStatus?: stringArgoCD application sync status
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDRepositoryCreationResponse' schema.
+Representation of the 'BckndArgoCDRepositoryCreationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndArgoCDRepositoryCredentials' schema.
+Representation of the 'BckndArgoCDRepositoryCredentials' schema.
Password for read-access to the repository
Username for read-access to the repository
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDRepositoryData' schema.
+Representation of the 'BckndArgoCDRepositoryData' schema.
Optionalname?: stringName of the repository Max Length: 51. Min Length: 1. @@ -7,4 +7,4 @@
URL of the repository to synchronise
Username for read-access to the repository
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
This represents a list of GitOps repositories for the tenant.
+This represents a list of GitOps repositories for the tenant.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDRepositoryDeletionResponse' schema.
+Representation of the 'BckndArgoCDRepositoryDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Repository details
+Repository details
Optionalname?: stringThe name of the repository
Optionalstatus?: "ERROR" | "IN-PROGRESS" | "COMPLETED"The status of the repository's on-boarding
Optionalurl?: stringThe repository URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDRepositoryModificationResponse' schema.
+Representation of the 'BckndArgoCDRepositoryModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndCommonResourceQuotaResponse' schema.
+Representation of the 'BckndCommonResourceQuotaResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndDeploymentQuota' schema.
+Representation of the 'BckndDeploymentQuota' schema.
OptionalmaxReplicaPerDeployment?: numberRepresentation of the 'BckndDeploymentQuotaItem' schema.
+Representation of the 'BckndDeploymentQuotaItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndDeploymentResourceQuotaResponse' schema.
+Representation of the 'BckndDeploymentResourceQuotaResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndDeploymentUsage' schema.
+Representation of the 'BckndDeploymentUsage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndError' schema.
+Representation of the 'BckndError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
@@ -8,4 +8,4 @@OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndErrorResponse' schema.
+Representation of the 'BckndErrorResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndExecutableResourceQuotaResponse' schema.
+Representation of the 'BckndExecutableResourceQuotaResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndExtendedService' schema.
+Representation of the 'BckndExtendedService' schema.
OptionalbrokerSecret?: BckndServiceBrokerSecretOptionalcapabilities?: BckndServiceCapabilitiesOptionaldescription?: stringservice description
Optionalname?: stringservice name
OptionalserviceCatalog?: BckndServiceServiceCatalogOptionalsharedResourceGroupStatus?: BckndSharedResourceGroupStatusOptionalstatus?: "PROVISIONED" | "ERROR" | "PROVISIONING" | "DEPROVISIONING"aggregated status of the service
OptionalstatusMessage?: stringstatus message
Optionalurl?: stringservice broker url
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Base64 encoded secret data
+Base64 encoded secret data
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretDataResponse' schema.
+Representation of the 'BckndGenericSecretDataResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretDetails' schema.
+Representation of the 'BckndGenericSecretDetails' schema.
Timestamp at which secret was created
Optionallabels?: BckndGenericSecretLabelsName of the secret
OptionalresourceGroupSecretsSyncStatus?: Record<string, boolean>Sync status of the replicated secrets in all resource groups of the tenant
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretLabel' schema.
+Representation of the 'BckndGenericSecretLabel' schema.
Arbitrary labels as meta information
+Arbitrary labels as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretPatchBody' schema.
+Representation of the 'BckndGenericSecretPatchBody' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretPostBody' schema.
+Representation of the 'BckndGenericSecretPostBody' schema.
Optionallabels?: BckndGenericSecretLabelsThe name of the secret Max Length: 252. Min Length: 1. Pattern: "^[a-z0-9\-\.]+$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInstanceType' schema.
+Representation of the 'BckndInstanceType' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInstanceTypeGetResponse' schema.
+Representation of the 'BckndInstanceTypeGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroup' schema.
+Representation of the 'BckndInternalResourceGroup' schema.
Optionalannotations?: BckndInternalResourceGroupAnnotationsTimestamp of resource group creation Format: "date-time".
Optionallabels?: BckndInternalResourceGroupLabelsresource group id
@@ -8,4 +8,4 @@OptionaltenantId?: stringtenant id
OptionalzoneId?: stringzone id
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroupAnnotation' schema.
+Representation of the 'BckndInternalResourceGroupAnnotation' schema.
Arbitrary annotations as meta information
+Arbitrary annotations as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroupLabel' schema.
+Representation of the 'BckndInternalResourceGroupLabel' schema.
Arbitrary labels as meta information
+Arbitrary labels as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
This represents a list of meta-data of the secret. The 'data' field of the secret is never retrieved.
+This represents a list of meta-data of the secret. The 'data' field of the secret is never retrieved.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Message
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name
+Name
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGetResourcePlans' schema.
+Representation of the 'BckndResourceGetResourcePlans' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGetResponse' schema.
+Representation of the 'BckndResourceGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroup' schema.
+Representation of the 'BckndResourceGroup' schema.
Timestamp of resource group creation Format: "date-time".
Optionallabels?: BckndResourceGroupLabelsresource group id
@@ -8,4 +8,4 @@OptionaltenantId?: stringtenant id
OptionalzoneId?: stringzone id
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupBase' schema.
+Representation of the 'BckndResourceGroupBase' schema.
OptionalresourceGroupId?: stringresource group id
OptionaltenantId?: stringtenant id
OptionalzoneId?: stringzone id
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupDeletionResponse' schema.
+Representation of the 'BckndResourceGroupDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndResourceGroupLabel' schema.
+Representation of the 'BckndResourceGroupLabel' schema.
Arbitrary labels as meta information
+Arbitrary labels as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupList' schema.
+Representation of the 'BckndResourceGroupList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupPatchRequest' schema.
+Representation of the 'BckndResourceGroupPatchRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupsPostRequest' schema.
+Representation of the 'BckndResourceGroupsPostRequest' schema.
Optionallabels?: BckndResourceGroupLabelsOptionalresourceGroupId?: stringresource group id Max Length: 253. Min Length: 3. Pattern: "^[a-zA-Z0-9][a-zA-Z0-9.-]{1,251}[a-zA-Z0-9]$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchBody' schema.
+Representation of the 'BckndResourcePatchBody' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchNodes' schema.
+Representation of the 'BckndResourcePatchNodes' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchResourcePlans' schema.
+Representation of the 'BckndResourcePatchResourcePlans' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchResponse' schema.
+Representation of the 'BckndResourcePatchResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndService' schema.
+Representation of the 'BckndService' schema.
Optionaldescription?: stringservice description
Optionalname?: stringservice name
Optionalstatus?: "PROVISIONED" | "ERROR" | "PROVISIONING" | "DEPROVISIONING"aggregated status of the service
OptionalstatusMessage?: stringstatus message
Optionalurl?: stringservice broker url
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceBrokerSecret' schema.
+Representation of the 'BckndServiceBrokerSecret' schema.
Optionalname?: stringbroker secret name
OptionalpasswordKeyRef?: stringusername key reference in broker secret
OptionalusernameKeyRef?: stringpassword key reference in broker secret
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceCapabilities' schema.
+Representation of the 'BckndServiceCapabilities' schema.
Optionalbasic?: {Basic capabilities like creating deployments and executions.
Optionallogs?: { deployments?: boolean; executions?: boolean } & Record<string, any>Capabilities to read logs from deployments and executions.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceList' schema.
+Representation of the 'BckndServiceList' schema.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServiceCatalog' schema.
+Representation of the 'BckndServiceServiceCatalog' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServiceCatalogItem' schema.
+Representation of the 'BckndServiceServiceCatalogItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServiceCatalogItemExtendCatalog' schema.
+Representation of the 'BckndServiceServiceCatalogItemExtendCatalog' schema.
Optionalbindable?: booleanif the service is bindable
Optionaldescription?: stringdescription of the service
Optionalid?: stringid of the service
Optionalname?: stringname of the service
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalplans?: BckndServiceServicePlanItem[]Optionalplans?: BckndServiceServicePlanItem[]Representation of the 'BckndServiceServiceCatalogItemExtendCredentials' schema.
+Representation of the 'BckndServiceServiceCatalogItemExtendCredentials' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServicePlanItem' schema.
+Representation of the 'BckndServiceServicePlanItem' schema.
Optionaldescription?: stringdescription of the service plan
Optionalfree?: booleanif the service plan free
Optionalid?: stringid of the service plan
Optionalmetadata?: BckndServiceServicePlanItemMetadataOptionalname?: stringname of the service plan
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServicePlanItemMetadata' schema.
+Representation of the 'BckndServiceServicePlanItemMetadata' schema.
OptionalsupportedPlatforms?: ("cloudfoundry" | "kubernetes" | "sapbtp")[]supported platforms of the service plan
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndSharedResourceGroupStatus' schema.
+Representation of the 'BckndSharedResourceGroupStatus' schema.
Optionalid?: stringshared resource group id
OptionalisEnabled?: booleanindicates whether shared resource group is enabled
Optionalstate?: stringcurrent state of shared resource group
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndTenant' schema.
+Representation of the 'BckndTenant' schema.
OptionalrealSubaccountId?: stringreal sub account id
OptionalservicePlan?: stringservice plan
OptionaltenantId?: stringtenant id
OptionalzoneId?: stringzone id
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndUrl' schema. +
Representation of the 'BckndUrl' schema. Format: "url".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndUsageResourcePlanItem' schema.
+Representation of the 'BckndUsageResourcePlanItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name of the docker Registry store for the secret.
+Name of the docker Registry store for the secret.
Message
+Message
Message
+Representation of the 'BcknddockerRegistrySecretDeletionResponse' schema.
+Representation of the 'BcknddockerRegistrySecretDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BcknddockerRegistrySecretModificationResponse' schema.
+Representation of the 'BcknddockerRegistrySecretModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+This represents the meta-data of a stored secret. The 'data' field of the secret is never retrieved.
+This represents the meta-data of a stored secret. The 'data' field of the secret is never retrieved.
This represents a list of meta-data of a stored secret. The 'data' field of the secret is never retrieved.
+This represents a list of meta-data of a stored secret. The 'data' field of the secret is never retrieved.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
This represents all the meta-data and extra information to be stored as a k8-secret
+This represents all the meta-data and extra information to be stored as a k8-secret
key:value pairs of data
.dockerconfigjson data
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Message
Message
+Representation of the 'BckndobjectStoreSecretDeletionResponse' schema.
+Representation of the 'BckndobjectStoreSecretDeletionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndobjectStoreSecretModificationResponse' schema.
+Representation of the 'BckndobjectStoreSecretModificationResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+This represents the meta-data of a stored secret. The 'data' field of the secret is never retrieved.
+This represents the meta-data of a stored secret. The 'data' field of the secret is never retrieved.
Optionalmetadata?: {Key value pairs of meta-data assigned to the secret when the secret was being created.
Optionalname?: stringName of objectstore
This represents a list of meta-data of a stored secret. The 'data' field of the secret is never retrieved.
+This represents a list of meta-data of a stored secret. The 'data' field of the secret is never retrieved.
Number of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
This represents all the meta-data and extra information to be stored as a k8-secret
+This represents all the meta-data and extra information to be stored as a k8-secret
This represents all the meta-data and extra information to be stored as a k8-secret
+This represents all the meta-data and extra information to be stored as a k8-secret
Error Response
+Error Response
Min Length: 1.
Optionaldetails?: Set<{ code: string; message: string } & Record<string, any>>Min Length: 1.
OptionalrequestId?: stringOptionaltarget?: stringMin Length: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response for successful file creation
+Response for successful file creation
File creation response message
Representation of the 'DSetUrl' schema.
+Representation of the 'KpiAggregationAttribute' schema.
+Representation of the 'KpiAggregationAttribute' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiApiError' schema.
+Representation of the 'KpiApiError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiArrayOfColumnNames' schema.
+Representation of the 'KpiArrayOfColumnNames' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name of the Column
+Name of the Column
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiCountAggregate' schema. +
Representation of the 'KpiCountAggregate' schema. Format: "int64".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRow' schema.
+Representation of the 'KpiResultRow' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRowItem' schema.
+Representation of the 'KpiResultRowItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRowList' schema.
+Representation of the 'KpiResultRowList' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
API version description
+API version description
There are (currently) the following types of execution engines 1) complete runtimes that offer executions and deployments, 2) runtimes that do only batch inference and therefore don't support deployments 3) runtimes that allow deployments, but with predefined models and therefore don't need executions 4) runtimes that have fixed endpoints and therefore only need listing deployments
+There are (currently) the following types of execution engines 1) complete runtimes that offer executions and deployments, 2) runtimes that do only batch inference and therefore don't support deployments 3) runtimes that allow deployments, but with predefined models and therefore don't need executions 4) runtimes that have fixed endpoints and therefore only need listing deployments
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaApiError' schema.
+Representation of the 'MetaApiError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaCapabilities' schema.
+Representation of the 'MetaCapabilities' schema.
Optionaldescription?: stringOptionalextensions?: MetaExtensionsOptionalruntimeApiVersion?: MetaVersionOptionalruntimeIdentifier?: stringThe name of the runtime
Representation of the 'MetaExtensions' schema.
+Representation of the 'MetaExtensions' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaVersion' schema.
+Representation of the 'MetaVersion' schema.
The configuration of a model deployment.
+The configuration of a model deployment.
String literal type representing the name of the model.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Entity having labels
+Entity having labels
Timestamp of resource creation Format: "date-time".
Kind of the artifact, i.e. model or dataset
Optionallabels?: RTALabelListName of the artifact; this is used for dependent pipelines to resolve an artifact Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalsignature?: RTAArtifactSignatureOptionalsignature?: RTAArtifactSignatureRepresentation of the 'RTAArtifactArray' schema.
+Representation of the 'RTAArtifactArray' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAArtifactLabel' schema.
+Representation of the 'RTAArtifactLabel' schema.
Arbitrary labels as meta information
+Arbitrary labels as meta information
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAArtifactName' schema. +
Representation of the 'RTAArtifactName' schema. Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAArtifactSignature' schema. +
Representation of the 'RTAArtifactSignature' schema. Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Reference to the location of the artifact. +
Reference to the location of the artifact. Note, the credentials will be found in a secret called 'some_bucket-object_store_secret'. If not provided, a default will be assumed.
Representation of the 'RTABackendDetails' schema.
+Representation of the 'RTABackendDetails' schema.
OptionalbackendDetails?: Record<string, any>Current details of the deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Detailed data about an inference-pipeline deployment
+Detailed data about an inference-pipeline deployment
Timestamp of resource creation Format: "date-time".
OptionaldeploymentUrl?: RTADeploymentUrlOptionalid?: RTADeploymentIdOptionallastOperation?: "CREATE" | "UPDATE" | "CASCADE-UPDATE" | "DELETE"Reflection of user's action on deployment. The value will be CREATE after user sends POST - create deployment, UPDATE after user sends PATCH - update deployment, and DELETE after user sends DELETE - delete deployment
@@ -8,4 +8,4 @@OptionalstatusMessage?: stringDeployment status message Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaltargetId?: RTATargetIdOptionalttl?: RTATtlOptionaltargetId?: RTATargetIdOptionalttl?: RTATtlMessage
+Representation of the 'RTADeploymentDetails' schema.
+Representation of the 'RTADeploymentDetails' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Current status details of the deployment
+Current status details of the deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Consumption URL of the pipeline deployment +
Consumption URL of the pipeline deployment Format: "url".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAError' schema.
+Representation of the 'RTAError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
@@ -8,4 +8,4 @@OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAErrorResponse' schema.
+Representation of the 'RTAErrorResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Entity having labels
+Entity having labels
Timestamp of resource creation Format: "date-time".
Whether this pipeline is deployable
@@ -7,4 +7,4 @@ Format: "date-time".Name of the executable
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaloutputArtifacts?: RTAExecutableOutputArtifactListOptionalparameters?: RTAExecutableParameterListOptionaloutputArtifacts?: RTAExecutableOutputArtifactListOptionalparameters?: RTAExecutableParameterListRequired for execution +
Required for execution Result of activation
Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input or output artifact
+Input or output artifact
Optionaldescription?: stringDescription of the signature argument Max Length: 5000.
Optionalkind?: stringKind of the artifact, i.e. model or dataset
Optionallabels?: RTAArtifactLabelListName of the signature argument
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
List of Artifacts that the executable expects as input artifacts
+List of Artifacts that the executable expects as input artifacts
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
List of Artifacts that the executable will produce. If storage is not managed internally, a storage location will have to be specified when triggering an execution
+List of Artifacts that the executable will produce. If storage is not managed internally, a storage location will have to be specified when triggering an execution
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Argument of an executable
+Argument of an executable
Optionaldefault?: stringDefault value of the signature argument
Optionaldescription?: stringDescription of the signature argument Max Length: 5000.
Name of the signature argument
Optionaltype?: "string"Type of the signature argument
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Executable parameters
+Executable parameters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution
+Execution
Timestamp of resource creation Format: "date-time".
OptionalfinishTimestamp?: string | nullTimestamp of execution finish
@@ -22,4 +22,4 @@Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Current status details of the execution
+Current status details of the execution
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Required for execution
+Required for execution
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTALabel' schema.
+Representation of the 'RTALabel' schema.
Target ID of the latest running deployment
+Representation of the 'RTALogCommonData' schema.
+Representation of the 'RTALogCommonData' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A common log query response.
+A common log query response.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTALogCommonResult' schema.
+Representation of the 'RTALogCommonResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Common log record.
+Common log record.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAModelBaseData' schema.
+Representation of the 'RTAModelBaseData' schema.
OptionalaccessType?: stringAccess type of the model
OptionalallowedScenarios?: (List of scenarioId:executuableId pair where the model supported
Description of the model and its capabilities
@@ -6,4 +6,4 @@Name of the model
Optionalprovider?: stringProvider of the model
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Model version information including whether it is latest version, its deprecation status and retirement date
+Model version information including whether it is latest version, its deprecation status and retirement date
Optionalcapabilities?: string[]List of capabilities supported by the model
OptionalcontextLength?: numberContext length of the model
Optionalcost?: Record<string, string>[]List of costs associated with the model
@@ -12,4 +12,4 @@OptionalstreamingSupported?: booleanStreaming support status of the model
OptionalsuggestedReplacements?: string[]List of suggested replacements for the model
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
List of model versions that the model object has
+List of model versions that the model object has
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Result of execution
+Result of execution
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Entity having labels
+Entity having labels
Timestamp of resource creation Format: "date-time".
Optionaldescription?: stringDescription of the scenario @@ -8,4 +8,4 @@
Name of the scenario Max Length: 256.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Client provided reference, with which the status of a PATCHed deployment can be tracked
+message content.
+message content.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TntApiError' schema.
+Representation of the 'TntApiError' schema.
Descriptive error code (not http status code)
Optionaldetails?: Record<string, any>Optional details of the error message
Plaintext error description
OptionalrequestId?: stringID of the individual request
Optionaltarget?: stringInvoked URL
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TntTenantInfo' schema.
+Representation of the 'TntTenantInfo' schema.
Representation of the 'TrckApiError' schema.
+Representation of the 'TrckApiError' schema.
Descriptive error code (not http status code).
Optionaldetails?: TrckDetailsErrorResponse[]plaintext error description
OptionalrequestId?: stringid of individual request
Optionaltarget?: stringurl that has been called
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
large object which provides rendering/semantic information regarding certain metric for consuming application or can be complex metrics in JSON format
+large object which provides rendering/semantic information regarding certain metric for consuming application or can be complex metrics in JSON format
{
* "name": "Confusion Matrix",
* "value": "[{'Predicted': 'False', 'Actual': 'False','value': 34},{'Predicted': 'False','Actual': 'True', 'value': 124}, {'Predicted': 'True','Actual': 'False','value': 165},{ 'Predicted': 'True','Actual': 'True','value': 36}]"
* }
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Message
"[{'Predicted': 'False',\t'Actual': 'False','value': 34},{'Predicted': 'False','Actual': 'True',\t'value': 124}, {'Predicted': 'True','Actual': 'False','value': 165},{\t'Predicted': 'True','Actual': 'True','value': 36}]"
Min Length: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TrckCustomInfoObjectList' schema.
+Representation of the 'TrckCustomInfoObjectList' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TrckDeleteMetricsResponse' schema.
+Representation of the 'TrckDeleteMetricsResponse' schema.
Optionalid?: TrckExecutionIdOptionalmessage?: stringRepresentation of the 'TrckDetailsErrorResponse' schema.
+Representation of the 'TrckDetailsErrorResponse' schema.
Optionalcode?: stringDescriptive error code (not http status code)
Optionalmessage?: stringPlaintext error description
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ID of the deployment/execution
+ID of the deployment/execution
Generic name which can belong to a tag,label,metric or customInfo Object
+Key-value metrics, where the value is numeric. Metric can also have optional step and label fields.
+Key-value metrics, where the value is numeric. Metric can also have optional step and label fields.
Optionallabels?: TrckLabelListOptionalstep?: numberstep is an optional integer that represents any measurement of training progress (number of training iterations, number of epochs, and so on) for the metric
Array of Metric items
+Array of Metric items
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Collection of various metrics/tags/labels associated against some execution/deployment
+Collection of various metrics/tags/labels associated against some execution/deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TrckGetMetricResourceList' schema.
+Representation of the 'TrckGetMetricResourceList' schema.
Optionalcount?: numberNumber of the resource instances in the list
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
a classifying phrase/name applied to a metric
+a classifying phrase/name applied to a metric
Metric Label Value
a list of name-value object pairs associated with some metric.
+a list of name-value object pairs associated with some metric.
Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" is a reserved label to associate an artifact with the metrics
+Label name to label one or more metrics. "metrics.ai.sap.com/Artifact.name" is a reserved label to associate an artifact with the metrics
Key-value metrics, where the value is numeric. Metric can also have optional step and label fields.
+Key-value metrics, where the value is numeric. Metric can also have optional step and label fields.
Optionallabels?: TrckLabelListOptionalstep?: numberstep is an optional integer that represents any measurement of training progress (number of training iterations, number of epochs, and so on) for the metric
Optionaltimestamp?: TrckTimestampOptionaltimestamp?: TrckTimestampArray of Metric items
+Array of Metric items
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Collection of various metrics/tags/labels associated against some execution/deployment
+Collection of various metrics/tags/labels associated against some execution/deployment
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TrckStringArray' schema.
+A dictionary of name-value pairs to support segregation at execution level.
+A dictionary of name-value pairs to support segregation at execution level.
tag value
a list of name-value object pairs associated with the execution/deployment. Tags are queryable.
+a list of name-value object pairs associated with the execution/deployment. Tags are queryable.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Time when the metric was created or logged in RFC3339 format +
Time when the metric was created or logged in RFC3339 format Format: "date-time".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Permissible value for $select could be either * or one or many of the values from metrics, tags, custominfo
+Permissible value for $select could be either * or one or many of the values from metrics, tags, custominfo
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AI Core open source models for chat completion.
+AI Core open source models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AI Core sap managed model for embedding.
+AI Core sap managed model for embedding.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AWS Bedrock models for chat completion.
+AWS Bedrock models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AWS Bedrock models for embedding.
+AWS Bedrock models for embedding.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for chat completion.
+Azure OpenAI models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for embedding.
+Azure OpenAI models for embedding.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The type for parameters in custom request configuration.
+The type for parameters in custom request configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
GCP Vertex AI models for chat completion.
+GCP Vertex AI models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Perplexity models for chat completion.
+Perplexity models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
SAP RPT models.
+SAP RPT models.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ApiError' schema.
+Representation of the 'ApiError' schema.
Descriptive error code (not http status code).
Optionaldetails?: DetailsErrorResponse[]plaintext error description
OptionalrequestId?: stringid of individual request
Optionaltarget?: stringurl that has been called
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Base class for documents, document requests and responses.
+Base class for documents, document requests and responses.
Optionalmetadata?: VectorDocumentKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BasePipelineMinimalResponse' schema.
+Representation of the 'BasePipelineMinimalResponse' schema.
Representation of the 'BasePipelineResponse' schema.
+Representation of the 'BasePipelineResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BinaryBooleanFilter' schema.
+Representation of the 'BinaryBooleanFilter' schema.
Left operand of the boolean expression
Boolean operator for combining filter conditions
Right operand of the boolean expression
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BoostingScoreComputationStrategy' schema.
+Representation of the 'BoostingScoreComputationStrategy' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BoostingScoringConfiguration' schema.
+Representation of the 'BoostingScoringConfiguration' schema.
Optionalenabled?: boolean | nullEnable metadata-based boosting. Default: true.
Optionalmetadata?: Default: [].
OptionalscoreComputationStrategy?: BoostingScoreComputationStrategyOptionalweight?: number | nullContribution to final score. Default: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'Chunk' schema.
+Representation of the 'Chunk' schema.
Optionalmetadata?: KeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A logical grouping of content.
+A logical grouping of content.
Unique identifier of a collection. Format: "uuid".
Optionalmetadata?: VectorKeyValueListPair[]Metadata attached to collection. Useful to restrict search to a subset of collections. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionaltitle?: string | nullOptionaltitle?: string | nullRepresentation of the 'CollectionCreatedResponse' schema.
+Representation of the 'CollectionCreatedResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'CollectionDeletedResponse' schema.
+Representation of the 'CollectionDeletedResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'CollectionPendingResponse' schema.
+Representation of the 'CollectionPendingResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A request for creating a new, single collection.
+A request for creating a new, single collection.
Optionalid?: string | nullUnique identifier of a collection. Format: "uuid".
Optionalmetadata?: VectorKeyValueListPair[]Metadata attached to collection. Useful to restrict search to a subset of collections. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionaltitle?: string | nullOptionaltitle?: string | nullA response containing collections retrieved from the server.
+A response containing collections retrieved from the server.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'CreatePipeline' schema.
+Representation of the 'CreatePipeline' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DataRepositories' schema.
+Representation of the 'DataRepositories' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
DataRepository schema expected by Retrieval.
+DataRepository schema expected by Retrieval.
Unique identifier of this DataRepository. Format: "uuid".
Optionalmessage?: string | nullOptionalmetadata?: RetrievalKeyValueListPair[]Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalremoteGroundingName?: string | nullOptionalremoteGroundingName?: string | nullRepresentation of the 'DataRepositoryMetaDataStrict' schema.
+Representation of the 'DataRepositoryMetaDataStrict' schema.
Representation of the 'DataRepositoryPerFilterSearchResult' schema.
+Representation of the 'DataRepositoryPerFilterSearchResult' schema.
Optionalresults?: DataRepositorySearchResult[]List of returned results. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DataRepositorySearchResult' schema.
+Representation of the 'DataRepositorySearchResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DataRepositorySearchResults' schema.
+Representation of the 'DataRepositorySearchResults' schema.
List of returned results.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Only include DataRepositories with the given type.
+Only include DataRepositories with the given type.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
DataRepository schema returned by the Vector search endpoint
+DataRepository schema returned by the Vector search endpoint
Unique identifier of this DataRepository. Format: "uuid".
Optionalmessage?: string | nullOptional message.
@@ -6,4 +6,4 @@ Default: [].OptionalremoteGroundingName?: string | nullFriendly destination Name (grounding.name) of remote instance.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DenseRetrievalScoringConfiguration' schema.
+Representation of the 'DenseRetrievalScoringConfiguration' schema.
Optionalenabled?: boolean | nullEnable dense retrieval. Default: true.
Optionalweight?: number | nullContribution to final score. Default: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DetailsErrorResponse' schema.
+Representation of the 'DetailsErrorResponse' schema.
Optionalcode?: stringDescriptive error code (not http status code)
Optionalmessage?: stringPlaintext error description
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'Document' schema.
+Representation of the 'Document' schema.
Optionalmetadata?: RetrievalDocumentKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A request to delete documents by their IDs.
+A request to delete documents by their IDs.
List of document IDs to delete Min Items: 1. Max Items: 100.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response after deleting documents in bulk.
+Response after deleting documents in bulk.
List of successfully deleted document IDs
List of document IDs that were not found
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A create request containing one or more new documents to create and store in a collection.
+A create request containing one or more new documents to create and store in a collection.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A single document stored in a collection by ID.
+A single document stored in a collection by ID.
Unique identifier of a document. Format: "uuid".
Optionalmetadata?: VectorDocumentKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentKeyValueListPair' schema.
+Representation of the 'DocumentKeyValueListPair' schema.
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumOptionalmatchMode?: FilterMatchModeEnumRepresentation of the 'DocumentOutput' schema.
+Representation of the 'DocumentOutput' schema.
Format: "uuid".
Optionalmetadata?: VectorDocumentKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A response containing information about a newly created, single document.
+A response containing information about a newly created, single document.
Unique identifier of a document. Format: "uuid".
Optionalmetadata?: VectorDocumentKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentStatus' schema.
+Representation of the 'DocumentStatus' schema.
An update request containing one or more documents to update existing documents in a collection by ID.
+An update request containing one or more documents to update existing documents in a collection by ID.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A single document stored in a collection by ID without exposing its chunks.
+A single document stored in a collection by ID without exposing its chunks.
Unique identifier of a document. Format: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A response containing documents retrieved from the server.
+A response containing documents retrieved from the server.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentsChunk' schema.
+Representation of the 'DocumentsChunk' schema.
Format: "uuid".
Optionalmetadata?: VectorKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A response containing documents retrieved from the server.
+A response containing documents retrieved from the server.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentsStatusResponse' schema.
+Representation of the 'DocumentsStatusResponse' schema.
Optionalcount?: numberOptionalresources?: (Optionalresources?: (Representation of the 'EmbeddingConfig' schema.
+Representation of the 'EmbeddingConfig' schema.
OptionalmodelName?: stringDefault: "text-embedding-ada-002". Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'FilterMatchModeEnum' schema.
+Representation of the 'FilterMatchModeEnum' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GenericError' schema.
+Human-readable error message
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GetPipeline' schema.
+Representation of the 'GetPipeline' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GetPipelineExecutionById' schema.
+Representation of the 'GetPipelineExecutionById' schema.
OptionalcreatedAt?: stringOptionalstatus?: PipelineExecutionStatusOptionalstatus?: PipelineExecutionStatusRepresentation of the 'GetPipelineExecutions' schema.
+Representation of the 'GetPipelineExecutions' schema.
Optionalcount?: numberOptionalresources?: PipelineExecutionData[]Optionalresources?: PipelineExecutionData[]Representation of the 'GetPipelineStatus' schema.
+Representation of the 'GetPipelineStatus' schema.
OptionalcreatedAt?: string | nullOptionalstatus?: PipelineExecutionStatusOptionalstatus?: PipelineExecutionStatusRepresentation of the 'GetPipelines' schema.
+Representation of the 'GetPipelines' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDriveConfig' schema.
+Representation of the 'GoogleDriveConfig' schema.
+OptionalincludePaths?: IncludePathsArrayOptionalresourceId?: stringRepresentation of the 'GoogleDriveConfigurationMinimal' schema.
-Representation of the 'GoogleDriveConfigurationMinimal' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDriveConfigurationStruct' schema.
+Representation of the 'GoogleDriveConfigurationStruct' schema.
Representation of the 'GoogleDriveFolder' schema.
-OptionaldriveId?: stringOptionalid?: stringOptionalincludePaths?: IncludePathsArrayRepresentation of the 'GoogleDriveFolderDetail' schema.
-OptionaldriveId?: stringOptionaldriverType?: "SHARED_FOLDER" | "SHARED_DRIVE"Optionalid?: stringOptionalincludePaths?: IncludePathsArrayRepresentation of the 'GoogleDrivePipelineCreateRequest' schema.
+Representation of the 'GoogleDrivePipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDrivePipelineGetResponse' schema.
+Representation of the 'GoogleDrivePipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDrivePipelineMinimalResponse' schema.
+Representation of the 'GoogleDrivePipelineMinimalResponse' schema.
Optionalconfiguration?: GoogleDriveConfigurationMinimalOptionalmetadata?: booleanRepresentation of the 'GoogleDriveResourceDetail' schema.
+OptionalincludePaths?: IncludePathsArrayOptionalresourceId?: stringOptionalresourceType?: "SHARED_FOLDER" | "SHARED_DRIVE"Representation of the 'HTTPValidationError' schema.
+Representation of the 'HTTPValidationError' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'IncludePathsArray' schema.
+Representation of the 'KeyValueListPair' schema.
+Representation of the 'KeyValueListPair' schema.
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KeyWordRetrievalScoringConfiguration' schema.
+Representation of the 'KeyWordRetrievalScoringConfiguration' schema.
Optionalenabled?: boolean | nullEnable dense retrieval. Default: true.
OptionalextractKeyWordsFromQuery?: boolean | nullExtract Keywords from Query.
Optionalweight?: number | nullContribution to final score. Default: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointConfiguration' schema.
+Representation of the 'MSSharePointConfiguration' schema.
OptionalcronExpression?: stringRepresentation of the 'MSSharePointConfigurationGetResponse' schema.
+Representation of the 'MSSharePointConfigurationGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointConfigurationMinimal' schema.
+Representation of the 'MSSharePointConfigurationMinimal' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineCreateRequest' schema.
+Representation of the 'MSSharePointPipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineGetResponse' schema.
+Representation of the 'MSSharePointPipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineMinimalResponse' schema.
+Representation of the 'MSSharePointPipelineMinimalResponse' schema.
Optionalmetadata?: booleanRepresentation of the 'ManualPipelineTrigger' schema.
+Representation of the 'ManualPipelineTrigger' schema.
The MergeStrategyReranker will call a reranker LLM to merge the given PerFilterSearchResult instances. This strategy adds latency, but yields good results.
+The MergeStrategyReranker will call a reranker LLM to merge the given PerFilterSearchResult instances. This strategy adds latency, but yields good results.
Optionalboosting?: Key-value pairs to be included in the ranking process, to boost related chunks according to chunk content and metadata, if includeMetaData is true.
OptionalincludeAllMetaData?: boolean | nullIf true, document and chunk metadata are sent to the reranker LLM along with the text content of the chunk.
Optionalmodel?: "cohere-3.5" | nullThe RerankerModel to use. Default: "cohere-3.5".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionaltype?: MergeStrategyTypeOptionaltype?: MergeStrategyTypeThe MergeStrategyScoreReuse merges the given PerFilterSearchResult instances according to the scores returned by the downstream retrieval process. It is important that the scores are comparable, meaning they should come from the same embedding model or reranker model.
+The MergeStrategyScoreReuse merges the given PerFilterSearchResult instances according to the scores returned by the downstream retrieval process. It is important that the scores are comparable, meaning they should come from the same embedding model or reranker model.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MergeStrategyType' schema.
+Representation of the 'MergeStrategyType' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaData' schema.
+Representation of the 'MetaData' schema.
OptionaldataRepositoryMetadata?: ({ key: string; value: string[] } & Record<string, any>)[]Representation of the 'MetaDataKeyValuePairStrict' schema.
+Representation of the 'MetaDataKeyValuePairStrict' schema.
Max Length: 1024. Min Length: 1.
Min Items: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataConfiguration' schema.
+Representation of the 'MetadataConfiguration' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataConfigurationStruct' schema.
+Representation of the 'MetadataConfigurationStruct' schema.
Representation of the 'MetadataItem' schema.
+Representation of the 'MetadataItem' schema.
ID of collection Format: "uuid".
Optionalmetadata?: VectorKeyValueListPair[] | nullList of metadata of the collections or documents or chunks Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataKeyUpdate' schema.
+Representation of the 'MetadataKeyUpdate' schema.
Key to update Min Length: 1.
Optionaloperations?: MetadataOperation[] | nullUpdate operation executed for the key
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataOperation' schema.
+Representation of the 'MetadataOperation' schema.
Optionalvalues?: string[] | nullList of values to update.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataOperationEnum' schema.
+Representation of the 'MetadataOperationEnum' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataResponse' schema.
+Representation of the 'MetadataResponse' schema.
Optionalcurrent_metadata?: MetadataItem[] | nullList of metadata after updates. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataUpdateItem' schema.
+Representation of the 'MetadataUpdateItem' schema.
List of collection or document or chunk ids for which the metadata should be updated
List of metadata updates for the given resource ids
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataUpdates' schema.
+Representation of the 'MetadataUpdates' schema.
List of metadata updates.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PatchPipeline' schema.
+Representation of the 'PatchPipeline' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PerFilterSearchResult' schema.
+Representation of the 'PerFilterSearchResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Error message if any.
+Error message if any.
Default: "Unknown Error Occurred".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PerFilterSearchResultWithError' schema.
+Representation of the 'PerFilterSearchResultWithError' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PipelineDocumentResponse' schema.
+Representation of the 'PipelineDocumentResponse' schema.
Representation of the 'PipelineExecutionData' schema.
+Representation of the 'PipelineExecutionData' schema.
OptionalcreatedAt?: string | nullOptionalstatus?: PipelineExecutionStatusOptionalstatus?: PipelineExecutionStatusRepresentation of the 'PipelineExecutionStatus' schema.
+Representation of the 'PipelineExecutionStatus' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PipelineId' schema.
+Representation of the 'PipelineMinimalResponse' schema.
+Representation of the 'PipelineMinimalResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PostProcessingObjectReference' schema.
+Representation of the 'PostProcessingObjectReference' schema.
Optionalid?: string | nullPerFilterSearchResult ID or PostProcessingOperation ID. Default: "6d3eeafd-f3db-4e8e-949a-0e40e50eab64".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PostProcessingOperation' schema.
+Representation of the 'PostProcessingOperation' schema.
Optionalid?: string | nullNew ID for each PostProcessingOperation. Default: "ae9eee48-4671-4321-a3e5-640adaaf26ae".
OptionalmaxChunkCount?: number | nullMaximum number of chunks to be retained in final PerSearchFilterResult. @@ -6,4 +6,4 @@ Maximum: 10000000.
Merging and scoring strategy to derive final PerSearchFilterResult.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalBinaryBooleanFilter' schema.
+Representation of the 'RetrievalBinaryBooleanFilter' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalChunk' schema.
+Representation of the 'RetrievalChunk' schema.
Optionalmetadata?: RetrievalKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalpostProcessingScore?: ScoreOptionalsearchScores?: SearchScoresOptionalpostProcessingScore?: ScoreOptionalsearchScores?: SearchScoresRepresentation of the 'RetrievalDataRepositorySearchResult' schema.
+Representation of the 'RetrievalDataRepositorySearchResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalDocumentKeyValueListPair' schema.
+Representation of the 'RetrievalDocumentKeyValueListPair' schema.
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumOptionalmatchMode?: FilterMatchModeEnumRepresentation of the 'RetrievalKeyValueListPair' schema.
+Representation of the 'RetrievalKeyValueListPair' schema.
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalPerFilterSearchResult' schema.
+Representation of the 'RetrievalPerFilterSearchResult' schema.
OptionalremoteGroundingName?: string | nullFriendly Destination Name of remote instance (grounding.name). Only present if dataRepositoryType = remote:dg.
Optionalresults?: RetrievalDataRepositorySearchResult[]List of returned results. Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Error message if any.
+Error message if any.
Default: "Unknown Error Occurred".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalPerFilterSearchResultWithError' schema.
+Representation of the 'RetrievalPerFilterSearchResultWithError' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalScopedKeyValueListPair' schema.
+Representation of the 'RetrievalScopedKeyValueListPair' schema.
Max Length: 1024.
Optionalscope?: "repository" | "document" | "chunk"Default: "document".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalSearchConfiguration' schema. +
Representation of the 'RetrievalSearchConfiguration' schema. Default: {}.
OptionalmaxChunkCount?: number | nullMaximum number of chunks to be returned. Cannot be used with 'maxDocumentCount'. Maximum: 10000000.
OptionalmaxDocumentCount?: number | null[Only supports 'vector' dataRepositoryType] - Maximum number of documents to be returned. Cannot be used with 'maxChunkCount'. If maxDocumentCount is given, then only one chunk per document is returned. Maximum: 10000000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalSearchDocumentKeyValueListPair' schema.
+Representation of the 'RetrievalSearchDocumentKeyValueListPair' schema.
Max Length: 1024.
OptionalselectMode?: RetrievalSearchSelectOptionEnum[] | nullSelect mode for search filters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Limit scope of search to certain DataRepositories, Documents or Chunks.
+Limit scope of search to certain DataRepositories, Documents or Chunks.
OptionalchunkMetadata?: RetrievalKeyValueListPair[]Restrict chunks considered during search to those with the given metadata. Default: [].
OptionaldataRepositories?: string[]Specify [''] to search across all DataRepositories or give a specific list of DataRepository ids. @@ -12,4 +12,4 @@
Identifier of this RetrievalSearchFilter - unique per request.
OptionalremoteName?: string | nullDestination Name of remote instance.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalsearchConfiguration?: RetrievalSearchConfigurationOptionalsearchConfiguration?: RetrievalSearchConfigurationRepresentation of the 'RetrievalSearchInput' schema.
+Representation of the 'RetrievalSearchInput' schema.
OptionalpostProcessing?: (List of operations to be performed across PerFilterSearchResults. Default: [].
Query string Min Length: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalSearchResults' schema.
+Representation of the 'RetrievalSearchResults' schema.
List of returned results.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalSearchSelectOptionEnum' schema.
+Representation of the 'RetrievalSearchSelectOptionEnum' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalVectorSearchFilter' schema.
+Representation of the 'RetrievalVectorSearchFilter' schema.
OptionalchunkMetadata?: RetrievalKeyValueListPair[]Restrict chunks considered during search to those with the given metadata. Default: [].
OptionaldataRepositories?: string[]Specify [''] to search across all DataRepositories or give a specific list of DataRepository ids. @@ -13,4 +13,4 @@
Identifier of this RetrievalSearchFilter - unique per request.
OptionalremoteName?: string | nullDestination Name of remote instance.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalscoringConfiguration?: VectorScoringConfigurationOptionalsearchConfiguration?: RetrievalSearchConfigurationOptionalscoringConfiguration?: VectorScoringConfigurationOptionalsearchConfiguration?: RetrievalSearchConfigurationRepresentation of the 'S3Configuration' schema.
+Representation of the 'S3Configuration' schema.
OptionalcronExpression?: stringOptionals3?: { includePaths?: IncludePathsArray } & Record<string, any>Optionals3?: { includePaths?: IncludePathsArray } & Record<string, any>Representation of the 'S3ConfigurationMinimal' schema.
+Representation of the 'S3ConfigurationMinimal' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineCreateRequest' schema.
+Representation of the 'S3PipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineGetResponse' schema.
+Representation of the 'S3PipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineMinimalResponse' schema.
+Representation of the 'S3PipelineMinimalResponse' schema.
Optionalconfiguration?: S3ConfigurationMinimalOptionalmetadata?: booleanRepresentation of the 'SDMPipelineCreateRequest' schema.
+Representation of the 'SDMPipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SDMPipelineGetResponse' schema.
+Representation of the 'SDMPipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SDMPipelineMinimalResponse' schema.
+Representation of the 'SDMPipelineMinimalResponse' schema.
Representation of the 'SFTPConfiguration' schema.
+Representation of the 'SFTPConfiguration' schema.
OptionalcronExpression?: stringOptionalsftp?: { includePaths?: IncludePathsArray } & Record<string, any>Optionalsftp?: { includePaths?: IncludePathsArray } & Record<string, any>Representation of the 'SFTPConfigurationMinimal' schema.
+Representation of the 'SFTPConfigurationMinimal' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineCreateRequest' schema.
+Representation of the 'SFTPPipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineGetResponse' schema.
+Representation of the 'SFTPPipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineMinimalResponse' schema.
+Representation of the 'SFTPPipelineMinimalResponse' schema.
Optionalconfiguration?: SFTPConfigurationMinimalOptionalmetadata?: booleanRepresentation of the 'ScopedKeyValueListPair' schema.
+Representation of the 'ScopedKeyValueListPair' schema.
Max Length: 1024.
Optionalscope?: "collection" | "document" | "chunk"Scope of the metadata filter (e.g., collection, document, chunk) Default: "document".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'Score' schema.
+Representation of the 'Score' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ScoresAggregationStrategy' schema.
+Representation of the 'ScoresAggregationStrategy' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchConfiguration' schema.
+Representation of the 'SearchConfiguration' schema.
OptionalmaxChunkCount?: number | nullMaximum number of chunks to be returned. Cannot be used with 'maxDocumentCount'.
OptionalmaxDocumentCount?: number | null[Only supports 'vector' dataRepositoryType] - Maximum number of documents to be returned. Cannot be used with 'maxChunkCount'. If maxDocumentCount is given, then only one chunk per document is returned.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchDocumentKeyValueListPair' schema.
+Representation of the 'SearchDocumentKeyValueListPair' schema.
Max Length: 1024.
OptionalselectMode?: SearchSelectOptionEnum[]Select mode for search filters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchFilter' schema.
+Representation of the 'SearchFilter' schema.
OptionalchunkMetadata?: KeyValueListPair[]Restrict chunks considered during search to those with the given metadata. Default: []. Max Items: 2000.
@@ -10,4 +10,4 @@ Max Items: 2000.Identifier of this SearchFilter - unique per request.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchPipeline' schema.
+Representation of the 'SearchPipeline' schema.
OptionaldataRepositoryMetadata?: ({ key: string; value: string[] } & Record<string, any>)[]Search for metadata happens at key level. Pipelines matching the search criteria will be returned.
Representation of the 'SearchPipelinesResponse' schema.
+Representation of the 'SearchPipelinesResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchResults' schema.
+Representation of the 'SearchResults' schema.
List of returned results.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchScores' schema.
+Representation of the 'SearchScores' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchSelectOptionEnum' schema. +
Representation of the 'SearchSelectOptionEnum' schema. Default: "ignoreIfKeyAbsent".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ServiceNowConfig' schema.
+Representation of the 'ServiceNowConfig' schema.
Representation of the 'ServiceNowConfigurationMinimal' schema.
+Representation of the 'ServiceNowConfigurationMinimal' schema.
OptionalserviceRepresentation of the 'ServiceNowConfigurationStruct' schema.
+Representation of the 'ServiceNowConfigurationStruct' schema.
OptionalcronExpression?: stringOptional cron expression for scheduling pipeline execution. Must represent an interval greater than 1 hour.
OptionalserviceNow?: ServiceNowConfigOptionalserviceNow?: ServiceNowConfigRepresentation of the 'ServiceNowPipelineCreateRequest' schema.
+Representation of the 'ServiceNowPipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ServiceNowPipelineGetResponse' schema.
+Representation of the 'ServiceNowPipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ServiceNowPipelineMinimalResponse' schema.
+Representation of the 'ServiceNowPipelineMinimalResponse' schema.
Representation of the 'SharePointConfig' schema.
+Representation of the 'SharePointConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SharePointConfigGetResponse' schema.
+Representation of the 'SharePointConfigGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SharePointSite' schema.
+Representation of the 'SharePointSite' schema.
OptionalincludePaths?: IncludePathsArrayRepresentation of the 'SharePointSiteDetail' schema.
+Representation of the 'SharePointSiteDetail' schema.
Representation of the 'SharePointSiteGetResponse' schema.
+Representation of the 'SharePointSiteGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Schema for a text-only chunk.
+Schema for a text-only chunk.
Unique identifier of a chuk. Format: "uuid".
Optionalmetadata?: VectorKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Schema for a text-only chunk.
+Schema for a text-only chunk.
Optionalmetadata?: VectorKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TextSearchRequest' schema.
+Representation of the 'TextSearchRequest' schema.
Query string Max Length: 2000. Min Length: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ValidationError' schema.
+Representation of the 'ValidationError' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorChunk' schema.
+Representation of the 'VectorChunk' schema.
Optionalmetadata?: VectorKeyValueListPair[]Default: [].
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorDocumentKeyValueListPair' schema.
+Representation of the 'VectorDocumentKeyValueListPair' schema.
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumOptionalmatchMode?: FilterMatchModeEnumCollection metadata during ingestion
+Collection metadata during ingestion
Max Length: 1024.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorPerFilterSearchResult' schema.
+Representation of the 'VectorPerFilterSearchResult' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorScoringConfiguration' schema.
+Representation of the 'VectorScoringConfiguration' schema.
OptionalaggregationStrategy?: ScoresAggregationStrategyOptionalboosting?: BoostingScoringConfigurationOptionaldenseRetrieval?: DenseRetrievalScoringConfigurationOptionalkeywordRetrieval?: KeyWordRetrievalScoringConfigurationOptionalscoreThreshold?: number | nullMinimum chunk score threshold.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchConfiguration' schema.
+Representation of the 'VectorSearchConfiguration' schema.
OptionalmaxChunkCount?: number | nullMaximum number of chunks to be returned. Cannot be used with 'maxDocumentCount'. Maximum: 10000000.
OptionalmaxDocumentCount?: number | null[Only supports 'vector' dataRepositoryType] - Maximum number of documents to be returned. Cannot be used with 'maxChunkCount'. If maxDocumentCount is given, then only one chunk per document is returned. Maximum: 10000000.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchDocumentKeyValueListPair' schema.
+Representation of the 'VectorSearchDocumentKeyValueListPair' schema.
Max Length: 1024.
OptionalselectMode?: VectorSearchSelectOptionEnum[] | nullSelect mode for search filters
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchFilter' schema.
+Representation of the 'VectorSearchFilter' schema.
OptionalchunkMetadata?: VectorKeyValueListPair[]Restrict chunks considered during search to those with the given metadata. Default: [].
OptionalcollectionMetadata?: VectorKeyValueListPair[] | nullRestrict collections considered during search to those annotated with the given metadata. Useful when combined with collections=['*'] @@ -8,4 +8,4 @@
Optionalfilter?: BinaryBooleanFilter | ScopedKeyValueListPair | nullAdvanced filter expression for combining metadata filters with boolean logic
Identifier of this VectorSearchFilter - unique per request.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchResults' schema.
+Representation of the 'VectorSearchResults' schema.
List of returned results.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchSelectOptionEnum' schema.
+Representation of the 'VectorSearchSelectOptionEnum' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineCreateRequest' schema.
+Representation of the 'WorkZonePipelineCreateRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineGetResponse' schema.
+Representation of the 'WorkZonePipelineGetResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineMinimalResponse' schema.
+Representation of the 'WorkZonePipelineMinimalResponse' schema.
Azure OpenAI chat completion input parameters.
+Azure OpenAI chat completion input parameters.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiChatCompletionRequestAssistantMessage' schema.
+Representation of the 'AzureOpenAiChatCompletionRequestAssistantMessage' schema.
Optionalcontent?: string | AzureOpenAiChatCompletionRequestAssistantMessageContentPart[] | nullThe contents of the assistant message. Required unless tool_calls or function_call is specified.
Optionalfunction_call?: { arguments: string; name: string } & Record<string, any> | nullDeprecated and replaced by tool_calls. The name and arguments of a function that should be called, as generated by the model.
Optionalname?: stringAn optional name for the participant. Provides the model information to differentiate between participants of the same role.
Optionalrefusal?: string | nullThe refusal message by the assistant.
The role of the messages author, in this case assistant.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionaltool_calls?: AzureOpenAiChatCompletionMessageToolCallsOptionaltool_calls?: AzureOpenAiChatCompletionMessageToolCallsRepresentation of the 'AzureOpenAiChatCompletionRequestMessage' schema.
+Representation of the 'AzureOpenAiChatCompletionRequestMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiChatCompletionRequestSystemMessage' schema.
+Representation of the 'AzureOpenAiChatCompletionRequestSystemMessage' schema.
The contents of the system message.
Optionalname?: stringAn optional name for the participant. Provides the model information to differentiate between participants of the same role.
The role of the messages author, in this case system.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiChatCompletionRequestToolMessage' schema.
+Representation of the 'AzureOpenAiChatCompletionRequestToolMessage' schema.
The contents of the tool message.
The role of the messages author, in this case tool.
Tool call that this message is responding to.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiChatCompletionRequestUserMessage' schema.
+Representation of the 'AzureOpenAiChatCompletionRequestUserMessage' schema.
The contents of the user message.
Optionalname?: stringAn optional name for the participant. Provides the model information to differentiate between participants of the same role.
The role of the messages author, in this case user.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiChatCompletionTool' schema.
+Representation of the 'AzureOpenAiChatCompletionTool' schema.
The type of the tool. Currently, only function is supported.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for chat completion.
+Azure OpenAI models for chat completion.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for embedding.
+Azure OpenAI models for embedding.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI embedding input parameters.
+Azure OpenAI embedding input parameters.
Optionaldimensions?: number | nullThe number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.
Optionaluser?: stringA unique identifier representing your end-user, which can help monitoring and detecting abuse.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AzureOpenAiFunctionObject' schema.
+Representation of the 'AzureOpenAiFunctionObject' schema.
Optionaldescription?: stringA description of what the function does, used by the model to choose when and how to call the function.
The name of the function to be called. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64.
Optionalparameters?: AzureOpenAiFunctionParametersOptionalstrict?: boolean | nullWhether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Call options for the AzureOpenAiChatClient.
+Call options for the AzureOpenAiChatClient.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input type for AzureOpenAiChatClient initialization.
+Input type for AzureOpenAiChatClient initialization.
Optionalstreaming?: booleanWhether the model should automatically stream responses when using invoke().
If disableStreaming is set to true, this option will be ignored.
If streaming is explicitly set to false, disableStreaming will be set to true.
OptionalsupportsStrictToolCalling?: booleanWhether the model supports the strict argument when passing in tools.
If undefined the strict argument will not be passed to OpenAI.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input type for AzureOpenAiEmbeddingClient initialization.
+Input type for AzureOpenAiEmbeddingClient initialization.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Tool type for LangChain Azure OpenAI client.
+Tool type for LangChain Azure OpenAI client.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Tool type for LangChain Orchestration client.
+Tool type for LangChain Orchestration client.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Langchain parameters for OrchestrationClient constructor langchainOptions argument.
Langchain parameters for OrchestrationClient constructor langchainOptions argument.
Optionalstreaming?: booleanWhether the model should automatically stream responses when using invoke().
If disableStreaming is set to true, this option will be ignored.
If streaming is explicitly set to false, disableStreaming will be set to true.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration module configuration for LangChain.
+Orchestration module configuration for LangChain.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Options for an orchestration call.
+Options for an orchestration call.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AssistantChatMessage' schema.
+Representation of the 'AssistantChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Parameters for Azure content safety filters.
+Parameters for Azure content safety filters.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Filter return type for Azure Content Safety.
+Filter return type for Azure Content Safety.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The Azure threshold level supported for each azure content filter category.
+The Azure threshold level supported for each azure content filter category.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatCompletionTool' schema.
+Representation of the 'ChatMessage' schema.
+Representation of the 'ChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessageContent' schema.
+Representation of the 'ChatMessageContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessages' schema.
+Representation of the 'ChatMessages' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Supported chat models for orchestration.
+Supported chat models for orchestration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'Citation' schema.
+Representation of the 'Citation' schema.
Optionalend_index?: numberEnd index of the citation in the response text
Optionalref_id?: numberUnique identifier for inline citation
Optionalstart_index?: numberStart index of the citation in the response text
Title of the citation
URL of the citation
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents a filter configuration for the Document Grounding Service.
+Represents a filter configuration for the Document Grounding Service.
Optionaldata_repository_type?: DataRepositoryTypeDefines the type of data repository. If not set, the default value is 'vector'.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents the configuration for the masking provider SAP Data Privacy Integration.
+Represents the configuration for the masking provider SAP Data Privacy Integration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DpiConfig' schema.
+Representation of the 'DpiConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Supported embedding models for orchestration.
+Supported embedding models for orchestration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding model details.
+Embedding model details.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding model parameters.
+Embedding model parameters.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'FileContent' schema.
+Representation of the 'FileContent' schema.
Representation of the 'FunctionObject' schema.
+Representation of the 'FunctionObject' schema.
OptionalparametersOptionalstrictWhether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The filter categories supported for Llama Guard 3 8B filter.
+The filter categories supported for Llama Guard 3 8B filter.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Filter return type for Llama Guard 3 8B.
+Filter return type for Llama Guard 3 8B.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input filter configuration for Llama Guard 3 8B.
+Input filter configuration for Llama Guard 3 8B.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output filter configuration for Llama Guard 3 8B.
+Output filter configuration for Llama Guard 3 8B.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
LLM model details.
+LLM model details.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Model Parameters for LLM module configuration.
+Model Parameters for LLM module configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Shared stream options applied to all module configurations.
+Shared stream options applied to all module configurations.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Reference to an orchestration configuration created via the Prompt Registry API. +
Reference to an orchestration configuration created via the Prompt Registry API. Use this to reference a pre-configured orchestration setup without defining the full configuration in code. The configuration must be created via the Prompt Registry API before it can be referenced. @@ -10,4 +10,4 @@
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'Error' schema.
+Representation of the 'Error' schema.
Orchestration error response.
+Orchestration error response.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Non-empty list of orchestration module configurations for module fallback. +
Non-empty list of orchestration module configurations for module fallback. The orchestration service will try each configuration in order until one succeeds.
Representation of the 'Template' schema.
+Representation of the 'Template' schema.
Optionaltemplate?: TemplatingChatMessageA chat message array to be formatted with values from placeholderValues.
Both role and content can use {{?variable}} placeholders.
For dynamic templating (changing per request), pass templated messages directly in .chatCompletion({ messages }).
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Stream options for orchestration requests. +
Stream options for orchestration requests. Either shared stream options for every module configuration or stream options with per-config overrides for module fallback.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Stream options with support for per-config overrides in module fallback scenarios. +
Stream options with support for per-config overrides in module fallback scenarios.
The overrides property allows you to specify stream options that apply to specific module configurations by their index in the fallback list.
If an override is not provided for a config, it will use the shared options defined in BaseStreamOptions.
Overrides do not merge with shared options.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ToolChatMessage' schema.
+Representation of the 'ToolChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Category for translation application scope.
+Category for translation application scope.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Parameters for translation configurations.
+Parameters for translation configurations.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input configuration for translation module.
+Input configuration for translation module.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input parameters for translation input configuration.
+Input parameters for translation input configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output configuration for translation module.
+Output configuration for translation module.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output parameters for translation output configuration.
+Output parameters for translation output configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Return type for translation configurations.
+Return type for translation configurations.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Target language for translation, either a language code or a selector configuration.
+Target language for translation, either a language code or a selector configuration.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContent' schema.
+Representation of the 'UserChatMessageContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContentItem' schema.
+Representation of the 'UserChatMessageContentItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AssistantChatMessage' schema.
+Representation of the 'AssistantChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Filter configuration for Azure Content Safety
+Filter configuration for Azure Content Safety
Optionalself_OptionalsexualOptionalviolenceRepresentation of the 'AzureContentSafetyInputFilterConfig' schema.
+Representation of the 'AzureContentSafetyInputFilterConfig' schema.
Filter configuration for Azure Content Safety
+Filter configuration for Azure Content Safety
OptionalhateOptionalprotected_Detect protected code content from known GitHub repositories. The scan includes software libraries, source code, algorithms, and other proprietary programming content.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalself_OptionalsexualOptionalviolenceOptionalself_OptionalsexualOptionalviolenceRepresentation of the 'AzureContentSafetyOutputFilterConfig' schema.
+Representation of the 'AzureContentSafetyOutputFilterConfig' schema.
Representation of the 'AzureThreshold' schema.
+Representation of the 'AzureThreshold' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatCompletionTool' schema.
+Representation of the 'ChatMessage' schema.
+Representation of the 'ChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessageContent' schema.
+Representation of the 'ChatMessageContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DPIConfig' schema.
+Representation of the 'DPIConfig' schema.
Type of masking method to be used
Type of masking service provider
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DPICustomEntity' schema.
+Default entities supported by data privacy and integration service
+Default entities supported by data privacy and integration service
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DPIEntityConfig' schema.
+Representation of the 'DPIEntityConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Replaces the entity with the specified value followed by an incrementing number
+Replaces the entity with the specified value followed by an incrementing number
Replaces the entity with a randomly generated value appropriate to its type.
+Replaces the entity with a randomly generated value appropriate to its type.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DPIStandardEntity' schema.
+Representation of the 'DPIStandardEntity' schema.
Only include DataRepositories with the given type.
+Only include DataRepositories with the given type.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentGroundingFilter' schema.
+Representation of the 'DocumentGroundingFilter' schema.
Optionaldata_Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*']
Optionaldocument_Restrict documents considered during search to those annotated with the given metadata.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalidOptionalsearch_OptionalidOptionalsearch_Representation of the 'ErrorResponse' schema.
+Representation of the 'ErrorResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'FileContent' schema.
+Representation of the 'FileContent' schema.
Representation of the 'FilteringModuleConfig' schema.
+Stream options for output filtering. Will be ignored if stream is false.
+Stream options for output filtering. Will be ignored if stream is false.
Representation of the 'FunctionObject' schema.
+Representation of the 'FunctionObject' schema.
OptionalparametersOptionalstrictWhether to enable strict schema adherence when generating the function call. If set to true, the model will follow the exact schema defined in the parameters field. Only a subset of JSON Schema is supported when strict is true. Learn more about Structured Outputs in the function calling guide.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. Omitting parameters defines a function with an empty parameter list.
The parameters the functions accepts, described as a JSON Schema object. See the guide for examples, and the JSON Schema reference for documentation about the format. Omitting parameters defines a function with an empty parameter list.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Options for streaming. Will be ignored if enabled is false.
+Identifier of this SearchFilter - unique per request.
+Identifier of this SearchFilter - unique per request.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GroundingFilterSearchConfiguration' schema.
+Representation of the 'GroundingFilterSearchConfiguration' schema.
Optionalmax_Maximum number of chunks to be returned. Cannot be used with 'maxDocumentCount'.
Optionalmax_[Only supports 'vector' dataRepositoryType] - Maximum number of documents to be returned. Cannot be used with 'maxChunkCount'. If maxDocumentCount is given, then only one chunk per document is returned.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GroundingModuleConfig' schema.
+Representation of the 'GroundingModuleConfig' schema.
Optionalfilters?: DocumentGroundingFilter[]Document grounding service filters to be used
@@ -14,4 +14,4 @@Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ImageContent' schema.
+Representation of the 'ImageContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'InputFilterConfig' schema.
+Representation of the 'InputFilterConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'InputFilteringConfig' schema.
+Representation of the 'InputFilteringConfig' schema.
The model and parameters to be used for the prompt templating. This is the model that will be used to generate the response.
+The model and parameters to be used for the prompt templating. This is the model that will be used to generate the response.
Filter configuration for Llama Guard 3 8B
+Filter configuration for Llama Guard 3 8B
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalchild_Optionalcode_OptionaldefamationOptionalelectionsOptionalhateOptionalindiscriminate_Optionalintellectual_Optionalnon_OptionalprivacyOptionalself_Optionalsex_Optionalsexual_Optionalspecialized_Optionalviolent_Optionalchild_Optionalcode_OptionaldefamationOptionalelectionsOptionalhateOptionalindiscriminate_Optionalintellectual_Optionalnon_OptionalprivacyOptionalself_Optionalsex_Optionalsexual_Optionalspecialized_Optionalviolent_Representation of the 'LlamaGuard38BFilterConfig' schema.
+Representation of the 'MaskingModuleConfig' schema.
+Representation of the 'MaskingModuleConfig' schema.
List of masking service providers Min Items: 1.
List of masking service providers. DEPRECATED: will be removed Sept 15, 2026. Use providers property instead.
Representation of the 'MaskingProviderConfig' schema.
+Representation of the 'MaskingProviderConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MessageToolCall' schema.
+Representation of the 'MessageToolCall' schema.
The function that the model called.
The ID of the tool call.
The type of the tool. Currently, only function is supported.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The tool calls generated by the model, such as function calls.
+The tool calls generated by the model, such as function calls.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ModuleConfigs' schema.
+Representation of the 'ModuleConfigs' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A list of module configurations. The first configuration in the list that succeeds will be used.
+A list of module configurations. The first configuration in the list that succeeds will be used.
Min Items: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MultiChatContent' schema.
+Representation of the 'MultiChatContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfig' schema.
+Representation of the 'OrchestrationConfig' schema.
Representation of the 'OrchestrationConfigDeleteResponse' schema.
+Representation of the 'OrchestrationConfigDeleteResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfigGetResponse' schema.
+Representation of the 'OrchestrationConfigGetResponse' schema.
Optionalcreation_timestamp?: stringFormat: "timestamp".
Optionalid?: stringFormat: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalis_version_head?: booleanOptionalmanaged_by?: stringOptionalname?: stringOptionalresource_group_id?: stringOptionalscenario?: stringOptionalspec?: OrchestrationConfigOptionalversion?: stringOptionalis_version_head?: booleanOptionalmanaged_by?: stringOptionalname?: stringOptionalresource_group_id?: stringOptionalscenario?: stringOptionalspec?: OrchestrationConfigOptionalversion?: stringRepresentation of the 'OrchestrationConfigListResponse' schema.
+Representation of the 'OrchestrationConfigListResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfigPostRequest' schema.
+Representation of the 'OrchestrationConfigPostRequest' schema.
Max Length: 120. Pattern: "^[a-zA-Z0-9_-]+$".
Max Length: 120. @@ -6,4 +6,4 @@
Max Length: 10. Pattern: "^[a-zA-Z0-9._-]+$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfigPostResponse' schema.
+Representation of the 'OrchestrationConfigPostResponse' schema.
Format: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfigResource' schema.
+Representation of the 'OrchestrationConfigResource' schema.
Optionalcreation_timestamp?: stringFormat: "timestamp".
Optionalid?: stringFormat: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalis_version_head?: booleanOptionalmanaged_by?: stringOptionalname?: stringOptionalresource_group_id?: stringOptionalscenario?: stringOptionalspec?: OrchestrationConfigOptionalversion?: stringOptionalis_version_head?: booleanOptionalmanaged_by?: stringOptionalname?: stringOptionalresource_group_id?: stringOptionalscenario?: stringOptionalspec?: OrchestrationConfigOptionalversion?: stringRepresentation of the 'OutputFilterConfig' schema.
+Representation of the 'OutputFilterConfig' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OutputFilteringConfig' schema.
+Representation of the 'OutputFilteringConfig' schema.
Optionalstream_Representation of the 'PromptTemplate' schema.
+Representation of the 'PromptTemplate' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateDeleteResponse' schema.
+Representation of the 'PromptTemplateDeleteResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateGetResponse' schema.
+Representation of the 'PromptTemplateGetResponse' schema.
OptionalcreationTimestamp?: stringFormat: "timestamp".
Optionalid?: stringFormat: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalisVersionHead?: booleanOptionalmanagedBy?: stringOptionalname?: stringOptionalresourceGroupId?: stringOptionalscenario?: stringOptionalspec?: PromptTemplateSpecOptionalversion?: stringOptionalisVersionHead?: booleanOptionalmanagedBy?: stringOptionalname?: stringOptionalresourceGroupId?: stringOptionalscenario?: stringOptionalspec?: PromptTemplateSpecOptionalversion?: stringRepresentation of the 'PromptTemplateListResponse' schema.
+Representation of the 'PromptTemplateListResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplatePostRequest' schema.
+Representation of the 'PromptTemplatePostRequest' schema.
Max Length: 120. Pattern: "^[a-zA-Z0-9_-]+$".
Max Length: 120. @@ -6,4 +6,4 @@
Max Length: 10. Pattern: "^[a-zA-Z0-9._-]+$".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplatePostResponse' schema.
+Representation of the 'PromptTemplatePostResponse' schema.
Format: "uuid".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateSpec' schema.
+Representation of the 'PromptTemplateSpec' schema.
OptionaladditionalFields?: Record<string, any>DEPRECATED. Please use additional_fields instead.
Optionaldefaults?: Record<string, any>Optionalresponse_format?: ResponseFormatText | ResponseFormatJsonObject | ResponseFormatJsonSchemaResponse format that the model output should adhere to. This is the same as the OpenAI definition. Compatible with GPT-4o, GPT-4o mini, GPT-4 (Turbo) and all GPT-3.5 Turbo models newer than gpt-3.5-turbo-1106.
Optionaltools?: ChatCompletionTool[]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.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateSubstitutionRequest' schema.
+Representation of the 'PromptTemplateSubstitutionRequest' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateSubstitutionResponse' schema.
+Representation of the 'PromptTemplateSubstitutionResponse' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplatingModuleConfig' schema.
+Representation of the 'PromptTemplatingModuleConfig' schema.
Representation of the 'ResponseFormatJsonObject' schema.
+Representation of the 'ResponseFormatJsonObject' schema.
Representation of the 'ResponseFormatJsonSchema' schema.
+Representation of the 'ResponseFormatJsonSchema' schema.
Optionaldescription?: stringA description of what the response format is for, used by the model to determine how to respond in the format.
@@ -8,4 +8,4 @@Optionalschema?: ResponseFormatJsonSchemaSchemaOptionalstrict?: boolean | nullWhether to enable strict schema adherence when generating the output. If set to true, the model will always follow the exact schema defined in the schema field. Only a subset of JSON Schema is supported when strict is true. To learn more, read the Structured Outputs guide.
The type of response format being defined: json_schema
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The schema for the response format, described as a JSON Schema object.
+The schema for the response format, described as a JSON Schema object.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ResponseFormatText' schema.
+Representation of the 'RuntimeOrchestrationConfigFile' schema.
+Representation of the 'RuntimeOrchestrationConfigFile' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RuntimePromptTemplateFile' schema.
+Representation of the 'RuntimePromptTemplateFile' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
This selector allows you to define the scope of translation, such as specific placeholders or messages with specific roles. For example, {"category": "placeholders", "items": ["user_input"], "source_language": "de-DE"} targets the value of "user_input" in placeholder_values specified in the request payload; and considers the value to be in German.
This selector allows you to define the scope of translation, such as specific placeholders or messages with specific roles. For example, {"category": "placeholders", "items": ["user_input"], "source_language": "de-DE"} targets the value of "user_input" in placeholder_values specified in the request payload; and considers the value to be in German.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SAPDocumentTranslationInput' schema.
+Representation of the 'SAPDocumentTranslationInput' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SAPDocumentTranslationOutput' schema.
+Representation of the 'SAPDocumentTranslationOutput' schema.
Representation of the 'SAPDocumentTranslationOutputTargetLanguage' schema.
+Representation of the 'SAPDocumentTranslationOutputTargetLanguage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SearchDocumentKeyValueListPair' schema.
+Representation of the 'SearchDocumentKeyValueListPair' schema.
Representation of the 'SearchSelectOptionEnum' schema.
+Representation of the 'SearchSelectOptionEnum' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SingleChatTemplate' schema.
+Representation of the 'Template' schema.
+Representation of the 'Template' schema.
{
* "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"
* }
* }
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.
OptionaltoolsA 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.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TemplateRef' schema.
+Representation of the 'TemplateRefByID' schema.
+Representation of the 'TemplateRefByID' schema.
OptionalscopeDefines 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".
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TemplateRefByScenarioNameVersion' schema.
+Representation of the 'TemplatingChatMessage' schema. +
Representation of the 'TemplatingChatMessage' schema. Min Items: 1.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TextContent' schema.
+Representation of the 'ToolChatMessage' schema.
+Representation of the 'ToolChatMessage' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Configuration for translation module
+Configuration for translation module
Representation of the 'UserChatMessageContent' schema.
+Representation of the 'UserChatMessageContent' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContentItem' schema.
+Representation of the 'UserChatMessageContentItem' schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents the type of the columns property.
+
Represents the type of the columns property.
It is an object that maps the known column names to a list of values.
If no data schema is given, it maps string to a list of values.
Type of the data schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents a date string in the format YYYY-MM-DD.
+Represents a date string in the format YYYY-MM-DD.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the payload for Parquet-based predictions.
+Representation of the payload for Parquet-based predictions.
Parquet file containing the data. Can also be a File to forward the filename.
Optionalindex_column?: stringOptional index column name.
Optionalparse_data_types?: booleanWhether to parse data types Default: true.
Configuration for the prediction.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Metadata about the prediction request.
+Metadata about the prediction request.
Number of columns in the input data.
Number of table cells containing the specified placeholder value.
Number of rows for which a prediction was made.
Number of rows in the input data.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Response payload for prediction requests. +
Response payload for prediction requests. Contains a list of prediction results.
Output status for prediction requests.
+Output status for prediction requests.
Status code (zero means success, other status codes indicate warnings)
Status message, either "ok" or contains a warning / more information.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of all data needed for prediction.
+Representation of all data needed for prediction.
Type of the data schema.
Optionalindex_column?: ColumnNames<T>The name of the index column. If provided, the service will return this column's value in each prediction object to facilitate aligning the output predictions with the input rows on the client side. If not provided, the column will not be included in the output.
Optionalparse_data_types?: booleanWhether to parse the data types of the columns. If set to True, numeric columns will be parsed to float or integer and dates in ISO format YYYY-MM-DD will be parsed. Default: true.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Represents the type of the rows property.
+
Represents the type of the rows property.
It is an object that maps the known column names to values.
If no data schema is given, it maps string to values.
Type of the data schema.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Compression middleware options for requests to the RPT service endpoint.
+Compression middleware options for requests to the RPT service endpoint.
The compression mode to use for requests to the RPT service endpoint.
always: Compress the request body for every request.never: Do not compress the request body.Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ApplicationApi'. +
ConstRepresentation of the 'ApplicationApi'. This API is part of the 'AI_CORE_API' service.
Create an ArgoCD application to synchronise a repository.
Delete an ArgoCD application
@@ -8,4 +8,4 @@Schedules a refresh of the specified application that will be picked up by ArgoCD asynchronously
Update the referenced ArgoCD application to synchronize the repository.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ArtifactApi'. +
ConstRepresentation of the 'ArtifactApi'. This API is part of the 'AI_CORE_API' service.
Retrieve the number of available artifacts that match the specified filter criteria. Filter criteria include a scenarioId, executionId, an artifact name, artifact kind, or artifact labels. @@ -10,4 +10,4 @@ Use top/skip parameters to paginate the result list. Search by substring of artifact name or description, if required.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ConfigurationApi'. +
ConstRepresentation of the 'ConfigurationApi'. This API is part of the 'AI_CORE_API' service.
Retrieve the number of available configurations that match the specified filter criteria. Filter criteria include a scenarioId or executableIdsList. Search by substring of configuration name is also possible.
@@ -8,4 +8,4 @@Retrieve a list of configurations. Filter results by scenario ID or a list of executable IDs. Search for configurations containing the search string as substring in the configuration name.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'DeploymentApi'. +
ConstRepresentation of the 'DeploymentApi'. This API is part of the 'AI_CORE_API' service.
Update status of multiple deployments. stop or delete multiple deployments.
Retrieve the number of available deployments. The number can be filtered by @@ -16,4 +16,4 @@ With select parameter it is possible to select only status.
Retrieve logs of a deployment for getting insight into the deployment results or failures.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'DockerRegistrySecretApi'. +
ConstRepresentation of the 'DockerRegistrySecretApi'. This API is part of the 'AI_CORE_API' service.
Create a secret based on the configuration in the request body.
Delete a secret with the name of dockerRegistryName if it exists.
@@ -6,4 +6,4 @@Update a secret with name of dockerRegistryName if it exists.
Retrieve a list of metadata of the stored secrets
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ExecutableApi'. +
ConstRepresentation of the 'ExecutableApi'. This API is part of the 'AI_CORE_API' service.
Retrieve details about an executable identified by executableId belonging to a scenario identified by scenarioId.
Retrieve a list of executables for a scenario. Filter by version ID, if required.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ExecutionApi'. +
ConstRepresentation of the 'ExecutionApi'. This API is part of the 'AI_CORE_API' service.
Patch multiple executions' status to stopped or deleted.
Retrieve the number of available executions. The number can be filtered by @@ -13,4 +13,4 @@ With select parameter it is possible to select only status.
Retrieve logs of an execution for getting insight into the execution results or failures.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ExecutionScheduleApi'. +
ConstRepresentation of the 'ExecutionScheduleApi'. This API is part of the 'AI_CORE_API' service.
Retrieve the number of scheduled executions. The number can be filtered by configurationId or executionScheduleStatus.
@@ -10,4 +10,4 @@ Filter criteria include executionScheduleStatus or a configurationId. With top/skip parameters it is possible to paginate the result list.Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'FileApi'. +
ConstRepresentation of the 'FileApi'. This API is part of the 'AI_CORE_API' service.
Delete the file specified by the path parameter.
Endpoint for downloading file. The path must point to an individual file.
@@ -17,4 +17,4 @@ /files/icr/datasets/training/20201001/20201001-02.csv /files/mask-detection/training/mask-detection-20210301.tar.gzCopyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'KPIApi'. +
ConstRepresentation of the 'KPIApi'. This API is part of the 'AI_CORE_API' service.
Retrieve the number of executions, artifacts, and deployments for each resource group, scenario, and executable. The columns to be returned can be specified in a query parameter.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'MetaApi'. +
ConstRepresentation of the 'MetaApi'. This API is part of the 'AI_CORE_API' service.
Meta information about an implementation of AI API, describing its capabilities, limits and extensions
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'MetricsApi'. +
ConstRepresentation of the 'MetricsApi'. This API is part of the 'AI_CORE_API' service.
Delete metrics, tags, or labels associated with an execution.
Retrieve metrics, labels, or tags according to filter conditions. @@ -7,4 +7,4 @@ With top/skip parameters it is possible to paginate the result list.
Update or create metrics, tags, or labels associated with an execution.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ObjectStoreSecretApi'. +
ConstRepresentation of the 'ObjectStoreSecretApi'. This API is part of the 'AI_CORE_API' service.
Create a secret based on the configuration in the request body
Delete a secret with the name of objectStoreName if it exists.
@@ -8,4 +8,4 @@Update a secret with name of objectStoreName if it exists.
Retrieve a list of metadata of the stored secrets.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'RepositoryApi'. +
ConstRepresentation of the 'RepositoryApi'. This API is part of the 'AI_CORE_API' service.
On-board a new GitOps repository as specified in the content payload
Remove a repository from GitOps.
@@ -6,4 +6,4 @@Retrieve a list of all GitOps repositories for a tenant.
Update the referenced repository credentials to synchronize a repository.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ResourceApi'. +
ConstRepresentation of the 'ResourceApi'. This API is part of the 'AI_CORE_API' service.
Lists all the instance types available in the cluster.
Lists all hot spare nodes, used nodes and total nodes corresponding to tenant.
Set hot spare nodes corresponding to tenant at main tenant level.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ResourceGroupApi'. +
ConstRepresentation of the 'ResourceGroupApi'. This API is part of the 'AI_CORE_API' service.
Create resource group to a given main tenant. The length of resource group id must be between 3 and 253.
Delete a resource group of a given main tenant.
@@ -6,4 +6,4 @@Retrieve a list of resource groups for a given tenant.
Replace some characteristics of the resource group, for instance labels.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ResourceQuotaApi'. +
ConstRepresentation of the 'ResourceQuotaApi'. This API is part of the 'AI_CORE_API' service.
Get the details about quota and usage for applications
Get the details about quota and usage for deployments
@@ -8,4 +8,4 @@Get the details about quota and usage for repositories
Get the details about quota and usage for resource groups
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ScenarioApi'. +
ConstRepresentation of the 'ScenarioApi'. This API is part of the 'AI_CORE_API' service.
Retrieve details for a scenario specified by scenarioId.
Retrieve a list of all available scenarios.
@@ -6,4 +6,4 @@Retrieve a list of scenario versions based on the versions of executables available within that scenario.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'SecretApi'. +
ConstRepresentation of the 'SecretApi'. This API is part of the 'AI_CORE_API' service.
Create a new generic secret in the corresponding resource group or at main tenant level.
Deletes the secret from provided resource group namespace
@@ -6,4 +6,4 @@Lists all secrets corresponding to tenant. This retrieves metadata only, not the secret data itself.
Update secret credentials. Replace secret data with the provided data.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'ServiceApi'. +
ConstRepresentation of the 'ServiceApi'. This API is part of the 'AI_CORE_API' service.
Get an service of a given main tenant.
Retrieve a list of services for a given main tenant.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'TenantInfoApi'. +
ConstRepresentation of the 'TenantInfoApi'. This API is part of the 'AI_CORE_API' service.
Tenant information containing the service plan that the tenant is subscribed to.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'PipelinesApi'. +
ConstRepresentation of the 'PipelinesApi'. This API is part of the 'api' service.
Create a pipeline
Delete a pipeline by pipeline id
@@ -15,4 +15,4 @@Patch a pipeline by pipeline id
Search for pipelines based on metadata
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'RetrievalApi'. +
ConstRepresentation of the 'RetrievalApi'. This API is part of the 'api' service.
List all Data Repositories
List data repository by id
Retrieve relevant content given a query string.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'VectorApi'. +
ConstRepresentation of the 'VectorApi'. This API is part of the 'api' service.
Creates a collection. This operation is asynchronous. Poll the collection resource and check the status field to understand creation status.
Create and stores one or multiple documents into a collection. If omitted, 'id' will be auto-generated.
@@ -17,4 +17,4 @@Upserts the data of multiple documents into a collection.
Allows to add, remove and modify the documents metadata.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'OrchestrationConfigsApi'. +
ConstRepresentation of the 'OrchestrationConfigsApi'. This API is part of the 'prompt-registry' service.
Create or update an orchestration config
Delete orchestration config
@@ -8,4 +8,4 @@List orchestration config history
List orchestration configs
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
ConstRepresentation of the 'PromptTemplatesApi'. +
ConstRepresentation of the 'PromptTemplatesApi'. This API is part of the 'prompt-registry' service.
Create or update a prompt template
Delete prompt template
Export prompt template
Get prompt template by UUID
Import prompt template
-List prompt template history
+List prompt template history
List prompt templates
Parse prompt template by ID
Parse prompt template by name and version
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A re-implementation of httpx's
LineDecoderin Python that handles incrementally +Class LineDecoder
A re-implementation of httpx's
LineDecoderin Python that handles incrementally reading lines from text.Https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258.
Index
Constructors
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Constructors
constructor
Returns LineDecoder
Properties
buffer
text
trailing
StaticNEWLINE_StaticNEWLINE_Methods
decode
Parameters
Returns string[]
decode
Parameters
Returns string
flush
Returns string[]
Settings
On This Page
Constructors
Properties
Methods