Instance Propertymacpaw.openai 0.3.3OpenAI

temperature

What sampling temperature to use, between 0 and 2. 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. Defaults to 1

ChatQuery.swift:59
let temperature: Double?

Other members in extension

Types

Type members

Instance members

  • let frequencyPenalty: Double?

    Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim. Defaults to 0 https://platform.openai.com/docs/guides/text-generation/parameter-details

  • let logitBias: [String : Int]?

    Modify the likelihood of specified tokens appearing in the completion. Accepts a JSON object that maps tokens (specified by their token ID in the tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token. Defaults to null

  • let logprobs: Bool?

    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. Defaults to false

  • let maxCompletionTokens: Int?

    An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens. https://platform.openai.com/docs/api-reference/chat/create#chat-create-max_completion_tokens See more about reasoning tokens: https://platform.openai.com/docs/guides/reasoning

  • let maxTokens: Int?

    The maximum number of tokens to generate in the completion. The total length of input tokens and generated tokens is limited by the model’s context length. https://platform.openai.com/tokenizer

  • let messages: [Self.ChatCompletionMessageParam]

    A list of messages comprising the conversation so far

  • let model: Model

    ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API. https://platform.openai.com/docs/models/model-endpoint-compatibility

  • let n: Int?

    How many chat completion choices to generate for each input message. Note that you will be charged based on the number of generated tokens across all of the choices. Keep n as 1 to minimize costs. Defaults to 1

  • let presencePenalty: Double?

    Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model’s likelihood to talk about new topics. https://platform.openai.com/docs/guides/text-generation/parameter-details

  • let reasoningEffort: ReasoningEffort?

    Constrains effort on reasoning for reasoning models. Currently supported values are low, medium, and high. Reducing reasoning effort can result in faster responses and fewer tokens used on reasoning in a response. Applies only to reasoning models (o1, o3-mini, etc)

  • let responseFormat: Self.ResponseFormat?

    An object specifying the format that the model must output. Compatible with gpt-4-1106-preview and gpt-3.5-turbo-1106. Setting to { “type”: “json_object” } enables JSON mode, which guarantees the message the model generates is valid JSON. Important: when using JSON mode, you must also instruct the model to produce JSON yourself via a system or user message. Without this, the model may generate an unending stream of whitespace until the generation reaches the token limit, resulting in a long-running and seemingly “stuck” request. Also note that the message content may be partially cut off if finish_reason=“length”, which indicates the generation exceeded max_tokens or the conversation exceeded the max context length.

  • let seed: Int?

    This feature is in Beta. If specified, our system will make a best effort to sample deterministically, such that repeated requests with the same seed and parameters should return the same result. Determinism is not guaranteed, and you should refer to the system_fingerprint response parameter to monitor changes in the backend.

  • let stop: Stop?

    Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence. Defaults to null

  • var stream: Bool

    If set, partial message deltas will be sent, like in ChatGPT. Tokens will be sent as data-only server-sent events as they become available, with the stream terminated by a data: [DONE] message. https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format

  • let toolChoice: Self.ChatCompletionFunctionCallOptionParam?

    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

  • let tools: [Self.ChatCompletionToolParam]?

    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.

  • let topLogprobs: Int?

    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.

  • let topP: Double?

    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. Defaults to 1

  • let user: String?

    A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. https://platform.openai.com/docs/guides/safety-best-practices/end-user-ids