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

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

Parameters

assistantId
String

The ID of the assistant for which the thread should be created.

thread
AssistantThreadCreationOptions

The details used to create the new thread.

overrideModelName
String

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

overrideInstructions
String

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

overrideTools
IEnumerable<ToolDefinition>

The overridden list of enabled tools 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

CreateAndRunThreadOptions

A new CreateAndRunThreadOptions instance for mocking.

Applies to