---
title: "Guides"
description: "Every guide in Weaviate Docs (migrated from docs.weaviate.io) Docs."
---

# Guides

Every guide in Weaviate Docs (migrated from docs.weaviate.io) Docs.

- [AI-assisted Weaviate code generation](./guides/ai-assisted-vibe-coding-index.md)
- [APIs](./guides/apis-index.md)
- [Agents](./guides/agents-index.md)
- [Authorization and authentication](./guides/authorization-and-authentication-index.md)
- [Benchmarks](./guides/benchmarks-index.md)
- [Best practices](./guides/best-practices-index.md)
- [Client Libraries / SDKs](./guides/client-libraries-index.md)
- [Client libraries](./guides/clients-index.md)
- [Cloud](./guides/cloud-index.md)
- [Cloud account management](./guides/cloud-account-management-index.md)
- [Cloud weaviate embeddings](./guides/cloud-weaviate-embeddings-index.md)
- [Cloud: Agents](./guides/cloud-agents-index.md)
- [Concepts](./guides/concepts-index.md)
- [Concepts](./guides/engram-concepts-index.md)
- [Configuration](./guides/agents-configuration-index.md)
- [Configuration](./guides/reference-configuration-index.md)
- [Connect to Weaviate](./guides/connect-to-weaviate-index.md)
- [Contributor](./guides/contributor-index.md)
- [Database configuration](./guides/database-configuration-index.md)
- [Deploy](./guides/deploy-index.md)
- [Deploy config](./guides/deploy-config-index.md)
- [Deploy faqs](./guides/deploy-faqs-index.md)
- [Deploy migration](./guides/deploy-migration-index.md)
- [Deploy production](./guides/deploy-production-index.md)
- [Deploy: AWS](./guides/deploy-aws-index.md)
- [Deploying Weaviate](./guides/installation-index.md)
- [Deploying Weaviate on AWS](./guides/deploy-production-aws-index.md)
- [DigitalOcean](./guides/digitalocean-index.md)
- [Engram](./guides/engram-index.md)
- [Errors](./guides/errors-index.md)
- [GCP](./guides/gcp-index.md)
- [Get started](./guides/get-started-index.md)
- [Guides](./guides/engram-guides-index.md)
- [Guides](./guides/guides-index.md)
- [How to configure Weaviate](./guides/how-to-configure-weaviate-index.md)
- [Indexing](./guides/indexing-index.md)
- [Kubernetes](./guides/kubernetes-index.md)
- [Manage clusters](./guides/manage-clusters-index.md)
- [Manage collections](./guides/how-to-manage-collections-index.md)
- [Manage collections](./guides/manage-collections-index.md)
- [Manage objects](./guides/how-to-manage-objects-index.md)
- [Model provider integrations](./guides/model-provider-integrations-index.md)
- [Modes](./guides/modes-index.md)
- [Monitoring and logging](./guides/monitoring-and-logging-index.md)
- [Open-source at Weaviate](./guides/contributor-guide-index.md)
- [Other tools](./guides/other-tools-index.md)
- [Others](./guides/others-index.md)
- [Query agent](./guides/query-agent-index.md)
- [Query and search](./guides/how-to-query-search-index.md)
- [Quickstart: With Cloud resources](./guides/quickstart-index.md)
- [Reference - Modules](./guides/modules-index.md)
- [Release Notes](./guides/releases-index.md)
- [Replication Architecture](./guides/replication-architecture-index.md)
- [Replication and scaling](./guides/replication-and-scaling-index.md)
- [Search](./guides/search-index.md)
- [Starter guides](./guides/starter-guides-index.md)
- [Storage and backups](./guides/storage-and-backups-index.md)
- [Support](./guides/support-index.md)
- [Tutorials](./guides/engram-tutorials-index.md)
- [Tutorials](./guides/guides-tutorials-index.md)
- [Tutorials and guides](./guides/tutorials-and-guides-index.md)
- [Weaviate](./guides/weaviate-index.md)
- [Weaviate Database](./guides/weaviate-database-index.md)
- [Weaviate Documentation](./guides/weaviate-docs-index.md)
- [Weaviate Recipes (code examples)](./guides/recipes-index.md)
- [Weaviate module system](./guides/weaviate-modules-index.md)
- [ANN Benchmark](./guides/benchmarks-ann.md)
- [AWS: Hardening your EKS deployment](./guides/deploy-production-aws-hardening-eks.md)
- [Add Long-Term Memory to a Chat App](./guides/engram-tutorials-memory-chat-app.md)
- [Architecture](./guides/weaviate-modules-architecture.md)
- [Ask Mode](./guides/modes-ask-mode.md)
- [Authentication](./guides/authorization-and-authentication-deploy-configuration-authentication.md)
- [Authentication and authorization](./guides/how-to-configure-weaviate-authz-authn.md)
- [Backups](./guides/storage-and-backups-backups.md)
- [Basic collection operations](./guides/how-to-manage-collections-collection-operations.md)
- [Billing](./guides/cloud-account-management-billing.md)
- [BlockMax WAND migration guide](./guides/deploy-migration-weaviate-1-30.md)
- [Class instantiation](./guides/agents-configuration-instantiation.md)
- [Code structure and style](./guides/weaviate-database-structure.md)
- [Collection definition](./guides/reference-configuration-collections.md)
- [Collections tool](./guides/manage-collections-tools-collections-tool.md)
- [Concepts](./guides/weaviate-concepts.md)
- [Configuration overview](./guides/deploy-config-overview.md)
- [Connect to Weaviate Cloud](./guides/manage-clusters-connect.md)
- [Contextionary Vectorizer](./guides/modules-text2vec-contextionary.md)
- [Create objects](./guides/how-to-manage-objects-create.md)
- [Data structure](./guides/concepts-data.md)
- [Deployment FAQs](./guides/deploy-faqs.md)
- [Deployment Troubleshooting Guide](./guides/deploy-faqs-troubleshooting.md)
- [DigitalOcean Managed Weaviate](./guides/digitalocean-digitalocean.md)
- [Engram](./guides/engram-overview.md)
- [Environment variables reference](./guides/database-configuration-overview.md)
- [Explorer tool](./guides/other-tools-explorer-tool.md)
- [FAQ](./guides/others-faq.md)
- [Feature requests and enhancements](./guides/contributor-guide-getting-started-suggesting-enhancements.md)
- [GCP Marketplace - Weaviate Shared Cloud](./guides/gcp-gcp-marketplace.md)
- [Generate new content with NVIDIA models and RAG](./guides/recipes-recipes-rag-llama-3-1-nemotron-51b-instruct.md)
- [Get started with the Weaviate Query Agent](./guides/tutorials-and-guides-query-agent-get-started.md)
- [How-to manuals and Guides](./guides/guides-guides.md)
- [Improve your cluster](./guides/errors-improve-your-cluster.md)
- [Introduction](./guides/agents-overview.md)
- [Known issues](./guides/releases-known-issues.md)
- [Kubernetes: Getting to production](./guides/kubernetes-get-to-production.md)
- [Marketplace - Weaviate Shared Cloud](./guides/deploy-aws-aws-marketplace.md)
- [Memories](./guides/engram-concepts-memories.md)
- [Monitoring](./guides/monitoring-and-logging-monitoring.md)
- [Production Environments](./guides/deploy-production-overview.md)
- [Python](./guides/client-libraries-python.md)
- [Python client](./guides/clients-python.md)
- [Query Agent](./guides/cloud-agents-query-agent.md)
- [Quick tour of Weaviate](./guides/guides-tutorials-quick-tour-of-weaviate.md)
- [Quickstart: Locally hosted with Docker](./guides/quickstart-local.md)
- [Replication](./guides/replication-and-scaling-replication.md)
- [Research Mode](./guides/query-agent-research-mode.md)
- [Search (GraphQL | gRPC)](./guides/apis-graphql.md)
- [Search patterns and basics](./guides/how-to-query-search-basics.md)
- [Setup and editing](./guides/weaviate-docs-development.md)
- [Store memories](./guides/engram-guides-store-memories.md)
- [Use Cases (Motivation)](./guides/replication-architecture-motivation.md)
- [Vector Indexing](./guides/indexing-vector-index.md)
- [Vector Search](./guides/search-vector-search.md)
- [Weaviate Clients](./guides/contributor-overview.md)
- [Weaviate Cloud](./guides/cloud-overview.md)
- [Weaviate Cloud](./guides/connect-to-weaviate-connect-cloud.md)
- [Weaviate Cloud](./guides/installation-installation-guides-weaviate-cloud.md)
- [Weaviate Database](./guides/get-started-overview.md)
- [Weaviate Embeddings](./guides/cloud-weaviate-embeddings-overview.md)
- [Weaviate Embeddings](./guides/model-provider-integrations-weaviate.md)
- [Weaviate MCP server](./guides/ai-assisted-vibe-coding-configuration-mcp-server.md)
- [Weaviate Support](./guides/support-overview.md)
- [Weaviate configurations](./guides/starter-guides-which-weaviate.md)
- [1.25 (For Kubernetes users)](./guides/deploy-migration-weaviate-1-25.md)
- [AWS: Network security - Best practices](./guides/deploy-production-aws-network-security.md)
- [Async API](./guides/client-libraries-python-async.md)
- [Async Replication](./guides/replication-and-scaling-async-rep.md)
- [Authorization](./guides/authorization-and-authentication-deploy-configuration-authorization.md)
- [Batch import](./guides/how-to-manage-objects-import.md)
- [Build a Query Agent e-commerce assistant](./guides/tutorials-and-guides-query-agent-ecommerce-assistant.md)
- [CICD philosophy](./guides/weaviate-database-cicd.md)
- [Collection export](./guides/storage-and-backups-export.md)
- [Compression](./guides/how-to-configure-weaviate-compression.md)
- [Context Window Management](./guides/engram-tutorials-context-window-management.md)
- [Create a cluster](./guides/manage-clusters-create.md)
- [Customizing the system prompt](./guides/agents-configuration-system-prompt.md)
- [Data import](./guides/concepts-data-import.md)
- [Docker](./guides/installation-installation-guides-docker-installation.md)
- [Enable compression](./guides/manage-collections-manage-collections-enable-compression.md)
- [Error and warning messages](./guides/errors-errors.md)
- [Generative search (RAG) with AWS Bedrock](./guides/recipes-recipes-rag-titan-text-express-v1-bedrock.md)
- [Glossary](./guides/others-glossary.md)
- [How to install Weaviate](./guides/deploy-installation-guides.md)
- [Installation](./guides/agents-installation.md)
- [Inverted indexes](./guides/indexing-inverted-index.md)
- [JavaScript/TypeScript client](./guides/clients-typescript.md)
- [Keyword Search (BM25)](./guides/search-keyword-search.md)
- [Kubernetes: Production readiness self-assessment](./guides/kubernetes-production-readiness.md)
- [Local instances](./guides/connect-to-weaviate-connect-local.md)
- [Logging](./guides/monitoring-and-logging-logging.md)
- [Module creation in a nutshell](./guides/weaviate-modules-how-to-build-a-new-module.md)
- [Object-level queries (Get)](./guides/apis-graphql-get.md)
- [Philosophy](./guides/replication-architecture-philosophy.md)
- [Query Agent search](./guides/how-to-query-search-query-agent.md)
- [Quickstart](./guides/cloud-weaviate-embeddings-quickstart.md)
- [Quickstart](./guides/engram-quickstart.md)
- [Quickstart: Bring your own vectors](./guides/starter-guides-custom-vectors.md)
- [Ref2Vec Centroid Vectorizer](./guides/modules-ref2vec-centroid.md)
- [Reporting bugs](./guides/contributor-guide-getting-started-reporting-bugs.md)
- [ResNet Image Vectorizer](./guides/weaviate-modules-img2vec-neural.md)
- [Runtime configuration management](./guides/database-configuration-runtime-config.md)
- [Search Mode](./guides/modes-search-mode.md)
- [Search memories](./guides/engram-guides-search-memories.md)
- [Self-Managed EKS](./guides/deploy-aws-eks.md)
- [Server version](./guides/cloud-account-management-version.md)
- [Style guidelines](./guides/weaviate-docs-style-guide.md)
- [Switching vectorizers](./guides/guides-tutorials-vectorizer-migration.md)
- [Text Embeddings](./guides/model-provider-integrations-weaviate-embeddings.md)
- [Topics](./guides/engram-concepts-topics.md)
- [Vector index](./guides/reference-configuration-indexing-vector-index.md)
- [Vectorizer and vector index config](./guides/how-to-manage-collections-vector-config.md)
- [Weaviate Cloud Quickstart](./guides/cloud-quickstart.md)
- [Weaviate Docs MCP Server](./guides/ai-assisted-vibe-coding-mcp-docs-mcp-server.md)
- [Aggregate](./guides/apis-graphql-aggregate.md)
- [Archive](./guides/deploy-migration-archive.md)
- [Batch data import](./guides/guides-tutorials-import.md)
- [Build a streaming chat UI with Streamlit](./guides/tutorials-and-guides-query-agent-streamlit-chat.md)
- [Choose a model](./guides/cloud-weaviate-embeddings-models.md)
- [Cluster Architecture](./guides/replication-architecture-cluster-architecture.md)
- [Cluster resource messages](./guides/errors-errors-cluster-resources.md)
- [Cluster status and metadata](./guides/monitoring-and-logging-status.md)
- [Cluster status and metrics](./guides/manage-clusters-status.md)
- [Custom connections](./guides/connect-to-weaviate-connect-custom.md)
- [Example datasets](./guides/others-example-datasets.md)
- [Example use cases and demos](./guides/weaviate-more-resources-example-use-cases.md)
- [FAQs](./guides/cloud-faq.md)
- [Generative and reranker models](./guides/how-to-manage-collections-generative-reranker-models.md)
- [Getting Started](./guides/contributor-guide-getting-started.md)
- [How to Use Weaviate Embedding Service](./guides/recipes-recipes-weaviate-embeddings-service.md)
- [Hybrid search](./guides/search-hybrid-search.md)
- [Install & integrate](./guides/engram-install-integrate.md)
- [Inverted index](./guides/reference-configuration-indexing-inverted-index.md)
- [Kubernetes](./guides/installation-installation-guides-k8s-installation.md)
- [Manage memories](./guides/engram-guides-manage-memories.md)
- [Manage user accounts](./guides/cloud-account-management-create-account.md)
- [Modules](./guides/concepts-modules.md)
- [Multi-turn conversations](./guides/agents-configuration-multi-turn-conversations.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-weaviate-embeddings-multimodal.md)
- [Notes and best practices](./guides/client-libraries-python-notes-best-practices.md)
- [OIDC Configuration](./guides/authorization-and-authentication-deploy-configuration-oidc.md)
- [Optimizing docs for LLMs](./guides/weaviate-docs-llms.md)
- [Persistence](./guides/storage-and-backups-persistence.md)
- [Personalized RAG with Per-User Memory](./guides/engram-tutorials-personalized-rag-multi-tenant.md)
- [Question Answering - transformers](./guides/modules-qna-transformers.md)
- [Quickstart](./guides/agents-quickstart.md)
- [Read objects](./guides/how-to-manage-objects-read.md)
- [Replica movement](./guides/replication-and-scaling-replica-movement.md)
- [Retrieval augmented generation (RAG)](./guides/starter-guides-generative.md)
- [Rotational Quantization (RQ)](./guides/how-to-configure-weaviate-compression-rq-compression.md)
- [Scopes](./guides/engram-concepts-scopes.md)
- [Snowpark Container Services (SPCS)](./guides/deploy-installation-guides-spcs-integration.md)
- [Suggest Queries Mode](./guides/modes-suggest-queries.md)
- [Tests](./guides/weaviate-database-tests.md)
- [Vector similarity search](./guides/how-to-query-search-similarity.md)
- [Additional filters](./guides/agents-configuration-additional-filters.md)
- [Administration](./guides/cloud-weaviate-embeddings-administration.md)
- [Anthropic + Weaviate](./guides/model-provider-integrations-anthropic.md)
- [Authentication](./guides/manage-clusters-authentication.md)
- [Check run status](./guides/engram-guides-check-run-status.md)
- [Collection configuration messages](./guides/errors-errors-collection-configuration.md)
- [Collection definitions (schemas)](./guides/starter-guides-managing-collections.md)
- [Consistency](./guides/replication-architecture-consistency.md)
- [Development setup](./guides/weaviate-database-setup.md)
- [Embedded Weaviate](./guides/connect-to-weaviate-connect-embedded.md)
- [Embedded Weaviate](./guides/installation-installation-guides-embedded.md)
- [Engram Web Console](./guides/engram-console.md)
- [Horizontal Scaling Deployment Strategies](./guides/replication-and-scaling-horizontal-scaling.md)
- [Hybrid Search with Mistral](./guides/recipes-recipes-hybrid-search-mistral-embed.md)
- [Input data types](./guides/engram-concepts-input-data-types.md)
- [Inverted index](./guides/how-to-manage-collections-inverted-index.md)
- [JavaScript and TypeScript](./guides/client-libraries-typescript.md)
- [Keyword search](./guides/how-to-query-search-bm25.md)
- [Limitations & troubleshooting](./guides/agents-reference-troubleshooting.md)
- [Migration and Upgrades](./guides/deploy-migration.md)
- [More resources](./guides/weaviate-more-resources.md)
- [Multi-factor authentication](./guides/cloud-account-management-multi-factor-auth.md)
- [Multi-vector embeddings (ColBERT, ColPali, etc.)](./guides/guides-tutorials-multi-vector-embeddings.md)
- [Product Quantization (PQ)](./guides/how-to-configure-weaviate-compression-pq-compression.md)
- [Property data types](./guides/reference-configuration-datatypes.md)
- [Query Agent vs. doing it yourself](./guides/tutorials-and-guides-query-agent-vs-diy.md)
- [Question Answering - OpenAI](./guides/modules-qna-openai.md)
- [RBAC Overview](./guides/authorization-and-authentication-weaviate-configuration-rbac.md)
- [Read all objects](./guides/how-to-manage-objects-read-all-objects.md)
- [Search operators](./guides/apis-graphql-search-operators.md)
- [Storage](./guides/concepts-storage.md)
- [Telemetry](./guides/monitoring-and-logging-telemetry.md)
- [Tenant Offloading](./guides/storage-and-backups-tenant-offloading.md)
- [Authorization](./guides/manage-clusters-authorization.md)
- [Binary Quantization (BQ)](./guides/how-to-configure-weaviate-compression-bq-compression.md)
- [Collection configuration](./guides/agents-configuration-advanced-collections.md)
- [Compression (Vector Quantization)](./guides/concepts-vector-quantization.md)
- [Conditional filters](./guides/apis-graphql-filters.md)
- [Connect with Query Agent](./guides/connect-to-weaviate-connect-query.md)
- [Distance metrics](./guides/reference-configuration-distances.md)
- [Enable and configure RBAC](./guides/authorization-and-authentication-deploy-configuration-configuring-rbac.md)
- [Generative AI](./guides/model-provider-integrations-anthropic-generative.md)
- [Hybrid search](./guides/how-to-query-search-hybrid.md)
- [Index types and performance](./guides/weaviate-more-resources-performance.md)
- [Model integration messages](./guides/errors-errors-model-integrations.md)
- [Multi-Data center](./guides/replication-architecture-multi-dc.md)
- [Multi-tenancy operations](./guides/how-to-manage-collections-multi-tenancy.md)
- [Multi-vector RAG: Using Weaviate to search a collection of PDF documents](./guides/recipes-recipes-multi-vector-colipali-rag.md)
- [Named Entity Recognition](./guides/modules-ner-transformers.md)
- [Notes and best practices](./guides/client-libraries-typescript-notes-best-practices.md)
- [Parsing objects & resolving references](./guides/weaviate-database-parsing-cross-refs.md)
- [Pipelines and runs](./guides/engram-concepts-pipelines.md)
- [Scaling limits with collections](./guides/starter-guides-managing-collections-collections-scaling-limits.md)
- [Select & configure vector indexes](./guides/guides-tutorials-vector-indexing-deep-dive.md)
- [Update objects](./guides/how-to-manage-objects-update.md)
- [Users and organizations](./guides/cloud-account-management-users-and-organizations.md)
- [Using the Query Agent as a tool](./guides/tutorials-and-guides-query-agent-as-a-tool.md)
- [Additional operators](./guides/apis-graphql-additional-operators.md)
- [Anyscale + Weaviate](./guides/model-provider-integrations-anyscale.md)
- [Configure tokenization for keyword search](./guides/guides-tutorials-tokenization.md)
- [Default cluster settings](./guides/manage-clusters-default-settings.md)
- [Delete objects](./guides/how-to-manage-objects-delete.md)
- [Filtering](./guides/concepts-filtering.md)
- [How to write great bug reports](./guides/weaviate-more-resources-write-great-bug-reports.md)
- [Image search](./guides/how-to-query-search-image.md)
- [Java](./guides/client-libraries-java.md)
- [Manage roles](./guides/authorization-and-authentication-weaviate-configuration-rbac-manage-roles.md)
- [Manage tenant states & temperature](./guides/how-to-manage-collections-tenant-states.md)
- [Managing resources (Hot, Warm, Cold)](./guides/starter-guides-managing-resources.md)
- [Runtime configurations](./guides/weaviate-database-support-new-runtime-configs.md)
- [Scalar Quantization (SQ)](./guides/how-to-configure-weaviate-compression-sq-compression.md)
- [Search](./guides/engram-concepts-search.md)
- [Similarity Search with Cohere](./guides/recipes-recipes-similarity-search-embed-multilingual-v2-0.md)
- [Spell Check](./guides/modules-spellcheck.md)
- [Structured outputs](./guides/agents-configuration-structured-outputs.md)
- [Additional properties (metadata)](./guides/apis-graphql-additional-properties.md)
- [C#](./guides/client-libraries-csharp.md)
- [Collection aliases](./guides/how-to-manage-collections-collection-aliases.md)
- [Compression](./guides/starter-guides-managing-resources-compression.md)
- [Generative AI](./guides/model-provider-integrations-anyscale-generative.md)
- [Groups](./guides/engram-concepts-groups.md)
- [Manage users](./guides/authorization-and-authentication-weaviate-configuration-rbac-manage-users.md)
- [Modules - an introduction](./guides/weaviate-tutorials-modules.md)
- [Multimedia search](./guides/how-to-query-search-near-media.md)
- [Reranking](./guides/concepts-reranking.md)
- [Setting up RBAC in Weaviate](./guides/guides-tutorials-rbac.md)
- [Summarization](./guides/modules-sum-transformers.md)
- [Uncompressed vector embeddings](./guides/how-to-configure-weaviate-compression-uncompressed.md)
- [AWS + Weaviate](./guides/model-provider-integrations-aws.md)
- [Custom modules](./guides/modules-custom-modules.md)
- [Explore](./guides/apis-graphql-explore.md)
- [Go](./guides/client-libraries-go.md)
- [Horizontal Scaling](./guides/concepts-cluster.md)
- [Imports - Vector provision options](./guides/weaviate-tutorials-vector-provision-options.md)
- [Indexing](./guides/starter-guides-managing-resources-indexing.md)
- [Manage groups](./guides/authorization-and-authentication-weaviate-configuration-rbac-manage-groups.md)
- [Multi-vector encodings](./guides/how-to-configure-weaviate-compression-multi-vectors.md)
- [Multiple target vectors](./guides/how-to-query-search-multi-vector.md)
- [Securing Weaviate with SSL/TLS](./guides/guides-tutorials-tls-ssl.md)
- [Time to live (TTL)](./guides/how-to-manage-collections-time-to-live.md)
- [Community clients](./guides/client-libraries-community.md)
- [Interface](./guides/concepts-interface.md)
- [Modules](./guides/how-to-configure-weaviate-modules.md)
- [Multi-node setup](./guides/how-to-manage-collections-multi-node-setup.md)
- [Retrieval Augmented Generation (RAG)](./guides/how-to-query-search-generative.md)
- [Tenant states](./guides/starter-guides-managing-resources-tenant-states.md)
- [Text Embeddings](./guides/model-provider-integrations-aws-embeddings.md)
- [Usage Module](./guides/modules-usage-modules.md)
- [Wikipedia with custom vectors](./guides/weaviate-tutorials-wikipedia.md)
- [Zero-downtime collection migration with aliases](./guides/guides-tutorials-collection-aliases.md)
- [gRPC](./guides/apis-grpc.md)
- [Generative AI](./guides/model-provider-integrations-aws-generative.md)
- [Manage relationships with cross-references](./guides/guides-tutorials-cross-references.md)
- [Migrate data](./guides/how-to-manage-collections-migrate.md)
- [Reranking](./guides/how-to-query-search-rerank.md)
- [Resource Planning](./guides/concepts-resources.md)
- [Boost](./guides/how-to-query-search-boost.md)
- [Cohere + Weaviate](./guides/model-provider-integrations-cohere.md)
- [Cross-references](./guides/how-to-manage-collections-cross-references.md)
- [Load data into Weaviate with Spark](./guides/guides-tutorials-spark-connector.md)
- [Aggregate data](./guides/how-to-query-search-aggregate.md)
- [Text Embeddings](./guides/model-provider-integrations-cohere-embeddings.md)
- [Filters](./guides/how-to-query-search-filters.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-cohere-embeddings-multimodal.md)
- [Generative AI](./guides/model-provider-integrations-cohere-generative.md)
- [Query profiling](./guides/how-to-query-search-query-profile.md)
- [Reranker](./guides/model-provider-integrations-cohere-reranker.md)
- [Contextual AI + Weaviate](./guides/model-provider-integrations-contextualai.md)
- [Generative AI](./guides/model-provider-integrations-contextualai-generative.md)
- [Reranker](./guides/model-provider-integrations-contextualai-reranker.md)
- [Databricks + Weaviate](./guides/model-provider-integrations-databricks.md)
- [Text Embeddings](./guides/model-provider-integrations-databricks-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-databricks-generative.md)
- [DeepSeek + Weaviate](./guides/model-provider-integrations-deepseek.md)
- [Generative AI](./guides/model-provider-integrations-deepseek-generative.md)
- [DigitalOcean + Weaviate](./guides/model-provider-integrations-digitalocean.md)
- [Text Embeddings](./guides/model-provider-integrations-digitalocean-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-digitalocean-generative.md)
- [FriendliAI + Weaviate](./guides/model-provider-integrations-friendliai.md)
- [Generative AI](./guides/model-provider-integrations-friendliai-generative.md)
- [Google + Weaviate](./guides/model-provider-integrations-google.md)
- [Text Embeddings](./guides/model-provider-integrations-google-embeddings.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-google-embeddings-multimodal.md)
- [Generative AI](./guides/model-provider-integrations-google-generative.md)
- [Hugging Face + Weaviate](./guides/model-provider-integrations-huggingface.md)
- [Text Embeddings](./guides/model-provider-integrations-huggingface-embeddings.md)
- [Jina AI + Weaviate](./guides/model-provider-integrations-jinaai.md)
- [Text Embeddings](./guides/model-provider-integrations-jinaai-embeddings.md)
- [ColBERT Embeddings](./guides/model-provider-integrations-jinaai-embeddings-colbert.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-jinaai-embeddings-multimodal.md)
- [Reranker](./guides/model-provider-integrations-jinaai-reranker.md)
- [Mistral + Weaviate](./guides/model-provider-integrations-mistral.md)
- [Text Embeddings](./guides/model-provider-integrations-mistral-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-mistral-generative.md)
- [Morph + Weaviate](./guides/model-provider-integrations-morph.md)
- [Text Embeddings](./guides/model-provider-integrations-morph-embeddings.md)
- [NVIDIA + Weaviate](./guides/model-provider-integrations-nvidia.md)
- [Text Embeddings](./guides/model-provider-integrations-nvidia-embeddings.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-nvidia-embeddings-multimodal.md)
- [Generative AI](./guides/model-provider-integrations-nvidia-generative.md)
- [Reranker](./guides/model-provider-integrations-nvidia-reranker.md)
- [OctoAI + Weaviate (Deprecated)](./guides/model-provider-integrations-octoai.md)
- [Text Embeddings (Deprecated)](./guides/model-provider-integrations-octoai-embeddings.md)
- [Generative AI (Deprecated)](./guides/model-provider-integrations-octoai-generative.md)
- [OpenAI + Weaviate](./guides/model-provider-integrations-openai.md)
- [Text Embeddings](./guides/model-provider-integrations-openai-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-openai-generative.md)
- [Azure OpenAI + Weaviate](./guides/model-provider-integrations-openai-azure.md)
- [Text Embeddings](./guides/model-provider-integrations-openai-azure-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-openai-azure-generative.md)
- [TwelveLabs + Weaviate](./guides/model-provider-integrations-twelvelabs.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-twelvelabs-embeddings-multimodal.md)
- [Voyage AI + Weaviate](./guides/model-provider-integrations-voyageai.md)
- [Text Embeddings](./guides/model-provider-integrations-voyageai-embeddings.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-voyageai-embeddings-multimodal.md)
- [Reranker](./guides/model-provider-integrations-voyageai-reranker.md)
- [xAI + Weaviate](./guides/model-provider-integrations-xai.md)
- [Generative AI](./guides/model-provider-integrations-xai-generative.md)
- [GPT4All + Weaviate](./guides/model-provider-integrations-gpt4all.md)
- [Text Embeddings](./guides/model-provider-integrations-gpt4all-embeddings.md)
- [Locally Hosted Transformers + Weaviate](./guides/model-provider-integrations-transformers.md)
- [Text Embeddings](./guides/model-provider-integrations-transformers-embeddings.md)
- [Text Embeddings (custom)](./guides/model-provider-integrations-transformers-embeddings-custom-image.md)
- [Multimodal (CLIP) Embeddings](./guides/model-provider-integrations-transformers-embeddings-multimodal.md)
- [Multimodal Embeddings (custom)](./guides/model-provider-integrations-transformers-embeddings-multimodal-custom-image.md)
- [Reranker](./guides/model-provider-integrations-transformers-reranker.md)
- [KubeAI + Weaviate](./guides/model-provider-integrations-kubeai.md)
- [Text Embeddings](./guides/model-provider-integrations-kubeai-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-kubeai-generative.md)
- [Locally Hosted ImageBind + Weaviate](./guides/model-provider-integrations-imagebind.md)
- [Multimodal Embeddings](./guides/model-provider-integrations-imagebind-embeddings-multimodal.md)
- [Model2Vec + Weaviate](./guides/model-provider-integrations-model2vec.md)
- [Text Embeddings](./guides/model-provider-integrations-model2vec-embeddings.md)
- [Ollama + Weaviate](./guides/model-provider-integrations-ollama.md)
- [Text Embeddings](./guides/model-provider-integrations-ollama-embeddings.md)
- [Generative AI](./guides/model-provider-integrations-ollama-generative.md)

# Agent Instructions

This portal answers questions programmatically. To receive a synthesized,
source-cited answer instead of crawling page by page, append the `?ask=`
query parameter to any page URL on this site:

    /guides/quickstart?ask=how+do+I+authenticate

Optional parameters:

- `&goal=<what-you-are-trying-to-do>` steers the answer toward your
  objective (e.g. `&goal=write+a+python+client`).
- `&version=<label>` scopes the answer to a mounted version when the
  portal publishes more than one.

The response is `text/markdown`: the answer followed by a `# Sources` list
of the portal pages it was grounded in. Status codes are the contract:

- `200` — the answer; `402` — the portal owner’s plan or answer credits are
  exhausted (surface this to your operator; do NOT retry); `429` — you are
  rate-limited; back off for the `Retry-After` seconds; `503` — the answer
  lane is temporarily unavailable; fall back to crawling the `.md` pages.

For the full corpus map read `llms.txt` at the site root; for the tool
surface (search + page fetch as MCP tools) see `/mcp`.
