Name | Type | Description | Notes |
---|---|---|---|
assistantId | String | The ID of the assistant to use to execute this run. | |
thread | CreateThreadRequest | [optional] | |
model | ModelEnum | [optional] | |
instructions | String | Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis. | [optional] |
tools | List<CreateThreadAndRunRequestToolsInner> | Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis. | [optional] |
toolResources | CreateThreadAndRunRequestToolResources | [optional] | |
metadata | Object | Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format. Keys can be a maximum of 64 characters long and values can be a maximum of 512 characters long. | [optional] |
temperature | BigDecimal | 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. | [optional] |
topP | BigDecimal | 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. | [optional] |
stream | Boolean | If `true`, returns a stream of events that happen during the Run as server-sent events, terminating when the Run enters a terminal state with a `data: [DONE]` message. | [optional] |
maxPromptTokens | Integer | The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. | [optional] |
maxCompletionTokens | Integer | The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info. | [optional] |
truncationStrategy | TruncationObject | [optional] | |
toolChoice | AssistantsApiToolChoiceOption | [optional] | |
parallelToolCalls | Boolean | Whether to enable parallel function calling during tool use. | [optional] |
responseFormat | AssistantsApiResponseFormatOption | [optional] |
Name | Value |
---|---|
_4O | "gpt-4o" |
_4O_2024_08_06 | "gpt-4o-2024-08-06" |
_4O_2024_05_13 | "gpt-4o-2024-05-13" |
_4O_2024_08_062 | "gpt-4o-2024-08-06" |
_4O_MINI | "gpt-4o-mini" |
_4O_MINI_2024_07_18 | "gpt-4o-mini-2024-07-18" |
_4_TURBO | "gpt-4-turbo" |
_4_TURBO_2024_04_09 | "gpt-4-turbo-2024-04-09" |
_4_0125_PREVIEW | "gpt-4-0125-preview" |
_4_TURBO_PREVIEW | "gpt-4-turbo-preview" |
_4_1106_PREVIEW | "gpt-4-1106-preview" |
_4_VISION_PREVIEW | "gpt-4-vision-preview" |
_4 | "gpt-4" |
_4_0314 | "gpt-4-0314" |
_4_0613 | "gpt-4-0613" |
_4_32K | "gpt-4-32k" |
_4_32K_0314 | "gpt-4-32k-0314" |
_4_32K_0613 | "gpt-4-32k-0613" |
_3_5_TURBO | "gpt-3.5-turbo" |
_3_5_TURBO_16K | "gpt-3.5-turbo-16k" |
_3_5_TURBO_0613 | "gpt-3.5-turbo-0613" |
_3_5_TURBO_1106 | "gpt-3.5-turbo-1106" |
_3_5_TURBO_0125 | "gpt-3.5-turbo-0125" |
_3_5_TURBO_16K_0613 | "gpt-3.5-turbo-16k-0613" |