google-api-client 0.48.0 → 0.53.0

data/generated/google/apis/healthcare_v1beta1/representations.rb

@@ -28,6 +28,18 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class AnalyzeEntitiesRequest
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class AnalyzeEntitiesResponse
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Annotation
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -244,7 +256,19 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class ErrorDetail
+      class Entity
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class EntityMention
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
+      class EntityMentionRelationship
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
         include Google::Apis::Core::JsonObjectSupport
@@ -316,6 +340,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class Feature
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class FhirConfig
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -556,12 +586,6 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
-      class ImportDicomDataErrorDetails
-        class Representation < Google::Apis::Core::JsonRepresentation; end
-      
-        include Google::Apis::Core::JsonObjectSupport
-      end
-      
       class ImportDicomDataRequest
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -616,6 +640,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class LinkedEntity
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class ListAnnotationStoresResponse
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -910,6 +940,12 @@ module Google
         include Google::Apis::Core::JsonObjectSupport
       end
       
+      class TextSpan
+        class Representation < Google::Apis::Core::JsonRepresentation; end
+      
+        include Google::Apis::Core::JsonObjectSupport
+      end
+      
       class Type
         class Representation < Google::Apis::Core::JsonRepresentation; end
       
@@ -943,6 +979,25 @@ module Google
         end
       end
       
+      class AnalyzeEntitiesRequest
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :document_content, as: 'documentContent'
+        end
+      end
+      
+      class AnalyzeEntitiesResponse
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          collection :entities, as: 'entities', class: Google::Apis::HealthcareV1beta1::Entity, decorator: Google::Apis::HealthcareV1beta1::Entity::Representation
+      
+          collection :entity_mentions, as: 'entityMentions', class: Google::Apis::HealthcareV1beta1::EntityMention, decorator: Google::Apis::HealthcareV1beta1::EntityMention::Representation
+      
+          collection :relationships, as: 'relationships', class: Google::Apis::HealthcareV1beta1::EntityMentionRelationship, decorator: Google::Apis::HealthcareV1beta1::EntityMentionRelationship::Representation
+      
+        end
+      end
+      
       class Annotation
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1096,6 +1151,7 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :consent_artifact, as: 'consentArtifact'
           property :expire_time, as: 'expireTime'
+          hash :metadata, as: 'metadata'
           property :name, as: 'name'
           collection :policies, as: 'policies', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1ConsentPolicy, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1ConsentPolicy::Representation
       
@@ -1277,12 +1333,40 @@ module Google
         end
       end
       
-      class ErrorDetail
+      class Entity
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
-          property :error, as: 'error', class: Google::Apis::HealthcareV1beta1::Status, decorator: Google::Apis::HealthcareV1beta1::Status::Representation
+          property :entity_id, as: 'entityId'
+          property :preferred_term, as: 'preferredTerm'
+          collection :vocabulary_codes, as: 'vocabularyCodes'
+        end
+      end
+      
+      class EntityMention
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :certainty_assessment, as: 'certaintyAssessment', class: Google::Apis::HealthcareV1beta1::Feature, decorator: Google::Apis::HealthcareV1beta1::Feature::Representation
+      
+          property :confidence, as: 'confidence'
+          collection :linked_entities, as: 'linkedEntities', class: Google::Apis::HealthcareV1beta1::LinkedEntity, decorator: Google::Apis::HealthcareV1beta1::LinkedEntity::Representation
+      
+          property :mention_id, as: 'mentionId'
+          property :subject, as: 'subject', class: Google::Apis::HealthcareV1beta1::Feature, decorator: Google::Apis::HealthcareV1beta1::Feature::Representation
+      
+          property :temporal_assessment, as: 'temporalAssessment', class: Google::Apis::HealthcareV1beta1::Feature, decorator: Google::Apis::HealthcareV1beta1::Feature::Representation
+      
+          property :text, as: 'text', class: Google::Apis::HealthcareV1beta1::TextSpan, decorator: Google::Apis::HealthcareV1beta1::TextSpan::Representation
+      
+          property :type, as: 'type'
+        end
+      end
       
-          property :resource, as: 'resource'
+      class EntityMentionRelationship
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :confidence, as: 'confidence'
+          property :object_id_prop, as: 'objectId'
+          property :subject_id, as: 'subjectId'
         end
       end
       
