Share via


FunctionToolCallOutput Class

Definition

Function tool call output.

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

Properties

Name Description
CallId

The unique ID of the function tool call generated by the model.

Id

The unique ID of the function tool call output. Populated when this item is returned via API.

Output

The output from the function 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" }.

Status

The status of the item. One of in_progress, completed, or incomplete. Populated when items are returned via API.

Methods

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

Explicit Interface Implementations

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

Applies to