OrchestrationClient.LowLevelChatCompletionExecutor

java.lang.Object

com.sap.ai.sdk.orchestration.OrchestrationClient.LowLevelChatCompletionExecutor

Enclosing class:: OrchestrationClient

public class OrchestrationClient.LowLevelChatCompletionExecutor extends Object

Client to execute a custom low-level chat completion request.

Method Summary

Modifier and Type

Method

Description

CompletionPostResponse

execute()

Execute the request and return the low-level response.

Stream<String>

executeStream()

Execute the request with text streaming.

Stream<OrchestrationChatCompletionDelta>

executeStreamDeltas()

Execute the request with detailed streaming deltas.

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

Method Details
- execute
  
  @Nonnull public CompletionPostResponse execute() throws OrchestrationClientException
  
  Execute the request and return the low-level response.
  
  Returns:
  
  the response data object from orchestration.
  
  Throws:
  
  OrchestrationClientException - if the request fails.
- executeStream
  
  @Nonnull public Stream<String> executeStream() throws OrchestrationClientException
  
  Execute the request with text streaming.
  The caller must close the returned stream.
  
  Returns:
  
  a stream of message text deltas.
  
  Throws:
  
  OrchestrationClientException - if the request fails or the output is filtered.
- executeStreamDeltas
  
  @Nonnull public Stream<OrchestrationChatCompletionDelta> executeStreamDeltas() throws OrchestrationClientException
  
  Execute the request with detailed streaming deltas.
  Streaming is enabled on a copy of the supplied 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.