Class ApiChatCompletionsResponseChoice

java.lang.Object
de.xima.fc.prompt.ms.impl.service.generic_oai.client.json.ApiChatCompletionsResponseChoice
public final class ApiChatCompletionsResponseChoice extends Object
A chat completion choices returned by the chat completion endpoint.
Since:
8.5.0

  • Field Details

  • Method Details

    • finishReason

      public String finishReason()
      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.
      Returns:
      The finish reason.

    • index

      public Long index()
      The index of the choice in the list of choices.
      Returns:
      The index.

    • logProbs

      public ApiChatCompletionsResponseChoiceLogProbs logProbs()
      Log probability information for the choice.
      Returns:
      The log probabilities.

    • message

      public ApiChatCompletionsResponseChoiceMessage message()
      A chat completion message generated by the model.
      Returns:
      The generated message.