FabricIQPreviewTool Class

Definition

A FabricIQ server-side tool.

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

Constructors

Name Description
FabricIQPreviewTool(String)

Initializes a new instance of FabricIQPreviewTool.

Properties

Name Description
Description

Optional user-defined description for this tool or configuration.

Name

Optional user-defined name for this tool or configuration.

ProjectConnectionId

The ID of the FabricIQ project connection.

RequireApproval

(Optional) Whether the agent requires approval before executing actions. Default is always.

To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions).

To assign an already formatted json string to this property use FromString(String).

<remarks> Supported types:

  • OpenAI.InternalMCPToolRequireApproval.
  • String.
</remarks>

Examples:

  • BinaryData.FromObjectAsJson("foo"). : Creates a payload of "foo".
  • BinaryData.FromString("\"foo\""). : Creates a payload of "foo".
  • BinaryData.FromObjectAsJson(new { key = "value" }). : Creates a payload of { "key": "value" }.
  • BinaryData.FromString("{\"key\": \"value\"}"). : Creates a payload of { "key": "value" }.

ServerLabel

(Optional) The label of the FabricIQ MCP server to connect to.

ServerUrl

(Optional) The URL of the FabricIQ MCP server. If not provided, the URL from the project connection will be used.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<FabricIQPreviewTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<FabricIQPreviewTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<ProjectsAgentTool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IJsonModel<ProjectsAgentTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from ProjectsAgentTool)
IPersistableModel<FabricIQPreviewTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<FabricIQPreviewTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<FabricIQPreviewTool>.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