Interface RunCreateParams

interface RunCreateParams {
    additional_instructions?: null | string;
    assistant_id: string;
    instructions?: null | string;
    metadata?: unknown;
    model?: null | string;
    tools?: null | (openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsCode | openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsRetrieval | openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsFunction)[];
}

Properties

additional_instructions? assistant_id instructions? metadata? model? tools?

Properties

Optional additional_instructions

additional_instructions?: null | string

Appends additional instructions 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.

assistant_id

assistant_id: string

The ID of the assistant to use to execute this run.

Optional instructions

instructions?: null | string

Overrides the instructions of the assistant. This is useful for modifying the behavior on a per-run basis.

Optional metadata

metadata?: unknown

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 maxium of 512 characters long.

Optional model

model?: null | string

The ID of the Model to be used to execute this run. If a value is provided here, it will override the model associated with the assistant. If not, the model associated with the assistant will be used.

Optional tools

tools?: null | (openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsCode | openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsRetrieval | openai.OpenAI.Beta.Threads.Runs.RunCreateParams.AssistantToolsFunction)[]

Override the tools the assistant can use for this run. This is useful for modifying the behavior on a per-run basis.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc