RetrievalToolCall interface

Package:

@azure/openai-assistants

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

Properties

id	The ID of the tool call. This ID must be referenced when you submit tool outputs.
retrieval	The key/value pairs produced by the retrieval tool.
type	The object type, which is always 'retrieval'.

Property Details

id

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

id: string

Property Value

string

retrieval

The key/value pairs produced by the retrieval tool.

retrieval: Record<string, string>

Property Value

Record<string, string>

type

The object type, which is always 'retrieval'.

type: "retrieval"

Property Value

"retrieval"