mirror of
https://github.com/lancedb/lancedb.git
synced 2026-10-17 17:22:27 +00:00
Brendan Clement
758f738b8c
This PR is part of the documentation revamp. Once the full set of PRs is merged, we’ll publish the combined site to staging for review before updating docs.lancedb.com. Ingestion, search and integration examples are incomplete or inconsistent across languages, and some guidance misstates SDK behavior. This brings the guides and their example sources together. It includes complete Python, TypeScript and Rust workflows, isolated provider and reranker examples, the Superlinked corrections, and guidance on retries that can duplicate writes. Stacked on #4491. Each MDX file has one PR owner. Rebase onto main after #4491 is squash-merged. Local assembly, Mint validation and link checks pass. Example code is unchanged from the previously validated package. Publication stays held through integration.
52 lines
1.6 KiB
Plaintext
52 lines
1.6 KiB
Plaintext
---
|
|
title: Jina
|
|
sidebarTitle: Jina
|
|
---
|
|
|
|
import {
|
|
PyEmbeddingJinaText,
|
|
PyEmbeddingJinaMultimodal,
|
|
} from '/snippets/provider_examples.mdx';
|
|
|
|
## Text Embedding Models {#text-embedding-models}
|
|
|
|
Jina embeddings are used to generate embeddings for text and image data.
|
|
You also need to set the `JINA_API_KEY` environment variable to use the Jina API.
|
|
|
|
You can find a list of supported models under [https://jina.ai/embeddings/](https://jina.ai/embeddings/)
|
|
|
|
Supported parameters (to be passed in `create` method) are:
|
|
|
|
| Parameter | Type | Default Value | Description |
|
|
|---|---|---|---|
|
|
| `name` | `str` | `"jina-clip-v1"` | The model ID of the jina model to use |
|
|
|
|
Usage Example:
|
|
|
|
Replace `your-api-key` with your Jina API key. This provider reads it from `JINA_API_KEY`; the example sets it explicitly. In application code, supply it through your environment or a secrets manager.
|
|
|
|
<CodeGroup>
|
|
<CodeBlock filename="Python" language="Python" icon="python">
|
|
{PyEmbeddingJinaText}
|
|
</CodeBlock>
|
|
</CodeGroup>
|
|
|
|
## Multimodal Embedding Models {#multimodal-embedding-models}
|
|
|
|
Jina embeddings can also be used to embed both text and image data, only some of the models support image data and you can check the list
|
|
under [https://jina.ai/embeddings/](https://jina.ai/embeddings/)
|
|
|
|
Supported parameters (to be passed in `create` method) are:
|
|
|
|
| Parameter | Type | Default Value | Description |
|
|
|---|---|---|---|
|
|
| `name` | `str` | `"jina-clip-v1"` | The model ID of the jina model to use |
|
|
|
|
Usage Example:
|
|
|
|
<CodeGroup>
|
|
<CodeBlock filename="Python" language="Python" icon="python">
|
|
{PyEmbeddingJinaMultimodal}
|
|
</CodeBlock>
|
|
</CodeGroup>
|