CreateRunOptions Class

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

Azure.AI.OpenAI.Assistants v1.0.0-beta.4

Source:

CreateRunOptions.cs

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

public class CreateRunOptions : System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.CreateRunOptions>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.CreateRunOptions>

type CreateRunOptions = class
    interface IJsonModel<CreateRunOptions>
    interface IPersistableModel<CreateRunOptions>

Public Class CreateRunOptions
Implements IJsonModel(Of CreateRunOptions), IPersistableModel(Of CreateRunOptions)

Inheritance

Object

CreateRunOptions

Implements

IJsonModel<CreateRunOptions> IPersistableModel<CreateRunOptions> IPersistableModel<T>

Constructors

CreateRunOptions(String)

Initializes a new instance of CreateRunOptions.

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.
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.
OverrideInstructions	The overridden system instructions that the assistant should use to run the thread.
OverrideModelName	The overridden model name that the assistant should use to run the thread.
OverrideTools	The overridden list of enabled tools that the assistant should use to run the thread. Please note ToolDefinition is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include CodeInterpreterToolDefinition, FunctionToolDefinition and RetrievalToolDefinition.

Explicit Interface Implementations

IJsonModel<CreateRunOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CreateRunOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<CreateRunOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CreateRunOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CreateRunOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.