Query pipeline executions

curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/pipelines/query \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "semanticQuery": {
    "value": "<string>",
    "paths": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    }
  },
  "query": {
    "and": "<array>",
    "id": "<string>"
  },
  "filter": {
    "and": "<array>",
    "id": "<string>"
  },
  "properties": {
    "include": [
      "<string>"
    ],
    "exclude": [
      "<string>"
    ]
  },
  "highlighting": [
    "<string>"
  ],
  "page": 123,
  "perPage": 20,
  "sort": {
    "path": "<string>",
    "direction": "DESC"
  },
  "ranking": {
    "type": "DEFAULT"
  },
  "aggregations": [
    {
      "type": "LEXICAL",
      "path": "<string>",
      "prefix": "<string>",
      "size": 20
    }
  ],
  "traversedProperties": [
    "<string>"
  ]
}
'

{
  "hits": [
    {
      "hitType": "RESOURCE",
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "numPages": 123,
    "page": 123,
    "perPage": 123,
    "total": 123,
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  },
  "aggregates": [
    {
      "type": "LEXICAL",
      "path": "<string>",
      "aggregate": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "semanticQueryInfo": {
    "reasoning": "<string>",
    "originalQuery": "<string>",
    "query": {
      "and": "<array>",
      "id": "<string>"
    },
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  }
}

Pipeline Executions

Query pipeline executions

Query the pipeline executions of a source. The fields that can be used to filter or sort pipeline executions are:

id: The pipeline execution id.
pipelineDefinitionId: The pipeline definition id.
createdAt: The pipeline execution creation timestamp.
updatedAt: The pipeline execution last update timestamp.
status: The pipeline execution status.
operation.action: The action of the operation that triggered the pipeline execution.
operation.taskId: The id of the task that triggered the pipeline execution.
operation.target.targetType: The type of the target that triggered the pipeline execution. It can be ‘RESOURCE’ or ‘RELATIONSHIP’.
operation.target.type: The type of the resource or relationship that triggered the pipeline execution.
operation.target.id: The id of the resource or relationship that triggered the pipeline execution.

POST

sources

{sourceKey}

pipelines

query

Query pipeline executions

curl --request POST \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/pipelines/query \
  --header 'Content-Type: application/json' \
  --header 'X-Clinia-API-Key: <api-key>' \
  --data '
{
  "semanticQuery": {
    "value": "<string>",
    "paths": {
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ]
    }
  },
  "query": {
    "and": "<array>",
    "id": "<string>"
  },
  "filter": {
    "and": "<array>",
    "id": "<string>"
  },
  "properties": {
    "include": [
      "<string>"
    ],
    "exclude": [
      "<string>"
    ]
  },
  "highlighting": [
    "<string>"
  ],
  "page": 123,
  "perPage": 20,
  "sort": {
    "path": "<string>",
    "direction": "DESC"
  },
  "ranking": {
    "type": "DEFAULT"
  },
  "aggregations": [
    {
      "type": "LEXICAL",
      "path": "<string>",
      "prefix": "<string>",
      "size": 20
    }
  ],
  "traversedProperties": [
    "<string>"
  ]
}
'

{
  "hits": [
    {
      "hitType": "RESOURCE",
      "score": 123,
      "resource": {},
      "traversedProperties": {},
      "highlighting": {}
    }
  ],
  "meta": {
    "numPages": 123,
    "page": 123,
    "perPage": 123,
    "total": 123,
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  },
  "aggregates": [
    {
      "type": "LEXICAL",
      "path": "<string>",
      "aggregate": [
        {
          "value": "<string>",
          "count": 123
        }
      ]
    }
  ],
  "semanticQueryInfo": {
    "reasoning": "<string>",
    "originalQuery": "<string>",
    "query": {
      "and": "<array>",
      "id": "<string>"
    },
    "filter": {
      "and": "<array>",
      "id": "<string>"
    }
  }
}

Authorizations

X-Clinia-API-Key

string

header

required

Path Parameters

sourceKey

string

required

The key of the source.

Query Parameters

withOperationBody

boolean

default:false

If set to true, the response will include, for each pipeline execution, the body of the operation which triggered the pipeline. Defaults to false.

Body

application/json

Use dot-notation paths (e.g., name, meta.updatedAt, address.city). To include properties from relationships or adjacent records, request them via traversedProperties and reference with @ (e.g., @worksAt.*, @[email protected]). Some endpoints require federated paths such as resources.<collectionKey>.<propertyKey> or relationships.<collectionKey>.<propertyKey>.

semanticQuery

object

A semantic query is a high-level representation of the user's intent. When specified, it will trigger our query understanding capabilities and generate a query and filter operator that will be applied to the search parameters.

Show child attributes

semanticQuery.value

string

required

The text value of the semantic query.

semanticQuery.paths

object

Limits the semantic paths the LLM can consider. Accepts collection-scoped paths or federated paths depending on the endpoint.

Show child attributes

semanticQuery.paths.include

string[]

The properties to include in the search response. System properties are included by default.

semanticQuery.paths.exclude

string[]

The properties to exclude from the search response. System properties are not allowed to be excluded.

query

object

An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

query.and

array

required

query.id

string

filter

object

An operator that will be used to filter the targeted collections. The filtering operator excludes results that do not match the specified criteria.

Option 1
Option 2
Option 3
Option 4
Option 5
Option 6
Option 7
Option 8
Option 9
Option 10
Option 11
Option 12

Show child attributes

filter.and

array

required

filter.id

string

properties

object

Properties selector allows to specify which properties should be included or excluded in the search response. System properties are always included and cannot be excluded. Exclude properties has precedence over include properties.

Show child attributes

properties.include

string[]

The properties to include in the search response. System properties are included by default.

properties.exclude

string[]

The properties to exclude from the search response. System properties are not allowed to be excluded.

highlighting

string[]

page

integer<int32>

perPage

integer<int32>

default:20

sort

object

Show child attributes

sort.path

string

required

Field to sort by. Use dot-notation or federated syntax as required by the endpoint.

sort.direction

enum<string>

default:DESC

Available options:

DESC,

ASC

ranking

object

Option 1
Option 2

Show child attributes

ranking.type

enum<string>

default:DEFAULT

required

Available options:

DEFAULT,

SEMANTIC

aggregations

object[]

Show child attributes

aggregations.type

enum<string>

required

Available options:

LEXICAL

aggregations.path

string

required

The path of the property to aggregate.

aggregations.prefix

string

The prefix is an optional query to filter the values to aggregate (e.g. 'mont' would match 'montreal', 'Montecarlo', etc.).

aggregations.size

integer<int32>

default:20

The maximum number of unique values to return in the aggregation.

traversedProperties

string[]

The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix

* will return all traversed properties.
@worksAt.* will return all traversed properties from the relationship 'worksAt'.
@worksAt.@clinic.* will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.

Response

A successful response.

hits

object[]

required

Show child attributes

hits.hitType

enum<string>

required

Available options:

RESOURCE,

RELATIONSHIP,

OBJECT,

CONCEPT,

PIPELINE_EXECUTION,

RESOLUTION_QUEUED_ITEM

hits.score

number<double>

required

The score of the hit in the search results, indicating its relevance.

hits.resource

object

required

hits.traversedProperties

object

Show child attributes

hits.traversedProperties.{key}

object[]

Show child attributes

hits.traversedProperties.{key}.type

enum<string>

required

Available options:

address,

attachment,

boolean,

code,

coding,

contactpoint,

date,

datetime,

decimal,

geopoint,

humanname,

identifier,

instant,

integer,

markdown,

period,

reference,

symbol,

time,

uri,

url,

xhtml,

array,

object

hits.traversedProperties.{key}.value

object

required

hits.traversedProperties.{key}.relationshipId

string

hits.traversedProperties.{key}.relationshipType

string

hits.traversedProperties.{key}.recordId

string

hits.traversedProperties.{key}.recordType

string

hits.highlighting

object

Show child attributes

hits.highlighting.{key}

object[]

Option 1
Option 2

Show child attributes

hits.highlighting.{key}.type

enum<string>

required

Available options:

textual,

vector

hits.highlighting.{key}.highlight

string

required

AI Endpoints

Data Catalog Endpoints

Data Partition Endpoints

MDM Endpoints

Registry Endpoints

Terminology Endpoints

Query pipeline executions

Authorizations

Path Parameters

Query Parameters

Body

Response