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.
A tool that searches for relevant content from uploaded files. Learn more about the file search tool.
public class FileSearchTool : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FileSearchTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FileSearchTool>type FileSearchTool = class
inherit Tool
interface IUtf8JsonSerializable
interface IJsonModel<FileSearchTool>
interface IPersistableModel<FileSearchTool>Public Class FileSearchTool
Inherits Tool
Implements IJsonModel(Of FileSearchTool), IPersistableModel(Of FileSearchTool)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| FileSearchTool() |
Initializes a new instance of FileSearchTool for deserialization. |
| FileSearchTool(IEnumerable<String>) |
Initializes a new instance of FileSearchTool. |
| FileSearchTool(ToolType, IDictionary<String,BinaryData>, IList<String>, Nullable<Int32>, RankingOptions, BinaryData) |
Initializes a new instance of FileSearchTool. |
Properties
| Name | Description |
|---|---|
| Filters |
A filter to apply. 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. |
| RankingOptions |
Ranking options for search. |
| Type |
Gets or sets the type. (Inherited from Tool) |
| VectorStoreIds |
The IDs of the vector stores to search. |
Methods
| Name | Description |
|---|---|
| DeserializeFileSearchTool(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
