ItemFieldCustomToolCallOutput Class

Definition

Custom tool call output.

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

Properties

Name Description
CallId

The call ID, used to map this custom tool call output to a custom tool call.

Id

The unique ID of the custom tool call output in the OpenAI platform.

Output

The output from the custom tool call generated by your code. Can be a string or an list of output content.

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

Methods

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

Explicit Interface Implementations

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

Applies to