Share via

HostedFileSearchTool Class

Definition

Namespace:
Microsoft.Extensions.AI
Assembly:
Microsoft.Extensions.AI.Abstractions.dll
Package:
Microsoft.Extensions.AI.Abstractions v10.0.0
Source:
HostedFileSearchTool.cs

Represents a hosted tool that can be specified to an AI service to enable it to perform file search operations.

public ref class HostedFileSearchTool : Microsoft::Extensions::AI::AITool
public class HostedFileSearchTool : Microsoft.Extensions.AI.AITool
type HostedFileSearchTool = class
    inherit AITool
Public Class HostedFileSearchTool
Inherits AITool
Inheritance
Object
AITool
HostedFileSearchTool

Remarks

This tool is designed to facilitate file search functionality within AI services. It allows the service to search for relevant content based on the provided inputs and constraints, such as the maximum number of results.

Constructors

Name Description
HostedFileSearchTool()

Initializes a new instance of the HostedFileSearchTool class.

Properties

Name Description
AdditionalProperties

Gets any additional properties associated with the tool.

(Inherited from AITool)
Description

Gets a description of the tool, suitable for use in describing the purpose to a model.

(Inherited from AITool)
Inputs

Gets or sets a collection of AIContent to be used as input to the file search tool.
MaximumResultCount

Gets or sets a requested bound on the number of matches the tool should produce.
Name

Gets the name of the tool.

Methods

Name Description
GetService(Type, Object)

Asks the AITool for an object of the specified type serviceType.

(Inherited from AITool)
GetService<TService>(Object)

Asks the AITool for an object of type TService.

(Inherited from AITool)
ToString()

Returns a string that represents the current object.

(Inherited from AITool)

Extension Methods

Name Description
AsOpenAIResponseTool(AITool)

Creates an OpenAI ResponseTool from an AITool.

Applies to