OutputItemFunctionShellCallOutput Class

Definition

Namespace:
Azure.AI.AgentServer.Responses.Models
Assembly:
Azure.AI.AgentServer.Responses.dll
Package:
Azure.AI.AgentServer.Responses v1.0.0-beta.3
Source:
OutputItemFunctionShellCallOutput.cs

Shell call output.

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

Constructors

Name Description
OutputItemFunctionShellCallOutput(String, String, LocalShellCallOutputStatusEnum, IEnumerable<FunctionShellCallOutputContent>, Nullable<Int64>)

Initializes a new instance of OutputItemFunctionShellCallOutput.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

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

The information about the creator of the item

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

(Inherited from OutputItem)
Id

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

Gets or sets the MaxOutputLength.
Output

An array of shell call output contents.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Status

The status of the shell call output. One of in_progress, completed, or incomplete.

Methods

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

Explicit Interface Implementations

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

Extension Methods

Name Description
GetId(OutputItem)

Gets the Id property from an OutputItem. Uses direct type checks for known subclasses; falls back to JSON serialization for unrecognized types.

Applies to