Class VespaRetriever

Class responsible for retrieving data from Vespa. It extends the RemoteRetriever class and includes methods for creating the JSON body for a query and processing the JSON response from Vespa.

Example

const retriever = new VespaRetriever({
  url: "https:
  auth: false,
  query_body: {
    yql: "select content from paragraph where userQuery()",
    hits: 5,
    ranking: "documentation",
    locale: "en-us",
  },
  content_field: "content",
});
const result = await retriever.getRelevantDocuments("what is vespa?");

Hierarchy (view full)

Constructors

constructor

Properties

asyncCaller auth content_field headers query_body url

Methods

createJsonBody processJsonResponse

Constructors

constructor

Properties

asyncCaller

asyncCaller: AsyncCaller

auth

auth: RemoteRetrieverAuth

The authentication method to use, currently implemented is

  • false: no authentication
  • { bearer: string }: Bearer token authentication

content_field

content_field: string

headers

headers: Record<string, string>

query_body

query_body: object

url

url: string

The URL of the remote retriever server

Methods

createJsonBody

processJsonResponse

Settings

Member Visibility

On This Page

Constructors
Properties
Methods