CodeInterpreterTool 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:

CodeInterpreterTool.cs

A tool that runs Python code to help generate a response to a prompt.

public class CodeInterpreterTool : Azure.AI.AgentServer.Contracts.Generated.OpenAI.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.CodeInterpreterTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.CodeInterpreterTool>

type CodeInterpreterTool = class
    inherit Tool
    interface IUtf8JsonSerializable
    interface IJsonModel<CodeInterpreterTool>
    interface IPersistableModel<CodeInterpreterTool>

Public Class CodeInterpreterTool
Inherits Tool
Implements IJsonModel(Of CodeInterpreterTool), IPersistableModel(Of CodeInterpreterTool)

Inheritance

Object

Tool

CodeInterpreterTool

Implements

IUtf8JsonSerializable IJsonModel<CodeInterpreterTool> IPersistableModel<CodeInterpreterTool> IPersistableModel<T>

Constructors

Name	Description
CodeInterpreterTool()	Initializes a new instance of CodeInterpreterTool for deserialization.
CodeInterpreterTool(BinaryData)	Initializes a new instance of CodeInterpreterTool.
CodeInterpreterTool(ToolType, IDictionary<String,BinaryData>, BinaryData)	Initializes a new instance of CodeInterpreterTool.

Properties

Name	Description
Container	The code interpreter container. Can be a container ID or an object that specifies uploaded file IDs to make available to your code. To assign an object to this property use FromObjectAsJson<T>(T, JsonSerializerOptions). To assign an already formatted json string to this property use FromString(String). <remarks> Supported types: String CodeInterpreterToolAuto </remarks> Examples: BinaryData.FromObjectAsJson("foo"): Creates a payload of "foo". BinaryData.FromString("\"foo\""): Creates a payload of "foo". BinaryData.FromObjectAsJson(new { key = "value" }): Creates a payload of { "key": "value" }. BinaryData.FromString("{\"key\": \"value\"}"): Creates a payload of { "key": "value" }.
Type	Gets or sets the type. (Inherited from Tool)

Methods

Name	Description
DeserializeCodeInterpreterTool(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<CodeInterpreterTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)	Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<CodeInterpreterTool>.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<CodeInterpreterTool>.Create(BinaryData, ModelReaderWriterOptions)	Converts the provided BinaryData into a model.
IPersistableModel<CodeInterpreterTool>.GetFormatFromOptions(ModelReaderWriterOptions)	Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<CodeInterpreterTool>.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)