@@ -1349,6 +1433,8 @@ module Google
         class Representation < Google::Apis::Core::JsonRepresentation
           property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomBigQueryDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomBigQueryDestination::Representation
       
+          property :filter_config, as: 'filterConfig', class: Google::Apis::HealthcareV1beta1::DicomFilterConfig, decorator: Google::Apis::HealthcareV1beta1::DicomFilterConfig::Representation
+      
           property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomGcsDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1DicomGcsDestination::Representation
       
         end
@@ -1373,6 +1459,8 @@ module Google
       class ExportResourcesRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
+          property :_since, as: '_since'
+          property :_type, as: '_type'
           property :bigquery_destination, as: 'bigqueryDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirBigQueryDestination::Representation
       
           property :gcs_destination, as: 'gcsDestination', class: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirGcsDestination, decorator: Google::Apis::HealthcareV1beta1::GoogleCloudHealthcareV1beta1FhirGcsDestination::Representation
@@ -1390,6 +1478,14 @@ module Google
         end
       end
       
+      class Feature
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :confidence, as: 'confidence'
+          property :value, as: 'value'
+        end
+      end
+      
       class FhirConfig
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1733,14 +1829,6 @@ module Google
         end
       end
       
-      class ImportDicomDataErrorDetails
-        # @private
-        class Representation < Google::Apis::Core::JsonRepresentation
-          collection :sample_errors, as: 'sampleErrors', class: Google::Apis::HealthcareV1beta1::ErrorDetail, decorator: Google::Apis::HealthcareV1beta1::ErrorDetail::Representation
-      
-        end
-      end
-      
       class ImportDicomDataRequest
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -1823,6 +1911,13 @@ module Google
         end
       end
       
+      class LinkedEntity
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :entity_id, as: 'entityId'
+        end
+      end
+      
       class ListAnnotationStoresResponse
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation
@@ -2269,6 +2364,14 @@ module Google
         end
       end
       
+      class TextSpan
+        # @private
+        class Representation < Google::Apis::Core::JsonRepresentation
+          property :begin_offset, as: 'beginOffset'
+          property :content, as: 'content'
+        end
+      end
+      
       class Type
         # @private
         class Representation < Google::Apis::Core::JsonRepresentation

data/generated/google/apis/healthcare_v1beta1/service.rb

@@ -307,7 +307,7 @@ module Google
         #   The name of the project whose datasets should be listed. For example, `
         #   projects/`project_id`/locations/`location_id``.
         # @param [Fixnum] page_size
-        #   The maximum number of items to return. Capped to 100 if not specified. May not
+        #   The maximum number of items to return. If not specified, 100 is used. May not
         #   be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from a previous List request, if any.
@@ -718,7 +718,7 @@ module Google
         #   on labels is supported, for example `labels.key=value`.
         # @param [Fixnum] page_size
         #   Limit on the number of Annotation stores to return in a single response. If
-        #   zero the default page size of 100 is used.
+        #   not specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -974,8 +974,8 @@ module Google
         #   matches("annotation", "some-content")`. - `type("text")`, `type("image")`, `
         #   type("resource")`. Filter on the type of annotation `data`.
         # @param [Fixnum] page_size
-        #   Limit on the number of Annotations to return in a single response. If zero the
-        #   default page size of 100 is used.
+        #   Limit on the number of Annotations to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] view
@@ -1272,8 +1272,8 @@ module Google
         #   cloud.google.com/appengine/docs/standard/python/search/query_strings. Only
         #   filtering on labels is supported. For example, `labels.key=value`.
         # @param [Fixnum] page_size
-        #   Limit on the number of Consent stores to return in a single response. If zero
-        #   the default page size of 100 is used.
+        #   Limit on the number of Consent stores to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   Token to retrieve the next page of results or empty to get the first page.
         # @param [String] fields
@@ -1511,8 +1511,8 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # Deletes the specified Attribute definition. Fails if it is referenced by the
-        # latest revision of any Consent or User data mapping.
+        # Deletes the specified Attribute definition. Fails if it is referenced by any
+        # User data mapping, or the latest revision of any Consent.
         # @param [String] name
         #   Required. The resource name of the Attribute definition to delete.
         # @param [String] fields
@@ -1581,7 +1581,7 @@ module Google
         #   field available for filtering is `category`.
         # @param [Fixnum] page_size
         #   Limit on the number of attribute definitions to return in a single response.
