Package org.springframework.ai.zhipuai.api

Record Class ZhiPuAiApi.ChatCompletionRequest

java.lang.Object
java.lang.Record
org.springframework.ai.zhipuai.api.ZhiPuAiApi.ChatCompletionRequest
Record Components:
messages - A list of messages comprising the conversation so far.
model - ID of the model to use.
maxTokens - The maximum number of tokens to generate in the chat completion. The total length of input tokens and generated tokens is limited by the model's context length.
stop - Up to 4 sequences where the API will stop generating further tokens.
stream - If set, partial message deltas will be sent.Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.
temperature - What sampling temperature to use, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. We generally recommend altering this or top_p but not both.
topP - An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
tools - A list of tools the model may call. Currently, only functions are supported as a tool. Use this to provide a list of functions the model may generate JSON inputs for.
toolChoice - Controls which (if any) function is called by the model. none means the model will not call a function and instead generates a message. auto means the model can pick between generating a message or calling a function. Specifying a particular function via {"type: "function", "function": {"name": "my_function"}} forces the model to call that function. none is the default when no functions are present. auto is the default if functions are present. Use the ZhiPuAiApi.ChatCompletionRequest.ToolChoiceBuilder to create the tool choice value.
user - A unique identifier representing your end-user, which can help ZhiPuAI to monitor and detect abuse.
requestId - A unique identifier for the request. If set, the request will be logged and can be used for debugging purposes.
doSample - If set, the model will use sampling to generate the next token. If not set, the model will use greedy decoding to generate the next token.
Enclosing class:
ZhiPuAiApi
public static record ZhiPuAiApi.ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, String model, Integer maxTokens, List<String> stop, Boolean stream, Double temperature, Double topP, List<ZhiPuAiApi.FunctionTool> tools, Object toolChoice, String user, String requestId, Boolean doSample) extends Record
Creates a model response for the given chat conversation.

  • Constructor Details

    • ChatCompletionRequest

      public ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, String model, Double temperature)
      Shortcut constructor for a chat completion request with the given messages and model.
      Parameters:
      messages - A list of messages comprising the conversation so far.
      model - ID of the model to use.
      temperature - What sampling temperature to use, between 0 and 1.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, String model, Double temperature, boolean stream)
      Shortcut constructor for a chat completion request with the given messages, model and control for streaming.
      Parameters:
      messages - A list of messages comprising the conversation so far.
      model - ID of the model to use.
      temperature - What sampling temperature to use, between 0 and 1.
      stream - If set, partial message deltas will be sent.Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, String model, List<ZhiPuAiApi.FunctionTool> tools, Object toolChoice)
      Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice. Streaming is set to false, temperature to 0.8 and all other parameters are null.
      Parameters:
      messages - A list of messages comprising the conversation so far.
      model - ID of the model to use.
      tools - A list of tools the model may call. Currently, only functions are supported as a tool.
      toolChoice - Controls which (if any) function is called by the model.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, Boolean stream)
      Shortcut constructor for a chat completion request with the given messages, model, tools and tool choice. Streaming is set to false, temperature to 0.8 and all other parameters are null.
      Parameters:
      messages - A list of messages comprising the conversation so far.
      stream - If set, partial message deltas will be sent.Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message.

    • ChatCompletionRequest

      public ChatCompletionRequest(List<ZhiPuAiApi.ChatCompletionMessage> messages, String model, Integer maxTokens, List<String> stop, Boolean stream, Double temperature, Double topP, List<ZhiPuAiApi.FunctionTool> tools, Object toolChoice, String user, String requestId, Boolean doSample)
      Creates an instance of a ChatCompletionRequest record class.
      Parameters:
      messages - the value for the messages record component
      model - the value for the model record component
      maxTokens - the value for the maxTokens record component
      stop - the value for the stop record component
      stream - the value for the stream record component
      temperature - the value for the temperature record component
      topP - the value for the topP record component
      tools - the value for the tools record component
      toolChoice - the value for the toolChoice record component
      user - the value for the user record component
      requestId - the value for the requestId record component
      doSample - the value for the doSample record component

  • Method Details

    • toString

      public final String toString()
      Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.
      Specified by:
      toString in class Record
      Returns:
      a string representation of this object

    • hashCode

      public final int hashCode()
      Returns a hash code value for this object. The value is derived from the hash code of each of the record components.
      Specified by:
      hashCode in class Record
      Returns:
      a hash code value for this object

    • equals

      public final boolean equals(Object o)
      Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. All components in this record class are compared with Objects::equals(Object,Object).
      Specified by:
      equals in class Record
      Parameters:
      o - the object with which to compare
      Returns:
      true if this object is the same as the o argument; false otherwise.

    • messages

      public List<ZhiPuAiApi.ChatCompletionMessage> messages()
      Returns the value of the messages record component.
      Returns:
      the value of the messages record component

    • model

      public String model()
      Returns the value of the model record component.
      Returns:
      the value of the model record component

    • maxTokens

      public Integer maxTokens()
      Returns the value of the maxTokens record component.
      Returns:
      the value of the maxTokens record component

    • stop

      public List<String> stop()
      Returns the value of the stop record component.
      Returns:
      the value of the stop record component

    • stream

      public Boolean stream()
      Returns the value of the stream record component.
      Returns:
      the value of the stream record component

    • temperature

      public Double temperature()
      Returns the value of the temperature record component.
      Returns:
      the value of the temperature record component

    • topP

      public Double topP()
      Returns the value of the topP record component.
      Returns:
      the value of the topP record component

    • tools

      public List<ZhiPuAiApi.FunctionTool> tools()
      Returns the value of the tools record component.
      Returns:
      the value of the tools record component

    • toolChoice

      public Object toolChoice()
      Returns the value of the toolChoice record component.
      Returns:
      the value of the toolChoice record component

    • user

      public String user()
      Returns the value of the user record component.
      Returns:
      the value of the user record component

    • requestId

      public String requestId()
      Returns the value of the requestId record component.
      Returns:
      the value of the requestId record component

    • doSample

      public Boolean doSample()
      Returns the value of the doSample record component.
      Returns:
      the value of the doSample record component