Share via

ComputerUsePreviewTool Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
ComputerUsePreviewTool.cs

A tool that controls a virtual computer. Learn more about the computer tool.

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

Constructors

Name Description
ComputerUsePreviewTool()

Initializes a new instance of ComputerUsePreviewTool for deserialization.
ComputerUsePreviewTool(ComputerUsePreviewToolEnvironment, Int32, Int32)

Initializes a new instance of ComputerUsePreviewTool.
ComputerUsePreviewTool(ToolType, IDictionary<String,BinaryData>, ComputerUsePreviewToolEnvironment, Int32, Int32)

Initializes a new instance of ComputerUsePreviewTool.

Properties

Name Description
DisplayHeight

The height of the computer display.
DisplayWidth

The width of the computer display.
Environment

The type of computer environment to control.
Type

Gets or sets the type.

(Inherited from Tool)

Methods

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

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<ComputerUsePreviewTool>.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<ComputerUsePreviewTool>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<ComputerUsePreviewTool>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<ComputerUsePreviewTool>.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