AssistantsModelFactory.AssistantCreationOptions Method

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Assistants
Assembly:
Azure.AI.OpenAI.Assistants.dll
Package:
Azure.AI.OpenAI.Assistants v1.0.0-beta.4
Source:
AssistantsModelFactory.cs

Initializes a new instance of AssistantCreationOptions.

public static Azure.AI.OpenAI.Assistants.AssistantCreationOptions AssistantCreationOptions (string model = default, string name = default, string description = default, string instructions = default, System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.Assistants.ToolDefinition> tools = default, System.Collections.Generic.IEnumerable<string> fileIds = default, System.Collections.Generic.IDictionary<string,string> metadata = default);
static member AssistantCreationOptions : string * string * string * string * seq<Azure.AI.OpenAI.Assistants.ToolDefinition> * seq<string> * System.Collections.Generic.IDictionary<string, string> -> Azure.AI.OpenAI.Assistants.AssistantCreationOptions
Public Shared Function AssistantCreationOptions (Optional model As String = Nothing, Optional name As String = Nothing, Optional description As String = Nothing, Optional instructions As String = Nothing, Optional tools As IEnumerable(Of ToolDefinition) = Nothing, Optional fileIds As IEnumerable(Of String) = Nothing, Optional metadata As IDictionary(Of String, String) = Nothing) As AssistantCreationOptions

Parameters

model
String

The ID of the model to use.

name
String

The name of the new assistant.

description
String

The description of the new assistant.

instructions
String

The system instructions for the new assistant to use.

tools
IEnumerable<ToolDefinition>

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.

fileIds
IEnumerable<String>

A list of previously uploaded file IDs to attach to the assistant.

metadata
IDictionary<String,String>

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.

Returns

AssistantCreationOptions

A new AssistantCreationOptions instance for mocking.

Applies to