معرفی شرکت ها
chatnoir-api-2.0.7
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Simple, type-safe access to the ChatNoir search API.
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | chatnoir-api-2.0.7 |
| نام | chatnoir-api |
| نسخه کتابخانه | 2.0.7 |
| نگهدارنده | ['Jan Heinrich Reimer'] |
| ایمیل نگهدارنده | [] |
| نویسنده | Jan Heinrich Reimer |
| ایمیل نویسنده | jan.reimer@student.uni-halle.de |
| آدرس صفحه اصلی | https://github.com/chatnoir-eu/chatnoir-api |
| آدرس اینترنتی | https://pypi.org/project/chatnoir-api/ |
| مجوز | - |
[](https://pypi.org/project/chatnoir-api/)
[](https://github.com/chatnoir-eu/chatnoir-api/actions/workflows/ci.yml)
[](https://codecov.io/github/chatnoir-eu/chatnoir-api/)
[](https://pypi.org/project/chatnoir-api/)
[](https://github.com/chatnoir-eu/chatnoir-api/issues)
[](https://github.com/chatnoir-eu/chatnoir-api/commits)
[](https://pypi.org/project/chatnoir-api/)
[](LICENSE)
# 🔍 chatnoir-api
Simple, type-safe access to the [ChatNoir](https://chatnoir.eu/) [search API](https://chatnoir.eu/doc/api/).
Working with PyTerrier? Check out the [`chatnoir-pyterrier`](https://pypi.org/project/chatnoir-pyterrier/) package.
## Installation
Install the package from PyPI:
```shell
pip install chatnoir-api
```
## Usage
The ChatNoir API offers two main features: [search](#search) with BM25F and [retrieving document contents](#retrieve-document-content).
### Search
To search with the ChatNoir API you need to request an [API key](https://chatnoir.eu/apikey/).
Then you can use our Python client to search for documents.
The `results` object is an iterable wrapper of the search results which handles pagination for you.
List-style indexing is supported to access individual results or sub-lists of results:
```python
from chatnoir_api.v1 import search
api_key: str = "<API_KEY>"
results = search(api_key, "python library")
top10_results = results[:10]
print(top10_results)
result_1234 = results[1234]
print(result_1234)
```
#### Search the new ChatNoir
There's a [new](https://chatnoir.web.webis.de/) ChatNoir version with the same API interface. To run your search requests against the new API (e.g., if you want to search the ClueWeb22), set `staging=True` like this:
```python
from chatnoir_api import Index
from chatnoir_api.v1 import search
api_key: str = "<API_KEY>"
results = search(api_key, "python library", staging=True, index=Index.ClueWeb22)
```
_Note for Touché 2023 participants: Set `index=Index.ClueWeb22` to search the ClueWeb22 index. (Otherwise, results from the ClueWeb09 and ClueWeb12 indices will be included.)_
#### Phrase Search
To search for phrases, use the `search_phrases` method in the same way as normal `search`:
```python
from chatnoir_api.v1 import search_phrases
api_key: str = "<API_KEY>"
results = search_phrases(api_key, "python library", staging=True)
```
### Retrieve Document Content
Often the title and ID of a document is not enough to effectively re-rank a list of search results.
To retrieve the full content or plain text for a given document you can use the `html_contents` helper function.
The `html_contents` function expects a ChatNoir-internal UUID, shorthand UUID, or a TREC ID
and the index from which to retrieve the document.
#### Retrieve by TREC ID
You can retrieve a document by its TREC ID like this:
```python
from chatnoir_api import cache_contents, Index
contents = cache_contents(
"clueweb09-en0051-90-00849",
Index.ClueWeb09,
)
print(contents)
plain_contents = cache_contents(
"clueweb09-en0051-90-00849",
Index.ClueWeb09,
plain=True,
)
print(plain_contents)
```
#### Retrieve by ChatNoir-internal UUID
You can also retrieve a document by its ChatNoir-internal UUID like this:
```python
from uuid import UUID
from chatnoir_api import cache_contents, Index
contents = cache_contents(
UUID("e635baa8-7341-596a-b3cf-b33c05954361"),
Index.CommonCrawl1511,
)
print(contents)
plain_contents = cache_contents(
UUID("e635baa8-7341-596a-b3cf-b33c05954361"),
Index.CommonCrawl1511,
plain=True,
)
print(plain_contents)
```
#### Retrieve by ChatNoir-internal short UUID
For newer ChatNoir versions, you can also retrieve a document by its ChatNoir-internal _short_ UUID like this:
```python
from chatnoir_api import cache_contents, Index, ShortUUID
contents = cache_contents(
ShortUUID("6svePe3PXteDeGPk1XqTLA"),
Index.ClueWeb22,
staging=True,
)
print(contents)
plain_contents = cache_contents(
ShortUUID("6svePe3PXteDeGPk1XqTLA"),
Index.ClueWeb22,
plain=True,
staging=True,
)
print(plain_contents)
```
## Citation
If you use this package, please cite the [paper](https://webis.de/publications.html#bevendorff_2018)
from the [ChatNoir](https://github.com/chatnoir-eu) authors.
You can use the following BibTeX information for citation:
```bibtex
@InProceedings{bevendorff:2018,
address = {Berlin Heidelberg New York},
author = {Janek Bevendorff and Benno Stein and Matthias Hagen and Martin Potthast},
booktitle = {Advances in Information Retrieval. 40th European Conference on IR Research (ECIR 2018)},
editor = {Leif Azzopardi and Allan Hanbury and Gabriella Pasi and Benjamin Piwowarski},
ids = {potthast:2018c,stein:2018c},
month = mar,
publisher = {Springer},
series = {Lecture Notes in Computer Science},
site = {Grenoble, France},
title = {{Elastic ChatNoir: Search Engine for the ClueWeb and the Common Crawl}},
year = 2018
}
```
## Development
To build and develop this package you need to install the `build` package:
```shell
pip install build
```
### Installation
Install package dependencies:
```shell
pip install -e .
```
### Testing
Install test dependencies:
```shell
pip install -e .[test]
```
Verify your changes against the test suite to verify.
```shell
flake8 chatnoir_api examples
pylint -E chatnoir_api examples
CHATNOIR_API_KEY="<API_KEY>" CHATNOIR_API_KEY_STAGING="<API_KEY>" pytest chatnoir_api examples
```
Please also add tests for your newly developed code.
### Build wheels
Wheels for this package can be built by:
```shell
python -m build
```
## License
This repository is released under the [MIT license](LICENSE).
نیازمندی
| مقدار | نام |
|---|---|
| ==2.*,>=2.26 | requests |
| ==0.5.*,>=0.5.5 | dataclasses-json |
| ==4.*,>=4.0 | typing-extensions |
| ==4.*,>=4.0 | importlib-metadata |
| ==4.*,>=4.0 | flake8 |
| ==2.*,>=2.12 | pylint |
| ==6.*,>=6.2 | pytest |
| ==3.*,>=3.0 | pytest-cov |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3.7 | Python |
نحوه نصب
نصب پکیج whl chatnoir-api-2.0.7:
pip install chatnoir-api-2.0.7.whl
نصب پکیج tar.gz chatnoir-api-2.0.7:
pip install chatnoir-api-2.0.7.tar.gz