OutputItemToolSearchCall Class

Definition

Namespace:

Azure.AI.Extensions.OpenAI

Assembly:

Azure.AI.Extensions.OpenAI.dll

Package:

Azure.AI.Extensions.OpenAI v2.1.0-beta.4

Source:

OutputItemToolSearchCall.cs

The OutputItemToolSearchCall.

public class OutputItemToolSearchCall : Azure.AI.Extensions.OpenAI.AgentResponseItem, System.ClientModel.Primitives.IJsonModel<Azure.AI.Extensions.OpenAI.OutputItemToolSearchCall>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.Extensions.OpenAI.OutputItemToolSearchCall>

type OutputItemToolSearchCall = class
    inherit AgentResponseItem
    interface IJsonModel<OutputItemToolSearchCall>
    interface IPersistableModel<OutputItemToolSearchCall>

Public Class OutputItemToolSearchCall
Inherits AgentResponseItem
Implements IJsonModel(Of OutputItemToolSearchCall), IPersistableModel(Of OutputItemToolSearchCall)

Inheritance

Object

AgentResponseItem

OutputItemToolSearchCall

Implements

IJsonModel<OutputItemToolSearchCall> IPersistableModel<OutputItemToolSearchCall> IPersistableModel<T>

Constructors

Name	Description
OutputItemToolSearchCall(String, ResponsesToolSearchExecutionType, BinaryData, ResponsesFunctionCallStatus)	Initializes a new instance of OutputItemToolSearchCall.

Properties

Name	Description
AgentReference	The agent that created the item. (Inherited from AgentResponseItem)
Arguments	Arguments used for the tool search 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). 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" }.
CallId	Gets or sets the CallId.
CreatedBy	The identifier of the actor that created the item.
Execution	Whether tool search was executed by the server or by the client.
Id	Gets the response item ID. (Inherited from AgentResponseItem)
ResponseId	The response on which the item is created. (Inherited from AgentResponseItem)
Status	The status of the tool search call item that was recorded.

Methods

Name	Description
AsResponseResultItem()	Converts this agent response item into an OpenAI response item. (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<OutputItemToolSearchCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)
IJsonModel<OutputItemToolSearchCall>.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<OutputItemToolSearchCall>.Create(BinaryData, ModelReaderWriterOptions)
IPersistableModel<OutputItemToolSearchCall>.GetFormatFromOptions(ModelReaderWriterOptions)
IPersistableModel<OutputItemToolSearchCall>.Write(ModelReaderWriterOptions)