PromptHelper
Defined in: packages/core/src/indices/prompt-helper.ts:46
A collection of helper functions for working with prompts.
Constructors
Constructor
new PromptHelper(
options):PromptHelper
Defined in: packages/core/src/indices/prompt-helper.ts:54
Parameters
options
PromptHelperOptions = {}
Returns
PromptHelper
Properties
contextWindow
contextWindow:
number
Defined in: packages/core/src/indices/prompt-helper.ts:47
numOutput
numOutput:
number
Defined in: packages/core/src/indices/prompt-helper.ts:48
chunkOverlapRatio
chunkOverlapRatio:
number
Defined in: packages/core/src/indices/prompt-helper.ts:49
chunkSizeLimit
chunkSizeLimit:
undefined|number
Defined in: packages/core/src/indices/prompt-helper.ts:50
tokenizer
tokenizer:
Tokenizer
Defined in: packages/core/src/indices/prompt-helper.ts:51
separator
separator:
string
Defined in: packages/core/src/indices/prompt-helper.ts:52
Methods
getTextSplitterGivenPrompt()
getTextSplitterGivenPrompt(
prompt,numChunks,padding):TextSplitter
Defined in: packages/core/src/indices/prompt-helper.ts:112
Creates a text splitter configured to maximally pack the available context window.
Parameters
prompt
numChunks
number = 1
padding
number = DEFAULT_PADDING
Returns
truncate()
truncate(
prompt,textChunks,padding):string[]
Defined in: packages/core/src/indices/prompt-helper.ts:133
Truncate text chunks to fit within the available context window.
Parameters
prompt
textChunks
string[]
padding
number = DEFAULT_PADDING
Returns
string[]
repack()
repack(
prompt,textChunks,padding):string[]
Defined in: packages/core/src/indices/prompt-helper.ts:149
Repack text chunks to better utilize the available context window.
Parameters
prompt
textChunks
string[]
padding
number = DEFAULT_PADDING
Returns
string[]
fromLLMMetadata()
staticfromLLMMetadata(metadata,options?):PromptHelper
Defined in: packages/core/src/indices/prompt-helper.ts:162
Parameters
metadata
options?
chunkOverlapRatio?
number
chunkSizeLimit?
number
tokenizer?
Tokenizer
separator?
string
Returns
PromptHelper