OutputItemFileSearchToolCall Class

Definition

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

File search tool call.

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

Constructors

Name Description
OutputItemFileSearchToolCall(String, ItemFileSearchToolCallStatus, IEnumerable<String>)

Initializes a new instance of OutputItemFileSearchToolCall.

Properties

Name Description
AgentReference

The agent that created the item.

(Inherited from OutputItem)
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 file search tool call.
Queries

The queries used to search for files.
ResponseId

The response on which the item is created.

(Inherited from OutputItem)
Results

Gets or sets the Results.
Status

The status of the file search tool call. One of in_progress, searching, incomplete or failed,

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