Skip to main content

Class: FixieCorpus<ChunkMetadata>

batteries/docs.FixieCorpus

A fully mananged Corpus served by Fixie.

Type parameters

NameType
ChunkMetadataextends Jsonifiable = Jsonifiable

Implements

Constructors

constructor

new FixieCorpus<ChunkMetadata>(corpusId, fixieApiConfiguration?)

Type parameters

NameType
ChunkMetadataextends Jsonifiable = Jsonifiable

Parameters

NameTypeDefault value
corpusIdstringundefined
fixieApiConfigurationFixieAPIConfigurationDEFAULT_API_CONFIGURATION

Defined in

packages/ai-jsx/src/batteries/docs.tsx:623

Methods

search(query, params?): Promise<ScoredChunk<ChunkMetadata>[]>

Finds document chunks that are semantically similar to the provided query.

Parameters

NameType
querystring
params?Object
params.limit?number

Returns

Promise<ScoredChunk<ChunkMetadata>[]>

Implementation of

Corpus.search

Defined in

packages/ai-jsx/src/batteries/docs.tsx:637


createTool

Static createTool(corpusId, description): Tool

Parameters

NameType
corpusIdstring
descriptionstring

Returns

Tool

Defined in

packages/ai-jsx/src/batteries/docs.tsx:668