OrchestrationClient.ChatCompletionExecutor

java.lang.Object

com.sap.ai.sdk.orchestration.OrchestrationClient.ChatCompletionExecutor

Enclosing class:: OrchestrationClient

public class OrchestrationClient.ChatCompletionExecutor extends Object

Client to execute a configured chat completion with a regular or streaming response.

Method Summary

Modifier and Type

Method

Description

OrchestrationChatResponse

execute()

Generate a completion for the given prompt.

Stream<String>

executeStream()

Generate a completion for the given prompt.

Stream<OrchestrationChatCompletionDelta>

executeStreamDeltas()

Generate a completion with detailed streaming deltas, including metadata.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details
- execute
  
  @Nonnull public OrchestrationChatResponse execute() throws OrchestrationClientException
  
  Generate a completion for the given prompt.
  
  Returns:
  
  the completion output
  
  Throws:
  
  OrchestrationClientException - if the request fails.
- executeStream
  
  @Nonnull public Stream<String> executeStream() throws OrchestrationClientException
  
  Generate a completion for the given prompt.
  
  Returns:
  
  a stream of message deltas
  
  Throws:
  
  OrchestrationClientException - if the request fails or if the finish reason is content_filter
  
  Since:
  
  1.1.0
- executeStreamDeltas
  
  @Nonnull public Stream<OrchestrationChatCompletionDelta> executeStreamDeltas() throws OrchestrationClientException
  
  Generate a completion with detailed streaming deltas, including metadata.
  Streaming is enabled on a copy of the configured request. The caller must close the returned stream. Content-filter finish reasons are available in the deltas rather than converted to exceptions.
  
  Returns:
  
  a stream of chat completion deltas.
  
  Throws:
  
  OrchestrationClientException - if the request fails.