{"id":26064822,"url":"https://github.com/syncano/syncano-socket-aws-comprehend","last_synced_at":"2026-04-22T04:35:01.180Z","repository":{"id":77440722,"uuid":"115132543","full_name":"Syncano/syncano-socket-aws-comprehend","owner":"Syncano","description":null,"archived":false,"fork":false,"pushed_at":"2018-04-04T11:27:38.000Z","size":122,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-12-25T16:16:31.856Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Syncano.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-12-22T16:31:13.000Z","updated_at":"2018-04-04T11:27:39.000Z","dependencies_parsed_at":"2023-02-26T10:45:10.402Z","dependency_job_id":null,"html_url":"https://github.com/Syncano/syncano-socket-aws-comprehend","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Syncano/syncano-socket-aws-comprehend","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-comprehend","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-comprehend/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-comprehend/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-comprehend/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Syncano","download_url":"https://codeload.github.com/Syncano/syncano-socket-aws-comprehend/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Syncano%2Fsyncano-socket-aws-comprehend/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32121146,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-22T00:31:26.853Z","status":"online","status_checked_at":"2026-04-22T02:00:05.693Z","response_time":58,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":[],"created_at":"2025-03-08T18:49:28.013Z","updated_at":"2026-04-22T04:35:01.175Z","avatar_url":"https://github.com/Syncano.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# aws-comprehend socket\n[![CircleCI](https://circleci.com/gh/Syncano/syncano-socket-aws-comprehend.svg?style=svg)](https://circleci.com/gh/Syncano/syncano-socket-aws-comprehend)\n\nThis socket integrates Amazon Comprehend to syncano.\n\n### Install\n\n```\nsyncano-cli add aws-comprehend\n```\n\n### Socket Documentation\n[Link to aws-comprehend socket documentation](https://syncano.io/#/sockets/aws-comprehend)\n\n## Endpoints\n#### batch-detect-dominant-language\nThis endpoint determines the dominant language of the input text for a batch of documents.\n\n*_Parameters_*\n\n| Name          | Type     | Description  | Example\n| ------------- |---------| ------------| ---------\n| TextList      | array   | List containing the text of the input documents | ['Hello Syncano', 'Bonjour mademoiselle']\n\n*_Response_*\n\n```\n{\n  \"ErrorList\": [\n    {\n      \"ErrorCode\": \"string\",\n      \"ErrorMessage\": \"string\",\n      \"Index\": number\n    }\n  ],\n  \"ResultList\": [\n    {\n      \"Index\": number,\n      \"Languages\": [\n        {\n          \"LanguageCode\": \"string\",\n          \"Score\": number\n        }\n      ]\n    }\n  ]\n}\n```\n\n#### batch-detect-entities\nThis endpoint inspects the text of a batch of documents for named entities and returns information about them\n\n*_Parameters_*\n\n\n| Name          | Type    | Description  | Example\n| ------------- |---------| ------------| ---------\n| LanguageCode  | string  | Language of the input documents        | en\n| TextList      | array   | List containing the text of the input documents | ['Hello Syncano', 'Bonjour mademoiselle']\n\n*_Response_*\n\n```\n{\n  \"ErrorList\": [\n    {\n      \"ErrorCode\": \"string\",\n      \"ErrorMessage\": \"string\",\n      \"Index\": number\n    }\n  ],\n  \"ResultList\": [\n    {\n      \"Index\": number,\n      \"Entities\": [\n        {\n          \"BeginOffset\": number,\n          \"EndOffset\": number,\n          \"Score\": number,\n          \"Text\": \"string\",\n          \"Type\": \"string\"\n        }\n      ]\n    }\n  ]\n}\n```\n\n#### batch-detect-key-phrases\nThis endpoint detects the key noun phrases found in a batch of documents\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| LanguageCode  | string  | Language of the input documents        | en\n| TextList      | array   | List containing the text of the input documents | ['Hello Syncano', 'Bonjour mademoiselle']\n\n*_Response_*\n\n```\n{\n  \"ErrorList\": [\n    {\n      \"ErrorCode\": \"string\",\n      \"ErrorMessage\": \"string\",\n      \"Index\": number\n    }\n  ],\n  \"ResultList\": [\n    {\n      \"Index\": number,\n      \"KeyPhrases\": [\n        {\n          \"BeginOffset\": number,\n          \"EndOffset\": number,\n          \"Score\": number,\n          \"Text\": \"string\"\n        }\n      ]\n    }\n  ]\n}\n```\n\n#### batch-detect-sentiment\nThis endpoint inspects a batch of documents and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, NEGATIVE for each document\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| LanguageCode  | string  | Language of the input documents        | en\n| TextList      | array   | List containing the text of the input documents | ['Hello Syncano', 'Bonjour mademoiselle']\n\n*_Response_*\n\n```\n{\n  \"ErrorList\": [\n    {\n      \"ErrorCode\": \"string\",\n      \"ErrorMessage\": \"string\",\n      \"Index\": number\n    }\n  ],\n  \"ResultList\": [\n    {\n      \"Index\": number,\n      \"Sentiment\": string,\n      \"SentimentScore\": [\n        {\n          \"Mixed\": number,\n          \"Negative\": number,\n          \"Neutral\": number,\n          \"Positive\": number\n        }\n      ]\n    }\n  ]\n}\n```\n\n#### describe-topics-detection-job\nThis endpoint gets the properties associated with a topic detection job. Use this operation to get the status of a detection job.\n\n*_Parameters_*\n\n\n| Name          | Type      | Description  | Example\n| ------------- |-----------| ------------| ---------\n| JobId      | string    | The identifier assigned by the user to the detection job | 1234\n\n*Response*\n\n```\n{\n  \"TopicsDetectionJobProperties\": {\n    \"EndTime\": number,\n    \"InputDataConfig\": {\n      \"InputFormat\": \"string\",\n      \"S3Uri\": \"string\"\n    },\n    \"JobId\": \"string\",\n    \"JobName\": \"string\",\n    \"JobStatus\": \"string\",\n    \"Message\": \"string\",\n    \"NumberOfTopics\": number,\n    \"OutputDataConfig\": {\n      \"S3Uri\": \"string\"\n    },\n    \"SubmitTime\": number\n  }\n}\n```\n\n#### detect-dominant-language\nThis endpoint determines the dominant language of the input text.\n\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| Text      | string   | A UTF-8 text string to detect dominant language | Bonjour monsieur Emmanuel\n\n*_Response_*\n\n```\n{\n  \"Languages\": [\n    {\n      \"LanguageCode\": \"string\",\n      \"Score\": number\n    }\n  ]\n}\n```\n\n#### detect-entities\nThis endpoint inspects text for named entities, and returns information about them.\n\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| Text      | string   | A UTF-8 text string to detect entities | Bonjour monsieur Emmanuel\n| LanguageCode  | string  | Language of the input document  | en\n\n*_Response_*\n\n```\n{\n  \"Entities\": [\n    {\n      \"BeginOffset\": number,\n      \"EndOffset\": number,\n      \"Score\": number,\n      \"Text\": \"string\",\n      \"Type\": \"string\"\n    }\n  ]\n}\n```\n\n#### detect-key-phrases\nThis endpoint detects the key noun phrases found in the text.\n\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| Text      | string   | A UTF-8 text string to detect key phrases | Bonjour monsieur Emmanuel\n| LanguageCode  | string  | Language of the input document  | en\n\n*_Response_*\n\n```\n{\n  \"KeyPhrases\": [\n    {\n      \"BeginOffset\": number,\n      \"EndOffset\": number,\n      \"Score\": number,\n      \"Text\": \"string\"\n    }\n  ]\n}\n```\n\n#### detect-sentiment\nThis endpoint inspects text and returns an inference of the prevailing sentiment, POSITIVE, NEUTRAL, MIXED, or NEGATIVE.\n\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| Text      | string   | A UTF-8 text string to detect sentiment | Bonjour monsieur Emmanuel\n| LanguageCode  | string  | Language of the input document  | en\n\n*_Response_*\n\n```\n{\n  \"Sentiment\": \"string\",\n  \"SentimentScore\": {\n    \"Mixed\": number,\n    \"Negative\": number,\n    \"Neutral\": number,\n    \"Positive\": number\n  }\n}\n```\n\n#### list-topics-detection-jobs\nThis endpoint gets a list of the topic detection jobs that you have submitted\n\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| Filter      | object   | Identifies the next page of results to return | ``` { \"jobName\": \"STRING_VALUE\", \"JobStatus\": COMPLETED, \"SubmitTimeAfter\": 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)',\"SubmitTimeBefore\": 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)'}```\n| MaxResults  | integer   | The maximum number of results to return in each page | 10\n| NextToken   | string   | Identifies the next page of results to return | 12345\n| LanguageCode | string  | Language of the input document  | en\n\n*_Response_*\n\n```\n{\n  \"NextToken\": \"string\",\n  \"TopicsDetectionJobPropertiesList\": [\n    {\n      \"EndTime\": number,\n      \"InputDataConfig\": {\n        \"InputFormat\": \"string\",\n        \"S3Uri\": \"string\"\n      },\n      \"JobId\": \"string\",\n      \"JobName\": \"string\",\n      \"JobStatus\": \"string\",\n      \"Message\": \"string\",\n      \"NumberOfTopics\": number,\n      \"OutputDataConfig\": {\n        \"S3Uri\": \"string\"\n      },\n      \"SubmitTime\": number\n    }\n  ]\n}\n```\n\n#### start-topics-detection-job\nThis endpoint starts an asynchronous topic detection job\n*_Parameters_*\n\n| Name      | Type     | Description  | Example\n| ----------|---------| ------------| ---------\n| JobName  | string   | The identifier of the job | sample-job\n| DataAccessRoleArn  | string   | The IAM Amazon Resource Name (ARN) | AmazonComprehendServiceRole-comprehend-role\n| InputDataConfig      | object   | Identifies the next page of results to return | ``` { \"S3Uri\": \"STRING_VALUE\", \"InputFormat\": ONE_DOC_PER_FILE}```\n| OutputDataConfig      | object   | Identifies the next page of results to return | ``` { \"S3Uri\": \"STRING_VALUE\"}```\n| ClientRequestToken   | string   | A unique identifier for the request | sample-token\n| NumberOfTopics  | integer   | The number of topics to detect | 10\n| LanguageCode | string  | Language of the input document  | en\n\n*_Response_*\n\n```\n{\n  \"JobId\": \"string\",\n  \"JobStatus\": \"string\"\n}\n```\n\n### Contributing\n\n#### How to Contribute\n  * Fork this repository\n  * Clone from your fork\n  * Make your contributions (Make sure your work is well tested)\n  * Create Pull request from the fork to this repo\n\n#### Setting up environment variables\n  * Create a `.env` on parent folder\n  * Copy contents of `.env-sample` file to newly created `.env` file and assign appropriate values to the listed variables.\n\n#### Testing\n  * Ensure all your test are written on the `test` directory\n  * Use the command `npm test` to run test","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-comprehend","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-comprehend","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsyncano%2Fsyncano-socket-aws-comprehend/lists"}