AssistantCreationOptions Class

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

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

Source:

AssistantCreationOptions.cs

The request details to use when creating a new assistant.

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

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

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

Inheritance

Object

AssistantCreationOptions

Implements

IJsonModel<AssistantCreationOptions> IPersistableModel<AssistantCreationOptions> IPersistableModel<T>

Constructors

AssistantCreationOptions(String)

Initializes a new instance of AssistantCreationOptions.

Properties

Description	The description of the new assistant.
FileIds	A list of previously uploaded file IDs to attach to the assistant.
Instructions	The system instructions for the new assistant to use.
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 ID of the model to use.
Name	The name of the new assistant.
Tools	The collection of tools to enable for the new assistant. 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<AssistantCreationOptions>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<AssistantCreationOptions>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<AssistantCreationOptions>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<AssistantCreationOptions>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<AssistantCreationOptions>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.