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

RemoteRetriever
- VespaRetriever

Index

Constructors

constructor

new VespaRetriever(fields): VespaRetriever
Parameters
- fields: VespaRetrieverParams
Returns VespaRetriever
Overrides RemoteRetriever.constructor
- Defined in docs/api_refs/langchain/src/retrievers/vespa.ts:52

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

`Optional` callbacks

callbacks?: Callbacks

`Optional` metadata

metadata?: Record<string, unknown>

`Optional` tags

tags?: string[]

`Optional` verbose

verbose?: boolean

Methods

batch

batch(inputs, options?, batchOptions?): Promise<Document<Record<string, any>>[][]>
Default implementation of batch, which calls invoke N times. Subclasses should override this method if they can batch more efficiently.
Parameters
- inputs: string[]
  
  Array of inputs to each batch call.
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
  
  Either a single call options object to apply to each batch call or an array for each call.
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions?: false;
  }
Returns Promise<Document<Record<string, any>>[][]>
An array of RunOutputs, or mixed RunOutputs and errors if batchOptions.returnExceptions is set
Inherited from RemoteRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:159
batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions & {
  returnExceptions: true;
  }
Returns Promise<(Error | Document<Record<string, any>>[])[]>
Inherited from RemoteRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:165
batch(inputs, options?, batchOptions?): Promise<(Error | Document<Record<string, any>>[])[]>
Parameters
- inputs: string[]
- Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]
- Optional batchOptions: RunnableBatchOptions
Returns Promise<(Error | Document<Record<string, any>>[])[]>
Inherited from RemoteRetriever.batch
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:171

bind

bind(kwargs): Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>
Bind arguments to a Runnable, returning a new Runnable.
Parameters
- kwargs: Partial<BaseCallbackConfig>
Returns Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableBinding that, when invoked, will apply the bound args.
Inherited from RemoteRetriever.bind
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:67

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 docs/api_refs/langchain/src/retrievers/vespa.ts:66

getRelevantDocuments

getRelevantDocuments(query, config?): Promise<Document<Record<string, any>>[]>
Main method used to retrieve relevant documents. It takes a query string and an optional configuration object, and returns a promise that resolves to an array of Document objects. This method handles the retrieval process, including starting and ending callbacks, and error handling.
Parameters
- query: string
  
  The query string to retrieve relevant documents for.
- Optional config: Callbacks | BaseCallbackConfig
  
  Optional configuration object for the retrieval process.
Returns Promise<Document<Record<string, any>>[]>
A promise that resolves to an array of Document objects.
Inherited from RemoteRetriever.getRelevantDocuments
- Defined in docs/api_refs/langchain/src/schema/retriever.ts:71

invoke

invoke(input, options?): Promise<Document<Record<string, any>>[]>
Parameters
- input: string
- Optional options: BaseCallbackConfig
Returns Promise<Document<Record<string, any>>[]>
Inherited from RemoteRetriever.invoke
- Defined in docs/api_refs/langchain/src/schema/retriever.ts:57

map

map(): Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>
Return a new Runnable that maps a list of inputs to a list of outputs, by calling invoke() with each input.

Returns Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>
Inherited from RemoteRetriever.map
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:78

pipe

pipe<NewRunOutput>(coerceable): RunnableSequence<string, Exclude<NewRunOutput, Error>>
Create a new runnable sequence that runs each individual runnable in series, piping the output of one runnable into another runnable or runnable-like.
Type Parameters
- NewRunOutput
Parameters
- coerceable: RunnableLike<Document<Record<string, any>>[], NewRunOutput>
  
  A runnable, function, or object whose values are functions or runnables.
Returns RunnableSequence<string, Exclude<NewRunOutput, Error>>
A new runnable sequence.
Inherited from RemoteRetriever.pipe
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:461

processJsonResponse

processJsonResponse(json): Document<Record<string, any>>[]
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 Document<Record<string, any>>[]
An array of Document instances.
Overrides RemoteRetriever.processJsonResponse
- Defined in docs/api_refs/langchain/src/retrievers/vespa.ts:80

stream

stream(input, options?): Promise<IterableReadableStream<Document<Record<string, any>>[]>>
Stream output in chunks.
Parameters
- input: string
- Optional options: Partial<BaseCallbackConfig>
Returns Promise<IterableReadableStream<Document<Record<string, any>>[]>>
A readable stream that is also an iterable.
Inherited from RemoteRetriever.stream
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:225

streamLog

streamLog(input, options?, streamOptions?): AsyncGenerator<RunLogPatch, any, unknown>
Stream all output from a runnable, as reported to the callback system. This includes all inner runs of LLMs, Retrievers, Tools, etc. Output is streamed as Log objects, which include a list of jsonpatch ops that describe how the state of the run has changed in each step, and the final state of the run. The jsonpatch ops can be applied in order to construct state.
Parameters
- input: string
- Optional options: Partial<BaseCallbackConfig>
- Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">
Returns AsyncGenerator<RunLogPatch, any, unknown>
Inherited from RemoteRetriever.streamLog
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:507

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from RemoteRetriever.toJSON
- Defined in docs/api_refs/langchain/src/load/serializable.ts:148

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from RemoteRetriever.toJSONNotImplemented
- Defined in docs/api_refs/langchain/src/load/serializable.ts:222

