CreateAndRunThreadOptions interface

Package:

@azure/openai-assistants

The details used when creating and immediately running a new assistant thread.

Properties

assistantId	The ID of the assistant for which the thread should be created.
instructions	The overridden system instructions 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 that the assistant should use to run the thread.
thread	The details used to create the new thread.
tools	The overridden list of enabled tools the assistant should use to run the thread.

Property Details

assistantId

The ID of the assistant for which the thread should be created.

assistantId: string

Property Value

string

instructions

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

instructions?: string

Property Value

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 that the assistant should use to run the thread.

model?: string

Property Value

string

thread

The details used to create the new thread.

thread?: AssistantThreadCreationOptions

Property Value

AssistantThreadCreationOptions

tools

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

tools?: ToolDefinition[]

Property Value

ToolDefinition[]