ChatGPT-Java-API/com.cjcrafter.openai.chat.tool/RetrievalToolCall

RetrievalToolCall

data class RetrievalToolCall(val id: String, val retrieval: Map<String, String>) : ToolCall

Represents a tool call for Tool.Type.RETRIEVAL.

Currently, this tool call serves no functionality other than to inform you that some retrieval operation has occurred. Currently, the OpenAI API does not return any information about the retrieval (retrieval will always be an empty map. retrieval's data type may be changed in the future, I recommend you DO NOT use it).

Constructors

Link copied to clipboard
constructor(id: String, retrieval: Map<String, String>)

Properties

Link copied to clipboard
open override val id: String

The unique id of this tool call

Link copied to clipboard
@ApiStatus.Experimental
val retrieval: Map<String, String>

An empty map, do not use this!

Link copied to clipboard
open override val type: Tool.Type

The type of tool call.