Package com.oracle.bmc.generativeaiinference.model

Class CohereChatRequest.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • message

        public CohereChatRequest.Builder message​(String message)
        The text that the user inputs for the model to respond to.
        Parameters:
        message - the value to set
        Returns:
        this builder

      • chatHistory

        public CohereChatRequest.Builder chatHistory​(List<CohereMessage> chatHistory)
        The list of previous messages between the user and the model.

        The chat history gives the model context for responding to the user’s inputs.

        Parameters:
        chatHistory - the value to set
        Returns:
        this builder

      • documents

        public 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.

        Some example keys that you can add to the dictionary are “text”, “author”, and “date”. Keep the total word count of the strings in the dictionary to 300 words or less.

        Example: [ { "title": "Tall penguins", "snippet": "Emperor penguins are the tallest." }, { "title": "Penguin habitats", "snippet": "Emperor penguins only live in Antarctica." } ]

        Parameters:
        documents - the value to set
        Returns:
        this builder

      • isSearchQueriesOnly

        public 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.
        Parameters:
        isSearchQueriesOnly - the value to set
        Returns:
        this builder

      • preambleOverride

        public CohereChatRequest.Builder preambleOverride​(String preambleOverride)
        If specified, the default Cohere preamble is replaced with the provided preamble.

        A preamble is an initial guideline message that can change the model’s overall chat behavior and conversation style. Default preambles vary for different models.

        Example: You are a travel advisor. Answer with a pirate tone.

        Parameters:
        preambleOverride - the value to set
        Returns:
        this builder

      • isStream

        public CohereChatRequest.Builder isStream​(Boolean isStream)
        Whether to stream the partial progress of the model’s response.

        When set to true, as tokens become available, they are sent as data-only server-sent events.

        Parameters:
        isStream - the value to set
        Returns:
        this builder

      • maxTokens

        public CohereChatRequest.Builder maxTokens​(Integer maxTokens)
        The maximum number of output tokens that the model will generate for the response.
        Parameters:
        maxTokens - the value to set
        Returns:
        this builder

      • maxInputTokens

        public CohereChatRequest.Builder maxInputTokens​(Integer maxInputTokens)
        The maximum number of input tokens to send to the model.

        If not specified, max_input_tokens is the model’s context length limit minus a small buffer.

        Parameters:
        maxInputTokens - the value to set
        Returns:
        this builder

      • temperature

        public CohereChatRequest.Builder temperature​(Double temperature)
        A number that sets the randomness of the generated output.

        A lower temperature means less random generations. Use lower numbers for tasks such as question answering or summarizing. High temperatures can generate hallucinations or factually incorrect information. Start with temperatures lower than 1.0 and increase the temperature for more creative outputs, as you regenerate the prompts to refine the outputs.

        Parameters:
        temperature - the value to set
        Returns:
        this builder

      • topK

        public CohereChatRequest.Builder topK​(Integer topK)
        A sampling method in which the model chooses the next token randomly from the top k most likely tokens.

        A higher value for k generates more random output, which makes the output text sound more natural. The default value for k is 0 which disables this method and considers all tokens. To set a number for the likely tokens, choose an integer between 1 and 500.

        If also using top p, then the model considers only the top tokens whose probabilities add up to p percent and ignores the rest of the k tokens. For example, if k is 20 but only the probabilities of the top 10 add up to the value of p, then only the top 10 tokens are chosen.

        Parameters:
        topK - the value to set
        Returns:
        this builder

      • topP

        public 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.

        To eliminate tokens with low likelihood, assign p a minimum percentage for the next token's likelihood. For example, when p is set to 0.75, the model eliminates the bottom 25 percent for the next token. Set to 1.0 to consider all tokens and set to 0 to disable. If both k and p are enabled, p acts after k.

        Parameters:
        topP - the value to set
        Returns:
        this builder

      • promptTruncation

        public CohereChatRequest.Builder promptTruncation​(CohereChatRequest.PromptTruncation promptTruncation)
        Defaults to OFF.

        Dictates how the prompt will be constructed. With promptTruncation set to AUTO_PRESERVE_ORDER, some elements from chatHistory and documents will be dropped to construct a prompt that fits within the model’s context length limit. During this process the order of the documents and chat history will be preserved. With prompt_truncation set to OFF, no elements will be dropped.

        Parameters:
        promptTruncation - the value to set
        Returns:
        this builder

      • frequencyPenalty

        public 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.

        Greater numbers encourage the model to use new tokens, while lower numbers encourage the model to repeat the tokens. Set to 0 to disable.

        Parameters:
        frequencyPenalty - the value to set
        Returns:
        this builder

      • presencePenalty

        public 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.

        Greater numbers encourage the model to use new tokens, while lower numbers encourage the model to repeat the tokens.

        Similar to frequency penalty, a penalty is applied to previously present tokens, except that this penalty is applied equally to all tokens that have already appeared, regardless of how many times they've appeared. Set to 0 to disable.

        Parameters:
        presencePenalty - the value to set
        Returns:
        this builder

      • seed

        public 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.

        However, determinism cannot be fully guaranteed.

        Parameters:
        seed - the value to set
        Returns:
        this builder

      • isEcho

        public CohereChatRequest.Builder isEcho​(Boolean isEcho)
        Returns the full prompt that was sent to the model when True.
        Parameters:
        isEcho - the value to set
        Returns:
        this builder

      • tools

        public CohereChatRequest.Builder tools​(List<CohereTool> tools)
        A list of available tools (functions) that the model may suggest invoking before producing a text response.
        Parameters:
        tools - the value to set
        Returns:
        this builder

      • toolResults

        public CohereChatRequest.Builder toolResults​(List<CohereToolResult> toolResults)
        A list of results from invoking tools recommended by the model in the previous chat turn.
        Parameters:
        toolResults - the value to set
        Returns:
        this builder

      • isForceSingleStep

        public 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.
        Parameters:
        isForceSingleStep - the value to set
        Returns:
        this builder

      • stopSequences

        public CohereChatRequest.Builder stopSequences​(List<String> stopSequences)
        Stop the model generation when it reaches a stop sequence defined in this parameter.
        Parameters:
        stopSequences - the value to set
        Returns:
        this builder

      • isRawPrompting

        public CohereChatRequest.Builder isRawPrompting​(Boolean isRawPrompting)
        When enabled, the user\u2019s message will be sent to the model without any preprocessing.
        Parameters:
        isRawPrompting - the value to set
        Returns:
        this builder

      • citationQuality

        public 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.

        May result in less accurate citations.

        Parameters:
        citationQuality - the value to set
        Returns:
        this builder