Assistant Class

Definition

Namespace:

Azure.AI.OpenAI.Assistants

Assembly:

Azure.AI.OpenAI.Assistants.dll

Package:

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

Source:

Assistant.cs

Represents an assistant that can call the model and use tools.

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

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

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

Inheritance

Object

Assistant

Implements

IJsonModel<Assistant> IPersistableModel<Assistant> IPersistableModel<T>

Properties

CreatedAt	The Unix timestamp, in seconds, representing when this object was created.
Description	The description of the assistant.
FileIds	A list of attached file IDs, ordered by creation date in ascending order.
Id	The identifier, which can be referenced in API endpoints.
Instructions	The system instructions for the 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 assistant.
Tools	The collection of tools enabled for the 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<Assistant>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<Assistant>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IPersistableModel<Assistant>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<Assistant>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<Assistant>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.