FileSearchToolboxTool Class

Definition

Namespace:

Azure.AI.Projects.Agents

Assembly:

Azure.AI.Projects.Agents.dll

Package:

Azure.AI.Projects.Agents v2.1.0-beta.4

Source:

FileSearchToolboxTool.cs

A file search tool stored in a toolbox.

public class FileSearchToolboxTool : Azure.AI.Projects.Agents.ToolboxTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.FileSearchToolboxTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.FileSearchToolboxTool>

type FileSearchToolboxTool = class
    inherit ToolboxTool
    interface IJsonModel<FileSearchToolboxTool>
    interface IPersistableModel<FileSearchToolboxTool>

Public Class FileSearchToolboxTool
Inherits ToolboxTool
Implements IJsonModel(Of FileSearchToolboxTool), IPersistableModel(Of FileSearchToolboxTool)

Inheritance

Object

ToolboxTool

FileSearchToolboxTool

Implements

IJsonModel<FileSearchToolboxTool> IPersistableModel<FileSearchToolboxTool> IPersistableModel<T>

Constructors

Name	Description
FileSearchToolboxTool()	Initializes a new instance of FileSearchToolboxTool.

Properties

Name	Description
Description	Optional user-defined description for this tool or configuration. (Inherited from ToolboxTool)
Filters	Gets or sets the Filters. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types: OpenAI.InternalComparisonFilter. OpenAI.InternalCompoundFilter. </remarks> Examples: BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo". BinaryData.FromString("\"foo\""). : Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.
MaxNumResults	The maximum number of results to return. This number should be between 1 and 50 inclusive.
Name	Optional user-defined name for this tool or configuration. (Inherited from ToolboxTool)
ToolConfigs	Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime. (Inherited from ToolboxTool)
VectorStoreIds	The IDs of the vector stores to search.

Methods

Name	Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name	Description
IJsonModel<FileSearchToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<FileSearchToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ToolboxTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)	(Inherited from ToolboxTool)
IJsonModel<ToolboxTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)	(Inherited from ToolboxTool)
IPersistableModel<FileSearchToolboxTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<FileSearchToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<FileSearchToolboxTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ToolboxTool>.Create(BinaryData, ModelReaderWriterOptions)	(Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.GetFormatFromOptions(ModelReaderWriterOptions)	(Inherited from ToolboxTool)
IPersistableModel<ToolboxTool>.Write(ModelReaderWriterOptions)	(Inherited from ToolboxTool)