Share via


FileSearchToolCallItemParam Class

Definition

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

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

Constructors

Name Description
FileSearchToolCallItemParam()

Initializes a new instance of FileSearchToolCallItemParam for deserialization.

FileSearchToolCallItemParam(IEnumerable<String>)

Initializes a new instance of FileSearchToolCallItemParam.

FileSearchToolCallItemParam(ItemType, IDictionary<String,BinaryData>, IList<String>, IList<FileSearchToolCallItemParamResult>)

Initializes a new instance of FileSearchToolCallItemParam.

Properties

Name Description
Queries

The queries used to search for files.

Results

The results of the file search tool call.

SerializedAdditionalRawData (Inherited from ItemParam)
Type

Gets or sets the type.

(Inherited from ItemParam)

Methods

Name Description
DeserializeFileSearchToolCallItemParam(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<FileSearchToolCallItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<FileSearchToolCallItemParam>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<ItemParam>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ItemParam)
IPersistableModel<FileSearchToolCallItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<FileSearchToolCallItemParam>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<FileSearchToolCallItemParam>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<ItemParam>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ItemParam)
IUtf8JsonSerializable.Write(Utf8JsonWriter)

Applies to