Share via

AssistantsModelFactory.CreateRunOptions 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 CreateRunOptions.

public static Azure.AI.OpenAI.Assistants.CreateRunOptions CreateRunOptions (string assistantId = default, string overrideModelName = default, string overrideInstructions = default, string additionalInstructions = default, System.Collections.Generic.IEnumerable<Azure.AI.OpenAI.Assistants.ToolDefinition> overrideTools = default, System.Collections.Generic.IDictionary<string,string> metadata = default);
static member CreateRunOptions : string * string * string * string * seq<Azure.AI.OpenAI.Assistants.ToolDefinition> * System.Collections.Generic.IDictionary<string, string> -> Azure.AI.OpenAI.Assistants.CreateRunOptions
Public Shared Function CreateRunOptions (Optional assistantId As String = Nothing, Optional overrideModelName As String = Nothing, Optional overrideInstructions As String = Nothing, Optional additionalInstructions As String = Nothing, Optional overrideTools As IEnumerable(Of ToolDefinition) = Nothing, Optional metadata As IDictionary(Of String, String) = Nothing) As CreateRunOptions

Parameters

assistantId
String

The ID of the assistant that should run the thread.

overrideModelName
String

The overridden model name that the assistant should use to run the thread.

overrideInstructions
String

The overridden system instructions that the assistant should use to run the thread.

additionalInstructions
String

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.

overrideTools
IEnumerable<ToolDefinition>

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.

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

CreateRunOptions

A new CreateRunOptions instance for mocking.

Applies to