BingGroundingTool Class

Definition

The input definition information for a bing grounding search tool as used to configure an agent.

public class BingGroundingTool : Azure.AI.Projects.Agents.ProjectsAgentTool, System.ClientModel.Primitives.IJsonModel<Azure.AI.Projects.Agents.BingGroundingTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Projects.Agents.BingGroundingTool>
type BingGroundingTool = class
    inherit ProjectsAgentTool
    interface IJsonModel<BingGroundingTool>
    interface IPersistableModel<BingGroundingTool>
Public Class BingGroundingTool
Inherits ProjectsAgentTool
Implements IJsonModel(Of BingGroundingTool), IPersistableModel(Of BingGroundingTool)
Inheritance
BingGroundingTool
Implements

Constructors

Name Description
BingGroundingTool(BingGroundingSearchToolOptions)

Initializes a new instance of BingGroundingTool.

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

Name

Optional user-defined name for this tool or configuration.

SearchToolOptions

The bing grounding search tool parameters.

ToolConfigs

Per-tool configuration map. Keys are tool names or * (catch-all default). Resolution order: exact tool name match takes priority over *. Unknown tool names are silently ignored at runtime.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<BingGroundingTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<BingGroundingTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ProjectsAgentTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IJsonModel<ProjectsAgentTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<BingGroundingTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<BingGroundingTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<BingGroundingTool>.Write(ModelReaderWriterOptions)
IPersistableModel<ProjectsAgentTool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<ProjectsAgentTool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<ProjectsAgentTool>.Write(ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)

Applies to