Class ChatGPTPluginRetriever

⚠️ Deprecated ⚠️

This feature is deprecated and will be removed in the future.

It is not recommended for use.

ChatGPT Plugins have been deprecated in favor of GPTs. Class that connects ChatGPT to third-party applications via plugins. It extends the RemoteRetriever class and implements the ChatGPTPluginRetrieverParams interface.

Example

const retriever = new ChatGPTPluginRetriever({
  url: "http:
  auth: {
    bearer: "super-secret-jwt-token-with-at-least-32-characters-long",
  },
});
const docs = await retriever.getRelevantDocuments("hello world");

Hierarchy (view full)

Implements

Constructors

constructor

Properties

topK filter?

Methods

createJsonBody processJsonResponse

Constructors

constructor

Properties

topK

topK: number

The number of results to request from the ChatGPTRetrievalPlugin server

Optional filter

filter?: ChatGPTPluginRetrieverFilter

The filter to use when querying the ChatGPTRetrievalPlugin server

Methods

createJsonBody

  • createJsonBody(query): RemoteRetrieverValues

  • Creates a JSON body for the request to the ChatGPTRetrievalPlugin server.

    Parameters

    • query: string

      The query to send to the server.

    Returns RemoteRetrieverValues

    A JSON object representing the body of the request.

processJsonResponse

  • processJsonResponse(json): Document[]

  • Processes the JSON response from the ChatGPTRetrievalPlugin server and returns an array of Document instances.

    Parameters

    • json: RemoteRetrieverValues

      The JSON response from the server.

    Returns Document[]

    An array of Document instances.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc