Share via

CreateRunOptions interface

  • Reference
Package:
@azure/openai-assistants

The details used when creating a new run of an assistant thread.

Properties

additionalInstructions

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.
assistantId

The ID of the assistant that should run the thread.
instructions

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

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.
model

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

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

Property Details

additionalInstructions

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.

additionalInstructions?: null | string

Property Value

null | string

assistantId

The ID of the assistant that should run the thread.

assistantId: string

Property Value

string

instructions

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

instructions?: null | string

Property Value

null | string

metadata

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.

metadata?: null | Record<string, string>

Property Value

null | Record<string, string>

model

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

model?: null | string

Property Value

null | string

tools

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

tools?: null | ToolDefinition[]

Property Value

null | ToolDefinition[]