llm-jina-api


Namellm-jina-api JSON
Version 0.1a0 PyPI version JSON
download
home_pageNone
SummaryAccess Jina AI embeddings via their API
upload_time2024-09-20 06:25:15
maintainerNone
docs_urlNone
authorSimon Willison
requires_pythonNone
licenseApache-2.0
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # llm-jina-api

[![PyPI](https://img.shields.io/pypi/v/llm-jina-api.svg)](https://pypi.org/project/llm-jina-api/)
[![Changelog](https://img.shields.io/github/v/release/simonw/llm-jina-api?include_prereleases&label=changelog)](https://github.com/simonw/llm-jina-api/releases)
[![Tests](https://github.com/simonw/llm-jina-api/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/llm-jina-api/actions/workflows/test.yml)
[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-jina-api/blob/main/LICENSE)

Access Jina AI embeddings via their API

## Installation

Install this plugin in the same environment as [LLM](https://llm.datasette.io/).
```bash
llm install llm-jina-api
```
## Usage

The plugin adds an embedding model called `jina-clip-v1-api`. You'll need to set [an API key](https://jina.ai/embeddings/) first:

```bash
llm keys set jina
# paste API key here
```

Follow the [LLM documentation](https://llm.datasette.io/en/stable/embeddings/cli.html) using `jina-clip-v1-api` as the model name. For example:

```bash
llm embed -m jina-clip-v1-api -c 'pelican'

# To embed an image file:
llm embed --binary -m jina-clip-v1-api -i pelican.jpg
```

## Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:
```bash
cd llm-jina-api
python -m venv venv
source venv/bin/activate
```
Now install the dependencies and test dependencies:
```bash
llm install -e '.[test]'
```
To run the tests:
```bash
python -m pytest
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "llm-jina-api",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": null,
    "author": "Simon Willison",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/c3/0b/43501628349bb8661aed1d8f6d59329f1673bc7daab17cc2dd4b253a659b/llm_jina_api-0.1a0.tar.gz",
    "platform": null,
    "description": "# llm-jina-api\n\n[![PyPI](https://img.shields.io/pypi/v/llm-jina-api.svg)](https://pypi.org/project/llm-jina-api/)\n[![Changelog](https://img.shields.io/github/v/release/simonw/llm-jina-api?include_prereleases&label=changelog)](https://github.com/simonw/llm-jina-api/releases)\n[![Tests](https://github.com/simonw/llm-jina-api/actions/workflows/test.yml/badge.svg)](https://github.com/simonw/llm-jina-api/actions/workflows/test.yml)\n[![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)](https://github.com/simonw/llm-jina-api/blob/main/LICENSE)\n\nAccess Jina AI embeddings via their API\n\n## Installation\n\nInstall this plugin in the same environment as [LLM](https://llm.datasette.io/).\n```bash\nllm install llm-jina-api\n```\n## Usage\n\nThe plugin adds an embedding model called `jina-clip-v1-api`. You'll need to set [an API key](https://jina.ai/embeddings/) first:\n\n```bash\nllm keys set jina\n# paste API key here\n```\n\nFollow the [LLM documentation](https://llm.datasette.io/en/stable/embeddings/cli.html) using `jina-clip-v1-api` as the model name. For example:\n\n```bash\nllm embed -m jina-clip-v1-api -c 'pelican'\n\n# To embed an image file:\nllm embed --binary -m jina-clip-v1-api -i pelican.jpg\n```\n\n## Development\n\nTo set up this plugin locally, first checkout the code. Then create a new virtual environment:\n```bash\ncd llm-jina-api\npython -m venv venv\nsource venv/bin/activate\n```\nNow install the dependencies and test dependencies:\n```bash\nllm install -e '.[test]'\n```\nTo run the tests:\n```bash\npython -m pytest\n```\n",
    "bugtrack_url": null,
    "license": "Apache-2.0",
    "summary": "Access Jina AI embeddings via their API",
    "version": "0.1a0",
    "project_urls": {
        "CI": "https://github.com/simonw/llm-jina-api/actions",
        "Changelog": "https://github.com/simonw/llm-jina-api/releases",
        "Homepage": "https://github.com/simonw/llm-jina-api",
        "Issues": "https://github.com/simonw/llm-jina-api/issues"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a3a0c9f0b7f2f46a1ce42d6627423881e12e4a68702649102f889c9698e21493",
                "md5": "1b868fb50c0205f45697f306689168bc",
                "sha256": "7d0fd962f9b4197f49d3e6aa9bd1f4dbad49d4ed7d8d33ecffbd0fe500aba709"
            },
            "downloads": -1,
            "filename": "llm_jina_api-0.1a0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1b868fb50c0205f45697f306689168bc",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": null,
            "size": 7134,
            "upload_time": "2024-09-20T06:25:14",
            "upload_time_iso_8601": "2024-09-20T06:25:14.500545Z",
            "url": "https://files.pythonhosted.org/packages/a3/a0/c9f0b7f2f46a1ce42d6627423881e12e4a68702649102f889c9698e21493/llm_jina_api-0.1a0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "c30b43501628349bb8661aed1d8f6d59329f1673bc7daab17cc2dd4b253a659b",
                "md5": "0d92ed157399b7af14bbd32c25d52888",
                "sha256": "82e6f96733efb72a478a5d53b080918a9b5322ee7e67f226fe83c58e55a494da"
            },
            "downloads": -1,
            "filename": "llm_jina_api-0.1a0.tar.gz",
            "has_sig": false,
            "md5_digest": "0d92ed157399b7af14bbd32c25d52888",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 6784,
            "upload_time": "2024-09-20T06:25:15",
            "upload_time_iso_8601": "2024-09-20T06:25:15.613002Z",
            "url": "https://files.pythonhosted.org/packages/c3/0b/43501628349bb8661aed1d8f6d59329f1673bc7daab17cc2dd4b253a659b/llm_jina_api-0.1a0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-20 06:25:15",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "simonw",
    "github_project": "llm-jina-api",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "llm-jina-api"
}
        
Elapsed time: 0.37091s