[Google] [PaLM] Support chat prompt (#36)

Author: qianmoQ

docs/docs/reference/google_palm/chat.md

@@ -0,0 +1,40 @@
+---
+title: Chat
+---
+
+!!! note
+
+    Support the google palm, product address: [https://developers.generativeai.google/products/palm](https://developers.generativeai.google/products/palm)
+
+### Create chat
+
+---
+
+Creates a model response for the given chat conversation.
+
+```java
+try(OpenAiClient client=OpenAiClient.builder()
+        .provider(ProviderModel.GOOGLE_PALM)
+        .model(CompletionModel.CHAT_BISON_001)
+        .apiKey(System.getProperty("google.token"))
+        .build())
+{
+    List<MessageEntity> messages = Lists.newArrayList();
+    messages.add(MessageEntity.builder()
+        .content("Hello, my name is openai-java-sdk")
+        .build());
+
+    PromptEntity prompt = PromptEntity.builder()
+        .messages(messages)
+        .build();
+
+    ChatEntity configure = ChatEntity.builder()
+        .prompt(prompt)
+        .build();
+
+    client.createPaLMChat(configure)
+        .getCandidates()
+        .forEach(System.out::println);
+}
+```
+

docs/docs/reference/google_palm/chat.zh.md

@@ -0,0 +1,39 @@
+---
+title: Chat
+---
+
+!!! note
+
+    支持 google palm，产品地址: [https://developers.generativeai.google/products/palm](https://developers.generativeai.google/products/palm)
+
+### Create chat
+
+---
+
+为给定的聊天对话创建模型响应。
+
+```java
+try(OpenAiClient client=OpenAiClient.builder()
+        .provider(ProviderModel.GOOGLE_PALM)
+        .model(CompletionModel.CHAT_BISON_001)
+        .apiKey(System.getProperty("google.token"))
+        .build())
+{
+    List<MessageEntity> messages = Lists.newArrayList();
+    messages.add(MessageEntity.builder()
+        .content("Hello, my name is openai-java-sdk")
+        .build());
+
+    PromptEntity prompt = PromptEntity.builder()
+        .messages(messages)
+        .build();
+
+    ChatEntity configure = ChatEntity.builder()
+        .prompt(prompt)
+        .build();
+
+    client.createPaLMChat(configure)
+        .getCandidates()
+        .forEach(System.out::println);
+}
+```

docs/mkdocs.yml

@@ -94,5 +94,6 @@ nav:
           - reference/anthropic/completions.md
       - Google PaLM:
           - reference/google_palm/completions.md
+          - reference/google_palm/chat.md
   - released.md
   - powered_by.md

src/main/java/org/devlive/sdk/openai/DefaultApi.java

@@ -57,10 +57,28 @@ public interface DefaultApi
     Single<CompleteResponse> fetchCompletions(@Url String url,
             @Body CompletionEntity configure);
 
+    /**
+     * Fetches the completions for PaLM.
+     *
+     * @param url the URL to fetch the completions from
+     * @param configure the configuration entity for the completions
+     * @return the complete response containing the fetched completions
+     */
     @POST
     Single<CompleteResponse> fetchPaLMCompletions(@Url String url,
             @Body org.devlive.sdk.openai.entity.google.CompletionEntity configure);
 
+    /**
+     * Fetches the PaLM Chat data from the specified URL.
+     *
+     * @param url the URL to fetch the data from
+     * @param configure the configuration of the chat entity
+     * @return a Single object representing the complete response
+     */
+    @POST
+    Single<CompleteResponse> fetchPaLMChat(@Url String url,
+            @Body org.devlive.sdk.openai.entity.google.ChatEntity configure);
+
     /**
      * Creates a model response for the given chat conversation.
      */

src/main/java/org/devlive/sdk/openai/DefaultClient.java

@@ -20,6 +20,7 @@
 import org.devlive.sdk.openai.entity.ModelEntity;
 import org.devlive.sdk.openai.entity.ModerationEntity;
 import org.devlive.sdk.openai.entity.UserKeyEntity;
+import org.devlive.sdk.openai.entity.google.MessageEntity;
 import org.devlive.sdk.openai.exception.RequestException;
 import org.devlive.sdk.openai.mixin.IgnoreUnknownMixin;
 import org.devlive.sdk.openai.model.ProviderModel;
@@ -79,6 +80,17 @@ public CompleteResponse createPaLMCompletion(org.devlive.sdk.openai.entity.googl
                 .blockingGet();
     }
 
+    public CompleteResponse createPaLMChat(org.devlive.sdk.openai.entity.google.ChatEntity configure)
+    {
+        MessageEntity message = MessageEntity.builder()
+                .content("NEXT REQUEST")
+                .build();
+        configure.getPrompt().getMessages()
+                .add(message);
+        return this.api.fetchPaLMChat(ProviderUtils.getUrl(provider, UrlModel.FETCH_COMPLETIONS), configure)
+                .blockingGet();
+    }
+
     public ChatResponse createChatCompletion(ChatEntity configure)
     {
         String url = ProviderUtils.getUrl(provider, UrlModel.FETCH_CHAT_COMPLETIONS);

src/main/java/org/devlive/sdk/openai/entity/google/ChatEntity.java

@@ -0,0 +1,35 @@
+package org.devlive.sdk.openai.entity.google;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.ToString;
+
+@Data
+@Builder
+@ToString
+@AllArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ChatEntity
+{
+    @JsonProperty(value = "prompt")
+    private PromptEntity prompt;
+
+    @JsonProperty(value = "temperature")
+    @Builder.Default
+    private Double temperature = 0.25;
+
+    @JsonProperty(value = "top_k")
+    @Builder.Default
+    private Integer topK = 40;
+
+    @JsonProperty(value = "top_p")
+    @Builder.Default
+    private Double topP = 1.0;
+
+    @JsonProperty(value = "candidate_count")
+    @Builder.Default
+    private Integer candidateCount = 1;
+}

src/main/java/org/devlive/sdk/openai/entity/google/ExampleEntity.java

@@ -0,0 +1,22 @@
+package org.devlive.sdk.openai.entity.google;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.ToString;
+
+@Data
+@Builder
+@ToString
+@AllArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class ExampleEntity
+{
+    @JsonProperty(value = "input")
+    private MessageEntity input;
+
+    @JsonProperty(value = "output")
+    private MessageEntity output;
+}

src/main/java/org/devlive/sdk/openai/entity/google/MessageEntity.java

@@ -0,0 +1,19 @@
+package org.devlive.sdk.openai.entity.google;
+
+import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import lombok.AllArgsConstructor;
+import lombok.Builder;
+import lombok.Data;
+import lombok.ToString;
+
+@Data
+@Builder
+@ToString
+@AllArgsConstructor
+@JsonIgnoreProperties(ignoreUnknown = true)
+public class MessageEntity
+{
+    @JsonProperty(value = "content")
+    private String content;
+}

src/main/java/org/devlive/sdk/openai/entity/google/PromptEntity.java

@@ -7,6 +7,8 @@
 import lombok.Data;
 import lombok.ToString;
 
+import java.util.List;
+
 @Data
 @Builder
 @ToString
@@ -16,4 +18,13 @@ public class PromptEntity
 {
     @JsonProperty(value = "text")
     private String text;
+
+    @JsonProperty(value = "context")
+    private String context;
+
+    @JsonProperty(value = "examples")
+    private List<ExampleEntity> examples;
+
+    @JsonProperty(value = "messages")
+    private List<MessageEntity> messages;
 }

src/main/java/org/devlive/sdk/openai/interceptor/GooglePaLMInterceptor.java

@@ -6,6 +6,8 @@
 import okhttp3.Request;
 import org.apache.commons.lang3.StringUtils;
 import org.devlive.sdk.openai.exception.ParamException;
+import org.devlive.sdk.openai.model.CompletionModel;
+import org.devlive.sdk.openai.utils.EnumsUtils;
 import org.devlive.sdk.openai.utils.HttpUrlUtils;
 
 import java.util.List;
@@ -29,7 +31,7 @@ protected Request prepared(Request original)
         List<String> pathSegments = Lists.newArrayList();
         httpUrl = HttpUrlUtils.removePathSegment(httpUrl);
         // https://generativelanguage.googleapis.com/v1beta2/models/text-bison-001:generateText?key=YOUR_KEY
-        pathSegments.add(0, String.join(":", this.getModel(), "generateText"));
+        pathSegments.add(0, String.join(":", this.getModel(), this.getModelType()));
         pathSegments.add(0, "models");
         pathSegments.add(0, "v1beta2");
         httpUrl = httpUrl.newBuilder()
@@ -45,4 +47,22 @@ protected Request prepared(Request original)
                 .method(original.method(), original.body())
                 .build();
     }
+
+    /**
+     * Retrieves the model type based on the current model value.
+     *
+     * @return the model type as a string
+     */
+    private String getModelType()
+    {
+        CompletionModel model = EnumsUtils.getCompleteModel(this.getModel());
+        switch (model) {
+            case TEXT_BISON_001:
+                return "generateText";
+            case CHAT_BISON_001:
+                return "generateMessage";
+            default:
+                throw new ParamException("Unsupported Google PaLM model");
+        }
+    }
 }