Class FileSearchTool

Namespace

OpenAI.Responses

Assembly

OpenAI-DotNet.dll

A tool that searches for relevant content from uploaded files.

public sealed class FileSearchTool : ITool

Inheritance

object

FileSearchTool

Implements

ITool

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

FileSearchTool()

public FileSearchTool()

FileSearchTool(IEnumerable<string>, int?, RankingOptions, IEnumerable<IFilter>)

public FileSearchTool(IEnumerable<string> vectorStoreIds, int? maxNumberOfResults = null, RankingOptions rankingOptions = null, IEnumerable<IFilter> filters = null)

Parameters

vectorStoreIds IEnumerable<string>

maxNumberOfResults int?

rankingOptions RankingOptions

filters IEnumerable<IFilter>

FileSearchTool(string, int?, RankingOptions, IEnumerable<IFilter>)

public FileSearchTool(string vectorStoreId, int? maxNumberOfResults = null, RankingOptions rankingOptions = null, IEnumerable<IFilter> filters = null)

Parameters

vectorStoreId string

maxNumberOfResults int?

rankingOptions RankingOptions

filters IEnumerable<IFilter>

Properties

Filters

[JsonInclude]
[JsonPropertyName("filters")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public IReadOnlyList<IFilter> Filters { get; }

Property Value

IReadOnlyList<IFilter>

MaxNumberOfResults

[JsonInclude]
[JsonPropertyName("max_num_results")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public int? MaxNumberOfResults { get; }

Property Value

int?

RankingOptions

[JsonInclude]
[JsonPropertyName("ranking_options")]
[JsonIgnore(Condition = JsonIgnoreCondition.WhenWritingNull)]
public RankingOptions RankingOptions { get; }

Property Value

RankingOptions

Type

[JsonInclude]
[JsonPropertyName("type")]
public string Type { get; }

Property Value

string

VectorStoreIds

[JsonInclude]
[JsonPropertyName("vector_store_ids")]
public IReadOnlyList<string> VectorStoreIds { get; }

Property Value

IReadOnlyList<string>

Operators

implicit operator Tool(FileSearchTool)

public static implicit operator Tool(FileSearchTool fileSearchTool)

Parameters

fileSearchTool FileSearchTool

Returns

Tool