Share via


CodeInterpreterTool Class

Definition

Code interpreter.

public class CodeInterpreterTool : Azure.AI.AgentServer.Responses.Models.Tool, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Responses.Models.CodeInterpreterTool>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Responses.Models.CodeInterpreterTool>
type CodeInterpreterTool = class
    inherit Tool
    interface IJsonModel<CodeInterpreterTool>
    interface IPersistableModel<CodeInterpreterTool>
Public Class CodeInterpreterTool
Inherits Tool
Implements IJsonModel(Of CodeInterpreterTool), IPersistableModel(Of CodeInterpreterTool)
Inheritance
CodeInterpreterTool
Implements

Constructors

Name Description
CodeInterpreterTool()

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, along with an optional memory_limit setting. If not provided, the service assumes auto.

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:

</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" }.

Description

Optional user-defined description for this tool or configuration.

Name

Optional user-defined name for this tool or configuration.

Methods

Name Description
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

Name Description
IJsonModel<CodeInterpreterTool>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<CodeInterpreterTool>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IJsonModel<Tool>.Create(Utf8JsonReader, ModelReaderWriterOptions) (Inherited from Tool)
IJsonModel<Tool>.Write(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<CodeInterpreterTool>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<CodeInterpreterTool>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<CodeInterpreterTool>.Write(ModelReaderWriterOptions)
IPersistableModel<Tool>.Create(BinaryData, ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.GetFormatFromOptions(ModelReaderWriterOptions) (Inherited from Tool)
IPersistableModel<Tool>.Write(ModelReaderWriterOptions) (Inherited from Tool)

Applies to