Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Request builder for OpenAPI requests.
+Type of the response for the request.
+Type of the response for the request.
+Optionalparameters: OpenApiRequestParametersOptionalbasePath: stringAdd custom headers to the request. If a header field with the given name already exists it is overwritten.
+Key-value pairs denoting additional custom headers.
+The request builder itself, to facilitate method chaining.
+Add custom request configuration to the request. Typically, this is used when specifying response type for downloading files. +If the custom request configuration contains keys in this list @sap-cloud-sdk/http-client!defaultDisallowedKeys, they will be removed.
+Key-value pairs denoting additional custom request configuration options to be set in the request.
+The request builder itself, to facilitate method chaining.
+Execute request and get the response data. Use this to conveniently access the data of a service without technical information about the response.
+Optionaldestination: The destination to execute the request against.
+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?: undefinedOptionalrequestConfig: CustomRequestConfigCustom request configuration.
+A promise resolving to the requested return type.
+Execute request and get the response data. Use this to conveniently access the data of a service without technical information about the response.
+Optionaldestination: The destination to execute the request against.
+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?: undefinedOptionalrequestConfig: CustomRequestConfigCustom request configuration.
+A promise resolving to an HttpResponse.
+Set middleware for requests towards the target system given in the destination.
+Middlewares to be applied to the executeHttpRequest().
+The request builder itself, to facilitate method chaining.
+Set middleware for requests towards the target system given in the destination.
+Middlewares to be applied to the executeHttpRequest().
+The request builder itself, to facilitate method chaining.
+ProtectedrequestGet HTTP request config.
+Promise of the HTTP request config with origin.
+Set the custom base path that gets prefixed to the API path parameter before a request.
+Base path to be set.
+The request builder itself, to facilitate method chaining.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Protected StatictransformAzure OpenAI client for chat completion.
+Creates an instance of the Azure OpenAI chat client.
+This configuration is used to retrieve a deployment. Depending on the configuration use either the given deployment ID or the model name to retrieve matching deployments. If model and deployment ID are given, the model is verified against the deployment.
+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?: undefinedCreates a completion for the chat messages.
+Request containing chat completion input parameters.
+OptionalrequestConfig: CustomRequestConfigThe request configuration.
+The completion result.
+Creates a completion stream for the chat messages.
+Request containing chat completion input parameters.
+Optionalsignal: AbortSignalThe abort signal.
+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.
+Readonly_The chat completion response.
+ReadonlyrawParses the response and returns the choice by index.
+The index of the choice to find.
+An LLMChoice object associated with the index.
+Optionalcontent_filter_results?: AzureOpenAiContentFilterChoiceResultsThe reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence,
+length if the maximum number of tokens specified in the request was reached,
+content_filter if content was omitted due to a flag from our content filters,
+tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.
The index of the choice in the list of choices.
+Log probability information for the choice.
+Gets the assistant message from the response.
+OptionalchoiceIndex: numberThe index of the choice to use (default is 0).
+The assistant message.
+Parses the Azure OpenAI response and returns the content.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The message content.
+Reason for stopping the completion.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The finish reason.
+Parses the Azure OpenAI response and returns the refusal message generated by the model.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The refusal string.
+Gets the request ID from the response headers.
+The request ID, or undefined if the header is not present.
+Usage of tokens in the response.
+Token usage.
+Parses the Azure OpenAI response and returns the tool calls generated by the model.
+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.
+InternalPipe the stream through a processing function.
+The function to process the input stream.
+Optionalresponse: AzureOpenAiChatCompletionStreamResponse<any>The AzureOpenAiChatCompletionStreamResponse object for process function to store finish reason, token usage, etc.
The output stream containing processed items.
+OptionalchoiceIndex: numberStatic_InternalCreate a chat completion stream based on the http response.
+Http response.
+Chat completion stream.
+Static_InternalWrap raw chunk data with chunk response class to provide helper functions.
+Chat completion stream.
+Static_InternalTransform a stream of chunks into a stream of content strings.
+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 StatictransformAzure OpenAI chat completion stream chunk response.
+Parses the chunk response and returns the choice by index.
+The index of the choice to find.
+An LLMChoiceStreaming object associated withe index.
+The reason the model stopped generating tokens. This will be stop if the model hit a natural stop point or a provided stop sequence,
+length if the maximum number of tokens specified in the request was reached,
+content_filter if content was omitted due to a flag from our content filters,
+tool_calls if the model called a tool, or function_call (deprecated) if the model called a function.
The index of the choice in the list of choices.
+Optionallogprobs?: Log probability information for the choice.
+Parses the chunk response and returns the delta content.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The message delta content.
+Gets the delta tool calls for a specific choice index.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The delta tool calls for the specified choice index.
+Reason for stopping the completion stream chunk.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The finish reason.
+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.
+Creates an Azure OpenAI chat completion stream response.
+The raw HTTP response. SSE data is not part of the immediate response.
+InternalInternalInternalGets the request ID from the response headers.
+The request ID, or undefined if the header is not present.
+Gets the tool calls for a specific choice index.
+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.
+Creates an instance of the Azure OpenAI embedding client.
+This configuration is used to retrieve a deployment. Depending on the configuration use either the given deployment ID or the model name to retrieve matching deployments. If model and deployment ID are given, the model is verified against the deployment.
+Optionaldestination: 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?: undefinedCreates an embedding vector representing the given text.
+Request containing embedding input parameters.
+OptionalrequestConfig: CustomRequestConfigThe request configuration.
+The completion result.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI embedding response.
+Readonly_The embedding response.
+ReadonlyrawParses the Azure OpenAI response and returns the embedding.
+OptionaldataIndex: numberThe index of the data to parse.
+The embedding vector.
+Parses the Azure OpenAI response and returns all embeddings.
+The embedding vectors.
+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.
+Optionaldestination: 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?: undefinedOptionalcacheOptionalcallbacksThe async caller should be used by subclasses to make any async calls, +which will thus benefit from the concurrency and retry logic.
+Optionalfrequency_A path to the module that contains the class, eg. ["langchain", "llms"] +Usually should be the same as the entrypoint the class is exported from.
+Protectedlc_Optionallogit_Optionalmax_OptionalmetadataOptionalnameOptionaloutputOptionalpresence_OptionalstopOptionalsupportsOptionaltagsOptionaltemperatureOptionaltop_OptionaluserWhether to print out response text.
+Keys that the language model accepts as call options.
+A map of aliases for constructor args. +Keys are the attribute names, e.g. "foo". +Values are the alias that will replace the key in serialization. +This is used to eg. make argument names match Python.
+A map of additional attributes to merge with constructor args. +Keys are the attribute names, e.g. "foo". +Values are the attribute values, which will be serialized. +These attributes need to be accepted by the constructor as arguments.
+The final serialized identifier for the module.
+A map of secrets, which will be omitted from serialization. +Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". +Values are the secret ids, which will be used when deserializing.
+A manual list of keys that should be serialized. +If not overridden, all fields passed into the constructor will be serialized.
+Return profiling information for the model.
+An object describing the model's capabilities and constraints
+Protected_Internal method that handles batching and configuration for a runnable +It takes a function, input values, and optional configuration, and +returns a promise that resolves to the output values.
+The function to be executed for each input value.
+Optionaloptions: OptionalbatchOptions: RunnableBatchOptionsA promise that resolves to the output values.
+Protected_Optionaloptions: Partial<AzureOpenAiChatCallOptions> & { runType?: string }Optional_OptionalrunManager: CallbackManagerForLLMRunProtected_Create a unique cache key for a specific call to a specific language model.
+Call options for the model
+OptionaloutputVersion?: MessageOutputVersionVersion of AIMessage output format to store in message content.
AIMessage.contentBlocks will lazily parse the contents of content into a
+standard format. This flag can be used to additionally store the standard format
+as the message content, e.g., for serialization purposes.
.contentBlocks).contentBlocks)You can also set LC_OUTPUT_VERSION as an environment variable to "v1" to
+enable this by default.
Optionaltool_choice?: ToolChoiceSpecifies how the chat model should use tools.
+undefined
Possible values:
- "auto": The model may choose to use any of the provided tools, or none.
- "any": The model must use one of the provided tools.
- "none": The model must not use any tools.
- A string (not "auto", "any", or "none"): The name of a specific tool the model must use.
- An object: A custom schema specifying tool choice parameters. Specific to the provider.
Note: Not all providers support tool_choice. An error will be thrown
if used with an unsupported model.
+
+
+OptionalpromptIndex?: numberOptionalrequestConfig?: CustomRequestConfigOptionalstrict?: booleanOptionaltools?: ChatAzureOpenAIToolType[]Optionalconfig?: RunnableConfig<Record<string, any>>A unique cache key.
+Get the identifying parameters of the LLM.
+Protected_Optionaloptions: Partial<AzureOpenAiChatCallOptions>Protected_Optionaloptions: Partial<AzureOpenAiChatCallOptions>Default streaming implementation. +Subclasses should override this method if they support streaming output.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions>Protected_Stream response chunks from the Azure OpenAI client.
+The messages to send to the model.
+The call options.
+OptionalrunManager: CallbackManagerForLLMRunThe callback manager for the run.
+An async generator of chat generation chunks.
+Protected_Helper method to transform an Iterator of Input values into an Iterator of
+Output values, with callbacks.
+Use this to implement stream() or transform() in Runnable subclasses.
Optionaloptions: Partial<AzureOpenAiChatCallOptions> & { runType?: string }Assigns new fields to the dict output of this runnable. Returns a new runnable.
+Convert a runnable to a tool. Return a new instance of RunnableToolLike
+which contains the runnable, name, description and schema.
Optionaldescription?: stringThe description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.
+Optionalname?: stringThe name of the tool. If not provided, it will default to the name of the runnable.
+The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.
+An instance of RunnableToolLike which is a runnable that can be used as a tool.
Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions> | Partial<AzureOpenAiChatCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptions & { returnExceptions?: false }Whether to return errors rather than throwing on the first one
+OptionalreturnExceptions?: falseWhether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions> | Partial<AzureOpenAiChatCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptions & { returnExceptions: true }Whether to return errors rather than throwing on the first one
+Whether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions> | Partial<AzureOpenAiChatCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptionsWhether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Bind tool-like objects to this chat model.
+A list of tool definitions to bind to this chat model. +Can be a structured tool, an OpenAI formatted tool, or an object +matching the provider's specific tool schema.
+Optionalkwargs: Partial<AzureOpenAiChatCallOptions>Any additional parameters to bind.
+Generates chat based on the input messages.
+An array of arrays of BaseMessage instances.
+Optionaloptions: string[] | Partial<AzureOpenAiChatCallOptions>The call options or an array of stop sequences.
+Optionalcallbacks: CallbacksThe callbacks for the language model.
+A Promise that resolves to an LLMResult.
+Generates a prompt based on the input prompt values.
+An array of BasePromptValue instances.
+Optionaloptions: string[] | Partial<AzureOpenAiChatCallOptions>The call options or an array of stop sequences.
+Optionalcallbacks: CallbacksThe callbacks for the language model.
+A Promise that resolves to an LLMResult.
+Optional_: RunnableConfig<Record<string, any>>Wraps getLsParams() and always appends ls_integration. +This ensures the integration tag is present even when +partner packages fully override getLsParams().
+Optionalsuffix: stringGet the number of tokens in the content.
+The content to get the number of tokens for.
+The number of tokens in the content.
+Get the parameters used to invoke the model
+Optional_options: Omit<Invokes the chat model with a single input.
+The input for the language model.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions>The call options.
+A Promise that resolves to a BaseMessageChunk.
+Pick keys from the dict output of this runnable. Returns a new runnable.
+Create a new runnable sequence that runs each individual runnable in series, +piping the output of one runnable into another runnable or runnable-like.
+A runnable, function, or object whose values are functions or runnables.
+A new runnable sequence.
+Stream output in chunks.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions>A readable stream that is also an iterable.
+Generate a stream of events emitted by the internal steps of the runnable.
+Use to create an iterator over StreamEvents that provide real-time information +about the progress of the runnable, including StreamEvents from intermediate +results.
+A StreamEvent is a dictionary with the following schema:
+event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).name: string - The name of the runnable that generated the event.run_id: string - Randomly generated ID associated with the given execution of
+the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a
+parent runnable is assigned its own unique ID.tags: string[] - The tags of the runnable that generated the event.metadata: Record<string, any> - The metadata of the runnable that generated the event.data: Record<string, any>Below is a table that illustrates some events that might be emitted by various +chains. Metadata fields have been omitted from the table for brevity. +Chain definitions have been included after the table.
+ATTENTION This reference table is for the V2 version of the schema.
++----------------------+-----------------------------+------------------------------------------+
+| event | input | output/chunk |
++======================+=============================+==========================================+
+| on_chat_model_start | {"messages": BaseMessage[]} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_stream | | AIMessageChunk("hello") |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_end | {"messages": BaseMessage[]} | AIMessageChunk("hello world") |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_start | {'input': 'hello'} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_stream | | 'Hello' |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_end | 'Hello human!' | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_start | | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_stream | | "hello world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_end | [Document(...)] | "hello world!, goodbye world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_start | {"x": 1, "y": "2"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_end | | {"x": 1, "y": "2"} |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_start | {"query": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_end | {"query": "hello"} | [Document(...), ..] |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_start | {"question": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_end | {"question": "hello"} | ChatPromptValue(messages: BaseMessage[]) |
++----------------------+-----------------------------+------------------------------------------+
+
+
+The "on_chain_*" events are the default for Runnables that don't fit one of the above categories.
+In addition to the standard events above, users can also dispatch custom events.
+Custom events will be only be surfaced with in the v2 version of the API!
A custom event has following format:
++-----------+------+------------------------------------------------------------+
+| Attribute | Type | Description |
++===========+======+============================================================+
+| name | str | A user defined name for the event. |
++-----------+------+------------------------------------------------------------+
+| data | Any | The data associated with the event. This can be anything. |
++-----------+------+------------------------------------------------------------+
+
+
+Here's an example:
+import { RunnableLambda } from "@langchain/core/runnables";
import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
// Use this import for web environments that don't support "async_hooks"
// and manually pass config to child runs.
// import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";
const slowThing = RunnableLambda.from(async (someInput: string) => {
// Placeholder for some slow operation
await new Promise((resolve) => setTimeout(resolve, 100));
await dispatchCustomEvent("progress_event", {
message: "Finished step 1 of 2",
});
await new Promise((resolve) => setTimeout(resolve, 100));
return "Done";
});
const eventStream = await slowThing.streamEvents("hello world", {
version: "v2",
});
for await (const event of eventStream) {
if (event.event === "on_custom_event") {
console.log(event);
}
}
+
+
+OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">Generate a stream of events emitted by the internal steps of the runnable.
+Use to create an iterator over StreamEvents that provide real-time information +about the progress of the runnable, including StreamEvents from intermediate +results.
+A StreamEvent is a dictionary with the following schema:
+event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).name: string - The name of the runnable that generated the event.run_id: string - Randomly generated ID associated with the given execution of
+the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a
+parent runnable is assigned its own unique ID.tags: string[] - The tags of the runnable that generated the event.metadata: Record<string, any> - The metadata of the runnable that generated the event.data: Record<string, any>Below is a table that illustrates some events that might be emitted by various +chains. Metadata fields have been omitted from the table for brevity. +Chain definitions have been included after the table.
+ATTENTION This reference table is for the V2 version of the schema.
++----------------------+-----------------------------+------------------------------------------+
+| event | input | output/chunk |
++======================+=============================+==========================================+
+| on_chat_model_start | {"messages": BaseMessage[]} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_stream | | AIMessageChunk("hello") |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_end | {"messages": BaseMessage[]} | AIMessageChunk("hello world") |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_start | {'input': 'hello'} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_stream | | 'Hello' |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_end | 'Hello human!' | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_start | | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_stream | | "hello world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_end | [Document(...)] | "hello world!, goodbye world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_start | {"x": 1, "y": "2"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_end | | {"x": 1, "y": "2"} |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_start | {"query": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_end | {"query": "hello"} | [Document(...), ..] |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_start | {"question": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_end | {"question": "hello"} | ChatPromptValue(messages: BaseMessage[]) |
++----------------------+-----------------------------+------------------------------------------+
+
+
+The "on_chain_*" events are the default for Runnables that don't fit one of the above categories.
+In addition to the standard events above, users can also dispatch custom events.
+Custom events will be only be surfaced with in the v2 version of the API!
A custom event has following format:
++-----------+------+------------------------------------------------------------+
+| Attribute | Type | Description |
++===========+======+============================================================+
+| name | str | A user defined name for the event. |
++-----------+------+------------------------------------------------------------+
+| data | Any | The data associated with the event. This can be anything. |
++-----------+------+------------------------------------------------------------+
+
+
+Here's an example:
+import { RunnableLambda } from "@langchain/core/runnables";
import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
// Use this import for web environments that don't support "async_hooks"
// and manually pass config to child runs.
// import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";
const slowThing = RunnableLambda.from(async (someInput: string) => {
// Placeholder for some slow operation
await new Promise((resolve) => setTimeout(resolve, 100));
await dispatchCustomEvent("progress_event", {
message: "Finished step 1 of 2",
});
await new Promise((resolve) => setTimeout(resolve, 100));
return "Done";
});
const eventStream = await slowThing.streamEvents("hello world", {
version: "v2",
});
for await (const event of eventStream) {
if (event.event === "on_custom_event") {
console.log(event);
}
}
+
+
+OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">Stream all output from a runnable, as reported to the callback system. +This includes all inner runs of LLMs, Retrievers, Tools, etc. +Output is streamed as Log objects, which include a list of +jsonpatch ops that describe how the state of the run has changed in each +step, and the final state of the run. +The jsonpatch ops can be applied in order to construct state.
+Optionaloptions: Partial<AzureOpenAiChatCallOptions>OptionalstreamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">Default implementation of transform, which buffers input and then calls stream. +Subclasses should override this method if they can start producing output while +input is still being generated.
+Bind config to a Runnable, returning a new Runnable.
+New configuration parameters to attach to the new runnable.
+A new RunnableBinding with a config matching what's passed.
+Create a new runnable from the current one that will try invoking +other passed fallback runnables if the initial invocation fails.
+Other runnables to call if the runnable errors.
+A new RunnableWithFallbacks.
+Bind lifecycle listeners to a Runnable, returning a new Runnable. +The Run object contains information about the run, including its id, +type, input, output, error, startTime, endTime, and any tags or metadata +added to the run.
+The object containing the callback functions.
+OptionalonEnd?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called after the runnable finishes running, with the Run object.
+OptionalonError?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called if the runnable throws an error, with the Run object.
+OptionalonStart?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called before the runnable starts running, with the Run object.
+Add retry logic to an existing runnable.
+Optionalfields: {OptionalonFailedAttempt?: RunnableRetryFailedAttemptHandlerA function that is called when a retry fails.
+OptionalstopAfterAttempt?: numberThe number of attempts to retry.
+A new RunnableRetry that, when invoked, will retry according to the parameters.
+Optionalconfig: StructuredOutputMethodOptions<boolean>Protected Static_StaticdeserializeStaticisStaticlc_The name of the serializable. Override to provide an alias or +to preserve the serialized module name in minified environments.
+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.
+Optionaldestination: 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 async caller should be used by subclasses to make any async calls, +which will thus benefit from the concurrency and retry logic.
+OptionalmodelOptionalresourceEmbed a list of document chunks. All chunks are embedded in one batch.
+Document chunks to embed.
+Embeddings.
+Embed a single string.
+Input string to embed.
+Embedding.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The Orchestration client.
+OptionallangchainOptions: LangChainOrchestrationChatModelParamsOptionaldeploymentConfig: ResourceGroupConfigOptionaldestination: 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?: undefinedOptionalcacheOptionalcallbacksThe async caller should be used by subclasses to make any async calls, +which will thus benefit from the concurrency and retry logic.
+OptionaldeploymentOptionaldestinationOptionalserviceBindingTransformFn?: 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?: undefinedA path to the module that contains the class, eg. ["langchain", "llms"] +Usually should be the same as the entrypoint the class is exported from.
+Protectedlc_OptionalmetadataOptionalnameOptionaloutputOptionaltagsWhether to print out response text.
+Keys that the language model accepts as call options.
+A map of aliases for constructor args. +Keys are the attribute names, e.g. "foo". +Values are the alias that will replace the key in serialization. +This is used to eg. make argument names match Python.
+A map of additional attributes to merge with constructor args. +Keys are the attribute names, e.g. "foo". +Values are the attribute values, which will be serialized. +These attributes need to be accepted by the constructor as arguments.
+The final serialized identifier for the module.
+A map of secrets, which will be omitted from serialization. +Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". +Values are the secret ids, which will be used when deserializing.
+A manual list of keys that should be serialized. +If not overridden, all fields passed into the constructor will be serialized.
+Return profiling information for the model.
+An object describing the model's capabilities and constraints
+Protected_Internal method that handles batching and configuration for a runnable +It takes a function, input values, and optional configuration, and +returns a promise that resolves to the output values.
+The function to be executed for each input value.
+Optionaloptions: OptionalbatchOptions: RunnableBatchOptionsA promise that resolves to the output values.
+Protected_Optionaloptions: Partial<OrchestrationCallOptions> & { runType?: string }Optional_OptionalrunManager: CallbackManagerForLLMRunProtected_Create a unique cache key for a specific call to a specific language model.
+Call options for the model
+A unique cache key.
+Get the identifying parameters of the LLM.
+Protected_Optionaloptions: Partial<OrchestrationCallOptions>Protected_Optionaloptions: Partial<OrchestrationCallOptions>Default streaming implementation. +Subclasses should override this method if they support streaming output.
+Optionaloptions: Partial<OrchestrationCallOptions>Protected_Stream response chunks from the Orchestration client.
+The messages to send to the model.
+The call options.
+OptionalrunManager: CallbackManagerForLLMRunThe callback manager for the run.
+An async generator of chat generation chunks.
+Protected_Helper method to transform an Iterator of Input values into an Iterator of
+Output values, with callbacks.
+Use this to implement stream() or transform() in Runnable subclasses.
Optionaloptions: Partial<OrchestrationCallOptions> & { runType?: string }Assigns new fields to the dict output of this runnable. Returns a new runnable.
+Convert a runnable to a tool. Return a new instance of RunnableToolLike
+which contains the runnable, name, description and schema.
Optionaldescription?: stringThe description of the tool. Falls back to the description on the Zod schema if not provided, or undefined if neither are provided.
+Optionalname?: stringThe name of the tool. If not provided, it will default to the name of the runnable.
+The Zod schema for the input of the tool. Infers the Zod type from the input type of the runnable.
+An instance of RunnableToolLike which is a runnable that can be used as a tool.
Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<OrchestrationCallOptions> | Partial<OrchestrationCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptions & { returnExceptions?: false }Whether to return errors rather than throwing on the first one
+OptionalreturnExceptions?: falseWhether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<OrchestrationCallOptions> | Partial<OrchestrationCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptions & { returnExceptions: true }Whether to return errors rather than throwing on the first one
+Whether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Default implementation of batch, which calls invoke N times. +Subclasses should override this method if they can batch more efficiently.
+Array of inputs to each batch call.
+Optionaloptions: Partial<OrchestrationCallOptions> | Partial<OrchestrationCallOptions>[]Either a single call options object to apply to each batch call or an array for each call.
+OptionalbatchOptions: RunnableBatchOptionsWhether to return errors rather than throwing on the first one
+An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
+Bind tool-like objects to this chat model.
+A list of tool definitions to bind to this chat model. +Can be a structured tool, an OpenAI formatted tool, or an object +matching the provider's specific tool schema.
+Optionalkwargs: Partial<OrchestrationCallOptions>Any additional parameters to bind.
+Generates chat based on the input messages.
+An array of arrays of BaseMessage instances.
+Optionaloptions: string[] | Partial<OrchestrationCallOptions>The call options or an array of stop sequences.
+Optionalcallbacks: CallbacksThe callbacks for the language model.
+A Promise that resolves to an LLMResult.
+Generates a prompt based on the input prompt values.
+An array of BasePromptValue instances.
+Optionaloptions: string[] | Partial<OrchestrationCallOptions>The call options or an array of stop sequences.
+Optionalcallbacks: CallbacksThe callbacks for the language model.
+A Promise that resolves to an LLMResult.
+Optional_: RunnableConfig<Record<string, any>>Wraps getLsParams() and always appends ls_integration. +This ensures the integration tag is present even when +partner packages fully override getLsParams().
+Optionalsuffix: stringGet the number of tokens in the content.
+The content to get the number of tokens for.
+The number of tokens in the content.
+Get the parameters used to invoke the model
+Optional_options: Omit<Invokes the chat model with a single input.
+The input for the language model.
+Optionaloptions: Partial<OrchestrationCallOptions>The call options.
+A Promise that resolves to a BaseMessageChunk.
+Pick keys from the dict output of this runnable. Returns a new runnable.
+Create a new runnable sequence that runs each individual runnable in series, +piping the output of one runnable into another runnable or runnable-like.
+A runnable, function, or object whose values are functions or runnables.
+A new runnable sequence.
+Stream output in chunks.
+Optionaloptions: Partial<OrchestrationCallOptions>A readable stream that is also an iterable.
+Generate a stream of events emitted by the internal steps of the runnable.
+Use to create an iterator over StreamEvents that provide real-time information +about the progress of the runnable, including StreamEvents from intermediate +results.
+A StreamEvent is a dictionary with the following schema:
+event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).name: string - The name of the runnable that generated the event.run_id: string - Randomly generated ID associated with the given execution of
+the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a
+parent runnable is assigned its own unique ID.tags: string[] - The tags of the runnable that generated the event.metadata: Record<string, any> - The metadata of the runnable that generated the event.data: Record<string, any>Below is a table that illustrates some events that might be emitted by various +chains. Metadata fields have been omitted from the table for brevity. +Chain definitions have been included after the table.
+ATTENTION This reference table is for the V2 version of the schema.
++----------------------+-----------------------------+------------------------------------------+
+| event | input | output/chunk |
++======================+=============================+==========================================+
+| on_chat_model_start | {"messages": BaseMessage[]} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_stream | | AIMessageChunk("hello") |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_end | {"messages": BaseMessage[]} | AIMessageChunk("hello world") |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_start | {'input': 'hello'} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_stream | | 'Hello' |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_end | 'Hello human!' | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_start | | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_stream | | "hello world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_end | [Document(...)] | "hello world!, goodbye world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_start | {"x": 1, "y": "2"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_end | | {"x": 1, "y": "2"} |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_start | {"query": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_end | {"query": "hello"} | [Document(...), ..] |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_start | {"question": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_end | {"question": "hello"} | ChatPromptValue(messages: BaseMessage[]) |
++----------------------+-----------------------------+------------------------------------------+
+
+
+The "on_chain_*" events are the default for Runnables that don't fit one of the above categories.
+In addition to the standard events above, users can also dispatch custom events.
+Custom events will be only be surfaced with in the v2 version of the API!
A custom event has following format:
++-----------+------+------------------------------------------------------------+
+| Attribute | Type | Description |
++===========+======+============================================================+
+| name | str | A user defined name for the event. |
++-----------+------+------------------------------------------------------------+
+| data | Any | The data associated with the event. This can be anything. |
++-----------+------+------------------------------------------------------------+
+
+
+Here's an example:
+import { RunnableLambda } from "@langchain/core/runnables";
import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
// Use this import for web environments that don't support "async_hooks"
// and manually pass config to child runs.
// import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";
const slowThing = RunnableLambda.from(async (someInput: string) => {
// Placeholder for some slow operation
await new Promise((resolve) => setTimeout(resolve, 100));
await dispatchCustomEvent("progress_event", {
message: "Finished step 1 of 2",
});
await new Promise((resolve) => setTimeout(resolve, 100));
return "Done";
});
const eventStream = await slowThing.streamEvents("hello world", {
version: "v2",
});
for await (const event of eventStream) {
if (event.event === "on_custom_event") {
console.log(event);
}
}
+
+
+OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">Generate a stream of events emitted by the internal steps of the runnable.
+Use to create an iterator over StreamEvents that provide real-time information +about the progress of the runnable, including StreamEvents from intermediate +results.
+A StreamEvent is a dictionary with the following schema:
+event: string - Event names are of the format: on_[runnable_type]_(start|stream|end).name: string - The name of the runnable that generated the event.run_id: string - Randomly generated ID associated with the given execution of
+the runnable that emitted the event. A child runnable that gets invoked as part of the execution of a
+parent runnable is assigned its own unique ID.tags: string[] - The tags of the runnable that generated the event.metadata: Record<string, any> - The metadata of the runnable that generated the event.data: Record<string, any>Below is a table that illustrates some events that might be emitted by various +chains. Metadata fields have been omitted from the table for brevity. +Chain definitions have been included after the table.
+ATTENTION This reference table is for the V2 version of the schema.
++----------------------+-----------------------------+------------------------------------------+
+| event | input | output/chunk |
++======================+=============================+==========================================+
+| on_chat_model_start | {"messages": BaseMessage[]} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_stream | | AIMessageChunk("hello") |
++----------------------+-----------------------------+------------------------------------------+
+| on_chat_model_end | {"messages": BaseMessage[]} | AIMessageChunk("hello world") |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_start | {'input': 'hello'} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_stream | | 'Hello' |
++----------------------+-----------------------------+------------------------------------------+
+| on_llm_end | 'Hello human!' | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_start | | |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_stream | | "hello world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_chain_end | [Document(...)] | "hello world!, goodbye world!" |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_start | {"x": 1, "y": "2"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_tool_end | | {"x": 1, "y": "2"} |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_start | {"query": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_retriever_end | {"query": "hello"} | [Document(...), ..] |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_start | {"question": "hello"} | |
++----------------------+-----------------------------+------------------------------------------+
+| on_prompt_end | {"question": "hello"} | ChatPromptValue(messages: BaseMessage[]) |
++----------------------+-----------------------------+------------------------------------------+
+
+
+The "on_chain_*" events are the default for Runnables that don't fit one of the above categories.
+In addition to the standard events above, users can also dispatch custom events.
+Custom events will be only be surfaced with in the v2 version of the API!
A custom event has following format:
++-----------+------+------------------------------------------------------------+
+| Attribute | Type | Description |
++===========+======+============================================================+
+| name | str | A user defined name for the event. |
++-----------+------+------------------------------------------------------------+
+| data | Any | The data associated with the event. This can be anything. |
++-----------+------+------------------------------------------------------------+
+
+
+Here's an example:
+import { RunnableLambda } from "@langchain/core/runnables";
import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch";
// Use this import for web environments that don't support "async_hooks"
// and manually pass config to child runs.
// import { dispatchCustomEvent } from "@langchain/core/callbacks/dispatch/web";
const slowThing = RunnableLambda.from(async (someInput: string) => {
// Placeholder for some slow operation
await new Promise((resolve) => setTimeout(resolve, 100));
await dispatchCustomEvent("progress_event", {
message: "Finished step 1 of 2",
});
await new Promise((resolve) => setTimeout(resolve, 100));
return "Done";
});
const eventStream = await slowThing.streamEvents("hello world", {
version: "v2",
});
for await (const event of eventStream) {
if (event.event === "on_custom_event") {
console.log(event);
}
}
+
+
+OptionalstreamOptions: Omit<EventStreamCallbackHandlerInput, "autoClose">Stream all output from a runnable, as reported to the callback system. +This includes all inner runs of LLMs, Retrievers, Tools, etc. +Output is streamed as Log objects, which include a list of +jsonpatch ops that describe how the state of the run has changed in each +step, and the final state of the run. +The jsonpatch ops can be applied in order to construct state.
+Optionaloptions: Partial<OrchestrationCallOptions>OptionalstreamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">Default implementation of transform, which buffers input and then calls stream. +Subclasses should override this method if they can start producing output while +input is still being generated.
+Bind config to a Runnable, returning a new Runnable.
+New configuration parameters to attach to the new runnable.
+A new RunnableBinding with a config matching what's passed.
+Create a new runnable from the current one that will try invoking +other passed fallback runnables if the initial invocation fails.
+Other runnables to call if the runnable errors.
+A new RunnableWithFallbacks.
+Bind lifecycle listeners to a Runnable, returning a new Runnable. +The Run object contains information about the run, including its id, +type, input, output, error, startTime, endTime, and any tags or metadata +added to the run.
+The object containing the callback functions.
+OptionalonEnd?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called after the runnable finishes running, with the Run object.
+OptionalonError?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called if the runnable throws an error, with the Run object.
+OptionalonStart?: (run: Run, config?: RunnableConfig<Record<string, any>>) => void | Promise<void>Called before the runnable starts running, with the Run object.
+Add retry logic to an existing runnable.
+Optionalfields: {OptionalonFailedAttempt?: RunnableRetryFailedAttemptHandlerA function that is called when a retry fails.
+OptionalstopAfterAttempt?: numberThe number of attempts to retry.
+A new RunnableRetry that, when invoked, will retry according to the parameters.
+Optionalconfig: StructuredOutputMethodOptions<boolean>Protected Static_StaticdeserializeStaticisStaticlc_The name of the serializable. Override to provide an alias or +to preserve the serialized module name in minified environments.
+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.
+Array of content blocks that make up the message content
+OptionalidUnique identifier for this message
+Optionalinvalid_A path to the module that contains the class, eg. ["langchain", "llms"] +Usually should be the same as the entrypoint the class is exported from.
+OptionalnameMetadata about the message
+Optionaltool_Optionaltool_ReadonlytypeOptionalusage_A map of additional attributes to merge with constructor args. +Keys are the attribute names, e.g. "foo". +Values are the attribute values, which will be serialized. +These attributes need to be accepted by the constructor as arguments.
+The final serialized identifier for the module.
+A map of secrets, which will be omitted from serialization. +Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". +Values are the secret ids, which will be used when deserializing.
+A manual list of keys that should be serialized. +If not overridden, all fields passed into the constructor will be serialized.
+Get text content of the message.
+Optionalformat: "pretty"StaticisType guard to check if an object is an AIMessageChunk. +Preserves the MessageStructure type parameter when called with a typed BaseMessage. +When called with a typed BaseMessage, preserves the TStructure type
+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_Get the orchestration client.
+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)OrchestrationConfigRef to reference a stored configuration by ID or name.OptionaldeploymentConfig: DeploymentIdConfig | ResourceGroupConfigDeployment configuration.
+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.
+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.
+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.
+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 stream response.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration embedding client for generating embeddings with optional orchestration modules.
+Creates an instance of the orchestration embedding client.
+Embedding module configuration.
+OptionaldeploymentConfig: DeploymentIdConfig | ResourceGroupConfigDeployment configuration.
+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?: undefinedGenerate embeddings for the given input.
+Embedding request configuration.
+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.
+Final embedding results with index and object type (which is always embedding) information.
Array of embedding data objects containing both vectors, indices, and object types.
+Intermediate results from orchestration modules.
+Intermediate results or undefined.
+Gets the request ID for the embedding response.
+The request ID.
+Usage information.
+Usage information or undefined.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of an orchestration response.
+Readonly_The completion post response.
+ReadonlyrawParses the response and returns the choice by index.
+The index of the choice to find.
+An LLMChoice object associated with the index.
+Messages that can be used for subsequent prompts as message history.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+A list of all messages.
+Gets the assistant message from the response.
+OptionalchoiceIndex: numberThe index of the choice to use (default is 0).
+The assistant message.
+Gets the citations from the orchestration response. +Citations are returned by models like Perplexity Sonar that provide source references.
+The citations, or undefined if there are none.
+Parses the orchestration response and returns the content. +If the response was filtered, an error is thrown.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The message content.
+Reason for stopping the completion.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The finish reason.
+Gets the intermediate failures from the orchestration response. +When using module fallback, this contains errors from module configurations +that failed before a successful one was found.
+Each failure includes:
+The intermediate failures, or undefined if there were none.
+Gets the intermediate results from the orchestration response.
+The intermediate results.
+Parses the orchestration response and returns the refusal message generated by the model.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The refusal string.
+Gets the request ID from the orchestration response.
+The request ID.
+Usage of tokens in the response.
+Token usage.
+Parses the orchestration response and returns the tool calls generated by the model.
+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.
+InternalPipe the stream through a processing function.
+The function to process the input stream.
+Optionalresponse: OrchestrationStreamResponse<OrchestrationStreamChunkResponse>The OrchestrationStreamResponse object for process function to store finish reason, token usage, etc.
The output stream containing processed items.
+Transform the stream of chunks into a stream of content strings.
+Orchestration stream.
+A stream of content strings.
+Static_InternalCreate an orchestration stream based on the http response.
+Http response.
+An orchestration stream.
+Static_InternalWrap raw chunk data with chunk response class to provide helper functions.
+Orchestration stream.
+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 StatictransformOrchestration stream chunk response.
+Parses the chunk response and returns the choice by index.
+The index of the choice to find.
+An LLMChoiceStreaming object associated with the index.
+Gets the citations from the chunk response. +Citations are returned by models like Perplexity Sonar that provide source references.
+The citations, or undefined if there are none.
+Parses the chunk response and returns the delta content.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The message delta content.
+Gets the delta tool calls for a specific choice index.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The delta tool calls for the specified choice index.
+Reason for stopping the completion stream chunk.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The finish reason.
+Gets the intermediate results from the chunk.
+The intermediate results.
+Usage of tokens in the chunk response.
+Token usage.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Orchestration stream response.
+Creates an orchestration stream response.
+The raw HTTP response from the orchestration service. SSE data is not part of the immediate response.
+Parses the response and returns the choice by index.
+The index of the choice to find.
+An LLMChoice object associated with the index.
+Messages that can be used for subsequent prompts as message history.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+A list of all messages.
+Gets the assistant message from the response.
+OptionalchoiceIndex: numberThe index of the choice to use (default is 0).
+The assistant message.
+Gets the citations from the orchestration response. +Citations are returned by models like Perplexity Sonar that provide source references.
+The citations, or undefined if there are none.
+Parses the orchestration response and returns the content. +If the response was filtered, an error is thrown.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The message content.
+Gets the finish reason for a specific choice index.
+OptionalchoiceIndex: numberThe index of the choice to get the finish reason for.
+The finish reason for the specified choice index.
+Gets the intermediate failures from the orchestration response. +When using module fallback, this contains errors from module configurations +that failed before a successful one was found.
+The intermediate failures, or undefined if there were none.
+Gets the intermediate results from the orchestration response.
+The intermediate results.
+Parses the orchestration response and returns the refusal message generated by the model.
+OptionalchoiceIndex: numberThe index of the choice to parse.
+The refusal string.
+Gets the request ID for the stream response.
+The request ID, or undefined if the first chunk has not been received yet.
+Gets the token usage for the response.
+The token usage for the response.
+Parses the orchestration response and returns the tool calls generated by the model.
+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. +This class is experimental and may change at any time without prior notice.
+ExperimentalCreates an instance of the RPT client.
+OptionalmodelDeployment: ModelDeployment<SapRptModel>This configuration is used to retrieve a deployment. Depending on the configuration use either the given deployment ID or the model name to retrieve matching deployments. If model and deployment ID are given, the model is verified against the deployment.
+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?: undefinedExperimentalPredict based on Parquet file data. +Parquet is a binary tabular data format with typed columns.
+Parquet data and prediction configuration to base prediction on.
+OptionalrequestConfig: Omit<RptRequestOptions, "compress">Custom request configuration.
+Prediction response.
+ExperimentalPredict based on prediction data with data schema inferred.
+Prefer using predictWithSchema when the data schema is known.
Data to base prediction on.
+OptionalrequestConfig: RptRequestOptionsCustom request configuration.
+Prediction response.
+ExperimentalPredict based on data schema and prediction data. +Prefer using this method when the data schema is known.
+Prediction data follows this schema. When using TypeScript, the data schema type is used to infer the types of the prediction data. In that case, the data schema must be provided as a constant (as const).
Data to base prediction on.
+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. +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.
+The options to call an endpoint.
+The input parameters for the request.
+OptionalrequestConfig: CustomRequestConfigThe request configuration.
+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 HttpResponse from the AI Core service.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
Azure content safety 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.
+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.
+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.
+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. +See https://help.sap.com/docs/translation-hub/sap-translation-hub/supported-languages-6854bbb1bd824ffebc3a097a7c0fd45d for list of supported languages.
+SAP Document Translation configuration.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
The deployment configuration when using a deployment ID.
+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 options to call an endpoint.
+Input parameters for Azure content safety input filter.
+OptionalhateThe filter category for hate content.
+Optionalprompt_A flag to use prompt shield.
+Optionalself_The filter category for self-harm content.
+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.
+OptionalhateThe filter category for hate content.
+Optionalprotected_Detect protected code content from known GitHub repositories. The scan includes software libraries, source code, algorithms, and other proprietary programming content.
+Optionalself_The filter category for self-harm content.
+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.
+OptionalglobalGlobal stream options.
+OptionaloutputOutput filtering stream options.
+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.
+Represents the configuration for the Document Grounding Service.
+OptionalfiltersDocument grounding service filters to be used.
+Optionalmetadata_Parameter name used for specifying metadata parameters.
+Placeholders to be used for grounding input questions and output.
+Configuration selector for applying translation to specific placeholders or message roles.
+Embedding data with vector and index information.
+The embedding vector, either as a number array, a base64-encoded string, or multiple formats in case multiple output formats were requested.
+The index of the embedding in the list of embeddings.
+The object type, which is always "embedding".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding model configuration.
+Embedding request configuration.
+Representation of the FilteringModuleConfig schema.
Representation of the GroundingModuleConfig schema.
Grounding service configuration.
+Optionalfilters?: DocumentGroundingFilter[]Document grounding service filters to be used.
+Optionalmetadata_params?: string[]Parameter name used for specifying metadata parameters.
+Placeholders to be used for grounding input questions and output.
+Contains the input parameters used for grounding input questions +Min Items: 1.
+Placeholder name for grounding output.
+Representation of the MaskingModuleConfig schema.
Orchestration module configuration.
+OptionalfilteringFiltering module configuration for both input and output filters.
+To configure a filter, use convenience functions like buildAzureContentSafetyFilter, buildLlamaGuard38BFilter, etc..
OptionalgroundingGrounding module configuraton.
+OptionalmaskingMasking module configuration.
+Prompt templating configuration.
+OptionaltranslationTranslation module configuration.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+LLM model details.
+OptionalpromptStatic prompts. Can be:
+template: an array of templated chat messages (with {{?placeholders}}).id or scenario, name and version: reference to a remote prompt template.This is meant for static instructions included with every call.
+For per-request templating, use messages in .chatCompletion() instead.
Request options for orchestration.
+OptionalrequestPrompt configuration.
+OptionalrequestCustom request configuration.
+OptionalstreamWhether to stream the response.
+OptionalstreamOptions for the stream.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Custom options for how requests to the RPT service endpoint are performed.
+OptionalcompressOptions to configure request compression.
+OptionalhttpThe custom agent used when performing http requests.
+OptionalhttpsThe custom agent used when performing https requests.
+OptionalmaxThe max size of the http response content in bytes.
+OptionalmiddlewareMiddleware @sap-cloud-sdk/resilience!Middleware to be applied to the request. +The request context is set using @sap-cloud-sdk/http-client!HttpMiddlewareContext.
+OptionalparameterEncoder for the query parameters key and values. Per default parameters and keys are percent encoded.
+OptionalproxySet this to false to disable the proxy.
+To configure the proxy you can add a @sap-cloud-sdk/connectivity!ProxyConfiguration to your destination.
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.
+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.
+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).
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 | nullRequired 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. +Max Items: 1000.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactArray' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiArtifactCreationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Description of the artifact +Max Length: 5000.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 +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).
Optionaldescription?: AiArtifactDescriptionKind of the artifact, i.e. model or dataset
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionallabels?: AiLabelListbackend-specific details of the deployment
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 | nullRepresentation of the 'AiConfigurationBaseData' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiConfigurationCreationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 +Max Length: 256. +Pattern: "^[\w\s.!?,;:\\{}<>"'=+*/\\^&%@~$#|-]*$".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Detailed data about a deployment
+OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED +Format: "date-time".
+OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation +Format: "date-time".
+OptionaldeploymentUrl?: AiDeploymentUrlOptionaldetails?: AiDeploymentDetailsOptionalexecutableId?: AiExecutableIdOptionallastOperation?: "CREATE" | "UPDATE" | "DELETE" | "CASCADE-UPDATE" | anyLast operation applied to this deployment.
+OptionallatestRunningConfigurationId?: stringconfigurationId that was running before a PATCH operation has modified the configurationId of the deployment. This can be used for a manual rollback in case the new configurationId results in a DEAD deployment
+Timestamp of latest resource modification +Format: "date-time".
+OptionalscenarioId?: AiScenarioIdOptionalstartTime?: stringTimestamp of job status changed to RUNNING +Format: "date-time".
+OptionalstatusMessage?: AiDeploymentStatusMessageOptionalsubmissionTime?: stringTimestamp of job submitted +Format: "date-time".
+OptionaltargetStatus?: "RUNNING" | "STOPPED" | "DELETED"Deployment target status
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalttl?: AiDeploymentTimeToLiveRequest 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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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).
+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.
+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)
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentModificationRequestList' schema.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiDeploymentModificationResponseList' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Detail properties of the deployment
+OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED +Format: "date-time".
+OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation +Format: "date-time".
+OptionaldeploymentUrl?: AiDeploymentUrlOptionaldetails?: AiDeploymentDetailsOptionalexecutableId?: AiExecutableIdOptionallastOperation?: "CREATE" | "UPDATE" | "DELETE" | "CASCADE-UPDATE" | anyLast operation applied to this deployment.
+OptionallatestRunningConfigurationId?: stringconfigurationId that was running before a PATCH operation has modified the configurationId of the deployment. This can be used for a manual rollback in case the new configurationId results in a DEAD deployment
+Timestamp of latest resource modification +Format: "date-time".
+OptionalscenarioId?: AiScenarioIdOptionalstartTime?: stringTimestamp of job status changed to RUNNING +Format: "date-time".
+OptionalstatusDetails?: AiDeploymentStatusDetailsOptionalstatusMessage?: AiDeploymentStatusMessageOptionalsubmissionTime?: stringTimestamp of job submitted +Format: "date-time".
+OptionaltargetStatus?: "RUNNING" | "STOPPED" | "DELETED"Deployment target status
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Optionalttl?: AiDeploymentTimeToLiveCurrent status details of the deployment
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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))
+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
+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?).
+Timestamp of resource creation +Format: "date-time".
+Whether this executable is deployable
+Optionaldescription?: stringDescription of the executable
+OptionalinputArtifacts?: AiExecutableArtifactListOptionallabels?: AiLabelListTimestamp of latest resource modification +Format: "date-time".
+Name of the executable
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaloutputArtifacts?: AiExecutableArtifactListOptionalparameters?: AiExecutableParameterListOptionalscenarioId?: AiScenarioIdRepresentation 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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution that may generate artifacts
+OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED +Format: "date-time".
+OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation +Format: "date-time".
+OptionalexecutableId?: AiExecutableIdOptionalexecutionScheduleId?: AiExecutionScheduleIdTimestamp of latest resource modification +Format: "date-time".
+OptionaloutputArtifacts?: AiArtifactArrayOptionalscenarioId?: AiScenarioIdOptionalstartTime?: stringTimestamp of job status changed to RUNNING +Format: "date-time".
+OptionalstatusMessage?: AiExecutionStatusMessageOptionalsubmissionTime?: stringTimestamp of job submitted +Format: "date-time".
+OptionaltargetStatus?: "COMPLETED" | "RUNNING" | "STOPPED" | "DELETED"Target status of the execution
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionCreationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionDeletionResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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)
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionModificationResponseList' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution that may generate artifacts
+OptionalcompletionTime?: stringTimestamp of job status changed to COMPLETED/DEAD/STOPPED +Format: "date-time".
+OptionalconfigurationName?: AiConfigurationNameTimestamp of resource creation +Format: "date-time".
+OptionalexecutableId?: AiExecutableIdOptionalexecutionScheduleId?: AiExecutionScheduleIdTimestamp of latest resource modification +Format: "date-time".
+OptionaloutputArtifacts?: AiArtifactArrayOptionalscenarioId?: AiScenarioIdOptionalstartTime?: stringTimestamp of job status changed to RUNNING +Format: "date-time".
+OptionalstatusDetails?: AiExecutionStatusDetailsOptionalstatusMessage?: AiExecutionStatusMessageOptionalsubmissionTime?: stringTimestamp of job submitted +Format: "date-time".
+OptionaltargetStatus?: "COMPLETED" | "RUNNING" | "STOPPED" | "DELETED"Target status of the execution
+Data about execution schedule
+Timestamp of resource creation +Format: "date-time".
+Optionalend?: stringTimestamp, defining when the executions should stop running +Format: "date-time".
+Optionalid?: AiExecutionScheduleIdTimestamp of latest resource modification +Format: "date-time".
+Name of the execution schedule +Max Length: 256.
+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?: AiExecutionScheduleStatusStart and end an execution schedule.
+Optionalend?: stringTimestamp, defining when the executions should stop running +Format: "date-time".
+Name of the execution schedule +Max Length: 256.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiExecutionScheduleDeletionResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+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?: AiExecutionScheduleStatusRepresentation of the 'AiExecutionScheduleModificationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Current status details of the execution
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution status message +Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLabel' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiLogCommonResult' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Common log record.
+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
+OptionaldisplayName?: stringDisplay name of the model
+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.
+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
+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
+Deprecation status of model
+OptionalinputTypes?: string[]List of input types supported by the model
+Displays whether it is the latest version offered for the model
+Optionalmetadata?: Record<string, string>[]List of metadata supported by the model
+Name of model version
+OptionalorchestrationCapabilities?: string[]List of model capabilities supported by orchestration service
+OptionalretirementDate?: stringRetirement date of model in ISO 8601 timestamp
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +Max Items: 1000.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Resources 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.
+Timestamp of resource creation +Format: "date-time".
+Optionaldescription?: stringDescription of the scenario +Max Length: 5000.
+Optionallabels?: AiScenarioLabelListTimestamp of latest resource modification +Format: "date-time".
+Name of the scenario +Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiScenarioLabel' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AiScenarioLabelKey' schema.
+Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +Format: "url".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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?: AiScenarioIdVersion ID
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationDataRepoName' schema.
+OptionalapplicationName?: stringArgoCD application name in the request body +Max Length: 54. +Min Length: 3. +Pattern: "^[a-z0-9\-]+$".
+path within the repository to synchronise
+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.
+OptionalapplicationName?: stringArgoCD application name in the request body +Max Length: 54. +Min Length: 3. +Pattern: "^[a-z0-9\-]+$".
+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 'BckndArgoCDApplicationDataResponse' schema.
+OptionalapplicationName?: stringArgoCD application name in the response body +Max Length: 63. +Min Length: 3. +Pattern: "^[a-z0-9\-]+$".
+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 'BckndArgoCDApplicationDeletionResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationModificationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndArgoCDApplicationRefreshResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+Optionalsource?: { path?: string; repoURL?: string; revision?: string } & Record<string, any>Information about the ArgoCD application itself
+OptionalsyncFinishedAt?: stringGets the timestamp information related to the sync state of the ArgoCD application
+OptionalsyncResourcesStatus?: (Status of all resources that need to be synchronized with the gitops repo
+OptionalsyncRessourcesStatus?: (Status of all resources that need to be synchronized with the gitops repo. Misspelled and deprecated, use syncResourcesStatus instead.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalname?: stringName of the repository +Max Length: 51. +Min Length: 1. +Pattern: "^[a-z0-9\-]+$".
+Password for read-access to the repository
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'BckndDeploymentQuotaItem' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndDeploymentResourceQuotaResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndDeploymentUsage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndExecutableResourceQuotaResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretDataResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndGenericSecretPatchBody' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInstanceTypeGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroup' schema.
+Optionalannotations?: BckndInternalResourceGroupAnnotationsTimestamp of resource group creation +Format: "date-time".
+Optionallabels?: BckndInternalResourceGroupLabelsresource group id
+OptionalservicePlan?: stringservice plan
+aggregated status of the onboarding process
+OptionalstatusMessage?: stringstatus message
+OptionaltenantId?: stringtenant id
+OptionalzoneId?: stringzone id
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroupAnnotation' schema.
+Arbitrary annotations as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndInternalResourceGroupLabel' schema.
+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.
+Number of the resource instances in the list
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGetResourcePlans' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroup' schema.
+Timestamp of resource group creation +Format: "date-time".
+Optionallabels?: BckndResourceGroupLabelsresource group id
+OptionalservicePlan?: stringservice plan
+aggregated status of the onboarding process
+OptionalstatusMessage?: stringstatus message
+OptionaltenantId?: stringtenant id
+OptionalzoneId?: stringzone id
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourceGroupLabel' schema.
+Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchNodes' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchResourcePlans' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndResourcePatchResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndServiceServiceCatalogItem' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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[]Representation of the 'BckndServiceServiceCatalogItemExtendCredentials' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+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.
+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. +Format: "url".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Message
+Representation of the 'BcknddockerRegistrySecretDeletionResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BcknddockerRegistrySecretModificationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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
+key:value pairs of data
+.dockerconfigjson data
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Message
+Representation of the 'BckndobjectStoreSecretDeletionResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BckndobjectStoreSecretModificationResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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
+Optionalbucket?: stringBucket to be used
+key:value pairs of data
+Optionalendpoint?: stringOptional parameter - URL of the storage server (S3 only)
+Name of the object store for the secret object to be created. Can be used later on check for existence of the secret.
+OptionalpathPrefix?: stringprefix folder to be added to storage path
+Optionalregion?: stringOptional parameter - Region of the storage server (S3 only)
+Storage type e.g. S3, GCS,...
+Optionalusehttps?: string0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps
+Optionalverifyssl?: string0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl
+This represents all the meta-data and extra information to be stored as a k8-secret
+Optionalbucket?: stringBucket to be used
+key:value pairs of data
+Optionalendpoint?: stringOptional parameter - URL of the storage server (S3 only)
+Name of the object store for the secret object to be created. Can be used later on check for existence of the secret.
+OptionalpathPrefix?: stringprefix folder to be added to storage path
+Optionalregion?: stringOptional parameter - Region of the storage server (S3 only)
+Storage type e.g. S3, GCS,...
+Optionalusehttps?: string0, 1 flag for KF-serving annotations - serving.kubeflow.org/s3-usehttps
+Optionalverifyssl?: string0, 1 flag for the KF-serving annotation - serving.kubeflow.org/s3-verifyssl
+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
+File creation response message
+Representation of the 'KpiAggregationAttribute' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Name of the Column
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiCountAggregate' schema. +Format: "int64".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRow' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRowItem' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'KpiResultRowList' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
API version description
+Optionaldescription?: stringversion description
+Optionalurl?: stringURL of the API version
+OptionalversionId?: stringAPI version identifier
+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.
+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.
+Optionaldescription?: stringOptionalextensions?: MetaExtensionsOptionalruntimeApiVersion?: MetaVersionOptionalruntimeIdentifier?: stringThe name of the runtime
+Representation of the 'MetaExtensions' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaVersion' schema.
+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
+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?: RTAArtifactSignatureRepresentation of the 'RTAArtifactArray' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTAArtifactLabel' schema.
+Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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
+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
+OptionallatestRunningTargetId?: RTALatestRunningTargetIdTimestamp of latest resource modification +Format: "date-time".
+Optionalstatus?: "PENDING" | "RUNNING" | "COMPLETED" | "DEAD" | "UNKNOWN" | "DELETING"Deployment status
+OptionalstatusMessage?: stringDeployment status message +Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaltargetId?: RTATargetIdOptionalttl?: RTATtlRepresentation of the 'RTADeploymentDetails' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Current status details of the deployment
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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 'RTAErrorResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Entity having labels
+Timestamp of resource creation +Format: "date-time".
+Whether this pipeline is deployable
+Optionaldescription?: stringDescription of the executable
+OptionalinputArtifacts?: RTAExecutableInputArtifactListOptionallabels?: RTALabelListTimestamp of latest resource modification +Format: "date-time".
+Name of the executable
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionaloutputArtifacts?: RTAExecutableOutputArtifactListOptionalparameters?: RTAExecutableParameterListRequired for execution +Result of activation
+Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Execution
+Timestamp of resource creation +Format: "date-time".
+OptionalfinishTimestamp?: string | nullTimestamp of execution finish
+Optionalid?: RTAExecutionIdTimestamp of latest resource modification +Format: "date-time".
+OptionalstartTimestamp?: string | nullTimestamp of execution start
+Optionalstatus?: Status of the execution
+OptionalstatusMessage?: stringExecution status message +Max Length: 256.
+OptionalsubmissionTimestamp?: string | nullTimestamp of execution submission
+Current status details of the execution
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Required for execution
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTALabel' schema.
+Arbitrary labels as meta information
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTALogCommonData' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
A common log query response.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RTALogCommonResult' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Common log record.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+OptionaldisplayName?: stringDisplay name of the model
+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
+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
+Deprecation status of model
+OptionalinputTypes?: string[]List of input types supported by the model
+Displays whether it is the latest version offered for the model
+Optionalmetadata?: Record<string, string>[]List of metadata supported by the model
+Name of model version
+OptionalorchestrationCapabilities?: string[]List of model capabilities supported by orchestration service
+OptionalretirementDate?: stringRetirement date of model in ISO 8601 timestamp
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Result of execution
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Entity having labels
+Timestamp of resource creation +Format: "date-time".
+Optionaldescription?: stringDescription of the scenario +Max Length: 5000.
+Optionallabels?: RTALabelListTimestamp of latest resource modification +Format: "date-time".
+Name of the scenario +Max Length: 256.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
message content.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 '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
+{
* "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
+"[{'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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'TrckDeleteMetricsResponse' schema.
+Optionalid?: TrckExecutionIdOptionalmessage?: stringRepresentation 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
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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
+Metric Label Value
+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
+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?: TrckTimestampArray 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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AWS Bedrock models for chat completion.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
AWS Bedrock models for embedding.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for chat completion.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
GCP Vertex AI models for chat completion.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Perplexity models for chat completion.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
SAP RPT models.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalmetadata?: VectorDocumentKeyValueListPair[]Default: [].
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'BasePipelineMinimalResponse' schema.
+Representation of the 'BasePipelineResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalmetadata?: KeyValueListPair[]Default: [].
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 | nullRepresentation of the 'CollectionCreatedResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'CollectionDeletedResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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 | nullA response containing collections retrieved from the server.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'CreatePipeline' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DataRepositories' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 | nullRepresentation of the 'DataRepositoryMetaDataStrict' 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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
DataRepository schema returned by the Vector search endpoint
+Unique identifier of this DataRepository. +Format: "uuid".
+Optionalmessage?: string | nullOptional message.
+Optionalmetadata?: RetrievalKeyValueListPair[]Metadata attached to DataRepository. Useful to later limit search to a subset of DataRepositories. +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.
+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.
+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.
+Optionalmetadata?: RetrievalDocumentKeyValueListPair[]Default: [].
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Max Length: 1024.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumRepresentation 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.
+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.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentsStatusResponse' schema.
+Optionalcount?: numberOptionalresources?: (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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GetPipelineExecutionById' schema.
+OptionalcreatedAt?: stringOptionalid?: stringOptionalmodifiedAt?: stringOptionalstatus?: PipelineExecutionStatusRepresentation of the 'GetPipelineExecutions' schema.
+Optionalcount?: numberOptionalresources?: PipelineExecutionData[]Representation of the 'GetPipelineStatus' schema.
+OptionalcreatedAt?: string | nullOptionallastCompletedAt?: string | nullOptionallastStarted?: stringOptionalstatus?: PipelineExecutionStatusRepresentation of the 'GetPipelines' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDriveConfig' schema.
+OptionalincludePaths?: IncludePathsArrayOptionalresourceId?: stringRepresentation of the 'GoogleDriveConfigurationMinimal' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDriveConfigurationStruct' schema.
+OptionalcronExpression?: stringOptional cron expression for scheduling pipeline execution. +Must represent an interval greater than 1 hour.
+OptionalmetadataConfigId?: stringRepresentation of the 'GoogleDrivePipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDrivePipelineGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'GoogleDrivePipelineMinimalResponse' schema.
+Optionalconfiguration?: GoogleDriveConfigurationMinimalOptionalmetadata?: booleanRepresentation of the 'GoogleDriveResourceDetail' schema.
+OptionalincludePaths?: IncludePathsArrayOptionalresourceId?: stringOptionalresourceType?: "SHARED_FOLDER" | "SHARED_DRIVE"Representation of the 'HTTPValidationError' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+OptionalcronExpression?: stringRepresentation of the 'MSSharePointConfigurationGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointConfigurationMinimal' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MSSharePointPipelineMinimalResponse' schema.
+Optionalmetadata?: booleanRepresentation 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.
+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?: 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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MergeStrategyType' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetaData' schema.
+OptionaldataRepositoryMetadata?: ({ key: string; value: string[] } & Record<string, any>)[]Optionaldestination?: stringRepresentation 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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataConfigurationStruct' schema.
+OptionalcronExpression?: stringOptional cron expression for scheduling pipeline execution. +Must represent an interval greater than 1 hour.
+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.
+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.
+Optionalvalues?: string[] | nullList of values to update.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'MetadataOperationEnum' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+List of metadata updates.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PatchPipeline' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PerFilterSearchResult' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PipelineDocumentResponse' schema.
+OptionalabsoluteUrl?: string | nullOptionalcreatedTimestamp?: stringOptionaldownloadLocation?: string | nullOptionalid?: stringOptionallastUpdatedTimestamp?: stringOptionalmetadataId?: string | nullOptionalstatus?: DocumentStatusOptionaltitle?: string | nullOptionalviewLocation?: string | nullRepresentation of the 'PipelineExecutionData' schema.
+OptionalcreatedAt?: string | nullOptionalid?: stringOptionalmodifiedAt?: string | nullOptionalstatus?: PipelineExecutionStatusRepresentation of the 'PipelineExecutionStatus' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PipelineMinimalResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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. +Default: 5. +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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalChunk' schema.
+Optionalmetadata?: RetrievalKeyValueListPair[]Default: [].
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalpostProcessingScore?: ScoreOptionalsearchScores?: SearchScoresRepresentation of the 'RetrievalDataRepositorySearchResult' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalDocumentKeyValueListPair' schema.
+Max Length: 1024.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumRepresentation of the 'RetrievalKeyValueListPair' schema.
+Max Length: 1024.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Default: "Unknown Error Occurred".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalPerFilterSearchResultWithError' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +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.
+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.
+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. +Default: [ +"" +].
+OptionaldataRepositoryMetadata?: RetrievalKeyValueListPair[]Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*'] +Default: [].
+OptionaldocumentMetadata?: RetrievalSearchDocumentKeyValueListPair[]Restrict documents considered during search to those annotated with the given metadata. +Default: [].
+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?: RetrievalSearchConfigurationRepresentation 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.
+List of returned results.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RetrievalSearchSelectOptionEnum' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +Default: [ +"" +].
+OptionaldataRepositoryMetadata?: RetrievalKeyValueListPair[]Restrict DataRepositories considered during search to those annotated with the given metadata. Useful when combined with dataRepositories=['*'] +Default: [].
+OptionaldataRepositoryType?: DataRepositoryTypeOptionaldocumentMetadata?: RetrievalSearchDocumentKeyValueListPair[]Restrict documents considered during search to those annotated with the given metadata. +Default: [].
+Optionalfilter?: RetrievalBinaryBooleanFilter | RetrievalScopedKeyValueListPair | nullFilter to apply on the search results. This cannot be used together with 'documentMetadata'. The depth of the filter must not exceed 5 levels.
+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?: RetrievalSearchConfigurationRepresentation of the 'S3Configuration' schema.
+OptionalcronExpression?: stringOptionals3?: { includePaths?: IncludePathsArray } & Record<string, any>Representation of the 'S3ConfigurationMinimal' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'S3PipelineMinimalResponse' schema.
+Optionalconfiguration?: S3ConfigurationMinimalOptionalmetadata?: booleanRepresentation of the 'SDMPipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'SFTPConfiguration' schema.
+OptionalcronExpression?: stringOptionalsftp?: { includePaths?: IncludePathsArray } & Record<string, any>Representation of the 'SFTPConfigurationMinimal' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SFTPPipelineMinimalResponse' schema.
+Optionalconfiguration?: SFTPConfigurationMinimalOptionalmetadata?: booleanRepresentation 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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ScoresAggregationStrategy' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+OptionalchunkMetadata?: KeyValueListPair[]Restrict chunks considered during search to those with the given metadata. +Default: []. +Max Items: 2000.
+OptionalcollectionMetadata?: KeyValueListPair[]Restrict collections considered during search to those annotated with the given metadata. Useful when combined with collections=['*'] +Default: []. +Max Items: 2000.
+OptionaldocumentMetadata?: SearchDocumentKeyValueListPair[]Restrict documents considered during search to those annotated with the given metadata. +Default: []. +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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'ServiceNowConfigurationMinimal' schema.
+Representation of the 'ServiceNowConfigurationStruct' schema.
+OptionalcronExpression?: stringOptional cron expression for scheduling pipeline execution. +Must represent an interval greater than 1 hour.
+OptionalmetadataConfigId?: stringOptionalserviceNow?: ServiceNowConfigRepresentation of the 'ServiceNowPipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'SharePointConfig' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SharePointConfigGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'SharePointSite' schema.
+OptionalincludePaths?: IncludePathsArrayRepresentation of the 'SharePointSiteDetail' schema.
+Optionalid?: stringOptionalincludePaths?: IncludePathsArrayRepresentation of the 'SharePointSiteGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalmetadata?: VectorKeyValueListPair[]Default: [].
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Max Length: 1024.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
OptionalmatchMode?: FilterMatchModeEnumCollection metadata during ingestion
+Max Length: 1024.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorPerFilterSearchResult' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+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.
+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=['*'] +Default: [].
+OptionaldocumentMetadata?: VectorSearchDocumentKeyValueListPair[] | nullRestrict documents considered during search to those annotated with the given metadata. +Default: [].
+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.
+List of returned results.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'VectorSearchSelectOptionEnum' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineCreateRequest' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineGetResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'WorkZonePipelineMinimalResponse' schema.
+Azure OpenAI chat completion input parameters.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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?: AzureOpenAiChatCompletionMessageToolCallsRepresentation of the 'AzureOpenAiChatCompletionRequestMessage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Azure OpenAI models for embedding.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
Optionalencoding_format?: string | nullThe format to return the embeddings in. Can be either float or base64. Defaults to float.
Input text to get embeddings for, encoded as a string. To get embeddings for multiple inputs in a single request, pass an array of strings. Each input must not exceed 2048 tokens in length. +Unless you are embedding code, we suggest replacing newlines (\n) in your input with a single space, as we have observed inferior results when newlines are present.
+Optionalinput_type?: stringInput type of embedding search to use.
+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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Options for an orchestration call.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AssistantChatMessage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'ChatMessage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessageContent' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessages' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Supported chat models for orchestration.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DpiConfig' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Supported embedding models for orchestration.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding model details.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Embedding model parameters.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'FileContent' schema.
+Representation of the 'FunctionObject' schema.
+OptionaldescriptionA 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. +Max Length: 64. +Pattern: "^[a-zA-Z0-9-_]+$".
+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.
Representation of the 'ImageContentUrl' schema.
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
LLM model details.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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. +Reference by ID.
+Representation of the 'Error' schema.
+Optionalheaders?: Record<string, string>HTTP headers returned from the failed request attempt
+Optionalintermediate_results?: ModuleResultsWhere the error occurred
+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. +The orchestration service will try each configuration in order until one succeeds.
+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 }).
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.
+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.
Per-config stream options that override shared settings. +Use object numeric keys for config indices you want to override. +Omit keys for configs that should use shared options or set their value to undefined.
+
const optionsWithOverrides: StreamOptions = {
global: { chunk_size: 100 },
promptTemplating: { include_usage: false },
overrides: {
0: { promptTemplating: { include_usage: true } }, // config 0, replaces base options fully
// 1: resolves base options because no override is provided (`{ promptTemplating: { include_usage: false } }`)
2: { outputFiltering: { overlap: 50 } } // config 2, replaces base options fully
}
};
+
+
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Category for translation application scope.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Parameters for translation configurations.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input configuration for translation module.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Input parameters for translation input configuration.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output configuration for translation module.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Output parameters for translation output configuration.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContent' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContentItem' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'AssistantChatMessage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Filter configuration for Azure Content Safety
+Representation of the 'AzureContentSafetyInputFilterConfig' schema.
+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_OptionalsexualOptionalviolenceRepresentation of the 'AzureContentSafetyOutputFilterConfig' schema.
+Representation of the 'AzureThreshold' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessage' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ChatMessageContent' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DPIConfig' schema.
+OptionalallowlistList of strings that should not be masked
+List of entities to be masked +Min Items: 1.
+Optionalmask_Type of masking method to be used for file inputs. Required if file inputs are provided.
+Optionalmask_Optionalenabled?: booleancontrols whether the input to the grounding module will be masked with the configuration supplied in the masking module
+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
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 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.
+Only include DataRepositories with the given type.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'DocumentGroundingFilter' schema.
+Optionalchunk_Restrict chunks considered during search to those with the given metadata.
+Optionaldata_Specify [''] to search across all DataRepositories or give a specific list of DataRepository ids. +Default: [ +"" +].
+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_Representation of the 'ErrorResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'FileContent' schema.
+Stream options for output filtering. Will be ignored if stream is false.
+Representation of the 'FunctionObject' schema.
+OptionaldescriptionA 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. +Max Length: 64. +Pattern: "^[a-zA-Z0-9-_]+$".
+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.
Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Options for streaming. Will be ignored if enabled is false.
+Optionalchunk_Minimum number of characters per chunk that post-LLM modules operate on. +Default: 100. +Maximum: 10000. +Minimum: 1.
+OptionaldelimitersList of delimiters to split the input text into chunks.Please note, this is a required parameter when input_translation_module_config or output_translation_module_config are configured.
OptionalenabledIf true, the response will be streamed back to the client
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Identifier of this SearchFilter - unique per request.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalfilters?: DocumentGroundingFilter[]Document grounding service filters to be used
+Optionalmetadata_params?: string[]Parameter name used for specifying metadata parameters
+Placeholders to be used for grounding input questions and output
+Contains the input parameters used for grounding input questions +Min Items: 1.
+Placeholder name for grounding output
+Representation of the 'ImageContent' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'ImageContentUrl' schema.
+Representation of the 'InputFilterConfig' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Optionalmax_Maximum number of retries for the LLM request. This parameter is currently ignored for Vertex AI models. +Default: 2. +Maximum: 5.
+Name of the model as in LLM Access configuration
+OptionalparamsAdditional parameters for the model. Default values are used for mandatory parameters.
+OptionaltimeoutTimeout for the LLM request in seconds. This parameter is currently ignored for Vertex AI models. +Default: 600. +Maximum: 600. +Minimum: 1.
+OptionalversionVersion of the model to be used +Default: "latest".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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_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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Min Items: 1.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'OrchestrationConfigDeleteResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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?: stringRepresentation of the 'OrchestrationConfigListResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OrchestrationConfigPostRequest' schema.
+Max Length: 120. +Pattern: "^[a-zA-Z0-9_-]+$".
+Max Length: 120. +Pattern: "^[a-zA-Z0-9_-]+$".
+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.
+Format: "uuid".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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?: stringRepresentation of the 'OutputFilterConfig' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'OutputFilteringConfig' schema.
+Representation of the 'PromptTemplate' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplateDeleteResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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?: stringRepresentation of the 'PromptTemplateListResponse' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'PromptTemplatePostRequest' schema.
+Max Length: 120. +Pattern: "^[a-zA-Z0-9_-]+$".
+Max Length: 120. +Pattern: "^[a-zA-Z0-9_-]+$".
+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.
+Format: "uuid".
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 'ResponseFormatJsonObject' 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.
+The name of the response format. Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum length of 64. +Max Length: 64. +Pattern: "^[a-zA-Z0-9-_]+$".
+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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'RuntimeOrchestrationConfigFile' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
Representation of the 'SAPDocumentTranslationInput' schema.
+Configuration for sap_document_translation translation provider.
Optionalapply_to?: SAPDocumentTranslationApplyToSelector[]Min Items: 1.
+Optionalsource_language?: stringLanguage of the text to be translated.
+Language to which the text should be translated.
+Optionaltranslate_If true, the messages history will be translated as well. +Default: true.
+Type of document translation provider
+Representation of the 'SAPDocumentTranslationOutput' schema.
+Optionalsource_language?: stringLanguage of the text to be translated.
+Configuration for sap_document_translation translation provider.
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 'SearchSelectOptionEnum' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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"
* }
* }
+
+
+OptionaldefaultsOptional default values for the template. If a parameter has no default it is required.
+Optionalresponse_Response format that the model output should adhere to. This is the same as the OpenAI definition.
+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 'TemplateRefByID' schema.
+ID of the template in prompt registry
+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.
+Name of the template
+Scenario name
+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".
+Version of the template
+Representation of the 'TemplatingChatMessage' schema. +Min Items: 1.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Configuration for translation module
+Representation of the 'UserChatMessageContent' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
Representation of the 'UserChatMessageContentItem' schema.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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.
+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. +Contains a list of prediction results.
+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.
+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.
+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.
+The compression mode to use for requests to the RPT service endpoint.
+always: Compress the request body for every request.auto: Compress the request body only if it exceeds a certain size threshold (e.g., 1KB). This is the default behavior.never: Do not compress the request body.Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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
+Retrieve the ArgoCD application details.
+Return all Argo CD application data objects.
+Returns the ArgoCD application health and sync status.
+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'. +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. +Search by substring of artifact name or description is also possible.
+Register an artifact for use in a configuration, for example a model or a dataset.
+Retrieve details for artifact with artifactId.
+Retrieve a list of artifacts that matches the specified filter criteria. +Filter criteria include scenario ID, execution ID, an artifact name, artifact kind, or artifact labels. +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'. +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.
+Create a new configuration linked to a specific scenario and executable for use in an execution +or deployment.
+Retrieve details for configuration with configurationId.
+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'. +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 +scenarioId, configurationId, executableIdsList or by deployment status.
+Create a deployment using the configuration specified by configurationId after synchronously checking the +correctness of the configuration.
+Mark deployment with deploymentId as deleted.
+Retrieve details for execution with deploymentId.
+Update target status of a deployment to stop a deployment or change the configuration to be used by the +deployment after synchronously checking the correctness of the configuration. A change of configuration is only +allowed for RUNNING and PENDING deployments.
+Retrieve a list of deployments that match the specified filter criteria. +Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a deployment status. +With top/skip parameters it is possible to paginate the result list. +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'. +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.
+Retrieve the stored secret metadata which matches the parameter dockerRegistryName. The base64 encoded field for the stored secret is not returned.
+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'. +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'. +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 +scenarioId, configurationId, executableIdsList or by execution status.
+Create an execution using the configuration specified by configurationId.
+Mark the execution with executionId as deleted.
+Retrieve details for execution with executionId.
+Update target status of the execution to stop an execution.
+Retrieve a list of executions that match the specified filter criteria. +Filter criteria include a list of executableIds, a scenarioId, a configurationId, or a execution status. +With top/skip parameters it is possible to paginate the result list. +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'. +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.
+Create an execution schedule using the configuration specified by configurationId, and schedule.
+Delete the execution schedule with executionScheduleId.
+Retrieve details for execution schedule with executionScheduleId.
+Update details of an execution schedule
+Retrieve a list of execution schedules that match the specified filter criteria. +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'. +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.
+Endpoint for uploading file. The maximum file size depends on the actual implementation
+but must not exceed 100MB. The actual file size limit can be obtained by querying
+the AI API Runtime Capabilities Endpoint and checking the limits in the section of the fileUpload extension.
Path cannot be a prefix, it must be a path to an object. +Clients may group the objects in any manner they choose by specifying path prefixes.
+Allowed mime-types will be decided by the implementation. +Content-Type header can be set to "application/octet-stream" but the implementation is responsible +for detecting the actual mime type and checking against the allowed list of mime types. +For security reasons, implementations cannot trust the mime type sent by the client.
+Example URLs: +/files/dar/schemas/schema.json +/files/icr/datasets/training/20201001/20201001-01.csv +/files/icr/datasets/training/20201001/20201001-02.csv +/files/mask-detection/training/mask-detection-20210301.tar.gz
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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'. +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'. +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. +One query parameter is mandatory, either execution ID or filter. +Use up to 10 execution IDs in a query parameter. +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'. +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.
+This retrieves the metadata of the stored secret which match the parameter objectStoreName. +The fetched secret is constructed like objectStoreName-object-store-secret +The base64 encoded field for the stored secret is not returned.
+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'. +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.
+Retrieve the access details for a repository if it exists.
+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'. +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'. +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.
+Get a resource group of a given main tenant.
+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'. +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
+Get the details about quota and usage for docker registry secrets
+Get the details about quota and usage for executables
+Get the details about quota and usage for tenant-scoped or tenant-wide generic secrets
+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'. +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.
+Retrieve information about all models available in LLM global scenario
+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'. +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
+Retrieve a single generic secret. This retrieves metadata only, not the secret data itself.
+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'. +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'. +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'. +This API is part of the 'api' service.
+Create a pipeline
+Delete a pipeline by pipeline id
+Retrieve all documents associated with a specific pipeline. Optionally, filter the results using query parameters.
+Retrieve all executions for a specific pipeline. Optionally, filter to get only the last execution.
+Get all pipelines
+Retrieve details of a specific document associated with a pipeline.
+Retrieve details of a specific document associated with a pipeline execution.
+Retrieve all documents associated with a specific pipeline execution. Optionally, filter the results using query parameters.
+Retrieve details of a specific pipeline execution by its execution ID.
+Get details of a pipeline by pipeline id
+Get pipeline status by pipeline id
+Manually trigger a pipeline
+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'. +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'. +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.
+Deletes list of documents across collections.
+Deletes a specific collection by ID. This operation is asynchronous. Poll the collection for a 404 status code.
+Deletes a specific document of a collection.
+Gets a list of collections.
+Gets a list of documents of a collection.
+Gets a specific collection by ID.
+Gets a specific collection status from monitor by ID.
+Gets a specific collection status from monitor by ID.
+Gets a specific document in a collection by ID.
+Search chunks
+Allows to add, remove and modify the chunks metadata.
+Allows to add, remove and modify the collections metadata.
+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'. +This API is part of the 'prompt-registry' service.
+Create or update an orchestration config
+Delete orchestration config
+Export orchestration config
+Get orchestration config by UUID
+Import orchestration config
+List orchestration config history
+List orchestration configs
+Copyright Ⓒ 2026 SAP SE or an SAP affiliate company. All rights reserved.
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 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 +reading lines from text.Https://github.com/encode/httpx/blob/920333ea98118e9cf617f246905d7b202510941c/httpx/_decoders.py#L258.
+