{"id":21297505,"url":"https://github.com/fvdm/nodejs-cloudsight","last_synced_at":"2025-07-13T21:06:52.107Z","repository":{"id":48589754,"uuid":"49467737","full_name":"fvdm/nodejs-cloudsight","owner":"fvdm","description":"Unofficial Node.js module for the CloudSight image recognition API","archived":false,"fork":false,"pushed_at":"2021-07-19T10:19:25.000Z","size":60,"stargazers_count":7,"open_issues_count":2,"forks_count":1,"subscribers_count":4,"default_branch":"develop","last_synced_at":"2025-07-11T18:49:06.871Z","etag":null,"topics":["analysis","api-client","cloudsight","image-classification","image-recognition","nodejs","ocr","unlicense"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/cloudsight","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"unlicense","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fvdm.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-01-12T01:59:22.000Z","updated_at":"2021-07-19T10:19:27.000Z","dependencies_parsed_at":"2022-08-27T22:41:41.440Z","dependency_job_id":null,"html_url":"https://github.com/fvdm/nodejs-cloudsight","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"purl":"pkg:github/fvdm/nodejs-cloudsight","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-cloudsight","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-cloudsight/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-cloudsight/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-cloudsight/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fvdm","download_url":"https://codeload.github.com/fvdm/nodejs-cloudsight/tar.gz/refs/heads/develop","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fvdm%2Fnodejs-cloudsight/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265205662,"owners_count":23727507,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","api-client","cloudsight","image-classification","image-recognition","nodejs","ocr","unlicense"],"created_at":"2024-11-21T14:37:50.976Z","updated_at":"2025-07-13T21:06:52.081Z","avatar_url":"https://github.com/fvdm.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"cloudsight\n==========\n\nUnofficial Node.js module for the CloudSight image recognition API.\n\n[![Changelog](https://img.shields.io/npm/v/cloudsight.svg?maxAge=3600)](https://github.com/fvdm/nodejs-cloudsight/blob/master/CHANGELOG.md)\n[![Build Status](https://travis-ci.org/fvdm/nodejs-cloudsight.svg?branch=master)](https://travis-ci.org/fvdm/nodejs-cloudsight)\n[![Dependency Status](https://gemnasium.com/badges/github.com/fvdm/nodejs-cloudsight.svg)](https://gemnasium.com/github.com/fvdm/nodejs-cloudsight#runtime-dependencies)\n[![Greenkeeper badge](https://badges.greenkeeper.io/fvdm/nodejs-cloudsight.svg)](https://greenkeeper.io/)\n\n* [Node.js](https://nodejs.org/)\n* [CloudSight](https://cloudsightapi.com/)\n* [API documentation](http://cloudsightapi.com/docs)\n* [Development](https://github.com/fvdm/nodejs-cloudsight/blob/develop/CONTRIBUTING.md)\n\n\nUsage\n-----\n\n```js\nvar cloudsight = require ('cloudsight') ({\n  apikey: 'abc123'\n});\n\nvar image = {\n  image: '/path/to/image.jpg',\n  locale: 'en-US'\n};\n\n// Upload image to analyze, report results\ncloudsight.request (image, true, console.log);\n```\n\n\nInstallation\n------------\n\nYou need a CloudSight account API key with enough credits.\n\n`npm install cloudsight`\n\n\nMethods\n-------\n\nThe callback function receives result data and errors.\n\n```js\nfunction myCallback (err, data) {\n  if (err) {\n    console.log (err);\n    return;\n  }\n\n  console.log (data);\n}\n```\n\n\n#### Errors\n\nerror message  | description             | additional\n:--------------|:------------------------|:--------------------------\nrequest failed | A request error occured | `err.error`\nAPI error      | API error occured       | `err.statusCode` and `err.error`\n\n\n### .request\n**( params, [polling], callback )**\n\nSend an image to the API for analysis.\n\n\nargument | type     | required | default | description\n:--------|:---------|:---------|:--------|:-----------------------\nparams   | object   | yes      |         | Image object, see below\npolling  | boolean  | no       | false   | Only callback when analysis is complete\ncallback | function | yes      |         | Callback function\n\n\n#### Image object\n\nparam            | required | default | description\n:----------------|:---------|:--------|:-------------------------------\nimage            | yes      |         | Local path to image, either this or `remote_image_url`\nremote_image_url | yes      |         | URL to image, either this or `image`\nlocale           | no       | en-US   | OCR locale for text recognition\nlanguage         | no       | en      | Response data language\ndevice_id        | no       | _UUID_  | Unique identifier for request, auto generated\nlatitude         | no       |         | Image context geo position\nlongitude        | no       |         | Image context geo position\naltitude         | no       |         | Image context geo position\nttl              | no       |         | Analysis deadline in seconds or `max`\nfocus_x          | no       |         | Focal point in px\nfocus_y          | no       |         | Focal point in px\n\n\n#### Example\n\n```js\n// Describe image\nvar image = {\n  image: '/path/to/image.jpg',\n  locale: 'en-US'\n};\n  \n// Upload image\ncloudsight.request (image, console.log);\n\n// Upload image and wait for completion\ncloudsight.request (image, true, console.log);\n```\n\n\n### .response\n**( token, callback )**\n\nGet analysis state or data for an image.\n\n\nargument | type     | required | description\n:--------|:---------|:---------|:---------------------------\ntoken    | string   | yes      | Image token from `.request`\ncallback | function | yes      | Callback function\n\n\n```js\ncloudsight.response ('xyz789', console.log);\n```\n\n\nUnlicense\n---------\n\nThis is free and unencumbered software released into the public domain.\n\nAnyone is free to copy, modify, publish, use, compile, sell, or\ndistribute this software, either in source code form or as a compiled\nbinary, for any purpose, commercial or non-commercial, and by any\nmeans.\n\nIn jurisdictions that recognize copyright laws, the author or authors\nof this software dedicate any and all copyright interest in the\nsoftware to the public domain. We make this dedication for the benefit\nof the public at large and to the detriment of our heirs and\nsuccessors. We intend this dedication to be an overt act of\nrelinquishment in perpetuity of all present and future rights to this\nsoftware under copyright law.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND,\nEXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF\nMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\nIN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR\nOTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,\nARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR\nOTHER DEALINGS IN THE SOFTWARE.\n\nFor more information, please refer to \u003chttp://unlicense.org/\u003e\n\n\nAuthor\n------\n\n[Franklin van de Meent](https://frankl.in/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvdm%2Fnodejs-cloudsight","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffvdm%2Fnodejs-cloudsight","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffvdm%2Fnodejs-cloudsight/lists"}