CreateRunStreamingOptions Class

Definition

Namespace:: Azure.AI.Agents.Persistent

Assembly:: Azure.AI.Agents.Persistent.dll

Package:: Azure.AI.Agents.Persistent v1.1.0

Package:: Azure.AI.Agents.Persistent v1.2.0-beta.8

Source:: CreateRunStreamingOptions.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

public class CreateRunStreamingOptions

type CreateRunStreamingOptions = class

Public Class CreateRunStreamingOptions

Inheritance: Object
CreateRunStreamingOptions

Constructors

Name	Description
CreateRunStreamingOptions()

Properties

Name	Description
AdditionalInstructions	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.
AdditionalMessages	Adds additional messages to the thread before creating the run.
AutoFunctionCallOptions	If specified, function calls defined in tools will be called automatically.
Include	A list of additional fields to include in the response. Currently the only supported value is `step_details.tool_calls[].file_search.results[].content`
MaxCompletionTokens	The maximum number of completion tokens that may be used over the course of the run. The run will make a best effort to use only the number of completion tokens specified, across multiple turns of the run. If the run exceeds the number of completion tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.
MaxPromptTokens	The maximum number of prompt tokens that may be used over the course of the run. The run will make a best effort to use only the number of prompt tokens specified, across multiple turns of the run. If the run exceeds the number of prompt tokens specified, the run will end with status `incomplete`. See `incomplete_details` for more info.
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.
OverrideInstructions	The overridden system instructions that the Agent should use to run the thread.
OverrideModelName	The overridden model name that the Agent should use to run the thread.
OverrideTools	The overridden list of enabled tools that the Agent should use to run the thread.
ParallelToolCalls	If `true` functions will run in parallel during tool use.
ResponseFormat	Specifies the format that the model must output.
Temperature	What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.
ToolChoice	Controls whether or not and which tool is called by the model.
ToolResources	The overridden tool resources that the Agent should use to run the thread.
TopP	An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered. We generally recommend altering this or temperature but not both.
TruncationStrategy	The strategy to use for dropping messages as the context windows moves forward.

Applies to

Feedback

Was this page helpful?