AI Endpoints
Data Catalog Endpoints
Data Partition Endpoints
MDM Endpoints
Registry Endpoints
Terminology Endpoints
curl --request GET \
--url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/collections \
--header 'X-Clinia-API-Key: <api-key>'{
"meta": {
"numPages": 123,
"page": 123,
"perPage": 123,
"total": 123
},
"data": [
{
"type": "resources",
"key": "<string>",
"profile": {
"key": "<string>",
"type": "ROOT",
"properties": {},
"description": "<string>",
"contained": {}
},
"pipeline": {
"steps": [
{
"type": "SEGMENTER",
"segmenter": {
"inputProperty": {
"content": {
"value": "content",
"summary": "The content property"
},
"attachment.content": {
"value": "attachment.content",
"summary": "The content property of the attachment"
}
},
"propertyKey": "passages",
"modelId": "clinia-segment-v1",
"propertyDescription": "The segmented content"
},
"trigger": {
"type": "OPERATOR",
"operator": {
"and": "<array>",
"id": "<string>"
}
}
}
],
"id": "<string>"
}
}
]
}List all collections in a source
List all collections in a registry.
curl --request GET \
--url https://{workspaceId}.clinia.cloud/sources/{sourceKey}/v1/collections \
--header 'X-Clinia-API-Key: <api-key>'{
"meta": {
"numPages": 123,
"page": 123,
"perPage": 123,
"total": 123
},
"data": [
{
"type": "resources",
"key": "<string>",
"profile": {
"key": "<string>",
"type": "ROOT",
"properties": {},
"description": "<string>",
"contained": {}
},
"pipeline": {
"steps": [
{
"type": "SEGMENTER",
"segmenter": {
"inputProperty": {
"content": {
"value": "content",
"summary": "The content property"
},
"attachment.content": {
"value": "attachment.content",
"summary": "The content property of the attachment"
}
},
"propertyKey": "passages",
"modelId": "clinia-segment-v1",
"propertyDescription": "The segmented content"
},
"trigger": {
"type": "OPERATOR",
"operator": {
"and": "<array>",
"id": "<string>"
}
}
}
],
"id": "<string>"
}
}
]
}Authorizations
Path Parameters
The key of the source.
Response
Return all collections available in the source.
Show child attributes
Show child attributes
The type of the collection.
resources, relationships, objects The key of the collection.
The profile of the collection.
Show child attributes
Show child attributes
ROOT, CONTAINED Show child attributes
Show child attributes
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
- Option 9
- Option 10
- Option 11
- Option 12
- Option 13
- Option 14
- Option 15
- Option 16
- Option 17
- Option 18
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
Show child attributes
Show child attributes
address, attachment, boolean, code, coding, contactpoint, date, datetime, decimal, geopoint, humanname, identifier, instant, integer, markdown, period, reference, symbol, time, uri, url, xhtml, array, object If set to true, the property cannot be set as required in the rules properties, and can only be set by the ingestion pipeline. Any value provided by the user will be ignored.
Description of the property.
Show child attributes
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The strength with which the binding is asserted.
- required: To be conformant, the concept in this element shall be from the specified value set.
- preferred: Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.
required, preferred Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
List of possible values for the property: string and number types only.
1An operator that defines when the rule should be applicable. Whenever this operator evaluates to true, the rule will be checked; when it is evaluated to false, the rule is ignored entirely and none of its validation is applied.
Supported operators are: 'eq', 'lt' and 'gt'. TODO: [ENG-4213] Add examples and document [current] and [*]..
Show child attributes
Show child attributes
Defines a subset of values the property can take. A binding can be defined for a code, a coding, a symbol or an URI property. In the case of a coding, the binding is applied to the code sub-attribute.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
The strength with which the binding is asserted.
- required: To be conformant, the concept in this element shall be from the specified value set.
- preferred: Instances are encouraged to draw from the specified codes for interoperability purposes but are not required to do so to be considered conformant.
required, preferred Description of the profile.
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Description of the contained definition respective to the profile.
0:*, 0:1, 1:1, 1:* The ingestion pipeline of the collection.
Show child attributes
Show child attributes
List of steps to evaluate and execute on ingested data before persistence.
Step that allows breaking down text in a field into smaller units (segments) and records result in an enriched property. This step is a Augmentation step type.
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
- Option 7
- Option 8
Show child attributes
Show child attributes
The type of the pipeline step.
SEGMENTER, VECTORIZER, ADDRESS_AUGMENTER, ACTIONABLE, SCHEMA_VALIDATOR, CLINIA_FUNCTION, OPTICAL_CHARACTER_RECOGNITION, DIFF_EVALUATOR The segmenter configuration.
Show child attributes
Show child attributes
The input property path to segment.
1{
"content": {
"value": "content",
"summary": "The content property"
},
"attachment.content": {
"value": "attachment.content",
"summary": "The content property of the attachment"
}
}The key of the property to store the segments. The property key will be accessible as a sub property of the input property.
It must follow pattern: ^[a-zA-Z0-9-][\w-]{0,61}$.
Therefore for an input property content and a property key passages, the segments will be accessible as content.passages.
1"passages"
The model to use for segmentation available in the model hub of the deployment.
1"clinia-segment-v1"
The description of the property.
"The segmented content"
The trigger configuration for a step. This is the configuration that indicates when a step needs to be executed. When this field is not configured, the step is always triggered.
- Option 1
- Option 2
Show child attributes
Show child attributes
The type of the pipeline step trigger.
OPERATOR, ALWAYS_TRIGGER Logical (and, or, not, all, any),
composite (composite),
comparisons (eq, gt, lt),
text match (match with types phrase, phrasePrefix, word, wordPrefix and optional fuzziness up to 3),
geo (geoDistance), and vector (knn).
The unique identifier of the pipeline definition.
Was this page helpful?