Share via


CodeInterpreterToolCallItemParam Class

Definition

A tool call to run code.

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

Constructors

Name Description
CodeInterpreterToolCallItemParam()

Initializes a new instance of CodeInterpreterToolCallItemParam for deserialization.

CodeInterpreterToolCallItemParam(ItemType, IDictionary<String,BinaryData>, String, String, IList<CodeInterpreterOutput>)

Initializes a new instance of CodeInterpreterToolCallItemParam.

CodeInterpreterToolCallItemParam(String, String, IEnumerable<CodeInterpreterOutput>)

Initializes a new instance of CodeInterpreterToolCallItemParam.

Properties

Name Description
Code

The code to run, or null if not available.

ContainerId

The ID of the container used to run the code.

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.

SerializedAdditionalRawData (Inherited from ItemParam)
Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

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

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

IJsonModel<CodeInterpreterToolCallItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemParam)
IPersistableModel<CodeInterpreterToolCallItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<CodeInterpreterToolCallItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<CodeInterpreterToolCallItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemParam)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to