# Text Embeddings :::callout{intent="warning" title="Deprecated integration"} This integration is deprecated and will be removed in a future release. We recommend using alternative model providers for new projects. For local AI model integrations, consider using [Ollama](ollama.md) or the [local HuggingFace](huggingface.md) model integrations. ::: Weaviate's integration with GPT4All's models allows you to access their models' capabilities directly from Weaviate. [Configure a Weaviate vector index](#configure-the-vectorizer) to use an GPT4All embedding model, and Weaviate will generate embeddings for various operations using the specified model via the GPT4All inference container. This feature is called the _vectorizer_. At [import time](#data-import), Weaviate generates text object embeddings and saves them into the index. For [vector](#vector-near-text-search) and [hybrid](#hybrid-search) search operations, Weaviate converts text queries into embeddings. ![Embedding integration illustration](/assets/docs/weaviate/model-providers/_includes/integration_gpt4all_embedding.png) This module is optimized for CPU using the [`ggml` library](https://github.com/ggerganov/ggml), allowing for fast inference even without a GPU. ## Requirements Currently, the GPT4All integration is only available for `amd64/x86_64` architecture devices, as the `gpt4all` library currently does not support ARM devices, such as Apple M-series. ### Weaviate configuration Your Weaviate instance must be configured with the GPT4All vectorizer integration (`text2vec-gpt4all`) module. :::accordion{title="For Weaviate Cloud (WCD) users"} This integration is not available for Weaviate Cloud (WCD) instances, as it requires a locally running GPT4All instance. ::: :::accordion{title="For self-hosted users"} - Check the [cluster metadata](../monitoring-and-logging/status.md#cluster-metadata) to verify if the module is enabled. - Follow the [how-to configure modules](../how-to-configure-weaviate/modules.md) guide to enable the module in Weaviate. ::: #### Configure the integration To use this integration, you must configure the container image of the GPT4All model, and the inference endpoint of the containerized model. The following example shows how to configure the GPT4All integration in Weaviate: ::::tabs{sync="deployments"} :::tab{title="Docker"} #### Docker Option 1: Use a pre-configured `docker-compose.yml` file Follow the instructions on the [Weaviate Docker installation configurator](../installation/installation-guides-docker-installation.md#configurator) to download a pre-configured `docker-compose.yml` file with a selected model #### Docker Option 2: Add the configuration manually Alternatively, add the configuration to the `docker-compose.yml` file manually as in the example below. ```yaml services: weaviate: # Other Weaviate configuration environment: GPT4ALL_INFERENCE_API: http://text2vec-gpt4all:8080 # Set the inference API endpoint text2vec-gpt4all: # Set the name of the inference container image: cr.weaviate.io/semitechnologies/gpt4all-inference:all-MiniLM-L6-v2 ``` - `GPT4ALL_INFERENCE_API` environment variable sets the inference API endpoint - `text2vec-gpt4all` is the name of the inference container - `image` is the container image ::: :::tab{title="Kubernetes"} Configure the GPT4All integration in Weaviate by adding or updating the `text2vec-gpt4all` module in the `modules` section of the Weaviate Helm chart values file. For example, modify the `values.yaml` file as follows: ```yaml modules: text2vec-gpt4all: enabled: true tag: all-MiniLM-L6-v2 repo: semitechnologies/gpt4all-inference registry: cr.weaviate.io ``` See the [Weaviate Helm chart](https://github.com/weaviate/weaviate-helm/blob/master/weaviate/values.yaml) for an example of the `values.yaml` file including more configuration options. ::: :::: ### Credentials As this integration connects to a local GPT4All container, no additional credentials (e.g. API key) are required. Connect to Weaviate as usual, such as in the examples below. :::code-group{sync="languages"} ```python title="Python" ``` ```typescript title="JavaScript/TypeScript" ``` ::: ## Configure the vectorizer [Configure a Weaviate index](../how-to-manage-collections/vector-config.md#specify-a-vectorizer) as follows to use a GPT4All embedding model: :::code-group{sync="languages"} ```python title="Python" {5-10} from weaviate.classes.config import Configure client.collections.create( "DemoCollection", vector_config=[ Configure.Vectors.text2vec_gpt4all( name="title_vector", source_properties=["title"], ) ], # Additional parameters not shown ) ``` ```typescript title="JavaScript/TypeScript" {3-8} await client.collections.create({ name: 'DemoCollection', vectorizers: [ weaviate.configure.vectors.text2VecGPT4All({ name: 'title_vector', sourceProperties: ['title'], }), ], ``` ::: Currently, the only available model is [`all-MiniLM-L6-v2`](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2). :::accordion{title="Vectorization behavior"} Weaviate follows the collection configuration and a set of predetermined rules to vectorize objects. Unless specified otherwise in the collection definition, the default behavior is to: - Only vectorize properties that use the `text` or `text[]` data type (unless [skipped](../how-to-manage-collections/vector-config.md#property-level-settings)) - Sort properties in alphabetical (a-z) order before concatenating values - If `vectorizePropertyName` is `true` (`false` by default) prepend the property name to each property value - Join the (prepended) property values with spaces - Prepend the class name (unless `vectorizeClassName` is `false`) - Convert the produced string to lowercase ::: ## Data import After configuring the vectorizer, [import data](../how-to-manage-objects/import.md) into Weaviate. Weaviate generates embeddings for text objects using the specified model. :::code-group{sync="languages"} ```python title="Python" {13-20} source_objects = [ {"title": "The Shawshank Redemption", "description": "A wrongfully imprisoned man forms an inspiring friendship while finding hope and redemption in the darkest of places."}, {"title": "The Godfather", "description": "A powerful mafia family struggles to balance loyalty, power, and betrayal in this iconic crime saga."}, {"title": "The Dark Knight", "description": "Batman faces his greatest challenge as he battles the chaos unleashed by the Joker in Gotham City."}, {"title": "Jingle All the Way", "description": "A desperate father goes to hilarious lengths to secure the season's hottest toy for his son on Christmas Eve."}, {"title": "A Christmas Carol", "description": "A miserly old man is transformed after being visited by three ghosts on Christmas Eve in this timeless tale of redemption."} ] collection = client.collections.use("DemoCollection") with collection.batch.fixed_size(batch_size=200) as batch: for src_obj in source_objects: # The model provider integration will automatically vectorize the object batch.add_object( properties={ "title": src_obj["title"], "description": src_obj["description"], }, # vector=vector # Optionally provide a pre-obtained vector ) if batch.number_errors > 10: print("Batch import stopped due to excessive errors.") break failed_objects = collection.batch.failed_objects if failed_objects: print(f"Number of failed imports: {len(failed_objects)}") print(f"First failed object: {failed_objects[0]}") ``` ```typescript title="JavaScript/TypeScript" let srcObjects = [ { title: "The Shawshank Redemption", description: "A wrongfully imprisoned man forms an inspiring friendship while finding hope and redemption in the darkest of places." }, { title: "The Godfather", description: "A powerful mafia family struggles to balance loyalty, power, and betrayal in this iconic crime saga." }, { title: "The Dark Knight", description: "Batman faces his greatest challenge as he battles the chaos unleashed by the Joker in Gotham City." }, { title: "Jingle All the Way", description: "A desperate father goes to hilarious lengths to secure the season's hottest toy for his son on Christmas Eve." }, { title: "A Christmas Carol", description: "A miserly old man is transformed after being visited by three ghosts on Christmas Eve in this timeless tale of redemption." } ]; ``` ::: :::callout{intent="tip" title="Re-use existing vectors"} If you already have a compatible model vector available, you can provide it directly to Weaviate. This can be useful if you have already generated embeddings using the same model and want to use them in Weaviate, such as when migrating data from another system. ::: ## Searches Once the vectorizer is configured, Weaviate will perform vector and hybrid search operations using the specified GPT4All model. ![Embedding integration at search illustration](/assets/docs/weaviate/model-providers/_includes/integration_gpt4all_embedding_search.png) ### Vector (near text) search When you perform a [vector search](../how-to-query-search/similarity.md#search-with-text), Weaviate converts the text query into an embedding using the specified model and returns the most similar objects from the database. The query below returns the `n` most similar objects from the database, set by `limit`. :::code-group{sync="languages"} ```python title="Python" {3-6} collection = client.collections.use("DemoCollection") response = collection.query.near_text( query="A holiday film", # The model provider integration will automatically vectorize the query limit=2 ) for obj in response.objects: print(obj.properties["title"]) ``` ```typescript title="JavaScript/TypeScript" const collectionName = 'DemoCollection' const myCollection = client.collections.use(collectionName) ``` ::: ### Hybrid search :::callout{intent="info" title="What is a hybrid search?"} A hybrid search performs a vector search and a keyword (BM25) search, before [combining the results](../how-to-query-search/hybrid.md) to return the best matching objects from the database. ::: When you perform a [hybrid search](../how-to-query-search/hybrid.md), Weaviate converts the text query into an embedding using the specified model and returns the best scoring objects from the database. The query below returns the `n` best scoring objects from the database, set by `limit`. :::code-group{sync="languages"} ```python title="Python" {3-6} collection = client.collections.use("DemoCollection") response = collection.query.hybrid( query="A holiday film", # The model provider integration will automatically vectorize the query limit=2 ) for obj in response.objects: print(obj.properties["title"]) ``` ```typescript title="JavaScript/TypeScript" const collectionName = 'DemoCollection' const myCollection = client.collections.use(collectionName) ``` ::: ## References ### Available models Currently, the only available model is [`all-MiniLM-L6-v2`](https://huggingface.co/sentence-transformers/all-MiniLM-L6-v2). ## Further resources ### Code examples Once the integrations are configured at the collection, the data management and search operations in Weaviate work identically to any other collection. See the following model-agnostic examples: - The [How-to: Manage collections](../how-to-manage-collections/index.md) and [How-to: Manage objects](../how-to-manage-objects/index.md) guides show how to perform data operations (i.e. create, read, update, delete collections and objects within them). - The [How-to: Query & Search](../how-to-query-search/index.md) guides show how to perform search operations (i.e. vector, keyword, hybrid) as well as retrieval augmented generation. ### External resources - [GPT4All documentation](https://docs.gpt4all.io/) ## Questions and feedback Have a question or feedback? Here's how to reach us. ::::card-grid :::card{title="Community Forum" href="https://forum.weaviate.io/c/support" icon="messages-square"} Ask questions and connect with other developers on our **Community forum**. ::: :::card{title="Support" href="/guides/support-overview" icon="life-buoy"} Weaviate Cloud user or customer? Find the right channel on the **Support page**. ::: :::: ## Related pages - [Agents](./agents-index.md) - [AI-assisted Weaviate code generation](./ai-assisted-vibe-coding-index.md) - [APIs](./apis-index.md) - [Authorization and authentication](./authorization-and-authentication-index.md) - [Benchmarks](./benchmarks-index.md) - [Best practices](./best-practices-index.md) - [Client libraries](./clients-index.md) - [Client Libraries / SDKs](./client-libraries-index.md) - [Cloud](./cloud-index.md) - [Cloud account management](./cloud-account-management-index.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=` steers the answer toward your objective (e.g. `&goal=write+a+python+client`). - `&version=