Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nationalarchives/annosearch
W3C web annotation search using the IIIF content search API
https://github.com/nationalarchives/annosearch
iiif-search w3c-web-annotations
Last synced: 6 days ago
JSON representation
W3C web annotation search using the IIIF content search API
- Host: GitHub
- URL: https://github.com/nationalarchives/annosearch
- Owner: nationalarchives
- Created: 2024-10-30T16:27:02.000Z (about 2 months ago)
- Default Branch: main
- Last Pushed: 2024-12-14T11:29:26.000Z (11 days ago)
- Last Synced: 2024-12-14T12:24:22.364Z (11 days ago)
- Topics: iiif-search, w3c-web-annotations
- Language: TypeScript
- Homepage:
- Size: 392 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Annotation Search
AnnoSearch uses [Quickwit](https://quickwit.io) as its backend database to efficiently index and query [W3C Web Annotation](https://www.w3.org/TR/annotation-model/) data, leveraging a declarative approach to simplify ingestion and management. AnnoSearch can ingest data directly from [IIIF](https://iiif.io/) resources and web annotation servers such as [Miiify](https://github.com/nationalarchives/miiify) and make it available to IIIF viewers through the [IIIF Content Search 2.0 API](https://iiif.io/api/search/2.0/).
## Tutorial
We first need to create an index.
```
❯ annosearch init --index cookbook
Index created successfully
```
We can now load the index with the annotations referenced in a IIIF manifest.
```
❯ annosearch load --index cookbook --type Manifest --uri https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/manifest.json
Loading Manifest from https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/manifest.json into index cookbook
|+|
```
After Quickwit finishes ingesting and indexing the data we can perform a search.
```
❯ annosearch search --index cookbook --query brunnen
{
"@context": "http://www.w3.org/ns/anno.jsonld",
"id": "http://localhost:3000/cookbook/search?q=brunnen&page=0",
"type": "AnnotationPage",
"startIndex": 0,
"items": [
{
"body": {
"format": "text/plain",
"language": "de",
"type": "TextualBody",
"value": "Göttinger Marktplatz mit Gänseliesel Brunnen"
},
"id": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1/annopage-2/anno-1",
"motivation": "commenting",
"target": "https://iiif.io/api/cookbook/recipe/0266-full-canvas-annotation/canvas-1",
"type": "Annotation"
}
]
}
```
## Usage
Make sure you have Quickwit installed and [running](https://quickwit.io/docs/get-started/quickstart) and then install AnnoSearch.
```bash
npm install -g annosearch
```
### Commands
#### `init`
Initialize a new index with a specified ID.
```bash
annosearch init --index
```
#### `load`
Load an index from a URI, specifying the type of content being loaded (e.g., Manifest, Collection, or AnnotationCollection).
```bash
annosearch load --index --type --uri
```
- `type`: The type of content (Manifest, Collection, AnnotationCollection).
- `uri`: The URI to load the content from.
#### `delete`
Delete an existing index by ID.
```bash
annosearch delete --index
```
#### `search`
Perform a search on a specified index.
```bash
annosearch search --index --query [--page ] [--motivation ] [--date ] [--user ]
```
- `query`: A space separated list of search query terms.
- `page`: Optional page number (defaults to 0).
- `motivation`: Optional space separated list of motivation terms.
- `date`: Optional space separated list of date ranges.
- `user`: Optional space separated list of URIs that are the identities of users.
#### `serve`
Start a web server that provides a search service using the [IIIF Content Search 2.0 API](https://iiif.io/api/search/2.0/).
```bash
annosearch serve --port --host
```
- `port`: The port on which to run the server.
- `host`: The host on which to run the server.
#### `version`
Display the current version of AnnoSearch.
```bash
annosearch version
```
## Configuration
Configure AnnoSearch by setting the following environment variables:
- **`ANNOSEARCH_MAX_HITS`**: Maximum number of search results per query.
- **Default**: `20`
- **`ANNOSEARCH_PORT`**: Port on which AnnoSearch runs.
- **Default**: `3000`
- **`ANNOSEARCH_HOST`**: Host on which AnnoSearch runs.
- **Default**: `localhost`
- **`ANNOSEARCH_PUBLIC_URL`**: URL for public-facing server requests.
- **Default**: `http://localhost:3000`
Adjust these values as needed to customize AnnoSearch’s configuration and behavior.
## Todo
- Implement the autocomplete service
- Implement extended API responses
## License
This project is licensed under the MIT License.