|
Unreal OpenAI API 1.0.0
|
Public Attributes | |
| TArray< FMessage > | Messages |
| FString | Model |
| float | Frequency_Penalty {0.0f} |
| FOptionalInt | Max_Tokens |
| TMap< FString, FString > | Metadata |
| TArray< FString > | Modalities |
| TMap< FString, int32 > | Logit_Bias |
| bool | Logprobs {false} |
| FOptionalInt | Top_Logprobs |
| FOptionalInt | Max_Completion_Tokens |
| int32 | N {1} |
| float | Presence_Penalty {0.0f} |
| FChatCompletionResponseFormat | Response_Format |
| FOptionalInt | Seed |
| FOptionalString | Service_Tier |
| TArray< FString > | Stop |
| bool | Stream {false} |
| FStreamOptions | Stream_Options |
| float | Temperature {1.0f} |
| float | Top_P {1.0f} |
| TArray< FTools > | Tools |
| FToolChoice | Tool_Choice |
| FOptionalBool | Parallel_Tool_Calls |
| FOptionalString | User |
| FOptionalString | Prompt_Cache_Key |
| FOptionalString | Prompt_Cache_Retention |
| FOptionalString | Reasoning_Effort |
| FOptionalString | Safety_Identifier |
| FOptionalBool | Store |
| FOptionalString | Verbosity |
| float FChatCompletion::Frequency_Penalty {0.0f} |
Parameters for audio output. Required when audio output is requested with modalities: ["audio"].
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.
| TMap<FString, int32> FChatCompletion::Logit_Bias |
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.
| bool FChatCompletion::Logprobs {false} |
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.
| FOptionalInt FChatCompletion::Max_Completion_Tokens |
An upper bound for the number of tokens that can be generated for a completion, including visible output tokens and reasoning tokens.
| FOptionalInt FChatCompletion::Max_Tokens |
The maximum number of tokens that can be generated in the chat completion. Deprecated in favor of max_completion_tokens.
| TArray<FMessage> FChatCompletion::Messages |
A list of messages comprising the conversation so far.
| TMap<FString, FString> FChatCompletion::Metadata |
Set of key-value pairs that can be attached to an object, useful for storing additional information about the object in a structured format.
| TArray<FString> FChatCompletion::Modalities |
Output types that you would like the model to generate, e.g. ["text"] or ["text", "audio"].
| FString FChatCompletion::Model |
ID of the model to use. See the model endpoint compatibility table for details on which models work with the Chat API.
| int32 FChatCompletion::N {1} |
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.
| FOptionalBool FChatCompletion::Parallel_Tool_Calls |
Whether to enable parallel function calling during tool use.
| float FChatCompletion::Presence_Penalty {0.0f} |
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.
| FOptionalString FChatCompletion::Prompt_Cache_Key |
Used by OpenAI to cache responses for similar requests. Replaces the user field.
| FOptionalString FChatCompletion::Prompt_Cache_Retention |
The retention policy for the prompt cache. Set to "24h" for extended caching. Values: "in-memory" or "24h".
| FOptionalString FChatCompletion::Reasoning_Effort |
Constrains effort on reasoning for reasoning models. Values: "none", "minimal", "low", "medium", "high", "xhigh".
| FChatCompletionResponseFormat FChatCompletion::Response_Format |
An object specifying the format that the model must output. 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.
| FOptionalString FChatCompletion::Safety_Identifier |
A stable identifier used to help detect users that may be violating usage policies. Replaces the user field. Maximum length of 64 characters.
| FOptionalInt FChatCompletion::Seed |
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 responseparameter to monitor changes in the backend.
| FOptionalString FChatCompletion::Service_Tier |
Specifies the latency tier to use for processing the request. This parameter is relevant for customers subscribed to the scale tier service:
If set to 'auto', and the Project is Scale tier enabled, the system will utilize scale tier credits until they are exhausted.
If set to 'auto', and the Project is not Scale tier enabled, the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.
If set to 'default', the request will be processed using the default service tier with a lower uptime SLA and no latency guarentee.
When not set, the default behavior is 'auto'. When this parameter is set, the response body will include the service_tier utilized.
| TArray<FString> FChatCompletion::Stop |
Up to 4 sequences where the API will stop generating further tokens.
| FOptionalBool FChatCompletion::Store |
Whether to store the output of this chat completion request for model distillation or evals.
| bool FChatCompletion::Stream {false} |
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. See the OpenAI Cookbook for example code [https://github.com/openai/openai-cookbook/blob/main/examples/How_to_stream_completions.ipynb]
| FStreamOptions FChatCompletion::Stream_Options |
Options for streaming response. Only set this when you set stream: true.
| float FChatCompletion::Temperature {1.0f} |
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.
| FToolChoice FChatCompletion::Tool_Choice |
Controls which (if any) tool is called by the model. "none" means the model will not call any tool and instead generates a message. "auto" means the model can pick between generating a message or calling one or more tools. "required" means the model must call one or more tools. Specifying a particular tool via {"type": "function", "function": {"name": "my_function"}} forces the model to call that tool.
none is the default when no functions are present. auto is the default if functions are present.
| TArray<FTools> FChatCompletion::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. A max of 128 functions are supported.
| FOptionalInt FChatCompletion::Top_Logprobs |
An integer between 0 and 20 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.
| float FChatCompletion::Top_P {1.0f} |
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.
| FOptionalString FChatCompletion::User |
A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Being replaced by safety_identifier and prompt_cache_key.
| FOptionalString FChatCompletion::Verbosity |
Constrains the verbosity of the model's response. Values: "low", "medium", "high".