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)

RemoteRetriever
- VespaRetriever

Index

Constructors

constructor

new VespaRetriever(fields): VespaRetriever
Parameters
- fields: VespaRetrieverParams
Returns VespaRetriever
Overrides RemoteRetriever.constructor
- Defined in libs/langchain-community/src/retrievers/vespa.ts:50

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

createJsonBody(query): RemoteRetrieverValues
Method that takes a query string as input and returns a JSON object that includes the query and the original query_body.
Parameters
- query: string
  The query string to be sent to Vespa.
Returns RemoteRetrieverValues
A JSON object that includes the query and the original query_body.
Overrides RemoteRetriever.createJsonBody
- Defined in libs/langchain-community/src/retrievers/vespa.ts:64

processJsonResponse

processJsonResponse(json): DocumentInterface[]
Method that processes the JSON response from Vespa into an array of Document instances. Each Document instance includes the content from the specified content_field and the document's ID.
Parameters
- json: RemoteRetrieverValues
  The JSON response from Vespa.
Returns DocumentInterface[]
An array of Document instances.
Overrides RemoteRetriever.processJsonResponse
- Defined in libs/langchain-community/src/retrievers/vespa.ts:78

Class VespaRetriever

Example

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: VespaRetrieverParams

Returns VespaRetriever

Properties

asyncCaller

auth

content_field

headers

query_body

url

Methods

createJsonBody

Parameters

query: string

Returns RemoteRetrieverValues

processJsonResponse

Parameters

json: RemoteRetrieverValues

Returns DocumentInterface[]

Settings

Member Visibility

Theme

On This Page