-        #   If zero the default page size of 100 is used.
+        #   If not specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   Token to retrieve the next page of results or empty to get the first page.
         # @param [String] fields
@@ -1760,7 +1760,7 @@ module Google
         #   fields available for filtering are: - user_id - consent_content_version
         # @param [Fixnum] page_size
         #   Limit on the number of consent artifacts to return in a single response. If
-        #   zero the default page size of 100 is used.
+        #   not specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -1980,10 +1980,11 @@ module Google
         #   Restricts the consents returned to those matching a filter. Syntax: https://
         #   cloud.google.com/appengine/docs/standard/python/search/query_strings The
         #   fields available for filtering are: - user_id - consent_artifact - state -
-        #   revision_create_time
+        #   revision_create_time - metadata. For example, `Metadata("key")="value"` or `
+        #   HasMetadata("key")`.
         # @param [Fixnum] page_size
-        #   Limit on the number of consents to return in a single response. If zero the
-        #   default page size of 100 is used.
+        #   Limit on the number of consents to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -2025,8 +2026,8 @@ module Google
         #   functions available for filtering are: - user_id - consent_artifact - state -
         #   revision_create_time
         # @param [Fixnum] page_size
-        #   Limit on the number of revisions to return in a single response. If zero the
-        #   default page size of 100 is used.
+        #   Limit on the number of revisions to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   Token to retrieve the next page of results or empty if there are no more
         #   results in the list.
@@ -2319,7 +2320,7 @@ module Google
         #   archive_time
         # @param [Fixnum] page_size
         #   Limit on the number of user data mappings to return in a single response. If
-        #   zero the default page size of 100 is used.
+        #   not specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   Token to retrieve the next page of results or empty to get the first page.
         # @param [String] fields
@@ -2655,8 +2656,8 @@ module Google
         #   google.com/appengine/docs/standard/python/search/query_strings Only filtering
         #   on labels is supported. For example, `labels.key=value`.
         # @param [Fixnum] page_size
-        #   Limit on the number of DICOM stores to return in a single response. If zero
-        #   the default page size of 100 is used.
+        #   Limit on the number of DICOM stores to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -2978,13 +2979,12 @@ module Google
           execute_or_queue_command(command, &block)
         end
         
-        # DeleteStudyAsync deletes all instances within the given study using an
-        # operation. Delete requests are equivalent to the GET requests specified in the
-        # Retrieve transaction. The method returns an Operation which will be marked
-        # successful when the deletion is complete. Warning: Inserting instances into a
-        # study while a delete operation is running for that study could result in the
-        # new instances not appearing in search results until the deletion operation
-        # finishes.
+        # DeleteStudyAsync deletes all instances within the given study using a long
+        # running operation. The method returns an Operation which will be marked
+        # successful when the deletion is complete. Warning: If you insert instances
+        # into a study while a delete operation is running for that study, the instances
+        # you insert might not appear in search results until after the deletion
+        # operation finishes.
         # @param [String] parent
         # @param [String] dicom_web_path
         #   The path of the DeleteStudy request. For example, `studies/`study_uid``.
@@ -3237,11 +3237,10 @@ module Google
         end
         
         # DeleteSeriesAsync deletes all instances within the given study and series
-        # using an operation. Delete requests are equivalent to the GET requests
-        # specified in the Retrieve transaction. The method returns an Operation which
-        # will be marked successful when the deletion is complete. Warning: Inserting
-        # instances into a series while a delete operation is running for that series
-        # could result in the new instances not appearing in search results until the
+        # using a long running operation. The method returns an Operation which will be
+        # marked successful when the deletion is complete. Warning: If you insert
+        # instances into a series while a delete operation is running for that series,
+        # the instances you insert might not appear in search results until after the
         # deletion operation finishes.
         # @param [String] parent
         #   The name of the DICOM store that is being accessed. For example, `projects/`
@@ -3981,8 +3980,8 @@ module Google
         #   google.com/appengine/docs/standard/python/search/query_strings Only filtering
         #   on labels is supported, for example `labels.key=value`.
         # @param [Fixnum] page_size
-        #   Limit on the number of FHIR stores to return in a single response. If zero the
-        #   default page size of 100 is used.
+        #   Limit on the number of FHIR stores to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -4317,7 +4316,8 @@ module Google
         # @param [String] name
         #   Name of the `Patient` resource for which the information is required.
         # @param [Fixnum] _count
