Comprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-comprehendmedical-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`ComprehendMedicalClient`) and the commands you need, for example `DetectEntitiesCommand`:\n\n```javascript\n//JavaScript\nconst {\n ComprehendMedicalClient\n} = require(\"@aws-sdk/client-comprehendmedical-browser/ComprehendMedicalClient\");\nconst {\n DetectEntitiesCommand\n} = require(\"@aws-sdk/client-comprehendmedical-browser/commands/DetectEntitiesCommand\");\n```\n\n```javascript\n//TypeScript\nimport { ComprehendMedicalClient } from \"@aws-sdk/client-comprehendmedical-browser/ComprehendMedicalClient\";\nimport { DetectEntitiesCommand } from \"@aws-sdk/client-comprehendmedical-browser/commands/DetectEntitiesCommand\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst comprehendMedical = new ComprehendMedicalClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n Text: /**a string value*/,\n};\nconst detectEntitiesCommand = new DetectEntitiesCommand(params);\ncomprehendMedical.send(detectEntitiesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncomprehendMedical.send(detectEntitiesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/@aws-sdk/client-comprehendmedical-browser/ComprehendMedical\";\nconst comprehendMedical = new AWS.ComprehendMedical({ region: \"region\" });\ncomprehendMedical.detectEntities(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-comprehendmedical-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-comprehendmedical-browser has been renamed to @aws-sdk/client-comprehendmedical. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Comprehend Medical","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.5","@aws-sdk/json-parser":"^0.1.0-preview.5","@aws-sdk/core-handler":"^0.1.0-preview.5","@aws-sdk/json-builder":"^0.1.0-preview.5","@aws-sdk/signature-v4":"^0.1.0-preview.7","@aws-sdk/config-resolver":"^0.1.0-preview.5","@aws-sdk/middleware-stack":"^0.1.0-preview.6","@aws-sdk/retry-middleware":"^0.1.0-preview.5","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.6","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.5","@aws-sdk/signing-middleware":"^0.1.0-preview.7","@aws-sdk/url-parser-browser":"^0.1.0-preview.5","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.5","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.6","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.6","@aws-sdk/stream-collector-browser":"^0.1.0-preview.5","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.5","@aws-sdk/middleware-header-default":"^0.1.0-preview.5"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-comprehendmedical-browser_0.1.0-preview.3_1568908136317_0.9376553305801225","host":"s3://npm-registry-packages"}},"0.1.0-preview.4":{"name":"@aws-sdk/client-comprehendmedical-browser","version":"0.1.0-preview.4","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-comprehendmedical-browser@0.1.0-preview.4","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"5b8fb9078a335bfee48ce9d59a5df3eb94c0fc32","tarball":"https://registry.npmjs.org/@aws-sdk/client-comprehendmedical-browser/-/client-comprehendmedical-browser-0.1.0-preview.4.tgz","fileCount":140,"integrity":"sha512-/NkQaTeasVGL7HF1ifR6YeNdH18kXaq/H6xzRVYifOTGj4ctj6qa42ffP7SOR5yFcVHvKuq0q+DZ0zCGXwY18w==","signatures":[{"sig":"MEQCIFHHhGR1alDXby7ARUmDzU6kUo0HtV98MAEXD05CDrt3AiApJiOeFqwPwoMdQ58ILgytn3llQNVYiS1s/A/xOZwe5Q==","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":96753,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJduM6ICRA9TVsSAnZWagAAPyMP/RsyEbOLP1Q0lDcqkVMr\nkO6Ex4Z1UOQd4NGwISR4bwcMEVRdYcIKN2webf8Dgwoku3tgo7QXOqullrVx\nWujFJOihTiUOO/cYXGvU/bVGORlkfA6CuksUsx8iRmTozruOa1csubNN9t1v\nGBEnC7UwoZ/qSPrcwOBO1e4e+DIt2gFaQiPaFfCD9MFnNwLqGQYa4giKLe6Q\nKfSpaaOrOk0ycMUzt80EW9GbTutPs3QACYnH0BOvrL3XFeEozdKKRUW7fSiR\nm3/7rc/R7W/o+K6t34yDHEN9rVFiroGy/JZn3LXFBKluDHwANoJhO5DGtlWz\nRhqvRN2GEanTV80QdkOADvGEgYnrTh1+Wmdt8eIzRh3suItZ1S97WHCjYXRo\nBvLP+zWaCUtUi/967nWeTmRdayYk2sRvYyy7W/E+tzmYz5i60wwZPg2G8WYR\nTt/N1PdoUTgholCg755fMzuL9MihCMa6VoaguMIwSX+cUbPg+NT+mtW/ULsn\nv5ZV7WGHJ6OKTDXnNxEzExCJq6ZgarbSPzyyP3tzJbk8qV7HRyNlaeGEVvGE\nwd1/Et2wS8i9DJI9Ai/7LRBcNHqhGx6DAi9TyYHqmv6TQQjuAY4RSaLH1tiK\nb4RCBO2bUV58czMC4uxC3VYB4B+pHEfsorCGx/C6yN3OZ6fZE+FJ6hbDE02X\nnGRx\r\n=bqZ9\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-comprehendmedical-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n\n## Description\n\nComprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-comprehendmedical-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`ComprehendMedicalClient`) and the commands you need, for example `DetectEntitiesCommand`:\n\n```javascript\n//JavaScript\nconst {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} = require(\"@aws-sdk/client-comprehendmedical-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} from \"@aws-sdk/client-comprehendmedical-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst comprehendMedical = new ComprehendMedicalClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n Text: /**a string value*/,\n};\nconst detectEntitiesCommand = new DetectEntitiesCommand(params);\ncomprehendMedical.send(detectEntitiesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncomprehendMedical.send(detectEntitiesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-comprehendmedical-browser\";\nconst comprehendMedical = new AWS.ComprehendMedical({ region: \"region\" });\ncomprehendMedical.detectEntities(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-comprehendmedical-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-comprehendmedical-browser has been renamed to @aws-sdk/client-comprehendmedical. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Comprehend Medical","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.6","@aws-sdk/json-parser":"^0.1.0-preview.6","@aws-sdk/core-handler":"^0.1.0-preview.6","@aws-sdk/json-builder":"^0.1.0-preview.6","@aws-sdk/signature-v4":"^0.1.0-preview.8","@aws-sdk/config-resolver":"^0.1.0-preview.6","@aws-sdk/middleware-stack":"^0.1.0-preview.7","@aws-sdk/retry-middleware":"^0.1.0-preview.6","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.7","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.6","@aws-sdk/signing-middleware":"^0.1.0-preview.8","@aws-sdk/url-parser-browser":"^0.1.0-preview.6","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.6","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.7","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.7","@aws-sdk/stream-collector-browser":"^0.1.0-preview.6","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.6","@aws-sdk/middleware-header-default":"^0.1.0-preview.6"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-comprehendmedical-browser_0.1.0-preview.4_1572392583637_0.21927887664578805","host":"s3://npm-registry-packages"}},"0.1.0-preview.5":{"name":"@aws-sdk/client-comprehendmedical-browser","version":"0.1.0-preview.5","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-comprehendmedical-browser@0.1.0-preview.5","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"7884c3a423f0529a5516023d1494b76e1edcf164","tarball":"https://registry.npmjs.org/@aws-sdk/client-comprehendmedical-browser/-/client-comprehendmedical-browser-0.1.0-preview.5.tgz","fileCount":140,"integrity":"sha512-NgmwARG071R/vZCZczIkbViP8KfUMbpNxXrErgHQW1Pqlzgv7HdVVpaz4j2hvNl4xNT/VMQOaTyleusDsqTuyg==","signatures":[{"sig":"MEUCIQCIMXaULvaZce3XfrLRxwtnj/LAMCTkiVIysaqHqtJxNwIgORnmwmc7a74KULq9vWTb7OY5RpIXWvvGqF0mSLGkszs=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":96997,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdueFvCRA9TVsSAnZWagAAFswQAKJkeut9U4cuzojpl5bA\n+I8Dxg0bRdVJ0V7LB06sbTlGnh1ZVWd9CjBY0+ju6dcdF2Z6TM/laoQxku8U\n9AXfOvKq3oGtiWNTTajfMzBrCWksarlancdW42l07Cwi90svlSAdD+mAPIM8\nl425kpUOGP5ljLVRC9/quG8hYBrs0EGvrWFXmc8mzPazuwELsgyuQwAnGj5O\nCpdBugaZLz0OrZf9znGWkti9ii3ZIa8YZI9zfi+utR8MEvYYkdnqflH68eoz\nYI+tgXI1dGYZwcL8OR0ZYC5RJCBu6QfHARdFxK98M/fbiHWr59MHZsQuq5jM\nkX4EujtbJi632zhxvaosKm6uXId9Ol7GPETj5G+1Qh8aN+NA9XBFrMNX92/N\ncTbntetnZDAEuhdaqTx7UXa57gnnJcD84ri1FNIjY1yeoXidCo6+UaIiKCuV\nba7uQ+urvee1eHmuG0HWRb7sHexmuKUJ0zXVeY6GqUhCatoYP4ddwtVLv6Pu\nmGb3MZTi2rySCLubDGebEqJpu34fGvxR7C2oJDLQTWaOkjhsS8Pw1lpyMwWu\nuanWDpghi7h+EsJ/iLZQLyc+A/2qeBTcvASB8gxw1z1X3LRDyva3ZBxjSElb\nfu6QIxGk/LIdj4OTuwp35DGbJ1a3xE4EComGPSRBWAEYj1MvDfKbkPmYzHP9\ndUku\r\n=88tO\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-comprehendmedical-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n\n## Description\n\nComprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-comprehendmedical-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`ComprehendMedicalClient`) and the commands you need, for example `DetectEntitiesCommand`:\n\n```javascript\n//JavaScript\nconst {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} = require(\"@aws-sdk/client-comprehendmedical-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} from \"@aws-sdk/client-comprehendmedical-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst comprehendMedical = new ComprehendMedicalClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n Text: /**a string value*/,\n};\nconst detectEntitiesCommand = new DetectEntitiesCommand(params);\ncomprehendMedical.send(detectEntitiesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncomprehendMedical.send(detectEntitiesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-comprehendmedical-browser\";\nconst comprehendMedical = new AWS.ComprehendMedical({ region: \"region\" });\ncomprehendMedical.detectEntities(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-comprehendmedical-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-comprehendmedical-browser has been renamed to @aws-sdk/client-comprehendmedical. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Comprehend Medical","directories":{},"_nodeVersion":"10.1.0","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.9","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.8","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.7","@aws-sdk/signing-middleware":"^0.1.0-preview.9","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.8","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-comprehendmedical-browser_0.1.0-preview.5_1572462958509_0.3487068058478744","host":"s3://npm-registry-packages"}},"0.1.0-preview.6":{"name":"@aws-sdk/client-comprehendmedical-browser","version":"0.1.0-preview.6","author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","_id":"@aws-sdk/client-comprehendmedical-browser@0.1.0-preview.6","maintainers":[{"name":"amzn-oss","email":"osa-3p@amazon.com"},{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},{"name":"trivikr-aws","email":"trivikr@amazon.com"},{"name":"zheallan","email":"zheallan@amazon.com"}],"dist":{"shasum":"d9b0d31ccd1617d8415d445d6e1cf484fad0d2e3","tarball":"https://registry.npmjs.org/@aws-sdk/client-comprehendmedical-browser/-/client-comprehendmedical-browser-0.1.0-preview.6.tgz","fileCount":140,"integrity":"sha512-pw/qCBummnl78zXN0/NhE3R49xmohQ7/YYr7iOrn7NdbdF2G6/aXVSrhm7TO4Iqf7poI9m2MzX/jNm9qaX6r8w==","signatures":[{"sig":"MEYCIQDz8MmxkMuqsjQ2Xhh/35FbaBP1j83GbtSEnKHbpxqZLgIhAOw6yDQ1Zjoe7xbgV35XbJJHOhQgN7B575O5Rl7nmqzc","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":97267,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJd1FMdCRA9TVsSAnZWagAAUMkP/A6xvhYLx2Y3KoYU3LW4\nJ15IGELgZ9kJx9aeBVTx/09Ivco597Pj3LgdE0x6SSAfa7j6XVsCG3fuQ1bV\nrKsow0PvSC88/o7x1CgcfgL/6/5pQIcRNru9PhJukt+LbmsMPd/77QnRLOx7\noS2uMuOpbeoGf8vmh1PGbXQQ0HV0htqD5JRg4Zaa7AtofJEFCpoNz7Y/J3Za\nIK9D53nuot56uGBksLmFu/aBxRasgTulT9uWaufU9aL1WvWPEMcwOc0aHNFG\n8FZIeaoPNwwM5m9PdHUxyqbzdllwkpLy5Rqxz4o3Y+4ney3RD5d2tDFPPXzs\nFdm079ORPZ8kE9IeVe3rnkMlm19eDv/HWYIjwW9Qym3KOxGFKLQB3ML/L3fW\nueW0XhYv+i4wo2mPE9oVvYsy0FhXNzibvM854ADY/ytQtvV7b6NdS8gZx68D\nIyXyw0TEE93xkIuyosp83ddk+IxDKcGss9ODMv3OC4iiaI0wMaohV72WnKtu\nBvRaLIyBx6kA5BfTFU7dx7rbvdYLs7X3INqjmv47hAoR5iO4MPvUf6uYNzsM\nWHhBQ/AYm9wtlzfv7+x+geZCJBnYJaFKcip3o6qYegBykR7Z3PB1+iuxZuf8\nCyaXmk3cu9qImgl5VG+3F+lVTdSofQaDqgKH0vknUV13t0Sg5ZaV0kBPVdZT\n8s7t\r\n=1RGR\r\n-----END PGP SIGNATURE-----\r\n"},"main":"./index.js","types":"./index.d.ts","readme":"# @aws-sdk/client-comprehendmedical-browser\n\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n[](https://www.npmjs.com/package/@aws-sdk/client-comprehendmedical-browser)\n\n## Description\n\nComprehend Medical extracts structured information from unstructured clinical text. Use these actions to gain insight in your documents.
\n\n## Installing\n\nTo install the this package using NPM, simply type the following into a terminal window:\n\n```\nnpm install @aws-sdk/client-comprehendmedical-browser\n```\n\n## Getting Started\n\n### Import\n\nThe AWS SDK is modulized by clients and commands in CommonJS modules. To send a request, you only need to import the client(`ComprehendMedicalClient`) and the commands you need, for example `DetectEntitiesCommand`:\n\n```javascript\n//JavaScript\nconst {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} = require(\"@aws-sdk/client-comprehendmedical-browser\");\n```\n\n```javascript\n//TypeScript\nimport {\n ComprehendMedicalClient,\n DetectEntitiesCommand\n} from \"@aws-sdk/client-comprehendmedical-browser\";\n```\n\n### Usage\n\nTo send a request, you:\n\n- Initiate client with configuration (e.g. credentials, region). For more information you can refer to the [API reference][].\n- Initiate command with input parameters.\n- Call `send` operation on client with command object as input.\n- If you are using a custom http handler, you may call `destroy()` to close open connections.\n\n```javascript\nconst comprehendMedical = new ComprehendMedicalClient({region: 'region'});\n//clients can be shared by different commands\nconst params = {\n Text: /**a string value*/,\n};\nconst detectEntitiesCommand = new DetectEntitiesCommand(params);\ncomprehendMedical.send(detectEntitiesCommand).then(data => {\n // do something\n}).catch(error => {\n // error handling\n})\n```\n\nIn addition to using promises, there are 2 other ways to send a request:\n\n```javascript\n// async/await\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n // error handling\n}\n```\n\n```javascript\n// callback\ncomprehendMedical.send(detectEntitiesCommand, (err, data) => {\n //do something\n});\n```\n\nThe SDK can also send requests using the simplified callback style from version 2 of the SDK.\n\n```javascript\nimport * as AWS from \"@aws-sdk/client-comprehendmedical-browser\";\nconst comprehendMedical = new AWS.ComprehendMedical({ region: \"region\" });\ncomprehendMedical.detectEntities(params, (err, data) => {\n //do something\n});\n```\n\n### Troubleshooting\n\nWhen the service returns an exception, the error will include the exception information, as well as response metadata (e.g. request id).\n\n```javascript\ntry {\n const data = await comprehendMedical.send(detectEntitiesCommand);\n // do something\n} catch (error) {\n const metadata = error.$metadata;\n console.log(\n `requestId: ${metadata.requestId}\ncfId: ${metadata.cfId}\nextendedRequestId: ${metadata.extendedRequestId}`\n );\n /*\nThe keys within exceptions are also parsed. You can access them by specifying exception names:\n if(error.name === 'SomeServiceException') {\n const value = error.specialKeyInException;\n }\n*/\n}\n```\n\n## Getting Help\n\nPlease use these community resources for getting help. We use the GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.\n\n- Ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/aws-sdk-js) and tag it with `aws-sdk-js`\n- Come join the AWS JavaScript community on [gitter](https://gitter.im/aws/aws-sdk-js-v3)\n- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-sdk-js-v3/issues)\n\n## Contributing\n\nThis client code is generated automatically. Any modifications will be overwritten the next time the `@aws-sdk/@aws-sdk/client-comprehendmedical-browser' package is updated. To contribute to SDK you can checkout our [code generator package][].\n\n## License\n\nThis SDK is distributed under the\n[Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0),\nsee LICENSE for more information.\n\n[code generator package]: https://github.com/aws/aws-sdk-js-v3/tree/master/packages/service-types-generator\n[api reference]: https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/\n","scripts":{"test":"exit 0","clean":"npm run remove-definitions && npm run remove-maps && npm run remove-js","pretest":"tsc","remove-js":"rimraf *.js && rimraf ./commands/*.js && rimraf ./model/*.js && rimraf ./types/*.js","smoke-test":"karma start karma.conf","remove-maps":"rimraf *.js.map && rimraf ./commands/*.js.map && rimraf ./model/*.js.map && rimraf ./types/*.js.map","prepublishOnly":"tsc","remove-definitions":"rimraf *.d.ts && rimraf ./commands/*.d.ts && rimraf ./model/*.d.ts rimraf ./types/*.d.ts","build-documentation":"npm run clean && typedoc ./","remove-documentation":"rimraf ./docs"},"_npmUser":{"name":"aws-sdk-bot","email":"aws-sdk-js@amazon.com"},"deprecated":"The package @aws-sdk/client-comprehendmedical-browser has been renamed to @aws-sdk/client-comprehendmedical. Please install the renamed package.","_npmVersion":"6.9.0","description":"Browser SDK for AWS Comprehend Medical","directories":{},"_nodeVersion":"10.16.3","dependencies":{"tslib":"^1.8.0","@aws-sdk/types":"^0.1.0-preview.7","@aws-sdk/json-parser":"^0.1.0-preview.7","@aws-sdk/core-handler":"^0.1.0-preview.7","@aws-sdk/json-builder":"^0.1.0-preview.7","@aws-sdk/signature-v4":"^0.1.0-preview.10","@aws-sdk/config-resolver":"^0.1.0-preview.7","@aws-sdk/middleware-stack":"^0.1.0-preview.9","@aws-sdk/retry-middleware":"^0.1.0-preview.7","@aws-crypto/sha256-browser":"^0.1.0-preview.1","@aws-sdk/protocol-json-rpc":"^0.1.0-preview.8","@aws-sdk/util-utf8-browser":"^0.1.0-preview.3","@aws-sdk/fetch-http-handler":"^0.1.0-preview.8","@aws-sdk/signing-middleware":"^0.1.0-preview.10","@aws-sdk/url-parser-browser":"^0.1.0-preview.7","@aws-sdk/util-base64-browser":"^0.1.0-preview.3","@aws-sdk/middleware-serializer":"^0.1.0-preview.7","@aws-sdk/json-error-unmarshaller":"^0.1.0-preview.8","@aws-sdk/util-user-agent-browser":"^0.1.0-preview.9","@aws-sdk/stream-collector-browser":"^0.1.0-preview.7","@aws-sdk/util-body-length-browser":"^0.1.0-preview.3","@aws-sdk/middleware-content-length":"^0.1.0-preview.7","@aws-sdk/middleware-header-default":"^0.1.0-preview.7"},"_hasShrinkwrap":false,"readmeFilename":"README.md","devDependencies":{"rimraf":"^2.6.2","typedoc":"^0.14.2","typescript":"~3.4.0","@aws-sdk/client-documentation-generator":"^0.1.0-preview.3"},"_npmOperationalInternal":{"tmp":"tmp/client-comprehendmedical-browser_0.1.0-preview.6_1574195996622_0.3211968217118164","host":"s3://npm-registry-packages"}}},"time":{"created":"2019-09-09T17:39:37.798Z","modified":"2025-03-27T18:37:26.110Z","0.1.0-preview.2":"2019-09-09T17:39:38.149Z","0.1.0-preview.3":"2019-09-19T15:48:56.503Z","0.1.0-preview.4":"2019-10-29T23:43:03.727Z","0.1.0-preview.5":"2019-10-30T19:15:58.621Z","0.1.0-preview.6":"2019-11-19T20:39:56.719Z"},"author":{"url":"https://aws.amazon.com/javascript/","name":"AWS SDK for JavaScript Team"},"license":"Apache-2.0","description":"Browser SDK for AWS Comprehend Medical","maintainers":[{"email":"osa-3p@amazon.com","name":"amzn-oss"},{"email":"aws-sdk-js-automation@amazon.com","name":"aws-sdk-bot"}],"readme":"","readmeFilename":""}