docs_dir: api_reference extra: analytics: property: G-BYVB1ZVE6J provider: google homepage: / extra_css: - css/style.css extra_javascript: - javascript/runllm.js markdown_extensions: - attr_list - admonition - pymdownx.details - pymdownx.superfences - md_in_html - mkdocs-click - toc: permalink: "#" plugins: - search - include_dir_to_nav - render_swagger - gh-admonitions - mkdocstrings: handlers: python: options: docstring_options: ignore_init_summary: true docstring_style: google extensions: - griffe_fieldz filters: - "!^_" - "!^__init__" members_order: source merge_init_into_class: false separate_signature: true show_root_full_path: true show_root_heading: false show_root_toc_entry: false show_signature_annotations: true signature_crossrefs: true paths: - ../workflows-py - ../../llama-index-core - ../../llama-index-instrumentation - ../../llama-index-experimental - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-singlestoredb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-qdrant - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-pinecone - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-duckdb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-supabase - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-upstash - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-astra - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-lancedb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-elasticsearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-postgres - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-cassandra - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-zep - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-rocksetdb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-tencentvectordb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-milvus - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-neo4jvector - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-deeplake - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-weaviate - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-timescalevector - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-dashvector - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-jaguar - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-faiss - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-azureaisearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-mongodb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-chroma - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-bagel - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-clickhouse - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-txtai - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-epsilla - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-lantern - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-awadb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-azurecosmosmongo - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-typesense - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-pgvecto-rs - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-opensearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-docarray - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-dynamodb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-tair - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-redis - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-google - ../../llama-index-integrations/retrievers/llama-index-retrievers-pathway - ../../llama-index-integrations/retrievers/llama-index-retrievers-bm25 - ../../llama-index-integrations/retrievers/llama-index-retrievers-you - ../../llama-index-integrations/indices/llama-index-indices-managed-llama-cloud - ../../llama-index-integrations/indices/llama-index-indices-managed-colbert - ../../llama-index-integrations/indices/llama-index-indices-managed-vectara - ../../llama-index-integrations/indices/llama-index-indices-managed-google - ../../llama-index-integrations/tools/llama-index-tools-salesforce - ../../llama-index-integrations/tools/llama-index-tools-python-file - ../../llama-index-integrations/tools/llama-index-tools-ionic-shopping - ../../llama-index-integrations/tools/llama-index-tools-text-to-image - ../../llama-index-integrations/tools/llama-index-tools-openapi - ../../llama-index-integrations/tools/llama-index-tools-shopify - ../../llama-index-integrations/tools/llama-index-tools-metaphor - ../../llama-index-integrations/tools/llama-index-tools-zapier - ../../llama-index-integrations/tools/llama-index-tools-wikipedia - ../../llama-index-integrations/tools/llama-index-tools-google - ../../llama-index-integrations/tools/llama-index-tools-azure-translate - ../../llama-index-integrations/tools/llama-index-tools-multion - ../../llama-index-integrations/tools/llama-index-tools-database - ../../llama-index-integrations/tools/llama-index-tools-chatgpt-plugin - ../../llama-index-integrations/tools/llama-index-tools-neo4j - ../../llama-index-integrations/tools/llama-index-tools-bing-search - ../../llama-index-integrations/tools/llama-index-tools-yahoo-finance - ../../llama-index-integrations/tools/llama-index-tools-exa - ../../llama-index-integrations/tools/llama-index-tools-cogniswitch - ../../llama-index-integrations/tools/llama-index-tools-azure-cv - ../../llama-index-integrations/tools/llama-index-tools-notion - ../../llama-index-integrations/tools/llama-index-tools-yelp - ../../llama-index-integrations/tools/llama-index-tools-weather - ../../llama-index-integrations/tools/llama-index-tools-azure-speech - ../../llama-index-integrations/tools/llama-index-tools-wolfram-alpha - ../../llama-index-integrations/tools/llama-index-tools-slack - ../../llama-index-integrations/tools/llama-index-tools-tavily-research - ../../llama-index-integrations/tools/llama-index-tools-arxiv - ../../llama-index-integrations/tools/llama-index-tools-vector-db - ../../llama-index-integrations/tools/llama-index-tools-code-interpreter - ../../llama-index-integrations/tools/llama-index-tools-waii - ../../llama-index-integrations/tools/llama-index-tools-requests - ../../llama-index-integrations/tools/llama-index-tools-openai - ../../llama-index-integrations/tools/llama-index-tools-graphql - ../../llama-index-integrations/tools/llama-index-tools-playgrounds - ../../llama-index-integrations/tools/llama-index-tools-dappier-ai-recommendations - ../../llama-index-integrations/tools/llama-index-tools-dappier-real-time-search - ../../llama-index-integrations/embeddings/llama-index-embeddings-clip - ../../llama-index-integrations/embeddings/llama-index-embeddings-anyscale - ../../llama-index-integrations/embeddings/llama-index-embeddings-llm-rails - ../../llama-index-integrations/embeddings/llama-index-embeddings-adapter - ../../llama-index-integrations/embeddings/llama-index-embeddings-together - ../../llama-index-integrations/embeddings/llama-index-embeddings-voyageai - ../../llama-index-integrations/embeddings/llama-index-embeddings-gradient - ../../llama-index-integrations/embeddings/llama-index-embeddings-dashscope - ../../llama-index-integrations/embeddings/llama-index-embeddings-huggingface - ../../llama-index-integrations/embeddings/llama-index-embeddings-ollama - ../../llama-index-integrations/embeddings/llama-index-embeddings-sagemaker-endpoint - ../../llama-index-integrations/embeddings/llama-index-embeddings-openai - ../../llama-index-integrations/embeddings/llama-index-embeddings-cohere - ../../llama-index-integrations/embeddings/llama-index-embeddings-huggingface-optimum-intel - ../../llama-index-integrations/embeddings/llama-index-embeddings-jinaai - ../../llama-index-integrations/embeddings/llama-index-embeddings-nomic - ../../llama-index-integrations/embeddings/llama-index-embeddings-fastembed - ../../llama-index-integrations/embeddings/llama-index-embeddings-fireworks - ../../llama-index-integrations/embeddings/llama-index-embeddings-instructor - ../../llama-index-integrations/embeddings/llama-index-embeddings-huggingface-optimum - ../../llama-index-integrations/embeddings/llama-index-embeddings-langchain - ../../llama-index-integrations/embeddings/llama-index-embeddings-mistralai - ../../llama-index-integrations/embeddings/llama-index-embeddings-bedrock - ../../llama-index-integrations/embeddings/llama-index-embeddings-clarifai - ../../llama-index-integrations/embeddings/llama-index-embeddings-elasticsearch - ../../llama-index-integrations/embeddings/llama-index-embeddings-azure-openai - ../../llama-index-integrations/embeddings/llama-index-embeddings-text-embeddings-inference - ../../llama-index-integrations/embeddings/llama-index-embeddings-nebius - ../../llama-index-integrations/callbacks/llama-index-callbacks-uptrain - ../../llama-index-integrations/callbacks/llama-index-callbacks-deepeval - ../../llama-index-integrations/callbacks/llama-index-callbacks-openinference - ../../llama-index-integrations/callbacks/llama-index-callbacks-wandb - ../../llama-index-integrations/callbacks/llama-index-callbacks-argilla - ../../llama-index-integrations/callbacks/llama-index-callbacks-honeyhive - ../../llama-index-integrations/callbacks/llama-index-callbacks-arize-phoenix - ../../llama-index-integrations/callbacks/llama-index-callbacks-aim - ../../llama-index-integrations/callbacks/llama-index-callbacks-promptlayer - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-colbert-rerank - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-sbert-rerank - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-longllmlingua - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-rankgpt-rerank - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-cohere-rerank - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-presidio - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-flag-embedding-reranker - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-neo4j - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-falkordb - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-kuzu - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-nebula - ../../llama-index-integrations/agent/llama-index-agent-openai - ../../llama-index-integrations/agent/llama-index-agent-openai-legacy - ../../llama-index-integrations/agent/llama-index-agent-dashscope - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-postgres - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-redis - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-firestore - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-mongodb - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-s3 - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-dynamodb - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-dynamodb - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-mongodb - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-firestore - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-redis - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-postgres - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-postgres - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-dynamodb - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-firestore - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-mongodb - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-redis - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-redis - ../../llama-index-integrations/output_parsers/llama-index-output-parsers-langchain - ../../llama-index-integrations/output_parsers/llama-index-output-parsers-guardrails - ../../llama-index-integrations/program/llama-index-program-lmformatenforcer - ../../llama-index-integrations/program/llama-index-program-guidance - ../../llama-index-integrations/program/llama-index-program-evaporate - ../../llama-index-integrations/response_synthesizers/llama-index-response-synthesizers-google - ../../llama-index-integrations/evaluation/llama-index-evaluation-tonic-validate - ../../llama-index-integrations/readers/llama-index-readers-llama-parse - ../../llama-index-integrations/readers/llama-index-readers-docugami - ../../llama-index-integrations/readers/llama-index-readers-slack - ../../llama-index-integrations/readers/llama-index-readers-youtube-transcript - ../../llama-index-integrations/readers/llama-index-readers-mbox - ../../llama-index-integrations/readers/llama-index-readers-stackoverflow - ../../llama-index-integrations/readers/llama-index-readers-pdb - ../../llama-index-integrations/readers/llama-index-readers-snowflake - ../../llama-index-integrations/readers/llama-index-readers-discord - ../../llama-index-integrations/readers/llama-index-readers-earnings-call-transcript - ../../llama-index-integrations/readers/llama-index-readers-couchdb - ../../llama-index-integrations/readers/llama-index-readers-singlestore - ../../llama-index-integrations/readers/llama-index-readers-json - ../../llama-index-integrations/readers/llama-index-readers-trello - ../../llama-index-integrations/readers/llama-index-readers-jaguar - ../../llama-index-integrations/readers/llama-index-readers-jira - ../../llama-index-integrations/readers/llama-index-readers-pdf-table - ../../llama-index-integrations/readers/llama-index-readers-kibela - ../../llama-index-integrations/readers/llama-index-readers-dashvector - ../../llama-index-integrations/readers/llama-index-readers-bilibili - ../../llama-index-integrations/readers/llama-index-readers-smart-pdf-loader - ../../llama-index-integrations/readers/llama-index-readers-agent-search - ../../llama-index-integrations/readers/llama-index-readers-macrometa-gdn - ../../llama-index-integrations/readers/llama-index-readers-twitter - ../../llama-index-integrations/readers/llama-index-readers-astra-db - ../../llama-index-integrations/readers/llama-index-readers-opendal - ../../llama-index-integrations/readers/llama-index-readers-azstorage-blob - ../../llama-index-integrations/readers/llama-index-readers-readwise - ../../llama-index-integrations/readers/llama-index-readers-genius - ../../llama-index-integrations/readers/llama-index-readers-apify - ../../llama-index-integrations/readers/llama-index-readers-athena - ../../llama-index-integrations/readers/llama-index-readers-database - ../../llama-index-integrations/readers/llama-index-readers-remote - ../../llama-index-integrations/readers/llama-index-readers-asana - ../../llama-index-integrations/readers/llama-index-readers-docstring-walker - ../../llama-index-integrations/readers/llama-index-readers-airbyte-salesforce - ../../llama-index-integrations/readers/llama-index-readers-stripe-docs - ../../llama-index-integrations/readers/llama-index-readers-milvus - ../../llama-index-integrations/readers/llama-index-readers-nougat-ocr - ../../llama-index-integrations/readers/llama-index-readers-assemblyai - ../../llama-index-integrations/readers/llama-index-readers-graphdb-cypher - ../../llama-index-integrations/readers/llama-index-readers-confluence - ../../llama-index-integrations/readers/llama-index-readers-lilac - ../../llama-index-integrations/readers/llama-index-readers-github - ../../llama-index-integrations/readers/llama-index-readers-wikipedia - ../../llama-index-integrations/readers/llama-index-readers-mongodb - ../../llama-index-integrations/readers/llama-index-readers-notion - ../../llama-index-integrations/readers/llama-index-readers-wordpress - ../../llama-index-integrations/readers/llama-index-readers-airbyte-typeform - ../../llama-index-integrations/readers/llama-index-readers-airbyte-zendesk-support - ../../llama-index-integrations/readers/llama-index-readers-firestore - ../../llama-index-integrations/readers/llama-index-readers-microsoft-outlook - ../../llama-index-integrations/readers/llama-index-readers-s3 - ../../llama-index-integrations/readers/llama-index-readers-semanticscholar - ../../llama-index-integrations/readers/llama-index-readers-wordlift - ../../llama-index-integrations/readers/llama-index-readers-spotify - ../../llama-index-integrations/readers/llama-index-readers-airbyte-cdk - ../../llama-index-integrations/readers/llama-index-readers-qdrant - ../../llama-index-integrations/readers/llama-index-readers-feedly-rss - ../../llama-index-integrations/readers/llama-index-readers-airbyte-shopify - ../../llama-index-integrations/readers/llama-index-readers-elasticsearch - ../../llama-index-integrations/readers/llama-index-readers-rayyan - ../../llama-index-integrations/readers/llama-index-readers-firebase-realtimedb - ../../llama-index-integrations/readers/llama-index-readers-remote-depth - ../../llama-index-integrations/readers/llama-index-readers-make-com - ../../llama-index-integrations/readers/llama-index-readers-arango-db - ../../llama-index-integrations/readers/llama-index-readers-mangadex - ../../llama-index-integrations/readers/llama-index-readers-intercom - ../../llama-index-integrations/readers/llama-index-readers-airbyte-gong - ../../llama-index-integrations/readers/llama-index-readers-reddit - ../../llama-index-integrations/readers/llama-index-readers-faiss - ../../llama-index-integrations/readers/llama-index-readers-dad-jokes - ../../llama-index-integrations/readers/llama-index-readers-patentsview - ../../llama-index-integrations/readers/llama-index-readers-guru - ../../llama-index-integrations/readers/llama-index-readers-linear - ../../llama-index-integrations/readers/llama-index-readers-telegram - ../../llama-index-integrations/readers/llama-index-readers-steamship - ../../llama-index-integrations/readers/llama-index-readers-maps - ../../llama-index-integrations/readers/llama-index-readers-pathway - ../../llama-index-integrations/readers/llama-index-readers-airbyte-hubspot - ../../llama-index-integrations/readers/llama-index-readers-hatena-blog - ../../llama-index-integrations/readers/llama-index-readers-sec-filings - ../../llama-index-integrations/readers/llama-index-readers-joplin - ../../llama-index-integrations/readers/llama-index-readers-graphql - ../../llama-index-integrations/readers/llama-index-readers-bagel - ../../llama-index-integrations/readers/llama-index-readers-preprocess - ../../llama-index-integrations/readers/llama-index-readers-google - ../../llama-index-integrations/readers/llama-index-readers-feishu-docs - ../../llama-index-integrations/readers/llama-index-readers-couchbase - ../../llama-index-integrations/readers/llama-index-readers-openalex - ../../llama-index-integrations/readers/llama-index-readers-txtai - ../../llama-index-integrations/readers/llama-index-readers-azcognitive-search - ../../llama-index-integrations/readers/llama-index-readers-pandas-ai - ../../llama-index-integrations/readers/llama-index-readers-airtable - ../../llama-index-integrations/readers/llama-index-readers-string-iterable - ../../llama-index-integrations/readers/llama-index-readers-zulip - ../../llama-index-integrations/readers/llama-index-readers-zendesk - ../../llama-index-integrations/readers/llama-index-readers-bitbucket - ../../llama-index-integrations/readers/llama-index-readers-web - ../../llama-index-integrations/readers/llama-index-readers-hubspot - ../../llama-index-integrations/readers/llama-index-readers-file - ../../llama-index-integrations/readers/llama-index-readers-kaltura - ../../llama-index-integrations/readers/llama-index-readers-awadb - ../../llama-index-integrations/readers/llama-index-readers-imdb-review - ../../llama-index-integrations/readers/llama-index-readers-opensearch - ../../llama-index-integrations/readers/llama-index-readers-microsoft-sharepoint - ../../llama-index-integrations/readers/llama-index-readers-minio - ../../llama-index-integrations/readers/llama-index-readers-mangoapps-guides - ../../llama-index-integrations/readers/llama-index-readers-gpt-repo - ../../llama-index-integrations/readers/llama-index-readers-microsoft-onedrive - ../../llama-index-integrations/readers/llama-index-readers-huggingface-fs - ../../llama-index-integrations/readers/llama-index-readers-weaviate - ../../llama-index-integrations/readers/llama-index-readers-deeplake - ../../llama-index-integrations/readers/llama-index-readers-whatsapp - ../../llama-index-integrations/readers/llama-index-readers-mondaydotcom - ../../llama-index-integrations/readers/llama-index-readers-airbyte-stripe - ../../llama-index-integrations/readers/llama-index-readers-papers - ../../llama-index-integrations/readers/llama-index-readers-obsidian - ../../llama-index-integrations/readers/llama-index-readers-zep - ../../llama-index-integrations/readers/llama-index-readers-memos - ../../llama-index-integrations/readers/llama-index-readers-psychic - ../../llama-index-integrations/readers/llama-index-readers-chroma - ../../llama-index-integrations/readers/llama-index-readers-weather - ../../llama-index-integrations/readers/llama-index-readers-chatgpt-plugin - ../../llama-index-integrations/readers/llama-index-readers-hwp - ../../llama-index-integrations/readers/llama-index-readers-metal - ../../llama-index-integrations/readers/llama-index-readers-boarddocs - ../../llama-index-integrations/question_gen/llama-index-question-gen-guidance - ../../llama-index-integrations/llms/llama-index-llms-palm - ../../llama-index-integrations/llms/llama-index-llms-cohere - ../../llama-index-integrations/llms/llama-index-llms-nvidia-triton - ../../llama-index-integrations/llms/llama-index-llms-ai21 - ../../llama-index-integrations/llms/llama-index-llms-apertis - ../../llama-index-integrations/llms/llama-index-llms-bedrock - ../../llama-index-integrations/llms/llama-index-llms-huggingface - ../../llama-index-integrations/llms/llama-index-llms-azure-openai - ../../llama-index-integrations/llms/llama-index-llms-dashscope - ../../llama-index-integrations/llms/llama-index-llms-nvidia-tensorrt - ../../llama-index-integrations/llms/llama-index-llms-anthropic - ../../llama-index-integrations/llms/llama-index-llms-clarifai - ../../llama-index-integrations/llms/llama-index-llms-llama-api - ../../llama-index-integrations/llms/llama-index-llms-mymagic - ../../llama-index-integrations/llms/llama-index-llms-llama-cpp - ../../llama-index-integrations/llms/llama-index-llms-perplexity - ../../llama-index-integrations/llms/llama-index-llms-rungpt - ../../llama-index-integrations/llms/llama-index-llms-replicate - ../../llama-index-integrations/llms/llama-index-llms-openai-like - ../../llama-index-integrations/llms/llama-index-llms-konko - ../../llama-index-integrations/llms/llama-index-llms-litellm - ../../llama-index-integrations/llms/llama-index-llms-sagemaker-endpoint - ../../llama-index-integrations/llms/llama-index-llms-portkey - ../../llama-index-integrations/llms/llama-index-llms-vllm - ../../llama-index-integrations/llms/llama-index-llms-maritalk - ../../llama-index-integrations/llms/llama-index-llms-groq - ../../llama-index-integrations/llms/llama-index-llms-neutrino - ../../llama-index-integrations/llms/llama-index-llms-monsterapi - ../../llama-index-integrations/llms/llama-index-llms-predibase - ../../llama-index-integrations/llms/llama-index-llms-xinference - ../../llama-index-integrations/llms/llama-index-llms-fireworks - ../../llama-index-integrations/llms/llama-index-llms-mistralai - ../../llama-index-integrations/llms/llama-index-llms-anyscale - ../../llama-index-integrations/llms/llama-index-llms-vertex - ../../llama-index-integrations/llms/llama-index-llms-localai - ../../llama-index-integrations/llms/llama-index-llms-together - ../../llama-index-integrations/llms/llama-index-llms-ollama - ../../llama-index-integrations/llms/llama-index-llms-langchain - ../../llama-index-integrations/llms/llama-index-llms-everlyai - ../../llama-index-integrations/llms/llama-index-llms-openrouter - ../../llama-index-integrations/llms/llama-index-llms-vercel-ai-gateway - ../../llama-index-integrations/llms/llama-index-llms-openai - ../../llama-index-integrations/llms/llama-index-llms-cerebras - ../../llama-index-integrations/llms/llama-index-llms-cometapi - ../../llama-index-integrations/llms/llama-index-llms-gradient - ../../llama-index-integrations/extractors/llama-index-extractors-entity - ../../llama-index-integrations/extractors/llama-index-extractors-marvin - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-baiduvectordb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-astra-db - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-databricks - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-tidbvector - ../../llama-index-integrations/retrievers/llama-index-retrievers-videodb - ../../llama-index-integrations/tools/llama-index-tools-duckduckgo - ../../llama-index-integrations/tools/llama-index-tools-finance - ../../llama-index-integrations/tools/llama-index-tools-brave-search - ../../llama-index-integrations/embeddings/llama-index-embeddings-vertex - ../../llama-index-integrations/embeddings/llama-index-embeddings-premai - ../../llama-index-integrations/embeddings/llama-index-embeddings-premai/llama_index/embeddings/premai - ../../llama-index-integrations/embeddings/llama-index-embeddings-llamafile - ../../llama-index-integrations/callbacks/llama-index-callbacks-langfuse - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-jinaai-rerank - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-elasticsearch - ../../llama-index-integrations/llms/llama-index-llms-friendli - ../../llama-index-integrations/llms/llama-index-llms-modelscope - ../../llama-index-integrations/llms/llama-index-llms-llamafile - ../../llama-index-integrations/llms/llama-index-llms-premai - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-kdbai - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-neptune - ../../llama-index-integrations/embeddings/llama-index-embeddings-alephalpha - ../../llama-index-integrations/llms/llama-index-llms-alephalpha - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-elasticsearch - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-elasticsearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-analyticdb - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-voyageai-rerank - ../../llama-index-integrations/readers/llama-index-readers-gcs - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-rankllm-rerank - ../../llama-index-integrations/llms/llama-index-llms-ipex-llm - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-neptune - ../../llama-index-integrations/embeddings/llama-index-embeddings-cloudflare-workersai - ../../llama-index-integrations/llms/llama-index-llms-databricks - ../../llama-index-integrations/embeddings/llama-index-embeddings-huggingface-openvino - ../../llama-index-integrations/llms/llama-index-llms-openvino - ../../llama-index-integrations/embeddings/llama-index-embeddings-ipex-llm - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-openvino-rerank - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-couchbase - ../../llama-index-integrations/retrievers/llama-index-retrievers-bedrock - ../../llama-index-integrations/retrievers/llama-index-retrievers-mongodb-atlas-bm25-retriever - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-vearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-awsdocdb - ../../llama-index-integrations/agent/llama-index-agent-llm-compiler - ../../llama-index-integrations/agent/llama-index-agent-lats - ../../llama-index-integrations/agent/llama-index-agent-coa - ../../llama-index-integrations/llms/llama-index-llms-octoai - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-firestore - ../../llama-index-integrations/llms/llama-index-llms-mistral-rs - ../../llama-index-integrations/agent/llama-index-agent-introspective - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-vertexaivectorsearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-vespa - ../../llama-index-integrations/embeddings/llama-index-embeddings-nvidia - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-nvidia-rerank - ../../llama-index-integrations/llms/llama-index-llms-nvidia - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-alibabacloud-opensearch - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-relyt - ../../llama-index-integrations/tools/llama-index-tools-azure-code-interpreter - ../../llama-index-integrations/embeddings/llama-index-embeddings-deepinfra - ../../llama-index-integrations/readers/llama-index-readers-pebblo - ../../llama-index-integrations/llms/llama-index-llms-mlx - ../../llama-index-integrations/embeddings/llama-index-embeddings-upstage - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-dashscope-rerank - ../../llama-index-integrations/llms/llama-index-llms-upstage - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-wordlift - ../../llama-index-integrations/tools/llama-index-tools-cassandra - ../../llama-index-integrations/llms/llama-index-llms-lmstudio - ../../llama-index-integrations/indices/llama-index-indices-managed-postgresml - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-azure - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-azure - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-azure - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-azure - ../../llama-index-integrations/llms/llama-index-llms-deepinfra - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-hologres - ../../llama-index-integrations/indices/llama-index-indices-managed-dashscope - ../../llama-index-integrations/embeddings/llama-index-embeddings-oci-genai - ../../llama-index-integrations/node_parser/llama-index-node-parser-relational-dashscope - ../../llama-index-integrations/readers/llama-index-readers-dashscope - ../../llama-index-integrations/llms/llama-index-llms-oci-genai - ../../llama-index-integrations/retrievers/llama-index-retrievers-duckdb-retriever - ../../llama-index-integrations/embeddings/llama-index-embeddings-huggingface-api - ../../llama-index-integrations/llms/llama-index-llms-text-generation-inference - ../../llama-index-integrations/llms/llama-index-llms-huggingface-api - ../../llama-index-integrations/indices/llama-index-indices-managed-vertexai - ../../llama-index-integrations/embeddings/llama-index-embeddings-ibm - ../../llama-index-integrations/llms/llama-index-llms-bedrock-converse - ../../llama-index-integrations/llms/llama-index-llms-ibm - ../../llama-index-integrations/readers/llama-index-readers-upstage - ../../llama-index-integrations/embeddings/llama-index-embeddings-mixedbreadai - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-mixedbreadai-rerank - ../../llama-index-integrations/readers/llama-index-readers-pdf-marker - ../../llama-index-integrations/llms/llama-index-llms-you - ../../llama-index-integrations/llms/llama-index-llms-watsonx - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-tidb - ../../llama-index-integrations/readers/llama-index-readers-toggl - ../../llama-index-integrations/tools/llama-index-tools-jina - ../../llama-index-integrations/readers/llama-index-readers-structured-data - ../../llama-index-integrations/llms/llama-index-llms-yi - ../../llama-index-integrations/embeddings/llama-index-embeddings-litellm - ../../llama-index-integrations/readers/llama-index-readers-iceberg - ../../llama-index-integrations/llms/llama-index-llms-cleanlab - ../../llama-index-integrations/embeddings/llama-index-embeddings-databricks - ../../llama-index-integrations/llms/llama-index-llms-optimum-intel - ../../llama-index-integrations/llms/llama-index-llms-qianfan - ../../llama-index-integrations/callbacks/llama-index-callbacks-agentops - ../../llama-index-integrations/embeddings/llama-index-embeddings-azure-inference - ../../llama-index-integrations/embeddings/llama-index-embeddings-yandexgpt - ../../llama-index-integrations/readers/llama-index-readers-box - ../../llama-index-integrations/llms/llama-index-llms-azure-inference - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-lindorm - ../../llama-index-integrations/retrievers/llama-index-retrievers-vertexai-search - ../../llama-index-integrations/embeddings/llama-index-embeddings-textembed - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-tei-rerank - ../../llama-index-integrations/readers/llama-index-readers-gitlab - ../../llama-index-integrations/extractors/llama-index-extractors-llama-extract - ../../llama-index-integrations/retrievers/llama-index-retrievers-relik - ../../llama-index-integrations/callbacks/llama-index-callbacks-literalai - ../../llama-index-integrations/llms/llama-index-llms-paieas - ../../llama-index-integrations/extractors/llama-index-extractors-relik - ../../llama-index-integrations/indices/llama-index-indices-managed-bge-m3 - ../../llama-index-integrations/tools/llama-index-tools-box - ../../llama-index-integrations/embeddings/llama-index-embeddings-gigachat - ../../llama-index-integrations/llms/llama-index-llms-gigachat - ../../llama-index-integrations/callbacks/llama-index-callbacks-opik - ../../llama-index-integrations/embeddings/llama-index-embeddings-xinference - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-xinference-rerank - ../../llama-index-integrations/selectors/llama-index-selectors-notdiamond - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-mariadb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-tablestore - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-azurecosmosnosql - ../../llama-index-integrations/embeddings/llama-index-embeddings-alibabacloud-aisearch - ../../llama-index-integrations/node_parser/llama-index-node-parser-alibabacloud-aisearch - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-alibabacloud-aisearch-rerank - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-dynamodb - ../../llama-index-integrations/readers/llama-index-readers-alibabacloud-aisearch - ../../llama-index-integrations/llms/llama-index-llms-alibabacloud-aisearch - ../../llama-index-integrations/readers/llama-index-readers-quip - ../../llama-index-integrations/sparse_embeddings/llama-index-sparse-embeddings-fastembed - ../../llama-index-integrations/node_parser/llama-index-node-parser-topic - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-oracledb - ../../llama-index-integrations/embeddings/llama-index-embeddings-oracleai - ../../llama-index-integrations/readers/llama-index-readers-oracleai - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-upstash - ../../llama-index-integrations/embeddings/llama-index-embeddings-vertex-endpoint - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-objectbox - ../../llama-index-integrations/node_parser/llama-index-node-parser-docling - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-azurecosmosnosql - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-azurecosmosnosql - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-azurecosmosnosql - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-azurecosmosnosql - ../../llama-index-integrations/readers/llama-index-readers-docling - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-nile - ../../llama-index-integrations/embeddings/llama-index-embeddings-zhipuai - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-memgraph - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-azurecosmosmongovcore - ../../llama-index-integrations/readers/llama-index-readers-zyte-serp - ../../llama-index-integrations/readers/llama-index-readers-document360 - ../../llama-index-integrations/llms/llama-index-llms-gaudi - ../../llama-index-integrations/llms/llama-index-llms-zhipuai - ../../llama-index-integrations/llms/llama-index-llms-pipeshift - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-hnswlib - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-oceanbase - ../../llama-index-integrations/embeddings/llama-index-embeddings-gaudi - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-postgres - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-couchbase - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-couchbase - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-couchbase - ../../llama-index-integrations/llms/llama-index-llms-reka - ../../llama-index-integrations/tools/llama-index-tools-vectara-query - ../../llama-index-integrations/embeddings/llama-index-embeddings-siliconflow - ../../llama-index-integrations/memory/llama-index-memory-mem0 - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-siliconflow-rerank - ../../llama-index-integrations/llms/llama-index-llms-sambanovasystems - ../../llama-index-integrations/embeddings/llama-index-embeddings-modelscope - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-colpali-rerank - ../../llama-index-integrations/readers/llama-index-readers-gitbook - ../../llama-index-integrations/llms/llama-index-llms-siliconflow - ../../llama-index-integrations/tools/llama-index-tools-elevenlabs - ../../llama-index-integrations/llms/llama-index-llms-nebius - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-bedrock-rerank - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-pinecone-native-rerank - ../../llama-index-integrations/graph_rag/llama-index-graph-rag-cognee - ../../llama-index-integrations/llms/llama-index-llms-keywordsai - ../../llama-index-integrations/embeddings/llama-index-embeddings-opea - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-tablestore - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-tablestore - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-tablestore - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-tablestore - ../../llama-index-integrations/llms/llama-index-llms-opea - ../../llama-index-integrations/llms/llama-index-llms-stepfun - ../../llama-index-integrations/tools/llama-index-tools-linkup-research - ../../llama-index-integrations/llms/llama-index-llms-deepseek - ../../llama-index-integrations/llms/llama-index-llms-cortex - ../../llama-index-integrations/embeddings/llama-index-embeddings-vllm - ../../llama-index-integrations/embeddings/llama-index-embeddings-oci-data-science - ../../llama-index-integrations/llms/llama-index-llms-oci-data-science - ../../llama-index-integrations/retrievers/llama-index-retrievers-kendra - ../../llama-index-integrations/tools/llama-index-tools-jira - ../../llama-index-integrations/tools/llama-index-tools-playwright - ../../llama-index-integrations/readers/llama-index-readers-whisper - ../../llama-index-integrations/llms/llama-index-llms-openvino-genai - ../../llama-index-integrations/tools/llama-index-tools-mcp - ../../llama-index-integrations/readers/llama-index-readers-microsoft-outlook-emails - ../../llama-index-integrations/retrievers/llama-index-retrievers-tldw - ../../llama-index-integrations/tools/llama-index-tools-valyu - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-ibm - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-mongo - ../../llama-index-integrations/llms/llama-index-llms-google-genai - ../../llama-index-integrations/embeddings/llama-index-embeddings-google-genai - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-contextual-rerank - ../../llama-index-integrations/llms/llama-index-llms-contextual - ../../llama-index-integrations/tools/llama-index-tools-agentql - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-aimon-rerank - ../../llama-index-integrations/embeddings/llama-index-embeddings-netmind - ../../llama-index-integrations/llms/llama-index-llms-novita - ../../llama-index-integrations/llms/llama-index-llms-netmind - ../../llama-index-integrations/tools/llama-index-tools-dappier - ../../llama-index-integrations/llms/llama-index-llms-asi - ../../llama-index-integrations/embeddings/llama-index-embeddings-openai-like - ../../llama-index-integrations/readers/llama-index-readers-myscale - ../../llama-index-integrations/retrievers/llama-index-retrievers-galaxia - ../../llama-index-integrations/readers/llama-index-readers-uniprot - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-ApertureDB - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-sqlite - ../../llama-index-integrations/embeddings/llama-index-embeddings-openvino-genai - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-gel - ../../llama-index-integrations/embeddings/llama-index-embeddings-autoembeddings - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-gel - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-gel - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-gel - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-gel - ../../llama-index-integrations/readers/llama-index-readers-markitdown - ../../llama-index-integrations/llms/llama-index-llms-meta - ../../llama-index-integrations/readers/llama-index-readers-oxylabs - ../../llama-index-integrations/node_parser/llama-index-node-parser-slide - ../../llama-index-integrations/readers/llama-index-readers-legacy-office - ../../llama-index-integrations/retrievers/llama-index-retrievers-vectorize - ../../llama-index-integrations/tools/llama-index-tools-brightdata - ../../llama-index-integrations/tools/llama-index-tools-desearch - ../../llama-index-integrations/observability/llama-index-observability-otel - ../../llama-index-integrations/llms/llama-index-llms-featherlessai - ../../llama-index-integrations/llms/llama-index-llms-sarvam - ../../llama-index-integrations/tools/llama-index-tools-measurespace - ../../llama-index-integrations/graph_stores/llama-index-graph-stores-ApertureDB - ../../llama-index-integrations/voice_agents/llama-index-voice-agents-elevenlabs - ../../llama-index-integrations/tools/llama-index-tools-artifact-editor - ../../llama-index-integrations/protocols/llama-index-protocols-ag-ui - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-openGauss - ../../llama-index-integrations/tools/llama-index-tools-hive - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-db2 - ../../llama-index-integrations/voice_agents/llama-index-voice-agents-openai - ../../llama-index-integrations/indices/llama-index-indices-managed-lancedb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-moorcheh - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-flashrank-rerank - ../../llama-index-integrations/storage/kvstore/llama-index-storage-kvstore-duckdb - ../../llama-index-integrations/storage/docstore/llama-index-storage-docstore-duckdb - ../../llama-index-integrations/storage/index_store/llama-index-storage-index-store-duckdb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-s3 - ../../llama-index-integrations/readers/llama-index-readers-service-now - ../../llama-index-integrations/llms/llama-index-llms-cloudflare-ai-gateway - ../../llama-index-integrations/tools/llama-index-tools-jira-issue - ../../llama-index-integrations/voice_agents/llama-index-voice-agents-gemini-live - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-bigquery - ../../llama-index-integrations/tools/llama-index-tools-aws-bedrock-agentcore - ../../llama-index-integrations/llms/llama-index-llms-heroku - ../../llama-index-integrations/retrievers/llama-index-retrievers-superlinked - ../../llama-index-integrations/embeddings/llama-index-embeddings-heroku - ../../llama-index-integrations/embeddings/llama-index-embeddings-baseten - ../../llama-index-integrations/llms/llama-index-llms-baseten - ../../llama-index-integrations/llms/llama-index-llms-ovhcloud - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-yugabytedb - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-vectorx - ../../llama-index-integrations/retrievers/llama-index-retrievers-alletra-x10000 - ../../llama-index-integrations/readers/llama-index-readers-solr - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-azurepostgresql - ../../llama-index-integrations/readers/llama-index-readers-paddle-ocr - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-solr - ../../llama-index-integrations/memory/llama-index-memory-bedrock-agentcore - ../../llama-index-integrations/tools/llama-index-tools-signnow - ../../llama-index-integrations/llms/llama-index-llms-sglang - ../../llama-index-integrations/embeddings/llama-index-embeddings-isaacus - ../../llama-index-integrations/llms/llama-index-llms-helicone - ../../llama-index-integrations/tools/llama-index-tools-serpex - ../../llama-index-integrations/tools/llama-index-tools-airweave - ../../llama-index-integrations/tools/llama-index-tools-typecast - ../../llama-index-integrations/llms/llama-index-llms-aibadgr - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-volcenginemysql - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-alibabacloud-mysql - ../../llama-index-integrations/tools/llama-index-tools-parallel-web-systems - ../../llama-index-integrations/ingestion/llama-index-ingestion-ray - ../../llama-index-integrations/readers/llama-index-readers-datasets - ../../llama-index-integrations/vector_stores/llama-index-vector-stores-yugabytedb - ../../llama-index-integrations/node_parser/llama-index-node-parser-chonkie - ../../llama-index-integrations/tools/llama-index-tools-mcp-discovery - ../../llama-index-integrations/tools/llama-index-tools-moss - ../../llama-index-integrations/tools/llama-index-tools-seltz - ../../llama-index-integrations/readers/llama-index-readers-layoutir - ../../llama-index-integrations/llms/llama-index-llms-modelslab - ../../llama-index-integrations/readers/llama-index-readers-screenpipe - ../../llama-index-integrations/readers/llama-index-readers-igpt-email - ../../llama-index-integrations/storage/chat_store/llama-index-storage-chat-store-opensearch - ../../llama-index-integrations/tools/llama-index-tools-igpt-email - ../../llama-index-integrations/postprocessor/llama-index-postprocessor-google-rerank - ../../llama-index-integrations/llms/llama-index-llms-minimax site_name: LlamaIndex site_url: https://developers.llamaindex.ai/python/framework-api-reference/ theme: custom_dir: overrides favicon: _static/assets/LlamaLogoBrowserTab.png features: - navigation.instant - navigation.prune - navigation.indexes - navigation.top - navigation.footer - toc.follow - content.code.copy - search.suggest - search.highlight logo: _static/assets/LlamaSquareBlack.svg name: material palette: - media: (prefers-color-scheme) toggle: icon: material/brightness-auto name: Switch to light mode - accent: purple media: "(prefers-color-scheme: light)" primary: white scheme: default toggle: icon: material/brightness-7 name: Switch to dark mode - accent: purple media: "(prefers-color-scheme: dark)" primary: black scheme: slate toggle: icon: material/brightness-4 name: Switch to system preference