OutputItemToolSearchOutput Class

Definition

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

The OutputItemToolSearchOutput.

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

Constructors

Name Description
OutputItemToolSearchOutput(String, String, ToolSearchExecutionType, IEnumerable<Tool>, FunctionCallOutputStatusEnum)

Initializes a new instance of OutputItemToolSearchOutput.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
CallId

Gets or sets the CallId.
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)
Execution

Whether tool search was executed by the server or by the client.
Id

The unique ID of the tool search output item.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Status

The status of the tool search output item that was recorded.
Tools

The loaded tool definitions returned by tool search.

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<OutputItemToolSearchOutput>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemToolSearchOutput>.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<OutputItemToolSearchOutput>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemToolSearchOutput>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemToolSearchOutput>.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