Add log probability code

Author: a-d

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatCompletionChoice.java

@@ -3,6 +3,7 @@
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.sap.ai.sdk.foundationmodels.openai.model.OpenAiChatMessage.OpenAiChatAssistantMessage;
 import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
 import lombok.AccessLevel;
 import lombok.EqualsAndHashCode;
 import lombok.Getter;
@@ -21,6 +22,12 @@ public class OpenAiChatCompletionChoice extends OpenAiCompletionChoice {
   @Setter(onMethod_ = @Nonnull, value = AccessLevel.PACKAGE)
   private OpenAiChatAssistantMessage message;
 
+  /** Completion chat log probability information for the choice. */
+  @JsonProperty("logprobs")
+  @Getter(onMethod_ = @Nullable)
+  @Setter(onMethod_ = @Nullable, value = AccessLevel.PACKAGE)
+  private OpenAiChatCompletionLogProbability logProbs;
+
   void addDelta(@Nonnull final OpenAiDeltaChatCompletionChoice delta) {
     super.addDelta(delta);
 

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatCompletionLogProbability.java

@@ -0,0 +1,17 @@
+package com.sap.ai.sdk.foundationmodels.openai.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.List;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+/** Log probability information for the choice. */
+@Accessors(chain = true)
+@EqualsAndHashCode
+@ToString
+public class OpenAiChatCompletionLogProbability {
+  /** A list of message content tokens with log probability information. */
+  @JsonProperty("content")
+  private List<OpenAiChatCompletionLogProbabilityTop> content;
+}

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatCompletionLogProbabilityToken.java

@@ -0,0 +1,26 @@
+package com.sap.ai.sdk.foundationmodels.openai.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import javax.annotation.Nullable;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+/** Log probability information for the choice. */
+@Accessors(chain = true)
+@EqualsAndHashCode
+@ToString
+public class OpenAiChatCompletionLogProbabilityToken {
+  /** The token. */
+  @JsonProperty("token")
+  private String token;
+
+  /** The log probability of this token. */
+  @JsonProperty("logprob")
+  private Number logprob;
+
+  /** A list of integers representing the UTF-8 bytes representation of the token. */
+  @JsonProperty("bytes")
+  @Nullable
+  private int[] bytes;
+}

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiChatCompletionLogProbabilityTop.java

@@ -0,0 +1,19 @@
+package com.sap.ai.sdk.foundationmodels.openai.model;
+
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.EqualsAndHashCode;
+import lombok.ToString;
+import lombok.experimental.Accessors;
+
+/** Log probability information for the choice. */
+@Accessors(chain = true)
+@EqualsAndHashCode(callSuper = true)
+@ToString
+public class OpenAiChatCompletionLogProbabilityTop extends OpenAiChatCompletionLogProbabilityToken {
+  /**
+   * List of the most likely tokens and their log probability, at this token position. In rare
+   * cases, there may be fewer than the number of requested `top_logprobs` returned.
+   */
+  @JsonProperty("top_logprobs")
+  private OpenAiChatCompletionLogProbabilityToken top_logprobs;
+}

foundation-models/openai/src/main/java/com/sap/ai/sdk/foundationmodels/openai/model/OpenAiCompletionParameters.java

@@ -109,6 +109,24 @@ public class OpenAiCompletionParameters {
   @JsonProperty("stream")
   private Boolean stream;
 
+  /**
+   * Whether to return log probabilities of the output tokens or not. If true, returns the log
+   * probabilities of each output token returned in the `content` of `message`. This option is
+   * currently not available on the `gpt-4-vision-preview` model. Default: false.
+   */
+  @JsonProperty("logprobs")
+  @Setter(onParam_ = @Nullable)
+  private Boolean logprobs;
+
+  /**
+   * An integer between 0 and 5 specifying the number of most likely tokens to return at each token
+   * position, each with an associated log probability. `logprobs` must be set to `true` if this
+   * parameter is used.
+   */
+  @JsonProperty("top_logprobs")
+  @Setter(onParam_ = @Nullable)
+  private Integer topLogprobs;
+
   /**
    * If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only
    * <a