Skip to content

Latest commit

 

History

History
326 lines (223 loc) · 9.81 KB

EntityMentionResolutionResponse.md

File metadata and controls

326 lines (223 loc) · 9.81 KB

Class: EntityMentionResolutionResponse

An entity resolution response returned by the ERE.

__

This is basically a list of candidate clusters to which the entity is deemed to be equivalent.

__

Note that, for the moment, we don't support batch requests. In future, we might support requests

_with multiple subjects in the EntityMention content (eg, RDF with multiple subjects), in which case _

_we might need to return multiple EntityMentionResolutionResponse messages, each with additional _

properties such as entityIndex and totalEntities.

__

URI: ere:EntityMentionResolutionResponse

 classDiagram
    class EntityMentionResolutionResponse
    click EntityMentionResolutionResponse href "../EntityMentionResolutionResponse/"
      EREResponse <|-- EntityMentionResolutionResponse
        click EREResponse href "../EREResponse/"
      
      EntityMentionResolutionResponse : candidates
        
          
    
        
        
        EntityMentionResolutionResponse --> "1..*" ClusterReference : candidates
        click ClusterReference href "../ClusterReference/"
    

        
      EntityMentionResolutionResponse : entity_mention_id
        
          
    
        
        
        EntityMentionResolutionResponse --> "1" EntityMentionIdentifier : entity_mention_id
        click EntityMentionIdentifier href "../EntityMentionIdentifier/"
    

        
      EntityMentionResolutionResponse : ere_request_id
        
      EntityMentionResolutionResponse : timestamp
        
      EntityMentionResolutionResponse : type
Loading

Inheritance

Slots

Name Cardinality and Range Description Inheritance
entity_mention_id 1
EntityMentionIdentifier		 The identifier of the entity mention that has been resolved direct
candidates 1..*
ClusterReference		 The set of cluster reference/score pairs representing the candidate clusters direct
type 1
String		 The type of the request or result EREMessage
ere_request_id 1
String		 A string representing the unique ID of an ERE request, or the ID of the reque... EREMessage
timestamp 0..1
Datetime		 The time when the message was created EREMessage

Examples

Value
{
"type": "EntityMentionResolutionResponse",
"entity_mention_id": { 
"request_id": "324fs3r345vx",
"source_id": "TEDSWS",
"entity_type": "http://www.w3.org/ns/org#Organization"

}, "candidates": [ { "cluster_id": "324fs3r345vx-aa32wa", "confidence_score": 0.91 }, { "cluster_id": "324fs3r345vx-bb45we", "confidence_score": 0.65 } ], "timestamp": "2026-01-14T12:34:59Z", "ere_request_id": "324fs3r345vx:01" }

|

Identifier and Mapping Information

Schema Source

Mappings

Mapping Type Mapped Value
self ere:EntityMentionResolutionResponse
native ere:EntityMentionResolutionResponse

LinkML Source

Direct

Details ```yaml name: EntityMentionResolutionResponse description: "An entity resolution response returned by the ERE.\n\nThis is basically\ \ a list of candidate clusters to which the entity is deemed to be equivalent.\n\ \nNote that, for the moment, we don't support batch requests. In future, we might\ \ support requests\nwith multiple subjects in the `EntityMention` content (eg, RDF\ \ with multiple subjects), in which case \nwe might need to return multiple `EntityMentionResolutionResponse`\ \ messages, each with additional \nproperties such as `entityIndex` and `totalEntities`.\n" examples: - value: "{\n \"type\": \"EntityMentionResolutionResponse\",\n \"entity_mention_id\"\ : {\n \"request_id\": \"324fs3r345vx\",\n \"source_id\": \"TEDSWS\",\n \ \ \"entity_type\": \"http://www.w3.org/ns/org#Organization\"\n },\n \"candidates\"\ : [\n { \n \"cluster_id\": \"324fs3r345vx-aa32wa\",\n \"confidence_score\"\ : 0.91\n },\n { \n \"cluster_id\": \"324fs3r345vx-bb45we\",\n \ \ \"confidence_score\": 0.65\n }\n ],\n \"timestamp\": \"2026-01-14T12:34:59Z\"\ ,\n \"ere_request_id\": \"324fs3r345vx:01\"\n}\n \n" from_schema: https://data.europa.eu/ers/schema/ere is_a: EREResponse attributes: entity_mention_id: name: entity_mention_id description: "The identifier of the entity mention that has been resolved.\n\n\ This isn't strictly needed, since the `ere_request_id` already links the response\ \ to \nthe request's entity mention. Yet, it's reported for convenience.\n" from_schema: https://data.europa.eu/ers/schema/ere rank: 1000 domain_of: - EntityMentionResolutionResponse range: EntityMentionIdentifier required: true candidates: name: candidates description: 'The set of cluster reference/score pairs representing the candidate clusters 
  that the entity mention in the original request could align to (be equivalent
  to).

  '
from_schema: https://data.europa.eu/ers/schema/ere
rank: 1000
domain_of:
- EntityMentionResolutionResponse
- Decision
- UserAction
range: ClusterReference
required: true
multivalued: true

</details>

### Induced

<details>
```yaml
name: EntityMentionResolutionResponse
description: "An entity resolution response returned by the ERE.\n\nThis is basically\
  \ a list of candidate clusters to which the entity is deemed to be equivalent.\n\
  \nNote that, for the moment, we don't support batch requests. In future, we might\
  \ support requests\nwith multiple subjects in the `EntityMention` content (eg, RDF\
  \ with multiple subjects), in which case \nwe might need to return multiple `EntityMentionResolutionResponse`\
  \ messages, each with additional \nproperties such as `entityIndex` and `totalEntities`.\n"
