Share via


LocalShellTool Class

Definition

A tool that allows the model to execute shell commands in a local environment.

public class LocalShellTool : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.LocalShellTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.LocalShellTool>
type LocalShellTool = class
    inherit Tool
    interface IUtf8JsonSerializable
    interface IJsonModel<LocalShellTool>
    interface IPersistableModel<LocalShellTool>
Public Class LocalShellTool
Inherits Tool
Implements IJsonModel(Of LocalShellTool), IPersistableModel(Of LocalShellTool)
Inheritance
LocalShellTool
Implements

Constructors

Name Description
LocalShellTool()

Initializes a new instance of LocalShellTool.

LocalShellTool(ToolType, IDictionary<String,BinaryData>)

Initializes a new instance of LocalShellTool.

Properties

Name Description
Type

Gets or sets the type.

(Inherited from Tool)

Methods

Name Description
DeserializeLocalShellTool(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<LocalShellTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<LocalShellTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from Tool)
IPersistableModel<LocalShellTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<LocalShellTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<LocalShellTool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from Tool)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to