Share via

HostedWebSearchTool Class

Definition

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

Represents a hosted tool that can be specified to an AI service to enable it to perform web searches.

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

Remarks

This tool does not itself implement web searches. It is a marker that can be used to inform a service that the service is allowed to perform web searches if the service is capable of doing so.

Constructors

Name Description
HostedWebSearchTool()

Initializes a new instance of the HostedWebSearchTool 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)
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