Språk

AzureFunctionToolCallOutput Class

Definition

The output of an Azure Function tool call.

public class AzureFunctionToolCallOutput : OpenAI.Responses.ResponseItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.AzureFunctionToolCallOutput>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.AzureFunctionToolCallOutput>
type AzureFunctionToolCallOutput = class
    inherit ResponseItem
    interface IJsonModel<AzureFunctionToolCallOutput>
    interface IPersistableModel<AzureFunctionToolCallOutput>
Public Class AzureFunctionToolCallOutput
Inherits ResponseItem
Implements IJsonModel(Of AzureFunctionToolCallOutput), IPersistableModel(Of AzureFunctionToolCallOutput)
Inheritance
OpenAI.Responses.ResponseItem
AzureFunctionToolCallOutput
Implements

Constructors

Name Description
AzureFunctionToolCallOutput(String, String, ToolCallStatus)

Initializes a new instance of AzureFunctionToolCallOutput.

Properties

Name Description
CallId

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

Name

The name of the Azure Function that was called.

Output

The output from the Azure Function tool call.

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 tool call.

Methods

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

Explicit Interface Implementations

Name Description
IJsonModel<AzureFunctionToolCallOutput>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<AzureFunctionToolCallOutput>.Write(Utf8JsonWriter, ModelReaderWriterOptions)
IPersistableModel<AzureFunctionToolCallOutput>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<AzureFunctionToolCallOutput>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<AzureFunctionToolCallOutput>.Write(ModelReaderWriterOptions)

Applies to