Sign in

v1

latestOpenAPI 3.1.02026-08-041911887.3 KB
Affinity

Explore concept connections (powered by the Signal AI Knowledge Graph)

This endpoint allows you to query the relationships from a source concept (entity or topic) to a set of target concepts (topics or entities) and how these relationships evolve over different months.

The relationship.type parameter allows you to specify the type of relationships you are interested in. Currently, the only type of relationship supported is proximity

There are two ways to use this endpoint:

a. Querying for specific concepts: you need to provide as input a list of target-concepts IDs (target-concepts.ids) for known concepts that you want to query.

b. Discovery: when you don't specify an explicit list of target-concepts IDs, the results will be the top relationships in order of proximity to the source-concept for any given month (these entities might differ month-on-month). You can also filter the results by concept type(s) of interest (target-concepts.types with values: topic, entity/organisation, entity/people, entity/location, etc.) You can also exclude specific concepts from the results (target-concepts.exclude.ids).

post/affinity

Request body

Example request

{
  "relationship": {
    "date": {
      "start": "2023-01",
      "end": "2023-01"
    }
  },
  "source-concept": {
    "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
  },
  "target-concepts": {
    "ids": [
      "bcd2d868-ed38-4382-b94a-622a30fc3215"
    ]
  }
}

Response

Returns a list of relationships matching the query

Example response

{
  "source-concept": {
    "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
  },
  "results": [
    {
      "relationship": {
        "date": "2023-01"
      },
      "target-concept": {
        "id": "bcd2d868-ed38-4382-b94a-622a30fc3215"
      }
    }
  ]
}