Class: Google::Apis::HealthcareV1::AnalyzeEntitiesResponse

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/healthcare_v1/classes.rb,
lib/google/apis/healthcare_v1/representations.rb,
lib/google/apis/healthcare_v1/representations.rb more...

Overview

Includes recognized entity mentions and relationships between them.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ AnalyzeEntitiesResponse

Returns a new instance of AnalyzeEntitiesResponse.

[View source]

172
173
174
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 172

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#entities ⇒ Array<Google::Apis::HealthcareV1::Entity>

The union of all the candidate entities that the entity_mentions in this response could link to. These are UMLS concepts or normalized mention content. Corresponds to the JSON property entities

Returns:


152
153
154
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 152

def entities
  @entities
end

#entity_mentions ⇒ Array<Google::Apis::HealthcareV1::EntityMention>

The entity_mentions field contains all the annotated medical entities that were mentioned in the provided document. Corresponds to the JSON property entityMentions

Returns:


158
159
160
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 158

def entity_mentions
  @entity_mentions
end

#fhir_bundle ⇒ String

The FHIR bundle (R4) that includes all the entities, the entity mentions, and the relationships in JSON format. Corresponds to the JSON property fhirBundle

Returns:

  • (String) 

164
165
166
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 164

def fhir_bundle
  @fhir_bundle
end

#relationships ⇒ Array<Google::Apis::HealthcareV1::EntityMentionRelationship>

relationships contains all the binary relationships that were identified between entity mentions within the provided document. Corresponds to the JSON property relationships

Returns:


170
171
172
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 170

def relationships
  @relationships
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object

[View source]

177
178
179
180
181
182
 
# File 'lib/google/apis/healthcare_v1/classes.rb', line 177

def update!(**args)
  @entities = args[:entities] if args.key?(:entities)
  @entity_mentions = args[:entity_mentions] if args.key?(:entity_mentions)
  @fhir_bundle = args[:fhir_bundle] if args.key?(:fhir_bundle)
  @relationships = args[:relationships] if args.key?(:relationships)
end