ComputerToolCallItemParam Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
A tool call to a computer use tool. See the computer use guide for more information.
public class ComputerToolCallItemParam : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemParam, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ComputerToolCallItemParam>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.ComputerToolCallItemParam>type ComputerToolCallItemParam = class
inherit ItemParam
interface IUtf8JsonSerializable
interface IJsonModel<ComputerToolCallItemParam>
interface IPersistableModel<ComputerToolCallItemParam>Public Class ComputerToolCallItemParam
Inherits ItemParam
Implements IJsonModel(Of ComputerToolCallItemParam), IPersistableModel(Of ComputerToolCallItemParam)- Inheritance
- Implements
Constructors
| Name | Description |
|---|---|
| ComputerToolCallItemParam() |
Initializes a new instance of ComputerToolCallItemParam for deserialization. |
| ComputerToolCallItemParam(ItemType, IDictionary<String,BinaryData>, String, ComputerAction, IList<ComputerToolCallSafetyCheck>) |
Initializes a new instance of ComputerToolCallItemParam. |
| ComputerToolCallItemParam(String, ComputerAction, IEnumerable<ComputerToolCallSafetyCheck>) |
Initializes a new instance of ComputerToolCallItemParam. |
Properties
| Name | Description |
|---|---|
| Action |
Gets or sets the action Please note ComputerAction is the base class. According to the scenario, a derived class of the base class might need to be assigned here, or this property needs to be casted to one of the possible derived classes. The available derived classes include ComputerActionClick, ComputerActionDoubleClick, ComputerActionDrag, ComputerActionKeyPress, ComputerActionMove, ComputerActionScreenshot, ComputerActionScroll, ComputerActionTypeKeys and ComputerActionWait. |
| CallId |
An identifier used when responding to the tool call with output. |
| PendingSafetyChecks |
The pending safety checks for the computer call. |
| SerializedAdditionalRawData | (Inherited from ItemParam) |
| Type |
Gets or sets the type. (Inherited from ItemParam) |
Methods
| Name | Description |
|---|---|
| DeserializeComputerToolCallItemParam(JsonElement, ModelReaderWriterOptions) | |
| FromResponse(Response) |
Deserializes the model from a raw response. |
| JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) | |
| ToRequestContent() |
Convert into a RequestContent. |
