Class RemoteRetrieverAbstract

constructor

• new RemoteRetriever(fields: RemoteRetrieverParams): RemoteRetriever

  Parameters

  • fields: RemoteRetrieverParams

  Returns RemoteRetriever

asyncCaller

auth

headers

url

lc_secrets

• get lc_secrets(): undefined | { [key: string]: string }

  Returns undefined | { [key: string]: string }

_getRelevantDocuments

• _getRelevantDocuments(query: string): Promise<DocumentInterface[]>

  Parameters

  • query: string

  Returns Promise<DocumentInterface[]>

AbstractcreateJsonBody

• createJsonBody(query: string): RemoteRetrieverValues

  Abstract method that should be implemented by subclasses to create the JSON body of the request based on the given query.

  Parameters

  • query: string

    The query based on which the JSON body of the request is created.

  Returns RemoteRetrieverValues

  The JSON body of the request.

AbstractprocessJsonResponse

• processJsonResponse(json: RemoteRetrieverValues): DocumentInterface[]

  Abstract method that should be implemented by subclasses to process the JSON response from the server and convert it into an array of Document instances.

  Parameters

  • json: RemoteRetrieverValues

    The JSON response from the server.

  Returns DocumentInterface[]

  An array of Document instances.