RetrievalToolDefinition Class

  • Reference

Definition

Namespace:
Azure.AI.OpenAI.Assistants
Assembly:
Azure.AI.OpenAI.Assistants.dll
Package:
Azure.AI.OpenAI.Assistants v1.0.0-beta.4
Source:
RetrievalToolDefinition.cs

The input definition information for a retrieval tool as used to configure an assistant.

public class RetrievalToolDefinition : Azure.AI.OpenAI.Assistants.ToolDefinition, System.ClientModel.Primitives.IJsonModel<Azure.AI.OpenAI.Assistants.RetrievalToolDefinition>, System.ClientModel.Primitives.IPersistableModel<Azure.AI.OpenAI.Assistants.RetrievalToolDefinition>
type RetrievalToolDefinition = class
    inherit ToolDefinition
    interface IJsonModel<RetrievalToolDefinition>
    interface IPersistableModel<RetrievalToolDefinition>
Public Class RetrievalToolDefinition
Inherits ToolDefinition
Implements IJsonModel(Of RetrievalToolDefinition), IPersistableModel(Of RetrievalToolDefinition)
Inheritance
Object
ToolDefinition
RetrievalToolDefinition
Implements
IJsonModel<RetrievalToolDefinition> IPersistableModel<RetrievalToolDefinition> IPersistableModel<T>

Constructors

RetrievalToolDefinition()

Initializes a new instance of RetrievalToolDefinition.

Explicit Interface Implementations

IJsonModel<RetrievalToolDefinition>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from ToolDefinition)
IPersistableModel<RetrievalToolDefinition>.Create(BinaryData, ModelReaderWriterOptions)

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

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

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

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from ToolDefinition)

Applies to