Skip to main content
GET
/
sources
/
{sourceKey}
/
v1
/
collections
/
{collectionKey}
/
pipeline
Get the pipeline definition of a collection
curl --request GET \
  --url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/collections/{collectionKey}/pipeline \
  --header 'X-Clinia-API-Key: <api-key>'
{
  "id": "<string>",
  "steps": [
    {
      "type": "SEGMENTER",
      "trigger": {
        "type": "OPERATOR",
        "operator": {
          "id": "<string>",
          "and": [
            "<any>"
          ]
        }
      },
      "segmenter": {
        "inputProperty": {
          "content": {
            "value": "content",
            "summary": "The content property"
          },
          "attachment.content": {
            "value": "attachment.content",
            "summary": "The content property of the attachment"
          }
        },
        "propertyKey": "passages",
        "propertyDescription": "The segmented content",
        "modelId": "clinia-segment-v1"
      }
    }
  ]
}

Authorizations

X-Clinia-API-Key
string
header
required

Path Parameters

sourceKey
string
required

The key of the source.

collectionKey
string
required

The key of the collection.

Query Parameters

version
integer

The version of the pipeline definition to retrieve.

revisionId
string

The revision id of the pipeline definition to retrieve.

Response

Returns the pipeline definition.

Configuration of a pipeline that can be executed on data ingestion. Each step will be executed with the ingested data if the triggers matches. These steps are executed before the data is persisted in the datasource and they are done async.

steps
object[]
required

List of steps to evaluate and execute on ingested data before persistence.

  • Option 1
  • Option 2
  • Option 3
  • Option 4
  • Option 5
  • Option 6
  • Option 7
id
string

The unique identifier of the pipeline definition.

I