llamaindex
Enumerations
- ClipEmbeddingModelType
- GEMINI_MODEL
- HuggingFaceEmbeddingModelType
- IndexStructType
- KeywordTableRetrieverMode
- MetadataMode
- MistralAIEmbeddingModelType
- NodeRelationship
- ObjectType
- ReplicateChatStrategy
- SimilarityType
- SummaryRetrieverMode
- Tokenizers
- VectorStoreQueryMode
Classes
- Anthropic
- AnthropicAgent
- AnthropicAgentWorker
- AstraDBVectorStore
- AudioSubtitlesReader
- AudioTranscriptParagraphsReader
- AudioTranscriptReader
- AudioTranscriptSentencesReader
- AzureOpenAI
- BaseDocumentStore
- BaseEmbedding
- BaseExtractor
- BaseInMemoryKVStore
- BaseIndex
- BaseIndexStore
- BaseKVStore
- BaseNode
- BaseObjectNodeMapping
- BaseSelector
- CallbackManager
- ChatHistory
- ChromaVectorStore
- ClipEmbedding
- CohereRerank
- CompactAndRefine
- CondenseQuestionChatEngine
- ContextChatEngine
- CorrectnessEvaluator
- Document
- DocxReader
- FaithfulnessEvaluator
- FireworksEmbedding
- FireworksLLM
- FunctionTool
- Gemini
- GeminiEmbedding
- Groq
- HTMLReader
- HuggingFaceEmbedding
- ImageDocument
- ImageNode
- ImageReader
- IndexDict
- IndexList
- IndexNode
- IndexStruct
- IngestionPipeline
- JinaAIEmbedding
- JinaAIReranker
- KeywordExtractor
- KeywordTable
- KeywordTableIndex
- KeywordTableLLMRetriever
- KeywordTableRAKERetriever
- KeywordTableSimpleRetriever
- LLMMultiSelector
- LLMQuestionGenerator
- LLMSingleSelector
- LlamaCloudIndex
- LlamaCloudRetriever
- LlamaIndexCustomEvent
- LlamaParseReader
- MarkdownNodeParser
- MarkdownReader
- MetadataReplacementPostProcessor
- MilvusVectorStore
- MistralAI
- MistralAIEmbedding
- MistralAISession
- MongoDBAtlasVectorSearch
- MultiModalEmbedding
- MultiModalResponseSynthesizer
- NotionReader
- ObjectIndex
- ObjectRetriever
- Ollama
- OllamaEmbedding
- OpenAI
- OpenAIAgent
- OpenAIAgentWorker
- OpenAIEmbedding
- OpenAISession
- PDFReader
- PGVectorStore
- PapaCSVReader
- PineconeVectorStore
- Portkey
- PromptHelper
- PromptMixin
- QdrantVectorStore
- QueryBundle
- QueryEngineTool
- QuestionsAnsweredExtractor
- ReACTAgentWorker
- ReActAgent
- Refine
- RelevancyEvaluator
- ReplicateLLM
- ReplicateSession
- Response
- ResponseSynthesizer
- RetrieverQueryEngine
- RouterQueryEngine
- SentenceSplitter
- SentenceWindowNodeParser
- SimilarityPostprocessor
- SimpleChatEngine
- SimpleChatHistory
- SimpleChatStore
- SimpleDirectoryReader
- SimpleDocumentStore
- SimpleIndexStore
- SimpleKVStore
- SimpleMongoReader
- SimpleNodeParser
- SimpleResponseBuilder
- SimpleToolNodeMapping
- SimpleVectorStore
- SubQuestionOutputParser
- SubQuestionQueryEngine
- SummaryChatHistory
- SummaryExtractor
- SummaryIndex
- SummaryIndexLLMRetriever
- SummaryIndexRetriever
- TextFileReader
- TextNode
- TitleExtractor
- TogetherEmbedding
- TogetherLLM
- TreeSummarize
- VectorIndexRetriever
- VectorStoreIndex
- WikipediaTool
Interfaces
- BaseChatStore
- BaseIndexInit
- BaseNodePostprocessor
- BaseOutputParser
- BaseReader
- BaseRetriever
- BaseSynthesizer
- BaseTool
- ChatEngine
- ChatEngineParamsBase
- ChatEngineParamsNonStreaming
- ChatEngineParamsStreaming
- ChatResponse
- CompletionResponse
- Context
- ContextGenerator
- DefaultStreamToken
- ExactMatchFilter
- FileReader
- KeywordIndexOptions
- LLM
- LLMChat
- LLMChatParamsBase
- LLMChatParamsNonStreaming
- LLMChatParamsStreaming
- LLMCompletionParamsBase
- LLMCompletionParamsNonStreaming
- LLMCompletionParamsStreaming
- LlamaIndexEventMaps
- MetadataFilters
- MetadataInfo
- NodeParser
- NodeWithScore
- QueryEngine
- QueryEngineParamsBase
- QueryEngineParamsNonStreaming
- QueryEngineParamsStreaming
- RefDocInfo
- RelatedNodeInfo
- ResponseBuilder
- ResponseBuilderParamsBase
- ResponseBuilderParamsNonStreaming
- ResponseBuilderParamsStreaming
- RetrievalCallbackResponse
- ServiceContext
- ServiceContextOptions
- SingleSelection
- StorageContext
- StreamCallbackResponse
- StructuredOutput
- SummaryIndexOptions
- SynthesizeParamsBase
- SynthesizeParamsNonStreaming
- SynthesizeParamsStreaming
- TransformComponent
- VectorIndexConstructorProps
- VectorIndexOptions
- VectorStore
- VectorStoreInfo
- VectorStoreQuery
- VectorStoreQueryResult
- VectorStoreQuerySpec
Type Aliases
AnthropicAgentParams
Ƭ AnthropicAgentParams: AnthropicParamsWithTools
| AnthropicParamsWithToolRetriever
Defined in
packages/core/src/agent/anthropic.ts:30
AnthropicStreamToken
Ƭ AnthropicStreamToken: Anthropic.Completion
Defined in
packages/core/src/callbacks/CallbackManager.ts:83
AssemblyAIOptions
Ƭ AssemblyAIOptions: Partial
<BaseServiceParams
>
Defined in
packages/core/src/readers/AssemblyAIReader.ts:13
BaseToolWithCall
Ƭ BaseToolWithCall<Input
>: Omit
<BaseTool
<Input
>, "call"
> & { call
: NonNullable
<Pick
<BaseTool
<Input
>, "call"
>["call"
]> }
Type parameters
Name | Type |
---|---|
Input | any |
Defined in
BuilderParams
Ƭ BuilderParams: Object
Type declaration
Name | Type |
---|---|
docStore | BaseDocumentStore |
fs | GenericFileSystem |
imageVectorStore | VectorStore |
indexStore | BaseIndexStore |
persistDir | string |
storeImages | boolean |
vectorStore | VectorStore |
Defined in
packages/core/src/storage/StorageContext.ts:21
ChatMessage
Ƭ ChatMessage<AdditionalMessageOptions
>: Object
Type parameters
Name | Type |
---|---|
AdditionalMessageOptions | extends object = object |
Type declaration
Name | Type |
---|---|
content | MessageContent |
options? | AdditionalMessageOptions |
role | MessageType |
Defined in
packages/core/src/llm/types.ts:86
ChatResponseChunk
Ƭ ChatResponseChunk<AdditionalMessageOptions
>: Object
Type parameters
Name | Type |
---|---|
AdditionalMessageOptions | extends object = object |
Type declaration
Name | Type |
---|---|
delta | string |
options? | AdditionalMessageOptions |
raw | object | null |
Defined in
packages/core/src/llm/types.ts:104
ChoiceSelectPrompt
Ƭ ChoiceSelectPrompt: typeof defaultChoiceSelectPrompt
Defined in
packages/core/src/Prompt.ts:178
CloudRetrieveParams
Ƭ CloudRetrieveParams: Omit
<PlatformApi.RetrievalParams
, "query"
| "searchFilters"
| "pipelineId"
| "className"
> & { similarityTopK?
: number
}
Defined in
packages/core/src/cloud/LlamaCloudRetriever.ts:10
CondenseQuestionPrompt
Ƭ CondenseQuestionPrompt: typeof defaultCondenseQuestionPrompt
Defined in
packages/core/src/Prompt.ts:359
ContextSystemPrompt
Ƭ ContextSystemPrompt: typeof defaultContextSystemPrompt
Defined in
packages/core/src/Prompt.ts:380
CorrectnessSystemPrompt
Ƭ CorrectnessSystemPrompt: typeof defaultCorrectnessSystemPrompt
Defined in
packages/core/src/evaluation/prompts.ts:52
FaithfulnessRefinePrompt
Ƭ FaithfulnessRefinePrompt: typeof defaultFaithfulnessRefinePrompt
Defined in
packages/core/src/evaluation/prompts.ts:76
FaithfulnessTextQAPrompt
Ƭ FaithfulnessTextQAPrompt: typeof defaultFaithfulnessTextQaPrompt
Defined in
packages/core/src/evaluation/prompts.ts:115
ImageNodeConstructorProps
Ƭ ImageNodeConstructorProps<T
>: Pick
<ImageNode
<T
>, "image"
| "id_"
> & Partial
<ImageNode
<T
>>
Type parameters
Name | Type |
---|---|
T | extends Metadata |
Defined in
ImageType
Ƭ ImageType: string
| Blob
| URL
Defined in
JSONObject
Ƭ JSONObject: Object
Index signature
▪ [key: string
]: JSONValue
Defined in
packages/core/src/types.ts:109
JSONValue
Ƭ JSONValue: string
| number
| boolean
| JSONObject
| JSONArray
Defined in
packages/core/src/types.ts:107
KeywordExtractPrompt
Ƭ KeywordExtractPrompt: typeof defaultKeywordExtractPrompt
Defined in
packages/core/src/Prompt.ts:395
LLMEndEvent
Ƭ LLMEndEvent: BaseEvent
<{ id
: UUID
; response
: ChatResponse
}>
Defined in
packages/core/src/llm/types.ts:16