Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion _includes/wcs/restart-warning.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion _includes/weaviate-embeddings-multimodal-models.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
- Generates multi-vector embeddings (ColBERT-style late-interaction) from document images and text queries.
- Ideal for getting documents directly into Weaviate without heavy preprocessing - no OCR or text extraction required.
- State-of-the-art performance in its size class, matching models up to 10x larger.
- Query token limit: 8,092 tokens
- Query token limit: 8,192 tokens
- Read more at the [Hugging Face model card](https://huggingface.co/ModernVBERT/colmodernvbert)
- For integration details, see [Weaviate Embeddings: Multimodal](/weaviate/model-providers/weaviate/embeddings-multimodal)

Expand Down
5 changes: 0 additions & 5 deletions docs/cloud/manage-clusters/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,6 @@ description: "Configure authentication options for Weaviate Cloud clusters by ad
image: og/wcd/user_guides.jpg
---

import WCDAPIKeys from "/docs/cloud/img/wcs-api-keys.jpg";
import WCDAddAPIKeys from "/docs/cloud/img/wcs-add-key-details.jpg";
import WCDDelAPIKeys from "/docs/cloud/img/wcs-delete-api-key.jpg";
import RestartTheCluster from "/_includes/wcs/restart-warning.mdx";

[Weaviate Cloud (WCD)](/go/console?utm_content=cloud) uses [RBAC (Role-Based Access Control)](/weaviate/configuration/rbac/index.mdx) to manage authentication. Below, you can find guides on how to create, edit, rotate and delete API keys for accessing Weaviate Cloud.

### Create an API key
Expand Down
7 changes: 0 additions & 7 deletions docs/weaviate/client-libraries/_includes/feedback.mdx

This file was deleted.

30 changes: 5 additions & 25 deletions docs/weaviate/model-providers/aws/generative.md
Original file line number Diff line number Diff line change
Expand Up @@ -147,7 +147,7 @@ For SageMaker, you must provide the endpoint address in the generative AI config

</Tabs>

You can [specify](#generative-parameters) one of the [available models](#available-models) for Weaviate to use. The [default model](#available-models) is used if no model is specified.
You can [specify](#generative-parameters) which [model](#available-models) Weaviate uses.

### Generative parameters

Expand Down Expand Up @@ -272,31 +272,11 @@ You can also supply images as a part of the input when performing retrieval augm

#### Bedrock

- `ai21.j2-ultra-v1`
- `ai21.j2-mid-v1`
- `amazon.titan-text-lite-v1`
- `amazon.titan-text-express-v1`
- `amazon.titan-text-premier-v1:0`
- `anthropic.claude-v2`
- `anthropic.claude-v2:1`
- `anthropic.claude-instant-v1`
- `anthropic.claude-3-sonnet-20240229-v1:0`
- `anthropic.claude-3-haiku-20240307-v1:0`
- `cohere.command-text-v14`
- `cohere.command-light-text-v14`
- `cohere.command-r-v1:0`
- `cohere.command-r-plus-v1:0`
- `meta.llama3-8b-instruct-v1:0`
- `meta.llama3-70b-instruct-v1:0`
- `meta.llama2-13b-chat-v1`
- `meta.llama2-70b-chat-v1`
- `mistral.mistral-7b-instruct-v0:2`
- `mistral.mixtral-8x7b-instruct-v0:1`
- `mistral.mistral-large-2402-v1:0`

Refer to the [this document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-usage.html) to find out how request access to a model.
Weaviate passes the `model` value through to Amazon Bedrock, so any Bedrock text generation model that your AWS account and region has access to can be used. Weaviate recognizes the model families offered by AI21 Labs, Amazon (Titan and Nova), Anthropic, Cohere, Meta, and Mistral AI, including their cross-region inference profile IDs.
Comment thread
g-despot marked this conversation as resolved.

### SageMaker
For the current model IDs, see the [Amazon Bedrock supported foundation models](https://docs.aws.amazon.com/bedrock/latest/userguide/models-supported.html) documentation. Refer to [this document](https://docs.aws.amazon.com/bedrock/latest/userguide/model-usage.html) to find out how to request access to a model.

#### SageMaker

Any custom SageMaker URL can be used as an endpoint.

Expand Down
6 changes: 2 additions & 4 deletions docs/weaviate/model-providers/google/embeddings-multimodal.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,9 +144,7 @@ import ApiKeyNote from '../_includes/google-api-key-note.md';

</Tabs>

You can [specify](#vectorizer-parameters) one of the [available models](#available-models) for the vectorizer to use.

<!-- The default model (`textembedding-gecko@001` for Vertex AI, `embedding-001` for Gemini API) is used if no model is specified. -->
You can [specify](#vectorizer-parameters) one of the [available models](#available-models) for the vectorizer to use. The [default model](#available-models) is used if no model is specified.

import VectorizationBehavior from '/_includes/vectorization.behavior.mdx';

Expand Down Expand Up @@ -327,7 +325,7 @@ The query below returns the `n` most similar objects to the input image from the
### Available models

- `gemini-embedding-2` (Vertex AI and Gemini API, added in 1.36.13). Supports text, images, PDFs, and audio (Gemini API only, up to 180 seconds); `3072` dimensions
- `multimodalembedding@001` (Vertex AI only). Supports text, images, and video; dimensions: `128`, `256`, `512`, `1408`
- `multimodalembedding@001` (default, Vertex AI only). Supports text, images, and video; dimensions: `128`, `256`, `512`, `1408`

## Further resources

Expand Down
6 changes: 5 additions & 1 deletion docs/weaviate/model-providers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,11 @@ This enables an enhanced developed experience, such as the ability to:

#### Enable all API-based modules

All API-based model integrations are available by default starting with Weaviate `v1.33`. For older versions, you can enable them all by setting the [`ENABLE_API_BASED_MODULES` environment variable](/deploy/configuration/env-vars#ENABLE_API_BASED_MODULES) to `true`.
All API-based model integrations are available by default starting with Weaviate `v1.33`.

To opt out, for example in an air-gapped or otherwise restricted deployment, set the [`API_BASED_MODULES_DISABLED` environment variable](/deploy/configuration/env-vars#API_BASED_MODULES_DISABLED) to `true`. Weaviate then loads only the modules that you list in [`ENABLE_MODULES`](/deploy/configuration/env-vars#ENABLE_MODULES). This variable was added in `v1.33`.

For releases before `v1.33`, enable all API-based modules by setting the [`ENABLE_API_BASED_MODULES` environment variable](/deploy/configuration/env-vars#ENABLE_API_BASED_MODULES) to `true`. Weaviate stopped reading that variable in `v1.33`.

### Locally hosted

Expand Down
2 changes: 1 addition & 1 deletion docs/weaviate/model-providers/jinaai/embeddings-colbert.md
Original file line number Diff line number Diff line change
Expand Up @@ -328,7 +328,7 @@ The query below returns the `n` best scoring objects from the database, set by `

### Available models

- `jina-colbert-v2`
- `jina-colbert-v2` (server default)
- By default, Weaviate uses `128` dimensions
- `jina-colbert-v1`

Expand Down
14 changes: 6 additions & 8 deletions docs/weaviate/model-providers/jinaai/embeddings-multimodal.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ You can specify one of the [available models](#available-models) for the vectori

</Tabs>

You can [specify](#vectorizer-parameters) one of the [available models](#available-models) for Weaviate to use. The [default model](#available-models) is used if no model is specified.
The [default model](#available-models) is used if you do not specify one.

import VectorizationBehavior from '/_includes/vectorization.behavior.mdx';

Expand All @@ -140,6 +140,10 @@ import VectorizationBehavior from '/_includes/vectorization.behavior.mdx';

The following examples show how to configure Jina AI-specific options.

- `model`: The model name.
- `dimensions`: The number of dimensions for the model.
- Note that [not all models](#available-models) support this parameter.

<Tabs className="code" groupId="languages">
<TabItem value="py" label="Python">
<FilteredTextBlock
Expand All @@ -161,12 +165,6 @@ The following examples show how to configure Jina AI-specific options.

</Tabs>

### Vectorizer parameters

- `model`: The model name.
- `dimensions`: The number of dimensions for the model.
- Note that [not all models](#available-models) support this parameter.

## Data import

After configuring the vectorizer, [import data](../../manage-objects/import.mdx) into Weaviate. Weaviate generates embeddings for text objects using the specified model.
Expand Down Expand Up @@ -297,7 +295,7 @@ The query below returns the `n` most similar objects to the input image from the

### Available models

- `jina-clip-v2`
- `jina-clip-v2` (server default)
- This model is a multilingual, multimodal model using [Matryoshka Representation Learning](https://arxiv.org/abs/2205.13147).
- It will accept a `dimensions` parameter, which can be any integer between (and including) 64 and 1024. The default value is 1024.
- `jina-clip-v1`
Expand Down
12 changes: 11 additions & 1 deletion docs/weaviate/model-providers/jinaai/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ Jina AI's embedding models transform text data into vector embeddings, capturing
[Jina AI ColBERT embedding integration page](./embeddings-colbert.md)
[Jina AI multimodal embedding integration page](./embeddings-multimodal.md)

### Reranker models

![Reranker integration illustration](../_includes/integration_jinaai_reranker.png)

Jina AI's reranker models are designed to improve the relevance and ranking of search results.

[The Weaviate reranker integration](./reranker.md) allows users to easily refine their search results by leveraging Jina AI's reranker models.

[Jina AI reranker integration page](./reranker.md)

## Summary

These integrations enable developers to leverage Jina AI's powerful models directly within Weaviate.
Expand All @@ -40,7 +50,7 @@ Then, go to the relevant integration page to learn how to configure Weaviate wit
- [Text Embeddings](./embeddings.md)
- [ColBERT embeddings](./embeddings-colbert.md)
- [Multimodal embeddings](./embeddings-multimodal.md)
- [Rerankers](./reranker.md)
- [Reranker](./reranker.md)

## Questions and feedback

Expand Down
2 changes: 1 addition & 1 deletion docs/weaviate/model-providers/jinaai/reranker.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,7 @@ Any search in Weaviate can be combined with a reranker to perform reranking oper

### Available models

- `jina-reranker-v2-base-multilingual` (default)
- `jina-reranker-v2-base-multilingual` (server default)
- `jina-reranker-v1-base-en`
- `jina-reranker-v1-turbo-en`
- `jina-reranker-v1-tiny-en`
Expand Down
11 changes: 11 additions & 0 deletions docs/weaviate/model-providers/transformers/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,16 @@ Transformers-compatible embedding models transform text data into vector embeddi

[Hugging Face Transformers embedding integration page](./embeddings.md)

### Reranker models

![Reranker integration illustration](../_includes/integration_transformers_reranker.png)

Transformers-compatible reranker models are designed to improve the relevance and ranking of search results.

[The Weaviate reranker integration](./reranker.md) allows users to easily refine their search results with a locally hosted Hugging Face Transformers reranker model.

[Hugging Face Transformers reranker integration page](./reranker.md)

## Summary

These integrations enable developers to leverage powerful Hugging Face Transformers models from directly within Weaviate.
Expand All @@ -41,6 +51,7 @@ Go to the relevant integration page to learn how to configure Weaviate with the
- [Text Embeddings (custom image)](./embeddings-custom-image.md)
- [Multimodal Embeddings](./embeddings-multimodal.md)
- [Multimodal Embeddings (custom image)](./embeddings-multimodal-custom-image.md)
- [Reranker](./reranker.md)

## Questions and feedback

Expand Down
Loading