Share via


RunStepRetrievalToolCall Class

Definition

A record of a call to a retrieval tool, issued by the model in evaluation of a defined tool, that represents executed retrieval actions.

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

Properties

Id

The ID of the tool call. This ID must be referenced when you submit tool outputs.

(Inherited from RunStepToolCall)
Retrieval

The key/value pairs produced by the retrieval tool.

Explicit Interface Implementations

IJsonModel<RunStepRetrievalToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

IJsonModel<RunStepRetrievalToolCall>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IJsonModel<RunStepToolCall>.Create(Utf8JsonReader, ModelReaderWriterOptions)

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

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

Writes the model to the provided Utf8JsonWriter.

(Inherited from RunStepToolCall)
IPersistableModel<RunStepRetrievalToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<RunStepRetrievalToolCall>.GetFormatFromOptions(ModelReaderWriterOptions)

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

IPersistableModel<RunStepRetrievalToolCall>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

IPersistableModel<RunStepToolCall>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

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

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

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

Writes the model into a BinaryData.

(Inherited from RunStepToolCall)

Applies to