FileSearchTool Class
Definition
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.
File search.
public class FileSearchTool : Azure.AI.AgentServer.Responses.Models.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.FileSearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.FileSearchTool>type FileSearchTool = class
inherit Tool
interface IJsonModel<FileSearchTool>
interface IPersistableModel<FileSearchTool>Public Class FileSearchTool
Inherits Tool
Implements IJsonModel(Of FileSearchTool), IPersistableModel(Of FileSearchTool)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| FileSearchTool(IEnumerable<String>) |
Initializes a new instance of FileSearchTool. |
Properties
| Name | Description |
|---|---|
| Description |
Optional user-defined description for this tool or configuration. |
| 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: </remarks>Examples:
|
| 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. |
| RankingOptions |
Ranking options for search. |
| VectorStoreIds |
The IDs of the vector stores to search. |