-        #   Maximum number of resources in a page. Defaults to 100.
+        #   Maximum number of resources in a page. If not specified, 100 is used. May not
+        #   be larger than 1000.
         # @param [String] _page_token
         #   Used to retrieve the next or previous page of results when using pagination.
         #   Set `_page_token` to the value of _page_token set in next or previous page
@@ -4806,8 +4806,8 @@ module Google
         #   entire year: `_at=2019` * An entire month: `_at=2019-01` * A specific day: `
         #   _at=2019-01-20` * A specific second: `_at=2018-12-31T23:59:58Z`
         # @param [Fixnum] _count
-        #   The maximum number of search results on a page. Default value is 100. Maximum
-        #   value is 1,000.
+        #   The maximum number of search results on a page. If not specified, 100 is used.
+        #   May not be larger than 1000.
         # @param [String] _page_token
         #   Used to retrieve the first, previous, next, or last page of resource versions
         #   when using pagination. Value should be set to the value of `_page_token` set
@@ -5343,8 +5343,8 @@ module Google
         #   google.com/appengine/docs/standard/python/search/query_strings Only filtering
         #   on labels is supported. For example, `labels.key=value`.
         # @param [Fixnum] page_size
-        #   Limit on the number of HL7v2 stores to return in a single response. If zero
-        #   the default page size of 100 is used.
+        #   Limit on the number of HL7v2 stores to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] fields
@@ -5660,8 +5660,8 @@ module Google
         #   cloud.google.com/apis/design/design_patterns#sorting_order Fields available
         #   for ordering are: * `send_time`
         # @param [Fixnum] page_size
-        #   Limit on the number of messages to return in a single response. If zero the
-        #   default page size of 100 is used.
+        #   Limit on the number of messages to return in a single response. If not
+        #   specified, 100 is used. May not be larger than 1000.
         # @param [String] page_token
         #   The next_page_token value returned from the previous List request, if any.
         # @param [String] view
@@ -5861,6 +5861,42 @@ module Google
           command.query['quotaUser'] = quota_user unless quota_user.nil?
           execute_or_queue_command(command, &block)
         end
+        
+        # Analyze heathcare entity in a document. Its response includes the recognized
+        # entity mentions and the relationships between them. AnalyzeEntities uses
+        # context aware models to detect entities.
+        # @param [String] nlp_service
+        #   The resource name of the service of the form: "projects/`project_id`/locations/
+        #   `location_id`/services/nlp".
+        # @param [Google::Apis::HealthcareV1beta1::AnalyzeEntitiesRequest] analyze_entities_request_object
+        # @param [String] fields
+        #   Selector specifying which fields to include in a partial response.
+        # @param [String] quota_user
+        #   Available to use for quota purposes for server-side applications. Can be any
+        #   arbitrary string assigned to a user, but should not exceed 40 characters.
+        # @param [Google::Apis::RequestOptions] options
+        #   Request-specific options
+        #
+        # @yield [result, err] Result & error if block supplied
+        # @yieldparam result [Google::Apis::HealthcareV1beta1::AnalyzeEntitiesResponse] parsed result object
+        # @yieldparam err [StandardError] error object if request failed
+        #
+        # @return [Google::Apis::HealthcareV1beta1::AnalyzeEntitiesResponse]
+        #
+        # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
+        # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
+        # @raise [Google::Apis::AuthorizationError] Authorization is required
+        def analyze_nlp_entities(nlp_service, analyze_entities_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
+          command = make_simple_command(:post, 'v1beta1/{+nlpService}:analyzeEntities', options)
+          command.request_representation = Google::Apis::HealthcareV1beta1::AnalyzeEntitiesRequest::Representation
+          command.request_object = analyze_entities_request_object
+          command.response_representation = Google::Apis::HealthcareV1beta1::AnalyzeEntitiesResponse::Representation
+          command.response_class = Google::Apis::HealthcareV1beta1::AnalyzeEntitiesResponse
+          command.params['nlpService'] = nlp_service unless nlp_service.nil?
+          command.query['fields'] = fields unless fields.nil?
+          command.query['quotaUser'] = quota_user unless quota_user.nil?
+          execute_or_queue_command(command, &block)
+        end
 
         protected