examples:
- value: "{\n  \"type\": \"EntityMentionResolutionResponse\",\n  \"entity_mention_id\"\
    : {\n    \"request_id\": \"324fs3r345vx\",\n    \"source_id\": \"TEDSWS\",\n \
    \   \"entity_type\": \"http://www.w3.org/ns/org#Organization\"\n  },\n  \"candidates\"\
    : [\n    { \n      \"cluster_id\": \"324fs3r345vx-aa32wa\",\n      \"confidence_score\"\
    : 0.91\n    },\n    { \n      \"cluster_id\": \"324fs3r345vx-bb45we\",\n     \
    \ \"confidence_score\": 0.65\n    }\n  ],\n  \"timestamp\": \"2026-01-14T12:34:59Z\"\
    ,\n  \"ere_request_id\": \"324fs3r345vx:01\"\n}\n    \n"
from_schema: https://data.europa.eu/ers/schema/ere
is_a: EREResponse
attributes:
  entity_mention_id:
    name: entity_mention_id
    description: "The identifier of the entity mention that has been resolved.\n\n\
      This isn't strictly needed, since the `ere_request_id` already links the response\
      \ to \nthe request's entity mention. Yet, it's reported for convenience.\n"
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: entity_mention_id
    owner: EntityMentionResolutionResponse
    domain_of:
    - EntityMentionResolutionResponse
    range: EntityMentionIdentifier
    required: true
  candidates:
    name: candidates
    description: 'The set of cluster reference/score pairs representing the candidate
      clusters

      that the entity mention in the original request could align to (be equivalent
      to).

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: candidates
    owner: EntityMentionResolutionResponse
    domain_of:
    - EntityMentionResolutionResponse
    - Decision
    - UserAction
    range: ClusterReference
    required: true
    multivalued: true
  type:
    name: type
    description: "The type of the request or result.\n\nAs per LinkML specification,\
      \ `designates_type` is used here in order to allow for this\nslot to tell the\
      \ concrete subclass that an instance (such as a JSON object) belongs to.\n\n\
      In other words, a particular request will have `type` set with values like \n\
      `EntityMentionResolutionRequest` or `EntityResolutionResult`\n"
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    designates_type: true
    alias: type
    owner: EntityMentionResolutionResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  ere_request_id:
    name: ere_request_id
    description: 'A string representing the unique ID of an ERE request, or the ID
      of the request a response is about.

      This **is not** the same as `request_id` + `source_id`.


      Note on notification responses: as per ERE contract, an `EntityMentionResolutionResponse`
      message

      can originate from within the ERE, without any previous request counterpart,
      as a notification of

      resolution update. In this case, `ere_request_id` has the prefix `ereNotification:`.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: ere_request_id
    owner: EntityMentionResolutionResponse
    domain_of:
    - EREMessage
    range: string
    required: true
  timestamp:
    name: timestamp
    description: 'The time when the message was created. Should be in ISO-8601 format.

      '
    from_schema: https://data.europa.eu/ers/schema/ere
    rank: 1000
    alias: timestamp
    owner: EntityMentionResolutionResponse
    domain_of:
    - EREMessage
    range: datetime