OutputItemFunctionToolCallOutput Class

Definition

Namespace:
Azure.AI.Extensions.OpenAI
Assembly:
Azure.AI.Extensions.OpenAI.dll
Package:
Azure.AI.Extensions.OpenAI v2.1.0-beta.1
Source:
OutputItemFunctionToolCallOutput.cs

Function tool call output.

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

Constructors

Name Description
OutputItemFunctionToolCallOutput(String, BinaryData)

Initializes a new instance of OutputItemFunctionToolCallOutput.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from AgentResponseItem)
CallId

The unique ID of the function tool call generated by the model.
Id (Inherited from AgentResponseItem)
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:

  • String.
  • IList<T> where T is of type Azure.AI.Extensions.OpenAI.InternalFunctionAndCustomToolCallOutput.
</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" }.

ResponseId

The response on which the item is created.

(Inherited from AgentResponseItem)
Status

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

Methods

Name Description
AsResponseResultItem() (Inherited from AgentResponseItem)
JsonModelCreateCore(Utf8JsonReader, ModelReaderWriterOptions)
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
PersistableModelCreateCore(BinaryData, ModelReaderWriterOptions)
PersistableModelWriteCore(ModelReaderWriterOptions)

Explicit Interface Implementations

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

Applies to