RegistryCollections
Get a Collection from the registry
Get a Collection from the registry.
X-Clinia-API-Key<token>
In: header
Path Parameters
sourceKey*string
The key of the source.
collectionKey*string
The key of the collection. The collection key is shared with the profile key or relationship definition key. A collection is a container for searchable documents, either resources or relationships. It may also contain an ingestion pipeline that specifies additional processing of the documents.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/sources/string/v1/collections/string"{ "type": "resources", "key": "string", "pipeline": { "id": "string", "steps": [ { "type": "VECTORIZER", "trigger": { "type": "OPERATOR", "operator": { "id": "string", "and": [ null ] } }, "vectorizer": { "inputProperty": "content.passages", "propertyKey": "vector", "propertyDescription": "The vectorized content", "provider": "openai", "modelId": "text-embedding-004", "dimensions": 768 } } ] }, "profile": { "description": "string", "properties": { "property1": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } }, "property2": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } } }, "contained": { "property1": { "description": "string", "cardinality": "0:*", "depth": 1, "properties": { "property1": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } }, "property2": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } } } }, "property2": { "description": "string", "cardinality": "0:*", "depth": 1, "properties": { "property1": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } }, "property2": { "type": "address", "readOnly": false, "description": "string", "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "binding": { "vocabulary": { "key": "string", "strength": "required" } }, "modelId": "string", "enrichedProperties": {}, "properties": { "property1": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } }, "property2": { "rules": [ { "required": true, "pattern": "string", "enum": [ "string" ], "min": 0, "max": 0, "when": { "id": "string", "and": [ null ] } } ], "properties": { "property1": {}, "property2": {} }, "items": {}, "binding": { "vocabulary": { "key": "string", "strength": "required" } } } } } } } }, "key": "string" }}