User email
| +| ambar-email-token | String |User token
| ### Success Response @@ -49,12 +66,18 @@ HTTP/1.1 404 Not Found ``` File meta or content not found ``` -## Get File Source by Meta Id +## Get File Source by File Id + + GET api/files/direct/:fileId/source - GET api/files/direct/:metaId/source +### Headers +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| ### Success Response @@ -70,12 +93,18 @@ HTTP/1.1 404 Not Found ``` File meta or content not found ``` -## Get Parsed Text From File by Meta Id +## Get Parsed Text From File by File Id + + GET api/files/direct/:fileId/text - GET api/files/direct/:metaId/text +### Headers +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| ### Success Response @@ -91,7 +120,7 @@ HTTP/1.1 404 Not Found ``` File meta or content not found ``` -## Get File Content by Secure Uri +## Download File Content by Secure Uri @@ -112,7 +141,7 @@ HTTP/1.1 404 Not Found ``` File meta or content not found ``` -## Get Parsed Text by Secure Uri +## Download Parsed Text by Secure Uri @@ -139,6 +168,12 @@ File meta or content not found POST api/files/:sourceId/:filename +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| ### Examples @@ -156,8 +191,7 @@ http://ambar_api_address/api/files/Default/test.txt \ HTTP/1.1 200 OK ``` -HTTP/1.1 200 OK -Json format: { metaId: xxxxx } +{ "fileId": xxxxx } ``` ### Error Response @@ -171,6 +205,60 @@ HTTP/1.1 404 Not Found ``` File meta or content not found ``` +## Hide File + +Hide file by file id
+ + PUT api/files/hide/:fileId + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Success Response + +HTTP/1.1 200 OK + +``` +HTTP/1.1 200 OK +``` +### Error Response + +HTTP/1.1 404 NotFound + +``` +File not found +``` +## Unhide File + +Unhide file by file id
+ + PUT api/files/unhide/:fileId + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Success Response + +HTTP/1.1 200 OK + +``` +HTTP/1.1 200 OK +``` +### Error Response + +HTTP/1.1 404 NotFound + +``` +File not found +``` # Search ## Search For Documents By Query @@ -179,6 +267,12 @@ File meta or content not found GET api/search +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email.
| +| ambar-email-token | String |User token.
| ### Parameters @@ -201,47 +295,54 @@ curl -i http://ambar_api_address/api/search?query=John HTTP/1.1 200 OK ``` -{ - "total": 1, - "hits": [ - { - "score": 0.5184899160927989, - "sha256": "318be2290125e0a6cfb7229133ba3c4632068ae04942ed5c7c660718d9d41eb3", - "meta": [ - { - "extension": ".txt", - "full_name": "//winserver/share/englishstories/aesop11.txt", - "updated_datetime": "2017-01-13 14:06:20.098", - "indexed_datetime": "2017-04-03 11:21:10.064", - "extra": [], - "short_name": "aesop11.txt", - "id": "b84b6d7cf88655e9916d5fbb67886b1befa0d00d99f58b62e72fb04b51ff3c31", - "source_id": "Books", - "created_datetime": "2017-01-13 14:06:20.026", - "download_uri": "b41c4aaa2999ce42957f087db8e7608970efcedb1eaa40c28336390ecb5373849c955f395258f3dfd7482d4b84d543cdcc27104c934cd4efdb0ba8c54e6e8e5f3367190091fa4db779fe2097565921e69be43e80068893bafa0dd0b98f90ec96469df54050dee2649b68646824da2cc32061c24a7ed93a6d1514a89a75360551267015c3035515bbb2971a1fcfdf456a" - } - ], - "content": { - "size": 229353, - "indexed_datetime": "2017-04-03 11:21:10.163", - "author": "", - "processed_datetime": "2017-04-03 11:21:10.163", - "length": "", - "language": "", - "thumb_available": false, - "state": "processed", - "title": "", - "type": "text/plain; charset=windows-1252" - "highlight": { - "text": [ - "taking no notice of the grain.User email.
| +| ambar-email-token | String |User token.
| ### Parameters @@ -300,6 +407,12 @@ HTTP/1.1 400 BadRequest GET api/sources/ +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email.
| +| ambar-email-token | String |User token.
| ### Success Response @@ -308,9 +421,7 @@ HTTP/1.1 200 OK ``` [ { - "_id": "58dce2754795070012ba2d42", "id": "Default", - "index_name": "d033e22ae348aeb5660fc2140aec35850c4da997", "description": "Automatically created on UI upload", "type": "bucket" }, @@ -334,6 +445,12 @@ HTTP/1.1 200 OK GET api/stats +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| ### Success Response @@ -384,6 +501,126 @@ HTTP/1.1 200 OK } } ``` +# Tags + +## Delete Tag From File + + + + DELETE api/tags/:fileId/:tagName + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Parameters + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| fileId | String |File Id to delete tag from.
| +| tagName | String |Tag name to delete.
| + +### Success Response + +HTTP/1.1 200 OK + +``` +{ + "tags":[ + { + "name":"ocr", + "filesCount":3 + }, + { + "name":"test", + "filesCount":2 + }, + { + "name":"pdf", + "filesCount":1 + } + ] +} +``` +## Get Tags + + + + GET api/tags/ + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Success Response + +HTTP/1.1 200 OK + +``` +[ + { + "name":"ocr", + "filesCount":3 + }, + { + "name":"test", + "filesCount":2 + }, + { + "name":"pdf", + "filesCount":1 + } +] +``` +## Add Tag For File + + + + POST api/tags/:fileId/:tagName + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Parameters + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| fileId | String |File Id to add tag to.
| +| tagName | String |Tag name to add.
| + +### Success Response + +HTTP/1.1 200 OK + +``` +{ + "tagId":"e9536a83e64ff03617ab0379d835ac7bbf213bafb95cb42907a56e735472d4fc", + "tags":[ + { + "name":"ocr", + "filesCount":3 + }, + { + "name":"test", + "filesCount":2 + }, + { + "name":"pdf", + "filesCount":1 + } + ] +} +``` # Thumbnails ## Get Thumbnail by Id @@ -428,4 +665,72 @@ HTTP/1.1 400 Bad Request ``` Request body is empty ``` +# Users + +## Login + + + + POST api/users/login + + +### Parameters + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| email | String |User Email
| +| password | String |User Password
| + +### Success Response + +HTTP/1.1 200 OK + +``` +{ + "token": "504d44935c2ccefb557fd49636a73239147b3895db2f2f...", + "ttl": "604800" +} +``` +### Error Response + +HTTP/1.1 400 BadRequest + +``` +Bad request +``` +HTTP/1.1 404 NotFound + +``` +User with specified email not found +``` +HTTP/1.1 409 Conflict + +``` +User is not in active state +``` +HTTP/1.1 401 Unauthorized + +``` +Wrong password +``` +## Logout + + + + POST api/users/logout + +### Headers + +| Name | Type | Description | +|---------|-----------|--------------------------------------| +| ambar-email | String |User email
| +| ambar-email-token | String |User token
| + +### Error Response + +HTTP/1.1 401 Unauthorized + +``` +Unauthorized +``` diff --git a/CHANGELOG.md b/CHANGELOG.md index 7307587..5f22947 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,49 @@ Change log ========== +0.10.0 (2017-06-02) +------------------- + +### New features + +#### Tags: + - Add tags just by typing them right into a search result with a smart autosuggest. Tags are separated by comma or `Enter` key + +  + + - Search by one or several tags with `tags:ocr,receipt` query + + + + - `ocr` tag is automatically added for ocr-proccessed files, more auto tags are coming soon + +#### Files removing: + + - Now you can hide irrelevant search results with *Hide* button, so they never display again in your search results + +  + + - You can search through hidden files by `show:hidden` query + +  + + - You can restore hidden files with *Restore* button + +#### UI: + - Last modified date is now displayed in a human readable format + - Search result card design was significantly changed + - Main menu was placed on the right side of the header + +### Bugfixes + + - Fixed igonoring `auth:none` in `config.json` bug + - Other minor bug fixes + +### Migration from 0.9.5 + + - Before updating your Ambar to this version, you need to reset all the data in your Ambar with `sudo ./ambar.py reset`. After reset run `sudo ./ambar.py update` to get the latest version. + + 0.9.5 (2017-05-19) ------------------- diff --git a/README.md b/README.md index b23bd29..0bfe06f 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -[](https://ambar.cloud) +[](https://ambar.cloud) [](https://github.com/RD17/ambar/blob/master/License.txt) [](https://stackshare.io/ambar/ambar) @@ -26,6 +26,7 @@ Ambar is a document search engine with automated crawling, OCR, deduplication an * Search By File Path (filename:\*.txt) * Search By Date (when: yesterday, today, lastweek, etc) * Search By Size (size>1M) +* Search By Tags (tags:ocr) * Search As You Type * Supported language analyzers: English `ambar_en`, Russian `ambar_ru`, German `ambar_de`, Italian `ambar_it`, Polish `ambar_pl`, Chinese `ambar_cn`, CJK `ambar_cjk` @@ -35,7 +36,6 @@ Ambar is a document search engine with automated crawling, OCR, deduplication an * [Mail Crawling](https://blog.ambar.cloud/crawling-and-searching-email-inbox-with-ambar/) * [Dropbox Crawling](https://blog.ambar.cloud/how-to-search-through-your-dropbox-files-content/) * Scheduled Crawling (Cron schedule syntax) -* Files Deduplication ### Content Extraction * Extract content from large files (>30M) @@ -53,6 +53,8 @@ Ambar is a document search engine with automated crawling, OCR, deduplication an ### General [Ambar features overview (Vimeo)](https://vimeo.com/202204412) +* Files Tagging +* Hiding Irrelevant Search Results * Files Preview (with Google Docs View) * Real-Time Statistics * Web UI @@ -88,14 +90,14 @@ Yes, almost every Ambar's module is published on GitHub under [Fair Source Licen Yes, Community Edition is forever free. We will NOT charge a penny from you to use it. Basic cloud account is also forever free. ### Does it perform OCR? -Yes, it performs OCR on images (jpg, tiff, bmp, etc) and PDF's. OCR is perfomed by well-known open-source library Tesseract. We tuned it to achieve best perfomance and quality on scanned documents. +Yes, it performs OCR on images (jpg, tiff, bmp, etc) and PDF's. OCR is perfomed by well-known open-source library Tesseract. We tuned it to achieve best perfomance and quality on scanned documents. You can easily find all files on which OCR was perfomed with `tags:ocr` query ### Which languages are supported for OCR? Supported languages: Eng, Rus, Ita, Deu, Fra, Spa. If you miss your language, please create an issue on GitHub and we'll add it ASAP. ### Does it support tagging? -Nope, we working on it. As a workaround you can use folders hierarchy as a set of tags. +Yes! ### What about searching in PDF? Yes, it can search through any PDF, even badly encoded or with scans inside. We did our best to make search over any kind of pdf document smooth. diff --git a/README_PL.md b/README_PL.md index 083605b..05880cc 100644 --- a/README_PL.md +++ b/README_PL.md @@ -5,6 +5,8 @@ Ambar: Proste Zarządzanie Dokumentami ================================ +**OUTDATED - USE README.MD AS MANUAL** + Jeśli Ambar Ci się podoba, daj :star:! [Wstęp](https://ambar.cloud) | [Chmura](https://app.ambar.cloud) | [Blog](https://blog.ambar.cloud)