Skip to main content
Module

x/openai/resources/beta/threads/threads.ts>ThreadCreateAndRunParamsBase

Deno build of the official Typescript library for the OpenAI API.
Extremely Popular
Go to Latest
interface ThreadCreateAndRunParamsBase
import { type ThreadCreateAndRunParamsBase } from "https://deno.land/x/openai@v4.29.0/resources/beta/threads/threads.ts";

Properties

assistant_id: string

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

optional
instructions: string | null

Override the default system message of the assistant. This is useful for modifying the behavior on a per-run basis.

optional
metadata: unknown | null

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: string | null

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
stream: boolean | null

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.

If no thread is provided, an empty thread will be created.

optional
tools: Array<AssistantsAPI.CodeInterpreterTool | AssistantsAPI.RetrievalTool | AssistantsAPI.FunctionTool> | null

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