Share via


CodeInterpreterToolCallItemResource Class

Definition

A tool call to run code.

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

Constructors

Name Description
CodeInterpreterToolCallItemResource()

Initializes a new instance of CodeInterpreterToolCallItemResource for deserialization.

CodeInterpreterToolCallItemResource(ItemType, String, CreatedBy, IDictionary<String,BinaryData>, CodeInterpreterToolCallItemResourceStatus, String, String, IReadOnlyList<CodeInterpreterOutput>)

Initializes a new instance of CodeInterpreterToolCallItemResource.

CodeInterpreterToolCallItemResource(String, CodeInterpreterToolCallItemResourceStatus, String, String, IEnumerable<CodeInterpreterOutput>)

Initializes a new instance of CodeInterpreterToolCallItemResource.

Properties

Name Description
Code

The code to run, or null if not available.

ContainerId

The ID of the container used to run the code.

CreatedBy

The information about the creator of the item.

(Inherited from ItemResource)
Id

Gets the id.

(Inherited from ItemResource)
Outputs

The outputs generated by the code interpreter, such as logs or images. Can be null if no outputs are available. Please note CodeInterpreterOutput 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 CodeInterpreterOutputImage and CodeInterpreterOutputLogs.

Status

Gets the status.

Type

Gets or sets the type.

(Inherited from ItemResource)

Methods

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

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

IJsonModel<CodeInterpreterToolCallItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

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)
IPersistableModel<CodeInterpreterToolCallItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CodeInterpreterToolCallItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CodeInterpreterToolCallItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

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)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to