LlamaIndex API Reference
Enumerations
- KeywordTableRetrieverMode
- SummaryRetrieverMode
- ClipEmbeddingModelType
- GEMINI_EMBEDDING_MODEL
- GEMINI_BACKENDS
- GEMINI_MODEL
- HuggingFaceEmbeddingModelType
- MistralAIEmbeddingModelType
- ReplicateChatStrategy
- IndexManagement
- MetadataIndexFieldType
Classes
- Bedrock
- AmazonKnowledgeBaseRetriever
- NotSupportCurrentRuntimeClass
- SubQuestionOutputParser
- LLMQuestionGenerator
- ReACTAgentWorker
- ReActAgent
- LLamaCloudFileService
- LlamaCloudIndex
- LlamaCloudRetriever
- CondenseQuestionChatEngine
- RouterQueryEngine
- SubQuestionQueryEngine
- CorrectnessEvaluator
- FaithfulnessEvaluator
- RelevancyEvaluator
- KeywordExtractor
- TitleExtractor
- QuestionsAnsweredExtractor
- SummaryExtractor
- BaseExtractor
- BaseIndex
- KeywordTableLLMRetriever
- KeywordTableSimpleRetriever
- KeywordTableRAKERetriever
- KeywordTableIndex
- SummaryIndex
- SummaryIndexRetriever
- SummaryIndexLLMRetriever
- VectorStoreIndex
- VectorIndexRetriever
- IngestionPipeline
- SimpleToolNodeMapping
- ObjectIndex
- MetadataReplacementPostProcessor
- SimilarityPostprocessor
- JinaAIReranker
- BaseSelector
- LLMMultiSelector
- LLMSingleSelector
- SimpleDocumentStore
- QueryEngineTool
- SimpleVectorStore
- AnthropicAgentWorker
- AnthropicAgent
- AnthropicSession
- Anthropic
- ClipEmbedding
- CohereRerank
- DeepInfraEmbedding
- DeepInfra
- DeepSeekLLM
- FireworksEmbedding
- FireworksLLM
- GeminiEmbedding
- GeminiSession
- GeminiSessionStore
- Gemini
- GeminiHelper
- GeminiVertexSession
- Groq
- HuggingFaceEmbedding
- HuggingFaceLLM
- HuggingFaceInferenceAPIEmbedding
- HuggingFaceInferenceAPI
- JinaAIEmbedding
- MistralAIEmbedding
- MistralAISession
- MistralAI
- MixedbreadAIEmbeddings
- MixedbreadAIReranker
- OllamaAgentWorker
- OllamaAgent
- OllamaEmbedding
- Ollama
- OpenAIAgentWorker
- OpenAIAgent
- OpenAIEmbedding
- OpenAI
- PortkeySession
- Portkey
- ReplicateSession
- ReplicateLLM
- AstraDBVectorStore
- AzureCosmosVCoreChatStore
- AzureCosmosNoSqlChatStore
- AzureCosmosVCoreDocumentStore
- AzureCosmosNoSqlDocumentStore
- AzureCosmosVCoreIndexStore
- AzureCosmosNoSqlIndexStore
- AzureCosmosVCoreKVStore
- AzureCosmosNoSqlKVStore
- AzureDynamicSessionTool
- AzureAISearchVectorStore
- AzureCosmosDBMongoDBVectorStore
- AzureCosmosDBNoSqlVectorStore
- AzureQueryResultSearchBase
- AzureQueryResultSearchDefault
- AzureQueryResultSearchSparse
- AzureQueryResultSearchHybrid
- AzureQueryResultSearchSemanticHybrid
- ChromaVectorStore
- FirestoreVectorStore
- MilvusVectorStore
- MongoDBAtlasVectorSearch
- PineconeVectorStore
- PGVectorStore
- PostgresDocumentStore
- PostgresIndexStore
- PostgresKVStore
- QdrantVectorStore
- UpstashVectorStore
- WeaviateVectorStore
- TogetherEmbedding
- TogetherLLM
- VercelLLM
- VLLM
- VoyageAIEmbedding
- WorkflowContext
- WorkflowEvent
- StartEvent
- StopEvent
- Workflow
Interfaces
- BaseIndexInit
- KeywordIndexOptions
- SummaryIndexOptions
- VectorIndexOptions
- VectorIndexConstructorProps
- SingleSelection
- StorageContext
- StructuredOutput
- DeepInfraEmbeddingResponse
- InferenceStatus
- GeminiModelInfo
- IGeminiSession
- HFLLMConfig
- MixedbreadAIEmbeddingsParams
- MixedbreadAIRerankerParams
- AzureCosmosVCoreChatStoreConfig
- AzureCosmosChatDatabaseProperties
- AzureCosmosChatContainerProperties
- AzureCosmosNoSqlChatStoreConfig
- AzureCosmosVCoreDocumentStoreArgs
- AzureCosmosNoSqlDocumentStoreArgs
- AzureCosmosVCoreIndexStoreArgs
- AzureCosmosNoSqlIndexStoreArgs
- VcoreConnectionStringOptions
- AzureCosmosVCoreKVStoreConfig
- CosmosDatabaseProperties
- CosmosContainerProperties
- ConnectionStringOptions
- AccountAndKeyOptions
- AadTokenOptions
- AzureCosmosNoSqlKVStoreConfig
- RemoteFileMetadata
- AzureAISearchOptions
- AzureCosmosDBNoSQLInitOptions
- AzureCosmosDBNoSQLConfig
- AzureCosmosQueryOptions
Type Aliases
- BEDROCK_MODELS
- INFERENCE_BEDROCK_MODELS
- Logger
- ReACTAgentParams
- CloudRetrieveParams
- CloudConstructorParams
- UserPrompt
- CorrectnessSystemPrompt
- FaithfulnessRefinePrompt
- FaithfulnessTextQAPrompt
- RelevancyEvalPrompt
- RelevancyRefinePrompt
- KeywordTableIndexChatEngineOptions
- SummaryIndexChatEngineOptions
- ListIndex
- ListRetrieverMode
- ListIndexRetriever
- ListIndexLLMRetriever
- VectorIndexChatEngineOptions
- VectorIndexRetrieverOptions
- SelectorResult
- QueryEngineToolParams
- QueryEngineParam
- ToolMetadataOnlyDescription
- UUID
- AnthropicAgentParams
- AnthropicAdditionalChatOptions
- GeminiConfig
- GoogleGeminiSessionOptions
- VertexGeminiSessionOptions
- GeminiSessionOptions
- Part
- FileDataPart
- InlineDataPart
- ModelParams
- FunctionDeclaration
- FunctionDeclarationSchema
- GenerativeModel
- ChatContext
- GeminiMessageRole
- GeminiAdditionalChatOptions
- GeminiChatParamsStreaming
- GeminiChatStreamResponse
- GeminiChatParamsNonStreaming
- GeminiChatNonStreamResponse
- HuggingFaceEmbeddingParams
- HFConfig
- JinaEmbeddingRequest
- JinaEmbeddingResponse
- OllamaAgentParams
- OllamaParams
- OpenAIAgentParams
- OpenAIAdditionalMetadata
- OpenAIAdditionalChatOptions
- InterpreterParameter
- InterpreterToolOutputImage
- InterpreterToolOutput
- AzureDynamicSessionToolParams
- FilterableMetadataFieldKeysType
- R
- AzureCosmosDBMongoDBSimilarityType
- AzureCosmosDBMongoDBIndexOptions
- AzureCosmosDBNoSqlCreateDatabaseOptions
- AzureCosmosDBNoSqlCreateContainerOptions
- PGVectorStoreConfig
- PostgresDocumentStoreConfig
- PostgresIndexStoreConfig
- DataType
- PostgresKVStoreBaseConfig
- PostgresKVStoreClientConfig
- PostgresKVStoreConfig
- VLLMParams
- StepHandler
- HandlerContext
- StepParameters
Variables
- BEDROCK_MODELS
- INFERENCE_BEDROCK_MODELS
- INFERENCE_TO_BEDROCK_MAP
- BEDROCK_MODEL_MAX_TOKENS
- process
- emptyLogger
- consoleLogger
- CustomEvent
- Settings
- OpenAIContextAwareAgent
- defaultUserPrompt
- defaultCorrectnessSystemPrompt
- defaultFaithfulnessRefinePrompt
- defaultFaithfulnessTextQaPrompt
- defaultRelevancyEvalPrompt
- defaultRelevancyRefinePrompt
- ALL_AVAILABLE_ANTHROPIC_LEGACY_MODELS
- ALL_AVAILABLE_V3_MODELS
- ALL_AVAILABLE_V3_5_MODELS
- ALL_AVAILABLE_ANTHROPIC_MODELS
- DEEPSEEK_MODELS
- GEMINI_MODEL_INFO_MAP
- DEFAULT_SAFETY_SETTINGS
- ALL_AVAILABLE_MISTRAL_MODELS
- ALL_OPENAI_EMBEDDING_MODELS
- GPT4_MODELS
- GPT35_MODELS
- O1_MODELS
- ALL_AVAILABLE_OPENAI_MODELS
- ALL_AVAILABLE_REPLICATE_MODELS
- DeuceChatStrategy
- LlamaDeuce
- AzureAISearchVectorStoreConfig
- AzureCosmosDBMongoDBSimilarityType
- PGVECTOR_SCHEMA
- PGVECTOR_TABLE
- DEFAULT_DIMENSIONS
Functions
- createSHA256
- setEnvs
- getEnv
- parseJsonMarkdown
- defaultEvaluationParser
- runTransformations
- addNodesToVectorStores
- imageToDataUrl
- getSelectorFromContext
- exists
- walk
- storageContextFromDefaults
- getPartsText
- getText
- cleanParts
- getChatContext
- mapBaseToolToGeminiFunctionDeclaration
- getFunctionCalls
- getPortkeySession
- llamaindex