Package version:

Interface RunsCreateRunOptionalParams

Optional parameters.

interface RunsCreateRunOptionalParams {
    additionalInstructions?: null | string;
    additionalMessages?: null | {};
    include?: {};
    instructions?: null | string;
    maxCompletionTokens?: null | number;
    maxPromptTokens?: null | number;
    metadata?: any;
    model?: null | string;
    parallelToolCalls?: boolean;
    responseFormat?: null | AgentsResponseFormatOption;
    stream?: boolean;
    temperature?: null | number;
    toolChoice?: null | AgentsToolChoiceOption;
    tools?: null | {};
    topP?: null | number;
    truncationStrategy?: null | TruncationObject;
}

Hierarchy

  • unknown
    • RunsCreateRunOptionalParams

Properties

additionalInstructions? additionalMessages? include? instructions? maxCompletionTokens? maxPromptTokens? metadata? model? parallelToolCalls? responseFormat? stream? temperature? toolChoice? tools? topP? truncationStrategy?

Properties

OptionaladditionalInstructions

additionalInstructions?: null | string

Additional instructions to append at the end of the instructions for the run. This is useful for modifying the behavior on a per-run basis without overriding other instructions.

OptionaladditionalMessages

additionalMessages?: null | {}

Adds additional messages to the thread before creating the run.

Optionalinclude

include?: {}

A list of additional fields to include in the response. Currently the only supported value is step_details.tool_calls[*].file_search.results[*].content to fetch the file search result content.

Optionalinstructions

instructions?: null | string

The overridden system instructions that the agent should use to run the thread.

OptionalmaxCompletionTokens

maxCompletionTokens?: null | number

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.

OptionalmaxPromptTokens

maxPromptTokens?: null | number

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.

Optionalmetadata

metadata?: any

A set of up to 16 key/value pairs that can be attached to an object, used for storing additional information about that object in a structured format. Keys may be up to 64 characters in length and values may be up to 512 characters in length.

Optionalmodel

model?: null | string

The overridden model name that the agent should use to run the thread.

OptionalparallelToolCalls

parallelToolCalls?: boolean

If true functions will run in parallel during tool use.

OptionalresponseFormat

responseFormat?: null | AgentsResponseFormatOption

Specifies the format that the model must output.

Optionalstream

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.

Optionaltemperature

temperature?: null | number

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.

OptionaltoolChoice

toolChoice?: null | AgentsToolChoiceOption

Controls whether or not and which tool is called by the model.

Optionaltools

tools?: null | {}

The overridden list of enabled tools that the agent should use to run the thread.

OptionaltopP

topP?: null | number

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.

OptionaltruncationStrategy

truncationStrategy?: null | TruncationObject

The strategy to use for dropping messages as the context windows moves forward.

Settings

Member Visibility