sdkagent

llama_index API reference

400 public APIs from llama_index (run-llama/llama_index) — 157 classes, 54 functions, 189 methods. Signatures extracted by static analysis of the actual source.

Repository: run-llama/llama_index

KindCount
Classes157
Functions54
Methods189

API list

funcllama-dev.llama_dev.release.changelog.changelog(obj:dict, dry_run:bool) -> None
Generate the changelog in markdown syntax.
funcllama-dev.llama_dev.utils.bump_version(current_version:str, bump_type:BumpType) -> str
Bump a version string according to semver rules.
funcllama-dev.llama_dev.utils.find_all_packages(root_path:Path) -> list[Path]
Returns a list of all the package folders in the monorepo.
funcllama-dev.llama_dev.utils.find_integrations(root_path:Path, recursive=False) -> list[Path]
Find all integrations packages in the repo.
funcllama-dev.llama_dev.utils.find_utils(root_path:Path) -> list[Path]
Find all llama-index-utils packages in the repo.
funcllama-dev.llama_dev.utils.get_dep_names(pyproject_data:dict) -> set[str]
Load dependencies from pyproject.toml.
funcllama-dev.llama_dev.utils.get_dependants_packages(changed_packages:set[Path], all_packages:list[Path]) -> set[Path]
Get packages containing the files in the changeset.
funcllama-dev.llama_dev.utils.is_llama_index_package(package_path:Path) -> bool
Returns whether a folder contains a 'pyproject.toml' file.
funcllama-dev.llama_dev.utils.load_pyproject(package_path:Path) -> dict
Thin wrapper around tomli.load().
funcllama-dev.llama_dev.utils.package_has_tests(package_path:Path) -> bool
Returns whether a package folder contains a 'tests' subfolder.
funcllama-dev.llama_dev.utils.update_pyproject_version(package_path:Path, new_version:str) -> None
Update the version in a pyproject.toml file.
classllama-index-core.llama_index.core.agent.react.formatter.BaseAgentChatFormatter
Base chat formatter.
methodllama-index-core.llama_index.core.agent.react.formatter.BaseAgentChatFormatter.format(tools:Sequence[BaseTool], chat_history:List[ChatMessage], current_reasoning:Optional[List[BaseReasoningStep]]=None) -> List[ChatMessage]
Format chat history into list of ChatMessage.
classllama-index-core.llama_index.core.agent.react.formatter.ReActChatFormatter
ReAct chat formatter.
methodllama-index-core.llama_index.core.agent.react.formatter.ReActChatFormatter.from_context(context:str) -> 'ReActChatFormatter'
Create ReActChatFormatter from context.
funcllama-index-core.llama_index.core.agent.react.formatter.get_react_tool_descriptions(tools:Sequence[BaseTool]) -> List[str]
Tool.
classllama-index-core.llama_index.core.agent.react.output_parser.ReActOutputParser
ReAct Output parser.
methodllama-index-core.llama_index.core.agent.react.output_parser.ReActOutputParser.parse(output:str, is_streaming:bool=False) -> BaseReasoningStep
Parse output from ReAct agent.
funcllama-index-core.llama_index.core.agent.react.output_parser.parse_action_reasoning_step(output:str) -> ActionReasoningStep
Parse an action reasoning step from the LLM output.
classllama-index-core.llama_index.core.agent.react.types.ActionReasoningStep
Action Reasoning step.
methodllama-index-core.llama_index.core.agent.react.types.ActionReasoningStep.get_content() -> str
Get content.
methodllama-index-core.llama_index.core.agent.react.types.ActionReasoningStep.is_done() -> bool
Is the reasoning step the last one.
classllama-index-core.llama_index.core.agent.react.types.BaseReasoningStep
Reasoning step.
methodllama-index-core.llama_index.core.agent.react.types.BaseReasoningStep.get_content() -> str
Get content.
methodllama-index-core.llama_index.core.agent.react.types.BaseReasoningStep.is_done() -> bool
Is the reasoning step the last one.
classllama-index-core.llama_index.core.agent.react.types.ObservationReasoningStep
Observation reasoning step.
methodllama-index-core.llama_index.core.agent.react.types.ObservationReasoningStep.get_content() -> str
Get content.
methodllama-index-core.llama_index.core.agent.react.types.ObservationReasoningStep.is_done() -> bool
Is the reasoning step the last one.
classllama-index-core.llama_index.core.agent.react.types.ResponseReasoningStep
Response reasoning step.
methodllama-index-core.llama_index.core.agent.react.types.ResponseReasoningStep.get_content() -> str
Get content.
methodllama-index-core.llama_index.core.agent.react.types.ResponseReasoningStep.is_done() -> bool
Is the reasoning step the last one.
methodllama-index-core.llama_index.core.agent.workflow.agent_context.AgentContext.write_event_to_stream(event:Any) -> None
Write an event to the output stream.
classllama-index-core.llama_index.core.agent.workflow.codeact_agent.CodeActAgent
A workflow agent that can execute code.
methodllama-index-core.llama_index.core.agent.workflow.codeact_agent.CodeActAgent.finalize(ctx:Context, output:AgentOutput, memory:BaseMemory) -> AgentOutput
Finalize the code act agent.
classllama-index-core.llama_index.core.agent.workflow.function_agent.FunctionAgent
Function calling agent implementation.
methodllama-index-core.llama_index.core.agent.workflow.function_agent.FunctionAgent.finalize(ctx:Context, output:AgentOutput, memory:BaseMemory) -> AgentOutput
Finalize the function calling agent.
funcllama-index-core.llama_index.core.agent.workflow.multi_agent_workflow.handoff(ctx:Context, to_agent:str, reason:str) -> str
Handoff control of that chat to the given agent.
classllama-index-core.llama_index.core.agent.workflow.react_agent.ReActAgent
React agent implementation.
methodllama-index-core.llama_index.core.agent.workflow.react_agent.ReActAgent.finalize(ctx:Context, output:AgentOutput, memory:BaseMemory) -> AgentOutput
Finalize the React agent.
methodllama-index-core.llama_index.core.agent.workflow.react_agent.ReActAgent.validate_formatter() -> 'ReActAgent'
Validate the formatter.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.AgentInput
LLM input.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.AgentOutput
LLM output.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.AgentSetup
Agent setup.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.AgentStream
Agent stream.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.AgentStreamStructuredOutput
Stream the structured output
classllama-index-core.llama_index.core.agent.workflow.workflow_events.ToolCall
All tool calls are surfaced.
classllama-index-core.llama_index.core.agent.workflow.workflow_events.ToolCallResult
Tool call result.
funcllama-index-core.llama_index.core.async_utils.asyncio_run(coro:Coroutine) -> Any
Gets an existing event loop to run the coroutine.
funcllama-index-core.llama_index.core.async_utils.run_async_tasks(tasks:List[Coroutine], show_progress:bool=False, progress_bar_desc:str='Running async tasks') -> List[Any]
Run a list of async tasks.
funcllama-index-core.llama_index.core.async_utils.run_jobs(jobs:List[Coroutine[Any, Any, T]], show_progress:bool=False, workers:int=DEFAULT_NUM_WORKERS, desc:Optional[str]=None) -> List[T]
Run jobs.
classllama-index-core.llama_index.core.base.base_auto_retriever.BaseAutoRetriever
Base auto retriever.
methodllama-index-core.llama_index.core.base.base_auto_retriever.BaseAutoRetriever.generate_retrieval_spec(query_bundle:QueryBundle, **kwargs:Any) -> BaseModel
Generate retrieval spec synchronously.
classllama-index-core.llama_index.core.base.base_multi_modal_retriever.MultiModalRetriever
Multi Modal base retriever.
methodllama-index-core.llama_index.core.base.base_multi_modal_retriever.MultiModalRetriever.text_retrieve(str_or_query_bundle:QueryType) -> List[NodeWithScore]
Retrieve text nodes given text query.
classllama-index-core.llama_index.core.base.base_query_engine.BaseQueryEngine
Base query engine.
classllama-index-core.llama_index.core.base.base_retriever.BaseRetriever
Base retriever.
methodllama-index-core.llama_index.core.base.base_retriever.BaseRetriever.retrieve(str_or_query_bundle:QueryType) -> List[NodeWithScore]
Retrieve nodes given query.
classllama-index-core.llama_index.core.base.base_selector.BaseSelector
Base selector.
classllama-index-core.llama_index.core.base.base_selector.MultiSelection
A multi-selection of choices.
classllama-index-core.llama_index.core.base.base_selector.SingleSelection
A single selection of a choice.
classllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding
Base class for embeddings.
methodllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding.aget_query_embedding(query:str) -> Embedding
Get query embedding.
methodllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding.aget_text_embedding(text:str) -> Embedding
Async get text embedding.
methodllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding.get_query_embedding(query:str) -> Embedding
Embed the input query.
methodllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding.get_text_embedding(text:str) -> Embedding
Embed the input text.
methodllama-index-core.llama_index.core.base.embeddings.base.BaseEmbedding.similarity(embedding1:Embedding, embedding2:Embedding, mode:SimilarityMode=SimilarityMode.DEFAULT) -> float
Get embedding similarity.
classllama-index-core.llama_index.core.base.embeddings.base.SimilarityMode
Modes for similarity/distance.
funcllama-index-core.llama_index.core.base.embeddings.base.mean_agg(embeddings:List[Embedding]) -> Embedding
Mean aggregation for embeddings.
funcllama-index-core.llama_index.core.base.embeddings.base.similarity(embedding1:Embedding, embedding2:Embedding, mode:SimilarityMode=SimilarityMode.DEFAULT) -> float
Get embedding similarity.
classllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding
Base class for embeddings.
methodllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding.aget_query_embedding(query:str) -> SparseEmbedding
Get query embedding.
methodllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding.aget_text_embedding(text:str) -> SparseEmbedding
Async get text embedding.
methodllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding.get_query_embedding(query:str) -> SparseEmbedding
Embed the input query.
methodllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding.get_text_embedding(text:str) -> SparseEmbedding
Embed the input text.
methodllama-index-core.llama_index.core.base.embeddings.base_sparse.BaseSparseEmbedding.similarity(embedding1:SparseEmbedding, embedding2:SparseEmbedding) -> float
Get sparse embedding similarity.
funcllama-index-core.llama_index.core.base.embeddings.base_sparse.mean_agg(embeddings:List[SparseEmbedding]) -> SparseEmbedding
Get mean aggregation of embeddings.
funcllama-index-core.llama_index.core.base.embeddings.base_sparse.sparse_similarity(embedding1:SparseEmbedding, embedding2:SparseEmbedding) -> float
Get sparse embedding similarity.
classllama-index-core.llama_index.core.base.llms.base.BaseLLM
BaseLLM interface.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.achat(messages:Sequence[ChatMessage], **kwargs:Any) -> ChatResponse
Async chat endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.acomplete(prompt:str, formatted:bool=False, **kwargs:Any) -> CompletionResponse
Async completion endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.astream_chat(messages:Sequence[ChatMessage], **kwargs:Any) -> ChatResponseAsyncGen
Async streaming chat endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.chat(messages:Sequence[ChatMessage], **kwargs:Any) -> ChatResponse
Chat endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.complete(prompt:str, formatted:bool=False, **kwargs:Any) -> CompletionResponse
Completion endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.metadata() -> LLMMetadata
LLM metadata.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.stream_chat(messages:Sequence[ChatMessage], **kwargs:Any) -> ChatResponseGen
Streaming chat endpoint for LLM.
methodllama-index-core.llama_index.core.base.llms.base.BaseLLM.stream_complete(prompt:str, formatted:bool=False, **kwargs:Any) -> CompletionResponseGen
Streaming completion endpoint for LLM.
funcllama-index-core.llama_index.core.base.llms.generic_utils.completion_response_to_chat_response(completion_response:CompletionResponse) -> ChatResponse
Convert a completion response to a chat response.
funcllama-index-core.llama_index.core.base.llms.generic_utils.image_node_to_image_block(image_node:ImageNode) -> ImageBlock
Get an ImageBlock from an ImageNode.
funcllama-index-core.llama_index.core.base.llms.generic_utils.messages_to_history_str(messages:Sequence[ChatMessage]) -> str
Convert messages to a history string.
funcllama-index-core.llama_index.core.base.llms.generic_utils.messages_to_prompt(messages:Sequence[ChatMessage]) -> str
Convert messages to a prompt string.
funcllama-index-core.llama_index.core.base.llms.generic_utils.prompt_to_messages(prompt:str) -> List[ChatMessage]
Convert a string prompt to a sequence of messages.
classllama-index-core.llama_index.core.base.llms.types.ChatMessage
Chat message.
methodllama-index-core.llama_index.core.base.llms.types.ChatMessage.legacy_additional_kwargs_image() -> Self
Provided for backward compatibility.
classllama-index-core.llama_index.core.base.llms.types.ChatResponse
Chat response.
classllama-index-core.llama_index.core.base.llms.types.CompletionResponse
Completion response.
classllama-index-core.llama_index.core.base.llms.types.LogProb
LogProb of a token.
classllama-index-core.llama_index.core.base.llms.types.MessageRole
Message role.
classllama-index-core.llama_index.core.base.llms.types.TextBlock
A representation of text data to directly pass to/from the LLM.
classllama-index-core.llama_index.core.base.response.schema.AsyncStreamingResponse
AsyncStreamingResponse object.
methodllama-index-core.llama_index.core.base.response.schema.AsyncStreamingResponse.async_response_gen() -> TokenAsyncGen
Yield the string response.
methodllama-index-core.llama_index.core.base.response.schema.AsyncStreamingResponse.get_formatted_sources(length:int=100, trim_text:int=True) -> str
Get formatted sources text.
methodllama-index-core.llama_index.core.base.response.schema.AsyncStreamingResponse.get_response() -> Response
Get a standard response object.
methodllama-index-core.llama_index.core.base.response.schema.AsyncStreamingResponse.print_response_stream() -> None
Print the response stream.
classllama-index-core.llama_index.core.base.response.schema.PydanticResponse
PydanticResponse object.
methodllama-index-core.llama_index.core.base.response.schema.PydanticResponse.get_formatted_sources(length:int=100) -> str
Get formatted sources text.
methodllama-index-core.llama_index.core.base.response.schema.PydanticResponse.get_response() -> Response
Get a standard response object.
classllama-index-core.llama_index.core.base.response.schema.Response
Response object.
methodllama-index-core.llama_index.core.base.response.schema.Response.get_formatted_sources(length:int=100) -> str
Get formatted sources text.
classllama-index-core.llama_index.core.base.response.schema.StreamingResponse
StreamingResponse object.
methodllama-index-core.llama_index.core.base.response.schema.StreamingResponse.get_formatted_sources(length:int=100, trim_text:int=True) -> str
Get formatted sources text.
methodllama-index-core.llama_index.core.base.response.schema.StreamingResponse.get_response() -> Response
Get a standard response object.
methodllama-index-core.llama_index.core.base.response.schema.StreamingResponse.print_response_stream() -> None
Print the response stream.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.add_handler(handler:BaseCallbackHandler) -> None
Add a handler to the callback manager.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.as_trace(trace_id:str) -> Generator[None, None, None]
Context manager tracer for lanching and shutdown of traces.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.end_trace(trace_id:Optional[str]=None, trace_map:Optional[Dict[str, List[str]]]=None) -> None
Run when an overall trace is exited.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.event(event_type:CBEventType, payload:Optional[Dict[str, Any]]=None, event_id:Optional[str]=None) -> Generator['EventContext', None, None]
Context manager for lanching and shutdown of events.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.on_event_end(event_type:CBEventType, payload:Optional[Dict[str, Any]]=None, event_id:Optional[str]=None, **kwargs:Any) -> None
Run handlers when an event ends.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.remove_handler(handler:BaseCallbackHandler) -> None
Remove a handler from the callback manager.
methodllama-index-core.llama_index.core.callbacks.base.CallbackManager.start_trace(trace_id:Optional[str]=None) -> None
Run when an overall trace is launched.
methodllama-index-core.llama_index.core.callbacks.base_handler.BaseCallbackHandler.on_event_end(event_type:CBEventType, payload:Optional[Dict[str, Any]]=None, event_id:str='', **kwargs:Any) -> None
Run when an event ends.
methodllama-index-core.llama_index.core.callbacks.base_handler.BaseCallbackHandler.start_trace(trace_id:Optional[str]=None) -> None
Run when an overall trace is launched.
funcllama-index-core.llama_index.core.callbacks.global_handlers.create_global_handler(eval_mode:str, **eval_params:Any) -> Optional[BaseCallbackHandler]
Get global eval handler.
funcllama-index-core.llama_index.core.callbacks.global_handlers.set_global_handler(eval_mode:str, **eval_params:Any) -> None
Set global eval handlers.
methodllama-index-core.llama_index.core.callbacks.llama_debug.LlamaDebugHandler.end_trace(trace_id:Optional[str]=None, trace_map:Optional[Dict[str, List[str]]]=None) -> None
Shutdown the current trace.
methodllama-index-core.llama_index.core.callbacks.llama_debug.LlamaDebugHandler.flush_event_logs() -> None
Clear all events from memory.
methodllama-index-core.llama_index.core.callbacks.llama_debug.LlamaDebugHandler.get_events(event_type:Optional[CBEventType]=None) -> List[CBEvent]
Get all events for a specific event type.
methodllama-index-core.llama_index.core.callbacks.llama_debug.LlamaDebugHandler.start_trace(trace_id:Optional[str]=None) -> None
Launch a trace.
classllama-index-core.llama_index.core.callbacks.schema.CBEvent
Generic class to store event information.
classllama-index-core.llama_index.core.callbacks.schema.CBEventType
Callback manager event types.
classllama-index-core.llama_index.core.callbacks.schema.EventStats
Time-based Statistics for events.
funcllama-index-core.llama_index.core.callbacks.utils.trace_method(trace_id:str, callback_manager_attr:str='callback_manager') -> Callable[[Callable], Callable]
Decorator to trace a method.
classllama-index-core.llama_index.core.chat_engine.condense_question.CondenseQuestionChatEngine
Condense Question Chat Engine.
methodllama-index-core.llama_index.core.chat_engine.condense_question.CondenseQuestionChatEngine.chat_history() -> List[ChatMessage]
Get chat history.
classllama-index-core.llama_index.core.chat_engine.context.ContextChatEngine
Context Chat Engine.
methodllama-index-core.llama_index.core.chat_engine.context.ContextChatEngine.chat_history() -> List[ChatMessage]
Get chat history.
classllama-index-core.llama_index.core.chat_engine.multi_modal_context.MultiModalContextChatEngine
Multimodal Context Chat Engine.
methodllama-index-core.llama_index.core.chat_engine.multi_modal_context.MultiModalContextChatEngine.chat_history() -> List[ChatMessage]
Get chat history.
classllama-index-core.llama_index.core.chat_engine.simple.SimpleChatEngine
Simple Chat Engine.
methodllama-index-core.llama_index.core.chat_engine.simple.SimpleChatEngine.chat_history() -> List[ChatMessage]
Get chat history.
classllama-index-core.llama_index.core.chat_engine.types.AgentChatResponse
Agent chat response.
methodllama-index-core.llama_index.core.chat_engine.types.AgentChatResponse.async_response_gen() -> AsyncGenerator[str, None]
Used for fake streaming, i.e.
methodllama-index-core.llama_index.core.chat_engine.types.AgentChatResponse.response_gen() -> Generator[str, None, None]
Used for fake streaming, i.e.
classllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine
Base Chat Engine.
methodllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine.achat(message:str, chat_history:Optional[List[ChatMessage]]=None) -> AGENT_CHAT_RESPONSE_TYPE
Async version of main chat interface.
methodllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine.chat(message:str, chat_history:Optional[List[ChatMessage]]=None) -> AGENT_CHAT_RESPONSE_TYPE
Main chat interface.
methodllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine.chat_repl() -> None
Enter interactive chat REPL.
methodllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine.reset() -> None
Reset conversation state.
methodllama-index-core.llama_index.core.chat_engine.types.BaseChatEngine.stream_chat(message:str, chat_history:Optional[List[ChatMessage]]=None) -> StreamingAgentChatResponse
Stream chat interface.
classllama-index-core.llama_index.core.chat_engine.types.ChatMode
Chat Engine Modes.
funcllama-index-core.llama_index.core.chat_engine.types.is_function(message:ChatMessage) -> bool
Utility for ChatMessage responses from OpenAI models.
classllama-index-core.llama_index.core.composability.joint_qa_summary.QASummaryQueryEngineBuilder
Joint QA Summary graph builder.
methodllama-index-core.llama_index.core.composability.joint_qa_summary.QASummaryQueryEngineBuilder.build_from_documents(documents:Sequence[Document]) -> RouterQueryEngine
Build query engine.
classllama-index-core.llama_index.core.data_structs.data_structs.EmptyIndexStruct
Empty index.
methodllama-index-core.llama_index.core.data_structs.data_structs.EmptyIndexStruct.get_type() -> IndexStructType
Get type.
classllama-index-core.llama_index.core.data_structs.data_structs.IndexDict
A simple dictionary of documents.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexDict.delete(doc_id:str) -> None
Delete a Node.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexDict.get_type() -> IndexStructType
Get type.
classllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph
A graph representing the tree-structured index.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.get_children(parent_node:Optional[BaseNode]) -> Dict[int, str]
Get children nodes.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.get_index(node:BaseNode) -> int
Get index of node.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.get_type() -> IndexStructType
Get type.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.insert(node:BaseNode, index:Optional[int]=None, children_nodes:Optional[Sequence[BaseNode]]=None) -> None
Insert node.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.insert_under_parent(node:BaseNode, parent_node:Optional[BaseNode], new_index:Optional[int]=None) -> None
Insert under parent node.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.node_id_to_index() -> Dict[str, int]
Map from node id to index.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexGraph.size() -> int
Get the size of the graph.
classllama-index-core.llama_index.core.data_structs.data_structs.IndexList
A list of documents.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexList.add_node(node:BaseNode) -> None
Add text to table, return current position in list.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexList.get_type() -> IndexStructType
Get type.
classllama-index-core.llama_index.core.data_structs.data_structs.IndexStruct
A base data struct for a LlamaIndex.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexStruct.get_summary() -> str
Get text summary.
methodllama-index-core.llama_index.core.data_structs.data_structs.IndexStruct.get_type() -> IndexStructType
Get index struct type.
classllama-index-core.llama_index.core.data_structs.struct_type.IndexStructType
Index struct type.
classllama-index-core.llama_index.core.data_structs.table.BaseStructTable
Struct outputs.
classllama-index-core.llama_index.core.data_structs.table.PandasStructTable
Pandas struct outputs.
methodllama-index-core.llama_index.core.data_structs.table.PandasStructTable.get_type() -> IndexStructType
Get type.
classllama-index-core.llama_index.core.data_structs.table.SQLStructTable
SQL struct outputs.
methodllama-index-core.llama_index.core.data_structs.table.SQLStructTable.get_type() -> IndexStructType
Get type.
classllama-index-core.llama_index.core.data_structs.table.StructDatapoint
Struct outputs.
funcllama-index-core.llama_index.core.embeddings.loading.load_embed_model(data:dict) -> BaseEmbedding
Load Embedding by name.
classllama-index-core.llama_index.core.embeddings.mock_embed_model.MockEmbedding
Mock embedding.
classllama-index-core.llama_index.core.embeddings.mock_embed_model.MockMultiModalEmbedding
Multi-Modal Mock embedding.
classllama-index-core.llama_index.core.embeddings.multi_modal_base.MultiModalEmbedding
Base class for Multi Modal embeddings.
methodllama-index-core.llama_index.core.embeddings.multi_modal_base.MultiModalEmbedding.aget_image_embedding(img_file_path:ImageType) -> Embedding
Get image embedding.
methodllama-index-core.llama_index.core.embeddings.multi_modal_base.MultiModalEmbedding.get_image_embedding(img_file_path:ImageType) -> Embedding
Embed the input image.
funcllama-index-core.llama_index.core.embeddings.utils.load_embedding(file_path:str) -> List[float]
Load embedding from file.
funcllama-index-core.llama_index.core.embeddings.utils.resolve_embed_model(embed_model:Optional[EmbedType]=None, callback_manager:Optional[CallbackManager]=None) -> BaseEmbedding
Resolve embed model.
funcllama-index-core.llama_index.core.embeddings.utils.save_embedding(embedding:List[float], file_path:str) -> None
Save embedding to file.
classllama-index-core.llama_index.core.evaluation.answer_relevancy.AnswerRelevancyEvaluator
Answer relevancy evaluator.
classllama-index-core.llama_index.core.evaluation.base.BaseEvaluator
Base Evaluator class.
classllama-index-core.llama_index.core.evaluation.base.EvaluationResult
Evaluation result.
classllama-index-core.llama_index.core.evaluation.batch_runner.BatchEvalRunner
Batch evaluation runner.
methodllama-index-core.llama_index.core.evaluation.batch_runner.BatchEvalRunner.aevaluate_queries(query_engine:BaseQueryEngine, queries:Optional[List[str]]=None, **eval_kwargs_lists:Dict[str, Any]) -> Dict[str, List[EvaluationResult]]
Evaluate queries.
methodllama-index-core.llama_index.core.evaluation.batch_runner.BatchEvalRunner.evaluate_queries(query_engine:BaseQueryEngine, queries:Optional[List[str]]=None, **eval_kwargs_lists:Dict[str, Any]) -> Dict[str, List[EvaluationResult]]
Evaluate queries.
funcllama-index-core.llama_index.core.evaluation.batch_runner.response_worker(semaphore:asyncio.Semaphore, query_engine:BaseQueryEngine, query:str) -> RESPONSE_TYPE
Get aquery tasks with semaphore.
classllama-index-core.llama_index.core.evaluation.context_relevancy.ContextRelevancyEvaluator
Context relevancy evaluator.
classllama-index-core.llama_index.core.evaluation.correctness.CorrectnessEvaluator
Correctness evaluator.
classllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset
Query Response Dataset.
methodllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset.from_json(path:str) -> QueryResponseDataset
Load json.
methodllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset.from_qr_pairs(qr_pairs:List[Tuple[str, str]]) -> QueryResponseDataset
Create from qr pairs.
methodllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset.qr_pairs() -> List[Tuple[str, str]]
Get pairs.
methodllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset.questions() -> List[str]
Get questions.
methodllama-index-core.llama_index.core.evaluation.dataset_generation.QueryResponseDataset.save_json(path:str) -> None
Save json.
funcllama-index-core.llama_index.core.evaluation.eval_utils.aget_responses(questions:List[str], query_engine:BaseQueryEngine, show_progress:bool=False) -> List[str]
Get responses.
funcllama-index-core.llama_index.core.evaluation.eval_utils.get_responses(*args:Any, **kwargs:Any) -> List[str]
Get responses.
funcllama-index-core.llama_index.core.evaluation.eval_utils.get_results_df(eval_results_list:List[Dict[str, List[EvaluationResult]]], names:List[str], metric_keys:List[str]) -> Any
Get results df.
classllama-index-core.llama_index.core.evaluation.faithfulness.FaithfulnessEvaluator
Faithfulness evaluator.
classllama-index-core.llama_index.core.evaluation.guideline.GuidelineEvaluator
Guideline evaluator.
classllama-index-core.llama_index.core.evaluation.multi_modal.faithfulness.MultiModalFaithfulnessEvaluator
Multi-Modal Faithfulness evaluator.
classllama-index-core.llama_index.core.evaluation.multi_modal.relevancy.MultiModalRelevancyEvaluator
Relevancy evaluator.
funcllama-index-core.llama_index.core.evaluation.notebook_utils.get_retrieval_results_df(names:List[str], results_arr:List[List[RetrievalEvalResult]], metric_keys:Optional[List[str]]=None) -> Any
Display retrieval results.
classllama-index-core.llama_index.core.evaluation.pairwise.EvaluationSource
To distinguish between flipped or original.
classllama-index-core.llama_index.core.evaluation.pairwise.PairwiseComparisonEvaluator
Pairwise comparison evaluator.
classllama-index-core.llama_index.core.evaluation.relevancy.RelevancyEvaluator
Relenvancy evaluator.
classllama-index-core.llama_index.core.evaluation.retrieval.base.BaseRetrievalEvaluator
Base Retrieval Evaluator class.
classllama-index-core.llama_index.core.evaluation.retrieval.base.RetrievalEvalMode
Evaluation of retrieval modality.
classllama-index-core.llama_index.core.evaluation.retrieval.base.RetrievalEvalResult
Retrieval eval result.
methodllama-index-core.llama_index.core.evaluation.retrieval.base.RetrievalEvalResult.metric_vals_dict() -> Dict[str, float]
Dictionary of metric values.
classllama-index-core.llama_index.core.evaluation.retrieval.evaluator.MultiModalRetrieverEvaluator
Retriever evaluator.
classllama-index-core.llama_index.core.evaluation.retrieval.evaluator.RetrieverEvaluator
Retriever evaluator.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics.AveragePrecision
Average Precision (AP) metric.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics.CohereRerankRelevancyMetric
Cohere rerank relevancy metric.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics.Precision
Precision metric.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics.Recall
Recall metric.
funcllama-index-core.llama_index.core.evaluation.retrieval.metrics.resolve_metrics(metrics:List[str]) -> List[Type[BaseRetrievalMetric]]
Resolve metrics from list of metric names.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics_base.BaseRetrievalMetric
Base class for retrieval metrics.
classllama-index-core.llama_index.core.evaluation.retrieval.metrics_base.RetrievalMetricResult
Metric result.
classllama-index-core.llama_index.core.evaluation.semantic_similarity.SemanticSimilarityEvaluator
Embedding similarity evaluator.
classllama-index-core.llama_index.core.extractors.interface.BaseExtractor
Metadata extractor.
methodllama-index-core.llama_index.core.extractors.interface.BaseExtractor.acall(nodes:Sequence[BaseNode], **kwargs:Any) -> List[BaseNode]
Post process nodes parsed from documents.
methodllama-index-core.llama_index.core.extractors.interface.BaseExtractor.class_name() -> str
Get class name.
classllama-index-core.llama_index.core.extractors.metadata_extractors.KeywordExtractor
Keyword extractor.
classllama-index-core.llama_index.core.extractors.metadata_extractors.PydanticProgramExtractor
Pydantic program extractor.
methodllama-index-core.llama_index.core.extractors.metadata_extractors.PydanticProgramExtractor.aextract(nodes:Sequence[BaseNode]) -> List[Dict]
Extract pydantic program.
classllama-index-core.llama_index.core.extractors.metadata_extractors.QuestionsAnsweredExtractor
Questions answered extractor.
classllama-index-core.llama_index.core.extractors.metadata_extractors.SummaryExtractor
Summary extractor.
classllama-index-core.llama_index.core.extractors.metadata_extractors.TitleExtractor
Title extractor.
classllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore
Simple Graph Store.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.client() -> None
Get client.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.delete(subj:str, rel:str, obj:str) -> None
Delete triplet.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.from_persist_dir(persist_dir:str=DEFAULT_PERSIST_DIR, fs:Optional[fsspec.AbstractFileSystem]=None) -> 'SimpleGraphStore'
Load from persist dir.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.get(subj:str) -> List[List[str]]
Get triplets.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.get_rel_map(subjs:Optional[List[str]]=None, depth:int=2, limit:int=30) -> Dict[str, List[List[str]]]
Get depth-aware rel map.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.get_schema(refresh:bool=False) -> str
Get the schema of the Simple Graph store.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.query(query:str, param_map:Optional[Dict[str, Any]]={}) -> Any
Query the Simple Graph store.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStore.upsert_triplet(subj:str, rel:str, obj:str) -> None
Add triplet.
classllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStoreData
Simple Graph Store Data container.
methodllama-index-core.llama_index.core.graph_stores.simple.SimpleGraphStoreData.get_rel_map(subjs:Optional[List[str]]=None, depth:int=2, limit:int=30) -> Dict[str, List[List[str]]]
Get subjects' rel map in max depth.
classllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore
Simple Labelled Property Graph Store.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.client() -> Any
Get client.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.from_dict(data:dict) -> 'SimplePropertyGraphStore'
Load from dict.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.from_persist_path(persist_path:str, fs:Optional[fsspec.AbstractFileSystem]=None) -> 'SimplePropertyGraphStore'
Load from persist path.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.get(properties:Optional[dict]=None, ids:Optional[List[str]]=None) -> List[LabelledNode]
Get nodes.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.get_rel_map(graph_nodes:List[LabelledNode], depth:int=2, limit:int=30, ignore_rels:Optional[List[str]]=None) -> List[Triplet]
Get depth-aware rel map.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.get_schema(refresh:bool=False) -> str
Get the schema of the graph store.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.get_triplets(entity_names:Optional[List[str]]=None, relation_names:Optional[List[str]]=None, properties:Optional[dict]=None, ids:Optional[List[str]]=None) -> List[Triplet]
Get triplets.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.persist(persist_path:str, fs:Optional[fsspec.AbstractFileSystem]=None) -> None
Persist the graph store to a file.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.to_dict() -> dict
Convert to dict.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.upsert_nodes(nodes:Sequence[LabelledNode]) -> None
Add nodes.
methodllama-index-core.llama_index.core.graph_stores.simple_labelled.SimplePropertyGraphStore.upsert_relations(relations:List[Relation]) -> None
Add relations.
classllama-index-core.llama_index.core.graph_stores.types.ChunkNode
A text chunk in a graph.
methodllama-index-core.llama_index.core.graph_stores.types.ChunkNode.id() -> str
Get the node id.
classllama-index-core.llama_index.core.graph_stores.types.EntityNode
An entity in a graph.
methodllama-index-core.llama_index.core.graph_stores.types.EntityNode.id() -> str
Get the node id.
classllama-index-core.llama_index.core.graph_stores.types.GraphStore
Abstract graph store protocol.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.client() -> Any
Get client.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.delete(subj:str, rel:str, obj:str) -> None
Delete triplet.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.get(subj:str) -> List[List[str]]
Get triplets.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.get_rel_map(subjs:Optional[List[str]]=None, depth:int=2, limit:int=30) -> Dict[str, List[List[str]]]
Get depth-aware rel map.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.get_schema(refresh:bool=False) -> str
Get the schema of the graph store.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.persist(persist_path:str, fs:Optional[fsspec.AbstractFileSystem]=None) -> None
Persist the graph store to a file.
methodllama-index-core.llama_index.core.graph_stores.types.GraphStore.upsert_triplet(subj:str, rel:str, obj:str) -> None
Add triplet.
classllama-index-core.llama_index.core.graph_stores.types.LabelledNode
An entity in a graph.
methodllama-index-core.llama_index.core.graph_stores.types.LabelledNode.id() -> str
Get the node id.
classllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore
Abstract labelled graph store protocol.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.aget(properties:Optional[dict]=None, ids:Optional[List[str]]=None) -> List[LabelledNode]
Asynchronously get nodes with matching values.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.aget_llama_nodes(node_ids:List[str]) -> List[BaseNode]
Asynchronously get nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.aget_schema(refresh:bool=False) -> str
Asynchronously get the schema of the graph store.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.aupsert_nodes(nodes:List[LabelledNode]) -> None
Asynchronously add nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.aupsert_relations(relations:List[Relation]) -> None
Asynchronously add relations.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.client() -> Any
Get client.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.delete(entity_names:Optional[List[str]]=None, relation_names:Optional[List[str]]=None, properties:Optional[dict]=None, ids:Optional[List[str]]=None) -> None
Delete matching data.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.delete_llama_nodes(node_ids:Optional[List[str]]=None, ref_doc_ids:Optional[List[str]]=None) -> None
Delete llama-index nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.get(properties:Optional[dict]=None, ids:Optional[List[str]]=None) -> List[LabelledNode]
Get nodes with matching values.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.get_llama_nodes(node_ids:List[str]) -> List[BaseNode]
Get llama-index nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.get_rel_map(graph_nodes:List[LabelledNode], depth:int=2, limit:int=30, ignore_rels:Optional[List[str]]=None) -> List[Triplet]
Get depth-aware rel map.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.get_schema(refresh:bool=False) -> Any
Get the schema of the graph store.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.get_schema_str(refresh:bool=False) -> str
Get the schema of the graph store as a string.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.persist(persist_path:str, fs:Optional[fsspec.AbstractFileSystem]=None) -> None
Persist the graph store to a file.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.upsert_llama_nodes(llama_nodes:List[BaseNode]) -> None
Add llama-index nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.upsert_nodes(nodes:Sequence[LabelledNode]) -> None
Upsert nodes.
methodllama-index-core.llama_index.core.graph_stores.types.PropertyGraphStore.upsert_relations(relations:List[Relation]) -> None
Upsert relations.
classllama-index-core.llama_index.core.graph_stores.types.Relation
A relation connecting two entities in a graph.
methodllama-index-core.llama_index.core.graph_stores.types.Relation.id() -> str
Get the relation id.
funcllama-index-core.llama_index.core.graph_stores.utils.value_sanitize(d:Any) -> Any
Sanitize the input dictionary or list.
classllama-index-core.llama_index.core.image_retriever.BaseImageRetriever
Base Image Retriever Abstraction.
funcllama-index-core.llama_index.core.img_utils.b64_2_img(data:str) -> ImageFile
Convert base64 encoded image string to a PIL.Image.
funcllama-index-core.llama_index.core.img_utils.img_2_b64(image:ImageFile, format:str='JPEG') -> str
Convert a PIL.Image to a base64 encoded image string.
classllama-index-core.llama_index.core.indices.base.BaseIndex
Base LlamaIndex.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.ainsert(document:Document, **insert_kwargs:Any) -> None
Asynchronously insert a document.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.ainsert_nodes(nodes:Sequence[BaseNode], **insert_kwargs:Any) -> None
Asynchronously insert nodes.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.as_chat_engine(chat_mode:ChatMode=ChatMode.BEST, llm:Optional[LLMType]=None, **kwargs:Any) -> BaseChatEngine
Convert the index to a chat engine.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.as_query_engine(llm:Optional[LLMType]=None, **kwargs:Any) -> BaseQueryEngine
Convert the index to a query engine.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.build_index_from_nodes(nodes:Sequence[BaseNode], **build_kwargs:Any) -> IS
Build the index from nodes.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.delete(doc_id:str, **delete_kwargs:Any) -> None
Delete a document from the index.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.delete_nodes(node_ids:List[str], delete_from_docstore:bool=False, **delete_kwargs:Any) -> None
Delete a list of nodes from the index.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.delete_ref_doc(ref_doc_id:str, delete_from_docstore:bool=False, **delete_kwargs:Any) -> None
Delete a document and it's nodes by using ref_doc_id.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.index_id() -> str
Get the index struct.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.index_struct() -> IS
Get the index struct.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.insert(document:Document, **insert_kwargs:Any) -> None
Insert a document.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.insert_nodes(nodes:Sequence[BaseNode], **insert_kwargs:Any) -> None
Insert nodes.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.refresh(documents:Sequence[Document], **update_kwargs:Any) -> List[bool]
Refresh an index with documents that have changed.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.set_index_id(index_id:str) -> None
Set the index id.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.update(document:Document, **update_kwargs:Any) -> None
Update a document and it's corresponding nodes.
methodllama-index-core.llama_index.core.indices.base.BaseIndex.update_ref_doc(document:Document, **update_kwargs:Any) -> None
Update a document and it's corresponding nodes.
classllama-index-core.llama_index.core.indices.common.struct_store.schema.SQLContextContainer
SQLContextContainer.
classllama-index-core.llama_index.core.indices.common_tree.base.GPTTreeIndexBuilder
GPT tree index builder.
methodllama-index-core.llama_index.core.indices.common_tree.base.GPTTreeIndexBuilder.build_from_nodes(nodes:Sequence[BaseNode], build_tree:bool=True) -> IndexGraph
Build from text.
methodllama-index-core.llama_index.core.indices.common_tree.base.GPTTreeIndexBuilder.docstore() -> BaseDocumentStore
Return docstore.
classllama-index-core.llama_index.core.indices.composability.graph.ComposableGraph
Composable graph.
methodllama-index-core.llama_index.core.indices.composability.graph.ComposableGraph.get_index(index_struct_id:Optional[str]=None) -> BaseIndex
Get index from index struct id.
classllama-index-core.llama_index.core.indices.document_summary.base.DocumentSummaryIndex
Document Summary Index.
methodllama-index-core.llama_index.core.indices.document_summary.base.DocumentSummaryIndex.as_retriever(retriever_mode:Union[str, _RetrieverMode]=_RetrieverMode.EMBEDDING, **kwargs:Any) -> BaseRetriever
Get retriever.
methodllama-index-core.llama_index.core.indices.document_summary.base.DocumentSummaryIndex.delete_ref_doc(ref_doc_id:str, delete_from_docstore:bool=False, **delete_kwargs:Any) -> None
Delete a document from the index.
methodllama-index-core.llama_index.core.indices.document_summary.base.DocumentSummaryIndex.get_document_summary(doc_id:str) -> str
Get document summary by doc id.
classllama-index-core.llama_index.core.indices.empty.base.EmptyIndex
Empty Index.
classllama-index-core.llama_index.core.indices.empty.retrievers.EmptyIndexRetriever
EmptyIndex query.
classllama-index-core.llama_index.core.indices.keyword_table.base.BaseKeywordTableIndex
Base Keyword Table Index.
classllama-index-core.llama_index.core.indices.keyword_table.base.KeywordTableIndex
Keyword Table Index.
classllama-index-core.llama_index.core.indices.keyword_table.rake_base.RAKEKeywordTableIndex
RAKE Keyword Table Index.
classllama-index-core.llama_index.core.indices.keyword_table.retrievers.BaseKeywordTableRetriever
Base Keyword Table Retriever.
classllama-index-core.llama_index.core.indices.keyword_table.retrievers.KeywordTableGPTRetriever
Keyword Table Index GPT Retriever.
classllama-index-core.llama_index.core.indices.keyword_table.retrievers.KeywordTableRAKERetriever
Keyword Table Index RAKE Retriever.
classllama-index-core.llama_index.core.indices.keyword_table.retrievers.KeywordTableSimpleRetriever
Keyword Table Index Simple Retriever.
classllama-index-core.llama_index.core.indices.keyword_table.simple_base.SimpleKeywordTableIndex
Simple Keyword Table Index.
funcllama-index-core.llama_index.core.indices.keyword_table.utils.rake_extract_keywords(text_chunk:str, max_keywords:Optional[int]=None, expand_with_subtokens:bool=True) -> Set[str]
Extract keywords with RAKE.
classllama-index-core.llama_index.core.indices.knowledge_graph.base.KnowledgeGraphIndex
Knowledge Graph Index.
methodllama-index-core.llama_index.core.indices.knowledge_graph.base.KnowledgeGraphIndex.add_node(keywords:List[str], node:BaseNode) -> None
Add node.
methodllama-index-core.llama_index.core.indices.knowledge_graph.base.KnowledgeGraphIndex.upsert_triplet_and_node(triplet:Tuple[str, str, str], node:BaseNode, include_embeddings:bool=False) -> None
Upsert KG triplet and node.
classllama-index-core.llama_index.core.indices.knowledge_graph.retrievers.KGRetrieverMode
Query mode enum for Knowledge Graphs.
classllama-index-core.llama_index.core.indices.knowledge_graph.retrievers.KGTableRetriever
KG Table Retriever.
classllama-index-core.llama_index.core.indices.knowledge_graph.retrievers.KnowledgeGraphRAGRetriever
Knowledge Graph RAG retriever.
classllama-index-core.llama_index.core.indices.list.base.SummaryIndex
Summary Index.
classllama-index-core.llama_index.core.indices.list.retrievers.SummaryIndexLLMRetriever
LLM retriever for SummaryIndex.
funcllama-index-core.llama_index.core.indices.loading.load_index_from_storage(storage_context:StorageContext, index_id:Optional[str]=None, **kwargs:Any) -> BaseIndex
Load index from storage context.
classllama-index-core.llama_index.core.indices.managed.base.BaseManagedIndex
Managed Index.
methodllama-index-core.llama_index.core.indices.managed.base.BaseManagedIndex.as_retriever(**kwargs:Any) -> BaseRetriever
Return a Retriever for this managed index.
classllama-index-core.llama_index.core.indices.managed.types.ManagedIndexQueryMode
Managed Index query mode.
classllama-index-core.llama_index.core.indices.multi_modal.base.MultiModalVectorStoreIndex
Multi-Modal Vector Store Index.
classllama-index-core.llama_index.core.indices.multi_modal.retriever.MultiModalVectorIndexRetriever
Multi Modal Vector index retriever.
methodllama-index-core.llama_index.core.indices.multi_modal.retriever.MultiModalVectorIndexRetriever.similarity_top_k() -> int
Return similarity top k.
classllama-index-core.llama_index.core.indices.prompt_helper.ChatPromptHelper
Chat Prompt helper.
classllama-index-core.llama_index.core.indices.prompt_helper.PromptHelper
Prompt helper.
classllama-index-core.llama_index.core.indices.property_graph.base.PropertyGraphIndex
An index for a property graph.
funcllama-index-core.llama_index.core.indices.property_graph.transformations.schema_llm.SchemaLLMPathExtractor.validate(v:Any) -> Any
Validate triplets.
classllama-index-core.llama_index.core.indices.property_graph.transformations.simple_llm.SimpleLLMPathExtractor
Extract triples from a graph.
funcllama-index-core.llama_index.core.indices.property_graph.transformations.utils.get_entity_class(possible_entities:TypeAlias, possible_entity_props:Optional[List[str]], strict:bool, clean_additional_properties:bool=False) -> Any
Get entity class.
funcllama-index-core.llama_index.core.indices.property_graph.transformations.utils.get_relation_class(possible_relations:TypeAlias, possible_relation_props:Optional[List[str]], strict:bool, clean_additional_properties:bool=False) -> Any
Get relation class.
classllama-index-core.llama_index.core.indices.query.query_transform.base.BaseQueryTransform
Base class for query transform.
methodllama-index-core.llama_index.core.indices.query.query_transform.base.BaseQueryTransform.run(query_bundle_or_str:QueryType, metadata:Optional[Dict]=None) -> QueryBundle
Run query transform.
classllama-index-core.llama_index.core.indices.query.query_transform.base.DecomposeQueryTransform
Decompose query transform.
classllama-index-core.llama_index.core.indices.query.query_transform.base.IdentityQueryTransform
Identity query transform.
classllama-index-core.llama_index.core.indices.query.query_transform.base.ImageOutputQueryTransform
Image output query transform.
classllama-index-core.llama_index.core.indices.query.query_transform.base.StepDecomposeQueryTransform
Step decompose query transform.
classllama-index-core.llama_index.core.indices.struct_store.base.BaseStructStoreIndex
Base Struct Store Index.
funcllama-index-core.llama_index.core.indices.struct_store.base.default_output_parser(output:str) -> Optional[Dict[str, Any]]
Parse output of schema extraction.
classllama-index-core.llama_index.core.indices.struct_store.container_builder.SQLContextContainerBuilder
SQLContextContainerBuilder.
methodllama-index-core.llama_index.core.indices.struct_store.container_builder.SQLContextContainerBuilder.build_context_container(ignore_db_schema:bool=False) -> SQLContextContainer
Build index structure.
classllama-index-core.llama_index.core.indices.struct_store.json_query.JSONQueryEngine
GPT JSON Query Engine.
funcllama-index-core.llama_index.core.indices.struct_store.json_query.default_output_response_parser(llm_output:str) -> str
Attempts to parse the JSON path prompt output.
classllama-index-core.llama_index.core.indices.struct_store.sql.SQLStructStoreIndex
SQL Struct Store Index.
classllama-index-core.llama_index.core.indices.struct_store.sql_query.BaseSQLTableQueryEngine
Base SQL Table query engine.
methodllama-index-core.llama_index.core.indices.struct_store.sql_query.BaseSQLTableQueryEngine.sql_retriever() -> NLSQLRetriever
Get SQL retriever.
classllama-index-core.llama_index.core.indices.struct_store.sql_query.NLSQLTableQueryEngine
Natural language SQL Table query engine.
methodllama-index-core.llama_index.core.indices.struct_store.sql_query.NLSQLTableQueryEngine.sql_retriever() -> NLSQLRetriever
Get SQL retriever.
classllama-index-core.llama_index.core.indices.struct_store.sql_query.PGVectorSQLQueryEngine
PGvector SQL query engine.
methodllama-index-core.llama_index.core.indices.struct_store.sql_query.PGVectorSQLQueryEngine.sql_retriever() -> NLSQLRetriever
Get SQL retriever.
classllama-index-core.llama_index.core.indices.struct_store.sql_query.SQLTableRetrieverQueryEngine
SQL Table retriever query engine.
methodllama-index-core.llama_index.core.indices.struct_store.sql_query.SQLTableRetrieverQueryEngine.sql_retriever() -> NLSQLRetriever
Get SQL retriever.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.BaseSQLParser
Base SQL Parser.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.BaseSQLParser.parse_response_to_sql(response:str, query_bundle:QueryBundle) -> str
Parse response to SQL.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.DefaultSQLParser
Default SQL Parser.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.DefaultSQLParser.parse_response_to_sql(response:str, query_bundle:QueryBundle) -> str
Parse response to SQL.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.NLSQLRetriever
Text-to-SQL Retriever.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.NLSQLRetriever.aretrieve_with_metadata(str_or_query_bundle:QueryType) -> Tuple[List[NodeWithScore], Dict]
Async retrieve with metadata.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.NLSQLRetriever.retrieve_with_metadata(str_or_query_bundle:QueryType) -> Tuple[List[NodeWithScore], Dict]
Retrieve with metadata.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.PGVectorSQLParser
PGVector SQL Parser.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.PGVectorSQLParser.parse_response_to_sql(response:str, query_bundle:QueryBundle) -> str
Parse response to SQL.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.SQLParserMode
SQL Parser Mode.
classllama-index-core.llama_index.core.indices.struct_store.sql_retriever.SQLRetriever
SQL Retriever.
methodllama-index-core.llama_index.core.indices.struct_store.sql_retriever.SQLRetriever.retrieve_with_metadata(str_or_query_bundle:QueryType) -> Tuple[List[NodeWithScore], Dict]
Retrieve with metadata.
classllama-index-core.llama_index.core.indices.tree.all_leaf_retriever.TreeAllLeafRetriever
GPT all leaf retriever.
classllama-index-core.llama_index.core.indices.tree.base.TreeIndex
Tree Index.
classllama-index-core.llama_index.core.indices.tree.inserter.TreeIndexInserter
LlamaIndex inserter.
methodllama-index-core.llama_index.core.indices.tree.inserter.TreeIndexInserter.insert(nodes:Sequence[BaseNode]) -> None
Insert into index_graph.
classllama-index-core.llama_index.core.indices.tree.select_leaf_retriever.TreeSelectLeafRetriever
Tree select leaf retriever.
funcllama-index-core.llama_index.core.indices.tree.select_leaf_retriever.get_text_from_node(node:BaseNode, level:Optional[int]=None, verbose:bool=False) -> str
Get text from node.
classllama-index-core.llama_index.core.indices.tree.tree_root_retriever.TreeRootRetriever
Tree root retriever.
funcllama-index-core.llama_index.core.indices.utils.default_format_node_batch_fn(summary_nodes:List[BaseNode]) -> str
Default format node batch function.
funcllama-index-core.llama_index.core.indices.utils.default_format_node_batch_for_chat_fn(summary_nodes:list[BaseNode]) -> list[ChatMessage]
Default format node batch function.
funcllama-index-core.llama_index.core.indices.utils.get_sorted_node_list(node_dict:Dict[int, BaseNode]) -> List[BaseNode]
Get sorted node list.

About this data

These signatures were extracted from the public source of run-llama/llama_index using Python's ast module. Argument names, default values, type annotations and return types are taken verbatim from the code. Implementation bodies are never stored. See how it works for details.

Back to all 805 libraries