Class: FixieCorpus<ChunkMetadata>
batteries/docs.FixieCorpus
A fully mananged Corpus served by Fixie.
Type parameters
| Name | Type |
|---|---|
ChunkMetadata | extends Jsonifiable = Jsonifiable |
Implements
Corpus<ChunkMetadata>
Constructors
constructor
• new FixieCorpus<ChunkMetadata>(corpusId, fixieApiConfiguration?)
Type parameters
| Name | Type |
|---|---|
ChunkMetadata | extends Jsonifiable = Jsonifiable |
Parameters
| Name | Type | Default value |
|---|---|---|
corpusId | string | undefined |
fixieApiConfiguration | FixieAPIConfiguration | DEFAULT_API_CONFIGURATION |
Defined in
packages/ai-jsx/src/batteries/docs.tsx:623
Methods
search
▸ search(query, params?): Promise<ScoredChunk<ChunkMetadata>[]>
Finds document chunks that are semantically similar to the provided query.
Parameters
| Name | Type |
|---|---|
query | string |
params? | Object |
params.limit? | number |
Returns
Promise<ScoredChunk<ChunkMetadata>[]>
Implementation of
Defined in
packages/ai-jsx/src/batteries/docs.tsx:637
createTool
▸ Static createTool(corpusId, description): Tool
Parameters
| Name | Type |
|---|---|
corpusId | string |
description | string |