# frozen_string_literal: true # WARNING ABOUT GENERATED CODE # # This file is generated. See the contributing guide for more information: # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md # # WARNING ABOUT GENERATED CODE module Aws::ComprehendMedical module Types # An extracted segment of the text that is an attribute of an entity, or # otherwise related to an entity, such as the dosage of a medication # taken. It contains information about the attribute such as id, begin # and end offset within the input text, and the segment of the input # text. # # @!attribute [rw] type # The type of attribute. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # segment of text is correctly recognized as an attribute. # @return [Float] # # @!attribute [rw] relationship_score # The level of confidence that Amazon Comprehend Medical has that this # attribute is correctly related to this entity. # @return [Float] # # @!attribute [rw] relationship_type # The type of relationship between the entity and attribute. Type for # the relationship is `OVERLAP`, indicating that the entity occurred # at the same time as the `Date_Expression`. # @return [String] # # @!attribute [rw] id # The numeric identifier for this attribute. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # attribute begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # attribute ends. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] text # The segment of input text extracted as this attribute. # @return [String] # # @!attribute [rw] category # The category of attribute. # @return [String] # # @!attribute [rw] traits # Contextual information for this attribute. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Attribute AWS API Documentation # class Attribute < Struct.new( :type, :score, :relationship_score, :relationship_type, :id, :begin_offset, :end_offset, :text, :category, :traits) SENSITIVE = [] include Aws::Structure end # The number of characters in the input text to be analyzed. # # @!attribute [rw] original_text_characters # The number of characters present in the input text document as # processed by Amazon Comprehend Medical. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Characters AWS API Documentation # class Characters < Struct.new( :original_text_characters) SENSITIVE = [] include Aws::Structure end # Provides information for filtering a list of detection jobs. # # @!attribute [rw] job_name # Filters on the name of the job. # @return [String] # # @!attribute [rw] job_status # Filters the list of jobs based on job status. Returns only jobs with # the specified status. # @return [String] # # @!attribute [rw] submit_time_before # Filters the list of jobs based on the time that the job was # submitted for processing. Returns only jobs submitted before the # specified time. Jobs are returned in ascending order, oldest to # newest. # @return [Time] # # @!attribute [rw] submit_time_after # Filters the list of jobs based on the time that the job was # submitted for processing. Returns only jobs submitted after the # specified time. Jobs are returned in descending order, newest to # oldest. # @return [Time] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobFilter AWS API Documentation # class ComprehendMedicalAsyncJobFilter < Struct.new( :job_name, :job_status, :submit_time_before, :submit_time_after) SENSITIVE = [] include Aws::Structure end # Provides information about a detection job. # # @!attribute [rw] job_id # The identifier assigned to the detection job. # @return [String] # # @!attribute [rw] job_name # The name that you assigned to the detection job. # @return [String] # # @!attribute [rw] job_status # The current status of the detection job. If the status is `FAILED`, # the `Message` field shows the reason for the failure. # @return [String] # # @!attribute [rw] message # A description of the status of a job. # @return [String] # # @!attribute [rw] submit_time # The time that the detection job was submitted for processing. # @return [Time] # # @!attribute [rw] end_time # The time that the detection job completed. # @return [Time] # # @!attribute [rw] expiration_time # The date and time that job metadata is deleted from the server. # Output files in your S3 bucket will not be deleted. After the # metadata is deleted, the job will no longer appear in the results of # the `ListEntitiesDetectionV2Job` or the `ListPHIDetectionJobs` # operation. # @return [Time] # # @!attribute [rw] input_data_config # The input data configuration that you supplied when you created the # detection job. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # The output data configuration that you supplied when you created the # detection job. # @return [Types::OutputDataConfig] # # @!attribute [rw] language_code # The language code of the input documents. # @return [String] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) that gives Amazon Comprehend Medical # read access to your input data. # @return [String] # # @!attribute [rw] manifest_file_path # The path to the file that describes the results of a batch job. # @return [String] # # @!attribute [rw] kms_key # The AWS Key Management Service key, if any, used to encrypt the # output files. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents. The version # number looks like X.X.X. You can use this information to track the # model used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ComprehendMedicalAsyncJobProperties AWS API Documentation # class ComprehendMedicalAsyncJobProperties < Struct.new( :job_id, :job_name, :job_status, :message, :submit_time, :end_time, :expiration_time, :input_data_config, :output_data_config, :language_code, :data_access_role_arn, :manifest_file_path, :kms_key, :model_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier that Amazon Comprehend Medical generated for the job. # The `StartEntitiesDetectionV2Job` operation returns this identifier # in its response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobRequest AWS API Documentation # class DescribeEntitiesDetectionV2JobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties # An object that contains the properties associated with a detection # job. # @return [Types::ComprehendMedicalAsyncJobProperties] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeEntitiesDetectionV2JobResponse AWS API Documentation # class DescribeEntitiesDetectionV2JobResponse < Struct.new( :comprehend_medical_async_job_properties) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier that Amazon Comprehend Medical generated for the job. # `The StartICD10CMInferenceJob` operation returns this identifier in # its response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJobRequest AWS API Documentation # class DescribeICD10CMInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties # An object that contains the properties associated with a detection # job. # @return [Types::ComprehendMedicalAsyncJobProperties] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeICD10CMInferenceJobResponse AWS API Documentation # class DescribeICD10CMInferenceJobResponse < Struct.new( :comprehend_medical_async_job_properties) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier that Amazon Comprehend Medical generated for the job. # The `StartPHIDetectionJob` operation returns this identifier in its # response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobRequest AWS API Documentation # class DescribePHIDetectionJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties # An object that contains the properties associated with a detection # job. # @return [Types::ComprehendMedicalAsyncJobProperties] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribePHIDetectionJobResponse AWS API Documentation # class DescribePHIDetectionJobResponse < Struct.new( :comprehend_medical_async_job_properties) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier that Amazon Comprehend Medical generated for the job. # The StartRxNormInferenceJob operation returns this identifier in its # response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJobRequest AWS API Documentation # class DescribeRxNormInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties # An object that contains the properties associated with a detection # job. # @return [Types::ComprehendMedicalAsyncJobProperties] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeRxNormInferenceJobResponse AWS API Documentation # class DescribeRxNormInferenceJobResponse < Struct.new( :comprehend_medical_async_job_properties) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier that Amazon Comprehend Medical generated for the job. # The StartSNOMEDCTInferenceJob operation returns this identifier in # its response. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJobRequest AWS API Documentation # class DescribeSNOMEDCTInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties # Provides information about a detection job. # @return [Types::ComprehendMedicalAsyncJobProperties] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DescribeSNOMEDCTInferenceJobResponse AWS API Documentation # class DescribeSNOMEDCTInferenceJobResponse < Struct.new( :comprehend_medical_async_job_properties) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # A UTF-8 text string containing the clinical content being examined # for entities. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesRequest AWS API Documentation # class DetectEntitiesRequest < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The collection of medical entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins # and ends, and the level of confidence that Amazon Comprehend Medical # has in the detection and analysis. Attributes and traits of the # entity are also returned. # @return [Array] # # @!attribute [rw] unmapped_attributes # Attributes extracted from the input text that we were unable to # relate to an entity. # @return [Array] # # @!attribute [rw] pagination_token # If the result of the previous request to `DetectEntities` was # truncated, include the `PaginationToken` to fetch the next page of # entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents. The version # number looks like X.X.X. You can use this information to track the # model used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesResponse AWS API Documentation # class DetectEntitiesResponse < Struct.new( :entities, :unmapped_attributes, :pagination_token, :model_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # A UTF-8 string containing the clinical content being examined for # entities. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Request AWS API Documentation # class DetectEntitiesV2Request < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The collection of medical entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins # and ends, and the level of confidence in the detection and analysis. # Attributes and traits of the entity are also returned. # @return [Array] # # @!attribute [rw] unmapped_attributes # Attributes extracted from the input text that couldn't be related # to an entity. # @return [Array] # # @!attribute [rw] pagination_token # If the result to the `DetectEntitiesV2` operation was truncated, # include the `PaginationToken` to fetch the next page of entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents. The version # number looks like X.X.X. You can use this information to track the # model used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectEntitiesV2Response AWS API Documentation # class DetectEntitiesV2Response < Struct.new( :entities, :unmapped_attributes, :pagination_token, :model_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # A UTF-8 text string containing the clinical content being examined # for PHI entities. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIRequest AWS API Documentation # class DetectPHIRequest < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The collection of PHI entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins # and ends, and the level of confidence that Amazon Comprehend Medical # has in its detection. # @return [Array] # # @!attribute [rw] pagination_token # If the result of the previous request to `DetectPHI` was truncated, # include the `PaginationToken` to fetch the next page of PHI # entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents. The version # number looks like X.X.X. You can use this information to track the # model used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/DetectPHIResponse AWS API Documentation # class DetectPHIResponse < Struct.new( :entities, :pagination_token, :model_version) SENSITIVE = [] include Aws::Structure end # Provides information about an extracted medical entity. # # @!attribute [rw] id # The numeric identifier for the entity. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # entity begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # entity ends. The offset returns the UTF-8 code point in the string. # @return [Integer] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of the detection. # @return [Float] # # @!attribute [rw] text # The segment of input text extracted as this entity. # @return [String] # # @!attribute [rw] category # The category of the entity. # @return [String] # # @!attribute [rw] type # Describes the specific type of entity with category of entities. # @return [String] # # @!attribute [rw] traits # Contextual information for the entity. # @return [Array] # # @!attribute [rw] attributes # The extracted attributes that relate to this entity. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Entity AWS API Documentation # class Entity < Struct.new( :id, :begin_offset, :end_offset, :score, :text, :category, :type, :traits, :attributes) SENSITIVE = [] include Aws::Structure end # The detected attributes that relate to an entity. This includes an # extracted segment of the text that is an attribute of an entity, or # otherwise related to an entity. InferICD10CM detects the following # attributes: `Direction`, `System, Organ or Site`, and `Acuity`. # # @!attribute [rw] type # The type of attribute. InferICD10CM detects entities of the type # `DX_NAME`. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # segment of text is correctly recognized as an attribute. # @return [Float] # # @!attribute [rw] relationship_score # The level of confidence that Amazon Comprehend Medical has that this # attribute is correctly related to this entity. # @return [Float] # # @!attribute [rw] id # The numeric identifier for this attribute. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # attribute begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # attribute ends. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] text # The segment of input text which contains the detected attribute. # @return [String] # # @!attribute [rw] traits # The contextual information for the attribute. The traits recognized # by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`. # @return [Array] # # @!attribute [rw] category # The category of attribute. Can be either of `DX_NAME` or # `TIME_EXPRESSION`. # @return [String] # # @!attribute [rw] relationship_type # The type of relationship between the entity and attribute. Type for # the relationship can be either of `OVERLAP` or `SYSTEM_ORGAN_SITE`. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMAttribute AWS API Documentation # class ICD10CMAttribute < Struct.new( :type, :score, :relationship_score, :id, :begin_offset, :end_offset, :text, :traits, :category, :relationship_type) SENSITIVE = [] include Aws::Structure end # The ICD-10-CM concepts that the entity could refer to, along with a # score indicating the likelihood of the match. # # @!attribute [rw] description # The long description of the ICD-10-CM code in the ontology. # @return [String] # # @!attribute [rw] code # The ICD-10-CM code that identifies the concept found in the # knowledge base from the Centers for Disease Control. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # entity is accurately linked to an ICD-10-CM concept. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMConcept AWS API Documentation # class ICD10CMConcept < Struct.new( :description, :code, :score) SENSITIVE = [] include Aws::Structure end # The collection of medical entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins and # ends, and the level of confidence that Amazon Comprehend Medical has # in the detection and analysis. Attributes and traits of the entity are # also returned. # # @!attribute [rw] id # The numeric identifier for the entity. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] text # The segment of input text that is matched to the detected entity. # @return [String] # # @!attribute [rw] category # The category of the entity. InferICD10CM detects entities in the # `MEDICAL_CONDITION` category. # @return [String] # # @!attribute [rw] type # Describes the specific type of entity with category of entities. # InferICD10CM detects entities of the type `DX_NAME` and # `TIME_EXPRESSION`. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of the detection. # @return [Float] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # entity begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # entity ends. The offset returns the UTF-8 code point in the string. # @return [Integer] # # @!attribute [rw] attributes # The detected attributes that relate to the entity. An extracted # segment of the text that is an attribute of an entity, or otherwise # related to an entity, such as the nature of a medical condition. # @return [Array] # # @!attribute [rw] traits # Provides Contextual information for the entity. The traits # recognized by InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and # `NEGATION.` # @return [Array] # # @!attribute [rw] icd10cm_concepts # The ICD-10-CM concepts that the entity could refer to, along with a # score indicating the likelihood of the match. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMEntity AWS API Documentation # class ICD10CMEntity < Struct.new( :id, :text, :category, :type, :score, :begin_offset, :end_offset, :attributes, :traits, :icd10cm_concepts) SENSITIVE = [] include Aws::Structure end # Contextual information for the entity. The traits recognized by # InferICD10CM are `DIAGNOSIS`, `SIGN`, `SYMPTOM`, and `NEGATION`. # # @!attribute [rw] name # Provides a name or contextual description about the trait. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # segment of text is correctly recognized as a trait. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ICD10CMTrait AWS API Documentation # class ICD10CMTrait < Struct.new( :name, :score) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # The input text used for analysis. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMRequest AWS API Documentation # class InferICD10CMRequest < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The medical conditions detected in the text linked to ICD-10-CM # concepts. If the action is successful, the service sends back an # HTTP 200 response, as well as the entities detected. # @return [Array] # # @!attribute [rw] pagination_token # If the result of the previous request to `InferICD10CM` was # truncated, include the `PaginationToken` to fetch the next page of # medical condition entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents, in the # format *n*.*n*.*n* You can use this information to track the model # used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferICD10CMResponse AWS API Documentation # class InferICD10CMResponse < Struct.new( :entities, :pagination_token, :model_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # The input text used for analysis. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormRequest AWS API Documentation # class InferRxNormRequest < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The medication entities detected in the text linked to RxNorm # concepts. If the action is successful, the service sends back an # HTTP 200 response, as well as the entities detected. # @return [Array] # # @!attribute [rw] pagination_token # If the result of the previous request to `InferRxNorm` was # truncated, include the `PaginationToken` to fetch the next page of # medication entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents, in the # format *n*.*n*.*n* You can use this information to track the model # used for a particular batch of documents. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferRxNormResponse AWS API Documentation # class InferRxNormResponse < Struct.new( :entities, :pagination_token, :model_version) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] text # The input text to be analyzed using InferSNOMEDCT. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCTRequest AWS API Documentation # class InferSNOMEDCTRequest < Struct.new( :text) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] entities # The collection of medical concept entities extracted from the input # text and their associated information. For each entity, the response # provides the entity text, the entity category, where the entity text # begins and ends, and the level of confidence that Amazon Comprehend # Medical has in the detection and analysis. Attributes and traits of # the entity are also returned. # @return [Array] # # @!attribute [rw] pagination_token # If the result of the request is truncated, the pagination token can # be used to fetch the next page of entities. # @return [String] # # @!attribute [rw] model_version # The version of the model used to analyze the documents, in the # format n.n.n You can use this information to track the model used # for a particular batch of documents. # @return [String] # # @!attribute [rw] snomedct_details # The details of the SNOMED-CT revision, including the edition, # language, and version date. # @return [Types::SNOMEDCTDetails] # # @!attribute [rw] characters # The number of characters in the input request documentation. # @return [Types::Characters] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InferSNOMEDCTResponse AWS API Documentation # class InferSNOMEDCTResponse < Struct.new( :entities, :pagination_token, :model_version, :snomedct_details, :characters) SENSITIVE = [] include Aws::Structure end # The input properties for an entities detection job. This includes the # name of the S3 bucket and the path to the files to be analyzed. # # @!attribute [rw] s3_bucket # The URI of the S3 bucket that contains the input data. The bucket # must be in the same region as the API endpoint that you are calling. # @return [String] # # @!attribute [rw] s3_key # The path to the input data files in the S3 bucket. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InputDataConfig AWS API Documentation # class InputDataConfig < Struct.new( :s3_bucket, :s3_key) SENSITIVE = [] include Aws::Structure end # An internal server error occurred. Retry your request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InternalServerException AWS API Documentation # class InternalServerException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The input text was not in valid UTF-8 character encoding. Check your # text then retry your request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidEncodingException AWS API Documentation # class InvalidEncodingException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The request that you made is invalid. Check your request to determine # why it's invalid and then retry the request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/InvalidRequestException AWS API Documentation # class InvalidRequestException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] filter # Filters the jobs that are returned. You can filter jobs based on # their names, status, or the date and time that they were submitted. # You can only set one filter at a time. # @return [Types::ComprehendMedicalAsyncJobFilter] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return in each page. The default is # 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsRequest AWS API Documentation # class ListEntitiesDetectionV2JobsRequest < Struct.new( :filter, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties_list # A list containing the properties of each job returned. # @return [Array] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListEntitiesDetectionV2JobsResponse AWS API Documentation # class ListEntitiesDetectionV2JobsResponse < Struct.new( :comprehend_medical_async_job_properties_list, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] filter # Filters the jobs that are returned. You can filter jobs based on # their names, status, or the date and time that they were submitted. # You can only set one filter at a time. # @return [Types::ComprehendMedicalAsyncJobFilter] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return in each page. The default is # 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobsRequest AWS API Documentation # class ListICD10CMInferenceJobsRequest < Struct.new( :filter, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties_list # A list containing the properties of each job that is returned. # @return [Array] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListICD10CMInferenceJobsResponse AWS API Documentation # class ListICD10CMInferenceJobsResponse < Struct.new( :comprehend_medical_async_job_properties_list, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] filter # Filters the jobs that are returned. You can filter jobs based on # their names, status, or the date and time that they were submitted. # You can only set one filter at a time. # @return [Types::ComprehendMedicalAsyncJobFilter] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return in each page. The default is # 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsRequest AWS API Documentation # class ListPHIDetectionJobsRequest < Struct.new( :filter, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties_list # A list containing the properties of each job returned. # @return [Array] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListPHIDetectionJobsResponse AWS API Documentation # class ListPHIDetectionJobsResponse < Struct.new( :comprehend_medical_async_job_properties_list, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] filter # Filters the jobs that are returned. You can filter jobs based on # their names, status, or the date and time that they were submitted. # You can only set one filter at a time. # @return [Types::ComprehendMedicalAsyncJobFilter] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @!attribute [rw] max_results # Identifies the next page of results to return. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobsRequest AWS API Documentation # class ListRxNormInferenceJobsRequest < Struct.new( :filter, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties_list # The maximum number of results to return in each page. The default is # 100. # @return [Array] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListRxNormInferenceJobsResponse AWS API Documentation # class ListRxNormInferenceJobsResponse < Struct.new( :comprehend_medical_async_job_properties_list, :next_token) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] filter # Provides information for filtering a list of detection jobs. # @return [Types::ComprehendMedicalAsyncJobFilter] # # @!attribute [rw] next_token # Identifies the next page of InferSNOMEDCT results to return. # @return [String] # # @!attribute [rw] max_results # The maximum number of results to return in each page. The default is # 100. # @return [Integer] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobsRequest AWS API Documentation # class ListSNOMEDCTInferenceJobsRequest < Struct.new( :filter, :next_token, :max_results) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] comprehend_medical_async_job_properties_list # A list containing the properties of each job that is returned. # @return [Array] # # @!attribute [rw] next_token # Identifies the next page of results to return. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ListSNOMEDCTInferenceJobsResponse AWS API Documentation # class ListSNOMEDCTInferenceJobsResponse < Struct.new( :comprehend_medical_async_job_properties_list, :next_token) SENSITIVE = [] include Aws::Structure end # The output properties for a detection job. # # @!attribute [rw] s3_bucket # When you use the `OutputDataConfig` object with asynchronous # operations, you specify the Amazon S3 location where you want to # write the output data. The URI must be in the same region as the API # endpoint that you are calling. The location is used as the prefix # for the actual location of the output. # @return [String] # # @!attribute [rw] s3_key # The path to the output data files in the S3 bucket. Amazon # Comprehend Medical creates an output directory using the job ID so # that the output from one job does not overwrite the output of # another. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/OutputDataConfig AWS API Documentation # class OutputDataConfig < Struct.new( :s3_bucket, :s3_key) SENSITIVE = [] include Aws::Structure end # The resource identified by the specified Amazon Resource Name (ARN) # was not found. Check the ARN and try your request again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ResourceNotFoundException AWS API Documentation # class ResourceNotFoundException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # The extracted attributes that relate to this entity. The attributes # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`, # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`. # # @!attribute [rw] type # The type of attribute. The types of attributes recognized by # InferRxNorm are `BRAND_NAME` and `GENERIC_NAME`. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # segment of text is correctly recognized as an attribute. # @return [Float] # # @!attribute [rw] relationship_score # The level of confidence that Amazon Comprehend Medical has that the # attribute is accurately linked to an entity. # @return [Float] # # @!attribute [rw] id # The numeric identifier for this attribute. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # attribute begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # attribute ends. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] text # The segment of input text which corresponds to the detected # attribute. # @return [String] # # @!attribute [rw] traits # Contextual information for the attribute. InferRxNorm recognizes the # trait `NEGATION` for attributes, i.e. that the patient is not taking # a specific dose or form of a medication. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormAttribute AWS API Documentation # class RxNormAttribute < Struct.new( :type, :score, :relationship_score, :id, :begin_offset, :end_offset, :text, :traits) SENSITIVE = [] include Aws::Structure end # The RxNorm concept that the entity could refer to, along with a score # indicating the likelihood of the match. # # @!attribute [rw] description # The description of the RxNorm concept. # @return [String] # # @!attribute [rw] code # RxNorm concept ID, also known as the RxCUI. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # entity is accurately linked to the reported RxNorm concept. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormConcept AWS API Documentation # class RxNormConcept < Struct.new( :description, :code, :score) SENSITIVE = [] include Aws::Structure end # The collection of medical entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins and # ends, and the level of confidence that Amazon Comprehend Medical has # in the detection and analysis. Attributes and traits of the entity are # also returned. # # @!attribute [rw] id # The numeric identifier for the entity. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] text # The segment of input text extracted from which the entity was # detected. # @return [String] # # @!attribute [rw] category # The category of the entity. The recognized categories are `GENERIC` # or `BRAND_NAME`. # @return [String] # # @!attribute [rw] type # Describes the specific type of entity. For InferRxNorm, the # recognized entity type is `MEDICATION`. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of the detected entity. # @return [Float] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # entity begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # entity ends. The offset returns the UTF-8 code point in the string. # @return [Integer] # # @!attribute [rw] attributes # The extracted attributes that relate to the entity. The attributes # recognized by InferRxNorm are `DOSAGE`, `DURATION`, `FORM`, # `FREQUENCY`, `RATE`, `ROUTE_OR_MODE`, and `STRENGTH`. # @return [Array] # # @!attribute [rw] traits # Contextual information for the entity. # @return [Array] # # @!attribute [rw] rx_norm_concepts # The RxNorm concepts that the entity could refer to, along with a # score indicating the likelihood of the match. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormEntity AWS API Documentation # class RxNormEntity < Struct.new( :id, :text, :category, :type, :score, :begin_offset, :end_offset, :attributes, :traits, :rx_norm_concepts) SENSITIVE = [] include Aws::Structure end # The contextual information for the entity. InferRxNorm recognizes the # trait `NEGATION`, which is any indication that the patient is not # taking a medication. # # @!attribute [rw] name # Provides a name or contextual description about the trait. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of the detected trait. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/RxNormTrait AWS API Documentation # class RxNormTrait < Struct.new( :name, :score) SENSITIVE = [] include Aws::Structure end # The extracted attributes that relate to an entity. An extracted # segment of the text that is an attribute of an entity, or otherwise # related to an entity, such as the dosage of a medication taken. # # @!attribute [rw] category # The category of the detected attribute. Possible categories include # MEDICAL\_CONDITION, ANATOMY, and TEST\_TREATMENT\_PROCEDURE. # @return [String] # # @!attribute [rw] type # The type of attribute. Possible types include DX\_NAME, ACUITY, # DIRECTION, SYSTEM\_ORGAN\_SITE,TEST\_NAME, TEST\_VALUE, TEST\_UNIT, # PROCEDURE\_NAME, and TREATMENT\_NAME. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has that the # segment of text is correctly recognized as an attribute. # @return [Float] # # @!attribute [rw] relationship_score # The level of confidence that Amazon Comprehend Medical has that this # attribute is correctly related to this entity. # @return [Float] # # @!attribute [rw] relationship_type # The type of relationship that exists between the entity and the # related attribute. # @return [String] # # @!attribute [rw] id # The numeric identifier for this attribute. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # attribute begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # attribute ends. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] text # The segment of input text extracted as this attribute. # @return [String] # # @!attribute [rw] traits # Contextual information for an attribute. Examples include signs, # symptoms, diagnosis, and negation. # @return [Array] # # @!attribute [rw] snomedct_concepts # The SNOMED-CT concepts specific to an attribute, along with a score # indicating the likelihood of the match. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTAttribute AWS API Documentation # class SNOMEDCTAttribute < Struct.new( :category, :type, :score, :relationship_score, :relationship_type, :id, :begin_offset, :end_offset, :text, :traits, :snomedct_concepts) SENSITIVE = [] include Aws::Structure end # The SNOMED-CT concepts that the entity could refer to, along with a # score indicating the likelihood of the match. # # @!attribute [rw] description # The description of the SNOMED-CT concept. # @return [String] # # @!attribute [rw] code # The numeric ID for the SNOMED-CT concept. # @return [String] # # @!attribute [rw] score # The level of confidence Amazon Comprehend Medical has that the # entity should be linked to the identified SNOMED-CT concept. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTConcept AWS API Documentation # class SNOMEDCTConcept < Struct.new( :description, :code, :score) SENSITIVE = [] include Aws::Structure end # The information about the revision of the SNOMED-CT ontology in the # response. Specifically, the details include the SNOMED-CT edition, # language, and version date. # # @!attribute [rw] edition # The edition of SNOMED-CT used. The edition used for the # InferSNOMEDCT editions is the US edition. # @return [String] # # @!attribute [rw] language # The language used in the SNOMED-CT ontology. All Amazon Comprehend # Medical operations are US English (en). # @return [String] # # @!attribute [rw] version_date # The version date of the SNOMED-CT ontology used. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTDetails AWS API Documentation # class SNOMEDCTDetails < Struct.new( :edition, :language, :version_date) SENSITIVE = [] include Aws::Structure end # The collection of medical entities extracted from the input text and # their associated information. For each entity, the response provides # the entity text, the entity category, where the entity text begins and # ends, and the level of confidence that Amazon Comprehend Medical has # in the detection and analysis. Attributes and traits of the entity are # also returned. # # @!attribute [rw] id # The numeric identifier for the entity. This is a monotonically # increasing id unique within this response rather than a global # unique identifier. # @return [Integer] # # @!attribute [rw] text # The segment of input text extracted as this entity. # @return [String] # # @!attribute [rw] category # The category of the detected entity. Possible categories are # MEDICAL\_CONDITION, ANATOMY, or TEST\_TREATMENT\_PROCEDURE. # @return [String] # # @!attribute [rw] type # Describes the specific type of entity with category of entities. # Possible types include DX\_NAME, ACUITY, DIRECTION, # SYSTEM\_ORGAN\_SITE, TEST\_NAME, TEST\_VALUE, TEST\_UNIT, # PROCEDURE\_NAME, or TREATMENT\_NAME. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of the detected entity. # @return [Float] # # @!attribute [rw] begin_offset # The 0-based character offset in the input text that shows where the # entity begins. The offset returns the UTF-8 code point in the # string. # @return [Integer] # # @!attribute [rw] end_offset # The 0-based character offset in the input text that shows where the # entity ends. The offset returns the UTF-8 code point in the string. # @return [Integer] # # @!attribute [rw] attributes # An extracted segment of the text that is an attribute of an entity, # or otherwise related to an entity, such as the dosage of a # medication taken. # @return [Array] # # @!attribute [rw] traits # Contextual information for the entity. # @return [Array] # # @!attribute [rw] snomedct_concepts # The SNOMED concepts that the entity could refer to, along with a # score indicating the likelihood of the match. # @return [Array] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTEntity AWS API Documentation # class SNOMEDCTEntity < Struct.new( :id, :text, :category, :type, :score, :begin_offset, :end_offset, :attributes, :traits, :snomedct_concepts) SENSITIVE = [] include Aws::Structure end # Contextual information for an entity. # # @!attribute [rw] name # The name or contextual description of a detected trait. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of a detected trait. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/SNOMEDCTTrait AWS API Documentation # class SNOMEDCTTrait < Struct.new( :name, :score) SENSITIVE = [] include Aws::Structure end # The Amazon Comprehend Medical service is temporarily unavailable. # Please wait and then retry your request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ServiceUnavailableException AWS API Documentation # class ServiceUnavailableException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] input_data_config # The input configuration that specifies the format and location of # the input data for the job. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # The output configuration that specifies where to send the output # files. # @return [Types::OutputDataConfig] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role that grants Amazon Comprehend Medical read # access to your input data. For more information, see [Role-Based # Permissions Required for Asynchronous Operations][1]. # # # # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med # @return [String] # # @!attribute [rw] job_name # The identifier of the job. # @return [String] # # @!attribute [rw] client_request_token # A unique identifier for the request. If you don't set the client # request token, Amazon Comprehend Medical generates one for you. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] kms_key # An AWS Key Management Service key to encrypt your output files. If # you do not specify a key, the files are written in plain text. # @return [String] # # @!attribute [rw] language_code # The language of the input documents. All documents must be in the # same language. Amazon Comprehend Medical processes files in US # English (en). # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobRequest AWS API Documentation # class StartEntitiesDetectionV2JobRequest < Struct.new( :input_data_config, :output_data_config, :data_access_role_arn, :job_name, :client_request_token, :kms_key, :language_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of a job, # use this identifier with the `DescribeEntitiesDetectionV2Job` # operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartEntitiesDetectionV2JobResponse AWS API Documentation # class StartEntitiesDetectionV2JobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] input_data_config # Specifies the format and location of the input data for the job. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # Specifies where to send the output files. # @return [Types::OutputDataConfig] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role that grants Amazon Comprehend Medical read # access to your input data. For more information, see [ Role-Based # Permissions Required for Asynchronous Operations][1]. # # # # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med # @return [String] # # @!attribute [rw] job_name # The identifier of the job. # @return [String] # # @!attribute [rw] client_request_token # A unique identifier for the request. If you don't set the client # request token, Amazon Comprehend Medical generates one. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] kms_key # An AWS Key Management Service key to encrypt your output files. If # you do not specify a key, the files are written in plain text. # @return [String] # # @!attribute [rw] language_code # The language of the input documents. All documents must be in the # same language. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJobRequest AWS API Documentation # class StartICD10CMInferenceJobRequest < Struct.new( :input_data_config, :output_data_config, :data_access_role_arn, :job_name, :client_request_token, :kms_key, :language_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of a job, # use this identifier with the `StartICD10CMInferenceJob` operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartICD10CMInferenceJobResponse AWS API Documentation # class StartICD10CMInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] input_data_config # Specifies the format and location of the input data for the job. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # Specifies where to send the output files. # @return [Types::OutputDataConfig] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role that grants Amazon Comprehend Medical read # access to your input data. For more information, see [ Role-Based # Permissions Required for Asynchronous Operations][1]. # # # # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med # @return [String] # # @!attribute [rw] job_name # The identifier of the job. # @return [String] # # @!attribute [rw] client_request_token # A unique identifier for the request. If you don't set the client # request token, Amazon Comprehend Medical generates one. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] kms_key # An AWS Key Management Service key to encrypt your output files. If # you do not specify a key, the files are written in plain text. # @return [String] # # @!attribute [rw] language_code # The language of the input documents. All documents must be in the # same language. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobRequest AWS API Documentation # class StartPHIDetectionJobRequest < Struct.new( :input_data_config, :output_data_config, :data_access_role_arn, :job_name, :client_request_token, :kms_key, :language_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of a job, # use this identifier with the `DescribePHIDetectionJob` operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartPHIDetectionJobResponse AWS API Documentation # class StartPHIDetectionJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] input_data_config # Specifies the format and location of the input data for the job. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # Specifies where to send the output files. # @return [Types::OutputDataConfig] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role that grants Amazon Comprehend Medical read # access to your input data. For more information, see [ Role-Based # Permissions Required for Asynchronous Operations][1]. # # # # [1]: https://docs.aws.amazon.com/comprehend/latest/dg/access-control-managing-permissions-med.html#auth-role-permissions-med # @return [String] # # @!attribute [rw] job_name # The identifier of the job. # @return [String] # # @!attribute [rw] client_request_token # A unique identifier for the request. If you don't set the client # request token, Amazon Comprehend Medical generates one. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] kms_key # An AWS Key Management Service key to encrypt your output files. If # you do not specify a key, the files are written in plain text. # @return [String] # # @!attribute [rw] language_code # The language of the input documents. All documents must be in the # same language. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJobRequest AWS API Documentation # class StartRxNormInferenceJobRequest < Struct.new( :input_data_config, :output_data_config, :data_access_role_arn, :job_name, :client_request_token, :kms_key, :language_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartRxNormInferenceJobResponse AWS API Documentation # class StartRxNormInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] input_data_config # The input properties for an entities detection job. This includes # the name of the S3 bucket and the path to the files to be analyzed. # @return [Types::InputDataConfig] # # @!attribute [rw] output_data_config # The output properties for a detection job. # @return [Types::OutputDataConfig] # # @!attribute [rw] data_access_role_arn # The Amazon Resource Name (ARN) of the AWS Identity and Access # Management (IAM) role that grants Amazon Comprehend Medical read # access to your input data. # @return [String] # # @!attribute [rw] job_name # The user generated name the asynchronous InferSNOMEDCT job. # @return [String] # # @!attribute [rw] client_request_token # A unique identifier for the request. If you don't set the client # request token, Amazon Comprehend Medical generates one. # # **A suitable default value is auto-generated.** You should normally # not need to pass this option. # @return [String] # # @!attribute [rw] kms_key # An AWS Key Management Service key used to encrypt your output files. # If you do not specify a key, the files are written in plain text. # @return [String] # # @!attribute [rw] language_code # The language of the input documents. All documents must be in the # same language. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJobRequest AWS API Documentation # class StartSNOMEDCTInferenceJobRequest < Struct.new( :input_data_config, :output_data_config, :data_access_role_arn, :job_name, :client_request_token, :kms_key, :language_code) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of a job, # use this identifier with the StartSNOMEDCTInferenceJob operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StartSNOMEDCTInferenceJobResponse AWS API Documentation # class StartSNOMEDCTInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the medical entities job to stop. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobRequest AWS API Documentation # class StopEntitiesDetectionV2JobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the medical entities detection job that was # stopped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopEntitiesDetectionV2JobResponse AWS API Documentation # class StopEntitiesDetectionV2JobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJobRequest AWS API Documentation # class StopICD10CMInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of job, use # this identifier with the `DescribeICD10CMInferenceJob` operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopICD10CMInferenceJobResponse AWS API Documentation # class StopICD10CMInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the PHI detection job to stop. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobRequest AWS API Documentation # class StopPHIDetectionJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the PHI detection job that was stopped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopPHIDetectionJobResponse AWS API Documentation # class StopPHIDetectionJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier of the job. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJobRequest AWS API Documentation # class StopRxNormInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of job, use # this identifier with the `DescribeRxNormInferenceJob` operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopRxNormInferenceJobResponse AWS API Documentation # class StopRxNormInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The job id of the asynchronous InferSNOMEDCT job to be stopped. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJobRequest AWS API Documentation # class StopSNOMEDCTInferenceJobRequest < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # @!attribute [rw] job_id # The identifier generated for the job. To get the status of job, use # this identifier with the DescribeSNOMEDCTInferenceJob operation. # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/StopSNOMEDCTInferenceJobResponse AWS API Documentation # class StopSNOMEDCTInferenceJobResponse < Struct.new( :job_id) SENSITIVE = [] include Aws::Structure end # The size of the text you submitted exceeds the size limit. Reduce the # size of the text or use a smaller document and then retry your # request. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TextSizeLimitExceededException AWS API Documentation # class TextSizeLimitExceededException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # You have made too many requests within a short period of time. Wait # for a short time and then try your request again. Contact customer # support for more information about a service limit increase. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/TooManyRequestsException AWS API Documentation # class TooManyRequestsException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end # Provides contextual information about the extracted entity. # # @!attribute [rw] name # Provides a name or contextual description about the trait. # @return [String] # # @!attribute [rw] score # The level of confidence that Amazon Comprehend Medical has in the # accuracy of this trait. # @return [Float] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/Trait AWS API Documentation # class Trait < Struct.new( :name, :score) SENSITIVE = [] include Aws::Structure end # An attribute that was extracted, but Amazon Comprehend Medical was # unable to relate to an entity. # # @!attribute [rw] type # The type of the unmapped attribute, could be one of the following # values: "MEDICATION", "MEDICAL\_CONDITION", "ANATOMY", # "TEST\_AND\_TREATMENT\_PROCEDURE" or # "PROTECTED\_HEALTH\_INFORMATION". # @return [String] # # @!attribute [rw] attribute # The specific attribute that has been extracted but not mapped to an # entity. # @return [Types::Attribute] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/UnmappedAttribute AWS API Documentation # class UnmappedAttribute < Struct.new( :type, :attribute) SENSITIVE = [] include Aws::Structure end # The filter that you specified for the operation is invalid. Check the # filter values that you entered and try your request again. # # @!attribute [rw] message # @return [String] # # @see http://docs.aws.amazon.com/goto/WebAPI/comprehendmedical-2018-10-30/ValidationException AWS API Documentation # class ValidationException < Struct.new( :message) SENSITIVE = [] include Aws::Structure end end end