Share via

FileSearchToolCallItemResource Class

Definition

Namespace:
Azure.AI.AgentServer.Contracts.Generated.OpenAI
Assembly:
Azure.AI.AgentServer.Contracts.dll
Package:
Azure.AI.AgentServer.Contracts v1.0.0-beta.4
Source:
FileSearchToolCallItemResource.cs

The results of a file search tool call. See the file search guide for more information.

public class FileSearchToolCallItemResource : Azure.AI.AgentServer.Contracts.Generated.OpenAI.ItemResource, System.ClientModel.Primitives.IJsonModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FileSearchToolCallItemResource>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.AgentServer.Contracts.Generated.OpenAI.FileSearchToolCallItemResource>
type FileSearchToolCallItemResource = class
    inherit ItemResource
    interface IUtf8JsonSerializable
    interface IJsonModel<FileSearchToolCallItemResource>
    interface IPersistableModel<FileSearchToolCallItemResource>
Public Class FileSearchToolCallItemResource
Inherits ItemResource
Implements IJsonModel(Of FileSearchToolCallItemResource), IPersistableModel(Of FileSearchToolCallItemResource)
Inheritance
Object
ItemResource
FileSearchToolCallItemResource
Implements
IUtf8JsonSerializable IJsonModel<FileSearchToolCallItemResource> IPersistableModel<FileSearchToolCallItemResource> IPersistableModel<T>

Constructors

Name Description
FileSearchToolCallItemResource()

Initializes a new instance of FileSearchToolCallItemResource for deserialization.
FileSearchToolCallItemResource(ItemType, String, CreatedBy, IDictionary<String, BinaryData>, FileSearchToolCallItemResourceStatus, IReadOnlyList<String>, IReadOnlyList<FileSearchToolCallItemParamResult>)

Initializes a new instance of FileSearchToolCallItemResource.
FileSearchToolCallItemResource(String, FileSearchToolCallItemResourceStatus, IEnumerable<String>)

Initializes a new instance of FileSearchToolCallItemResource.

Properties

Name Description
CreatedBy

The information about the creator of the item.

(Inherited from ItemResource)
Id

Gets the id.

(Inherited from ItemResource)
Queries

The queries used to search for files.
Results

The results of the file search tool call.
Status

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

Gets or sets the type.

(Inherited from ItemResource)

Methods

Name Description
DeserializeFileSearchToolCallItemResource(JsonElement, ModelReaderWriterOptions)
FromResponse(Response)

Deserializes the model from a raw response.
JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions)
ToRequestContent()

Convert into a RequestContent.

Explicit Interface Implementations

Name Description
IJsonModel<FileSearchToolCallItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.
IJsonModel<FileSearchToolCallItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.
IJsonModel<ItemResource>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

(Inherited from ItemResource)
IJsonModel<ItemResource>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemResource)
IPersistableModel<FileSearchToolCallItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.
IPersistableModel<FileSearchToolCallItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.
IPersistableModel<FileSearchToolCallItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.
IPersistableModel<ItemResource>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

(Inherited from ItemResource)
IPersistableModel<ItemResource>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

(Inherited from ItemResource)
IPersistableModel<ItemResource>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

(Inherited from ItemResource)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to