DeepResearchToolDefinition Class

Definition

Namespace:: Azure.AI.Agents.Persistent

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

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

Source:: DeepResearchToolDefinition.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.

The input definition information for a Deep Research tool as used to configure an agent.

public class DeepResearchToolDefinition : Azure.AI.Agents.Persistent.ToolDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.Agents.Persistent.DeepResearchToolDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Agents.Persistent.DeepResearchToolDefinition>

type DeepResearchToolDefinition = class
    inherit ToolDefinition
    interface IJsonModel<DeepResearchToolDefinition>
    interface IPersistableModel<DeepResearchToolDefinition>

Public Class DeepResearchToolDefinition
Inherits ToolDefinition
Implements IJsonModel(Of DeepResearchToolDefinition), IPersistableModel(Of DeepResearchToolDefinition)

Inheritance: Object

ToolDefinition
DeepResearchToolDefinition

Implements: IJsonModel<DeepResearchToolDefinition> IPersistableModel<DeepResearchToolDefinition> IPersistableModel<T>

Constructors

DeepResearchToolDefinition(DeepResearchDetails)

Initializes a new instance of DeepResearchToolDefinition.

Properties

DeepResearch

The deep_research tool definition configuration.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

IJsonModel<DeepResearchToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<DeepResearchToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter.
IJsonModel<ToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model. (Inherited from ToolDefinition)
IJsonModel<ToolDefinition>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	Writes the model to the provided Utf8JsonWriter. (Inherited from ToolDefinition)
IPersistableModel<DeepResearchToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<DeepResearchToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<DeepResearchToolDefinition>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData.
IPersistableModel<ToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model. (Inherited from ToolDefinition)
IPersistableModel<ToolDefinition>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service. (Inherited from ToolDefinition)
IPersistableModel<ToolDefinition>.Write(ModelReaderWriterOptions)	Writes the model into a BinaryData. (Inherited from ToolDefinition)

Applies to