Share via


LocalShellToolCallItemResource Class

Definition

A tool call to run a command on the local shell.

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

Constructors

Name Description
LocalShellToolCallItemResource()

Initializes a new instance of LocalShellToolCallItemResource for deserialization.

LocalShellToolCallItemResource(ItemType, String, CreatedBy, IDictionary<String, BinaryData>, LocalShellToolCallItemResourceStatus, String, LocalShellExecAction)

Initializes a new instance of LocalShellToolCallItemResource.

LocalShellToolCallItemResource(String, LocalShellToolCallItemResourceStatus, String, LocalShellExecAction)

Initializes a new instance of LocalShellToolCallItemResource.

Properties

Name Description
Action

Gets the action.

CallId

The unique ID of the local shell tool call generated by the model.

CreatedBy

The information about the creator of the item.

(Inherited from ItemResource)
Id

Gets the id.

(Inherited from ItemResource)
Status

Gets the status.

Type

Gets or sets the type.

(Inherited from ItemResource)

Methods

Name Description
DeserializeLocalShellToolCallItemResource(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<ItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemResource)
IJsonModel<LocalShellToolCallItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<LocalShellToolCallItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<ItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemResource)
IPersistableModel<LocalShellToolCallItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<LocalShellToolCallItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<LocalShellToolCallItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to