transform

transform(generator, options): AsyncGenerator<Document<Record<string, any>>[], any, unknown>
Default implementation of transform, which buffers input and then calls stream. Subclasses should override this method if they can start producing output while input is still being generated.
Parameters
- generator: AsyncGenerator<string, any, unknown>
- options: Partial<BaseCallbackConfig>
Returns AsyncGenerator<Document<Record<string, any>>[], any, unknown>
Inherited from RemoteRetriever.transform
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:478

withConfig

withConfig(config): RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>
Bind config to a Runnable, returning a new Runnable.
Parameters
- config: BaseCallbackConfig
  
  New configuration parameters to attach to the new runnable.
Returns RunnableBinding<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableBinding with a config matching what's passed.
Inherited from RemoteRetriever.withConfig
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:107

withFallbacks

withFallbacks(fields): RunnableWithFallbacks<string, Document<Record<string, any>>[]>
Create a new runnable from the current one that will try invoking other passed fallback runnables if the initial invocation fails.
Parameters
- fields: {
  fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[];
  }
  - fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[]
    
    Other runnables to call if the runnable errors.
Returns RunnableWithFallbacks<string, Document<Record<string, any>>[]>
A new RunnableWithFallbacks.
Inherited from RemoteRetriever.withFallbacks
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:124

withRetry

withRetry(fields?): RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>
Add retry logic to an existing runnable.
Parameters
- Optional fields: {
  onFailedAttempt?: RunnableRetryFailedAttemptHandler;
  stopAfterAttempt?: number;
  }
  - Optional onFailedAttempt?: RunnableRetryFailedAttemptHandler
  - Optional stopAfterAttempt?: number
Returns RunnableRetry<string, Document<Record<string, any>>[], BaseCallbackConfig>
A new RunnableRetry that, when invoked, will retry according to the parameters.
Inherited from RemoteRetriever.withRetry
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:88

`Static` isRunnable

isRunnable(thing): thing is Runnable<any, any, BaseCallbackConfig>
Parameters
- thing: any
Returns thing is Runnable<any, any, BaseCallbackConfig>
Inherited from RemoteRetriever.isRunnable
- Defined in docs/api_refs/langchain/src/schema/runnable/base.ts:557

Class VespaRetriever

Example

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

fields: VespaRetrieverParams

Returns VespaRetriever

Properties

asyncCaller

auth

content_field

headers

query_body

url

Optional callbacks

Optional metadata

Optional tags

Optional verbose

Methods

batch

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions?: false; }

Returns Promise<Document<Record<string, any>>[][]>

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions & { returnExceptions: true; }

Returns Promise<(Error | Document<Record<string, any>>[])[]>

Parameters

inputs: string[]

Optional options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

Optional batchOptions: RunnableBatchOptions

Returns Promise<(Error | Document<Record<string, any>>[])[]>

bind

Parameters

kwargs: Partial<BaseCallbackConfig>

Returns Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>

createJsonBody

Parameters

query: string

Returns RemoteRetrieverValues

getRelevantDocuments

Parameters

query: string

Optional config: Callbacks | BaseCallbackConfig

Returns Promise<Document<Record<string, any>>[]>

invoke

Parameters

input: string

Optional options: BaseCallbackConfig

Returns Promise<Document<Record<string, any>>[]>

map

Returns Runnable<string[], Document<Record<string, any>>[][], BaseCallbackConfig>

pipe

Type Parameters

NewRunOutput

Parameters

coerceable: RunnableLike<Document<Record<string, any>>[], NewRunOutput>

Returns RunnableSequence<string, Exclude<NewRunOutput, Error>>

processJsonResponse

Parameters

json: RemoteRetrieverValues

Returns Document<Record<string, any>>[]

stream

Parameters

input: string

Optional options: Partial<BaseCallbackConfig>

Returns Promise<IterableReadableStream<Document<Record<string, any>>[]>>

streamLog

Parameters

input: string

Optional options: Partial<BaseCallbackConfig>

Optional streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

`Optional` callbacks

`Optional` metadata

`Optional` tags

`Optional` verbose

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions?: false;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions & {
returnExceptions: true;
}

`Optional` options: Partial<BaseCallbackConfig> | Partial<BaseCallbackConfig>[]

`Optional` batchOptions: RunnableBatchOptions

`Optional` config: Callbacks | BaseCallbackConfig

`Optional` options: BaseCallbackConfig

`Optional` options: Partial<BaseCallbackConfig>

`Optional` options: Partial<BaseCallbackConfig>

`Optional` streamOptions: Omit<LogStreamCallbackHandlerInput, "autoClose">

fields: {
fallbacks: Runnable<string, Document<Record<string, any>>[], BaseCallbackConfig>[];
}

`Optional` fields: {
onFailedAttempt?: RunnableRetryFailedAttemptHandler;
stopAfterAttempt?: number;
}

`Optional` onFailedAttempt?: RunnableRetryFailedAttemptHandler

`Optional` stopAfterAttempt?: number

`Static` isRunnable