FileSearchToolDefinitionDetails Class

Reference

Definition

Namespace:: Azure.AI.Projects

Assembly:: Azure.AI.Projects.dll

Package:: Azure.AI.Projects v1.0.0-beta.1

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

Options overrides for the file search tool.

public class FileSearchToolDefinitionDetails : System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.FileSearchToolDefinitionDetails>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.FileSearchToolDefinitionDetails>

type FileSearchToolDefinitionDetails = class
    interface IJsonModel<FileSearchToolDefinitionDetails>
    interface IPersistableModel<FileSearchToolDefinitionDetails>

Public Class FileSearchToolDefinitionDetails
Implements IJsonModel(Of FileSearchToolDefinitionDetails), IPersistableModel(Of FileSearchToolDefinitionDetails)

Inheritance: Object
FileSearchToolDefinitionDetails

Implements: IJsonModel<FileSearchToolDefinitionDetails> IPersistableModel<FileSearchToolDefinitionDetails> IPersistableModel<T>

Constructors

FileSearchToolDefinitionDetails()

Initializes a new instance of FileSearchToolDefinitionDetails.

Properties

MaxNumResults

The maximum number of results the file search tool should output. The default is 20 for gpt-4* models and 5 for gpt-3.5-turbo. This number should be between 1 and 50 inclusive.

Note that the file search tool may output fewer than max_num_results results. See the file search tool documentation for more information.

RankingOptions

Gets or sets the ranking options.

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to

Share via