static CohereChatRequest.Builder |
CohereChatRequest.builder() |
Create a new builder.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.chatHistory(List<CohereMessage> chatHistory) |
The list of previous messages between the user and the model.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.citationQuality(CohereChatRequest.CitationQuality citationQuality) |
When FAST is selected, citations are generated at the same time as the text output and
the request will be completed sooner.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.copy(CohereChatRequest model) |
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.documents(List<Object> documents) |
A list of relevant documents that the model can refer to for generating grounded
responses to the user’s requests.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.frequencyPenalty(Double frequencyPenalty) |
To reduce repetitiveness of generated tokens, this number penalizes new tokens based on
their frequency in the generated text so far.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.isEcho(Boolean isEcho) |
Returns the full prompt that was sent to the model when True.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.isForceSingleStep(Boolean isForceSingleStep) |
When enabled, the model will issue (potentially multiple) tool calls in a single step,
before it receives the tool responses and directly answers the user’s original message.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.isRawPrompting(Boolean isRawPrompting) |
When enabled, the user\u2019s message will be sent to the model without any
preprocessing.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.isSearchQueriesOnly(Boolean isSearchQueriesOnly) |
When set to true, the response contains only a list of generated search queries without
the search results and the model will not respond to the user’s message.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.isStream(Boolean isStream) |
Whether to stream the partial progress of the model’s response.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.maxInputTokens(Integer maxInputTokens) |
The maximum number of input tokens to send to the model.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.maxTokens(Integer maxTokens) |
The maximum number of output tokens that the model will generate for the response.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.message(String message) |
The text that the user inputs for the model to respond to.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.preambleOverride(String preambleOverride) |
If specified, the default Cohere preamble is replaced with the provided preamble.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.presencePenalty(Double presencePenalty) |
To reduce repetitiveness of generated tokens, this number penalizes new tokens based on
whether they’ve appeared in the generated text so far.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.promptTruncation(CohereChatRequest.PromptTruncation promptTruncation) |
Defaults to OFF.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.responseFormat(CohereResponseFormat responseFormat) |
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.safetyMode(CohereChatRequest.SafetyMode safetyMode) |
Safety mode: Adds a safety instruction for the model to use when generating responses.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.seed(Integer seed) |
If specified, the backend will make a best effort to sample tokens deterministically, so
that repeated requests with the same seed and parameters yield the same result.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.stopSequences(List<String> stopSequences) |
Stop the model generation when it reaches a stop sequence defined in this parameter.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.streamOptions(StreamOptions streamOptions) |
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.temperature(Double temperature) |
A number that sets the randomness of the generated output.
|
CohereChatRequest.Builder |
CohereChatRequest.toBuilder() |
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.toolResults(List<CohereToolResult> toolResults) |
A list of results from invoking tools recommended by the model in the previous chat turn.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.tools(List<CohereTool> tools) |
A list of available tools (functions) that the model may suggest invoking before
producing a text response.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.topK(Integer topK) |
A sampling method in which the model chooses the next token randomly from the top k most
likely tokens.
|
CohereChatRequest.Builder |
CohereChatRequest.Builder.topP(Double topP) |
If set to a probability 0.0 < p < 1.0, it ensures that only the most likely tokens, with
total probability mass of p, are considered for generation at each step.
|