@arke-institute/sdk 3.6.6 → 3.6.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (11) hide show
  1. package/dist/generated/index.d.cts +322 -81
  2. package/dist/generated/index.d.ts +322 -81
  3. package/dist/index.cjs.map +1 -1
  4. package/dist/index.js.map +1 -1
  5. package/dist/operations/index.cjs +2 -1
  6. package/dist/operations/index.cjs.map +1 -1
  7. package/dist/operations/index.js +2 -1
  8. package/dist/operations/index.js.map +1 -1
  9. package/openapi/spec.json +295 -161
  10. package/openapi/version.json +1 -1
  11. package/package.json +1 -1
package/dist/generated/index.d.cts CHANGED
@@ -6,7 +6,7 @@
6
6
  *
7
7
  * Source: Arke v1 API
8
8
  * Version: 1.0.0
9
- * Generated: 2026-02-13T15:33:39.556Z
9
+ * Generated: 2026-02-16T21:35:43.532Z
10
10
  */
11
11
  type paths = {
12
12
  "/ops-reference": {
@@ -2024,6 +2024,7 @@ type paths = {
2024
2024
  parameters: {
2025
2025
  query?: {
2026
2026
  type?: string;
2027
+ filter?: string;
2027
2028
  limit?: number;
2028
2029
  offset?: number | null;
2029
2030
  expand?: "preview" | "full";
@@ -7078,8 +7079,8 @@ type paths = {
7078
7079
  requestBody?: {
7079
7080
  content: {
7080
7081
  "application/json": {
7081
- /** @description Collection PI to find similar collections for */
7082
- pi: string;
7082
+ /** @description Collection ID to find similar collections for */
7083
+ id: string;
7083
7084
  /**
7084
7085
  * @description Maximum results to return
7085
7086
  * @default 10
@@ -7108,7 +7109,7 @@ type paths = {
7108
7109
  content: {
7109
7110
  "application/json": {
7110
7111
  results: {
7111
- pi: string;
7112
+ id: string;
7112
7113
  label: string;
7113
7114
  score: number;
7114
7115
  created_at?: string;
@@ -7117,7 +7118,7 @@ type paths = {
7117
7118
  entity?: components["schemas"]["EntityResponse"] & unknown;
7118
7119
  }[];
7119
7120
  metadata: {
7120
- source_pi: string;
7121
+ source_id: string;
7121
7122
  result_count: number;
7122
7123
  cached?: boolean;
7123
7124
  cached_at?: string;
@@ -7232,10 +7233,10 @@ type paths = {
7232
7233
  requestBody?: {
7233
7234
  content: {
7234
7235
  "application/json": {
7235
- /** @description Entity PI to find similar items for */
7236
- pi: string;
7237
- /** @description Entity's collection PI */
7238
- collection_pi: string;
7236
+ /** @description Entity ID to find similar items for */
7237
+ id: string;
7238
+ /** @description Entity's collection ID */
7239
+ collection_id: string;
7239
7240
  /**
7240
7241
  * @description Maximum results to return
7241
7242
  * @default 20
@@ -7279,10 +7280,10 @@ type paths = {
7279
7280
  content: {
7280
7281
  "application/json": {
7281
7282
  results: {
7282
- pi: string;
7283
+ id: string;
7283
7284
  type: string;
7284
7285
  label: string;
7285
- collection_pi: string | null;
7286
+ collection_id: string | null;
7286
7287
  score: number;
7287
7288
  created_at?: string;
7288
7289
  updated_at?: string;
@@ -7290,7 +7291,7 @@ type paths = {
7290
7291
  entity?: components["schemas"]["EntityResponse"] & unknown;
7291
7292
  }[];
7292
7293
  metadata: {
7293
- source_pi: string;
7294
+ source_id: string;
7294
7295
  collections_searched: number;
7295
7296
  result_count: number;
7296
7297
  cached?: boolean;
@@ -7412,6 +7413,56 @@ type paths = {
7412
7413
  limit?: number;
7413
7414
  /** @description Filter by collection types */
7414
7415
  types?: string[];
7416
+ /**
7417
+ * @description Filter by indexed metadata properties.
7418
+ *
7419
+ * **Filterable Properties:**
7420
+ * Only underscore-prefixed properties (`_year`, `_class`, etc.) are indexed as filterable metadata.
7421
+ *
7422
+ * **Operators:**
7423
+ * | Operator | Description | Example |
7424
+ * |----------|-------------|---------|
7425
+ * | `$eq` | Equals | `{ "_year": { "$eq": 1905 } }` |
7426
+ * | `$ne` | Not equals | `{ "_class": { "$ne": "draft" } }` |
7427
+ * | `$gt` | Greater than | `{ "_year": { "$gt": 1900 } }` |
7428
+ * | `$gte` | Greater than or equal | `{ "_year": { "$gte": 1900 } }` |
7429
+ * | `$lt` | Less than | `{ "_year": { "$lt": 2000 } }` |
7430
+ * | `$lte` | Less than or equal | `{ "_year": { "$lte": 2000 } }` |
7431
+ * | `$in` | In array | `{ "_class": { "$in": ["letter", "memo"] } }` |
7432
+ * | `$nin` | Not in array | `{ "_class": { "$nin": ["draft"] } }` |
7433
+ * | `$exists` | Property exists | `{ "_ocr_text": { "$exists": true } }` |
7434
+ *
7435
+ * **Logical Operators:**
7436
+ * | Operator | Description | Example |
7437
+ * |----------|-------------|---------|
7438
+ * | `$and` | All conditions must match | `{ "$and": [{ "_year": { "$gt": 1900 } }, { "_year": { "$lt": 2000 } }] }` |
7439
+ * | `$or` | Any condition must match | `{ "$or": [{ "_class": "letter" }, { "_class": "memo" }] }` |
7440
+ *
7441
+ * **Built-in Fields (always available):**
7442
+ * - `type` - Entity type
7443
+ * - `created_at` - ISO timestamp string
7444
+ * - `updated_at` - ISO timestamp string
7445
+ *
7446
+ * **Example - Find letters from 1800-1900:**
7447
+ * ```json
7448
+ * {
7449
+ * "$and": [
7450
+ * { "type": { "$eq": "letter" } },
7451
+ * { "_year": { "$gte": 1800 } },
7452
+ * { "_year": { "$lte": 1900 } }
7453
+ * ]
7454
+ * }
7455
+ * ```
7456
+ * @example {
7457
+ * "_year": {
7458
+ * "$gt": 1800
7459
+ * },
7460
+ * "type": "letter"
7461
+ * }
7462
+ */
7463
+ filter?: {
7464
+ [key: string]: unknown;
7465
+ };
7415
7466
  /**
7416
7467
  * @description Entity expansion mode. Default: "preview" for lightweight previews, "full" for complete manifests, "none" for no expansion.
7417
7468
  * @example preview
@@ -7430,7 +7481,7 @@ type paths = {
7430
7481
  content: {
7431
7482
  "application/json": {
7432
7483
  results: {
7433
- pi: string;
7484
+ id: string;
7434
7485
  label: string;
7435
7486
  type: string;
7436
7487
  score: number;
@@ -7544,6 +7595,56 @@ type paths = {
7544
7595
  * @default 10
7545
7596
  */
7546
7597
  limit?: number;
7598
+ /**
7599
+ * @description Filter by indexed metadata properties.
7600
+ *
7601
+ * **Filterable Properties:**
7602
+ * Only underscore-prefixed properties (`_year`, `_class`, etc.) are indexed as filterable metadata.
7603
+ *
7604
+ * **Operators:**
7605
+ * | Operator | Description | Example |
7606
+ * |----------|-------------|---------|
7607
+ * | `$eq` | Equals | `{ "_year": { "$eq": 1905 } }` |
7608
+ * | `$ne` | Not equals | `{ "_class": { "$ne": "draft" } }` |
7609
+ * | `$gt` | Greater than | `{ "_year": { "$gt": 1900 } }` |
7610
+ * | `$gte` | Greater than or equal | `{ "_year": { "$gte": 1900 } }` |
7611
+ * | `$lt` | Less than | `{ "_year": { "$lt": 2000 } }` |
7612
+ * | `$lte` | Less than or equal | `{ "_year": { "$lte": 2000 } }` |
7613
+ * | `$in` | In array | `{ "_class": { "$in": ["letter", "memo"] } }` |
7614
+ * | `$nin` | Not in array | `{ "_class": { "$nin": ["draft"] } }` |
7615
+ * | `$exists` | Property exists | `{ "_ocr_text": { "$exists": true } }` |
7616
+ *
7617
+ * **Logical Operators:**
7618
+ * | Operator | Description | Example |
7619
+ * |----------|-------------|---------|
7620
+ * | `$and` | All conditions must match | `{ "$and": [{ "_year": { "$gt": 1900 } }, { "_year": { "$lt": 2000 } }] }` |
7621
+ * | `$or` | Any condition must match | `{ "$or": [{ "_class": "letter" }, { "_class": "memo" }] }` |
7622
+ *
7623
+ * **Built-in Fields (always available):**
7624
+ * - `type` - Entity type
7625
+ * - `created_at` - ISO timestamp string
7626
+ * - `updated_at` - ISO timestamp string
7627
+ *
7628
+ * **Example - Find letters from 1800-1900:**
7629
+ * ```json
7630
+ * {
7631
+ * "$and": [
7632
+ * { "type": { "$eq": "letter" } },
7633
+ * { "_year": { "$gte": 1800 } },
7634
+ * { "_year": { "$lte": 1900 } }
7635
+ * ]
7636
+ * }
7637
+ * ```
7638
+ * @example {
7639
+ * "_year": {
7640
+ * "$gt": 1800
7641
+ * },
7642
+ * "type": "letter"
7643
+ * }
7644
+ */
7645
+ filter?: {
7646
+ [key: string]: unknown;
7647
+ };
7547
7648
  /**
7548
7649
  * @description Entity expansion mode. Default: "preview" for lightweight previews, "full" for complete manifests, "none" for no expansion.
7549
7650
  * @example preview
@@ -7568,10 +7669,10 @@ type paths = {
7568
7669
  content: {
7569
7670
  "application/json": {
7570
7671
  results: {
7571
- pi: string;
7672
+ id: string;
7572
7673
  label: string;
7573
7674
  score: number;
7574
- collection_pi: string | null;
7675
+ collection_id: string | null;
7575
7676
  status?: string;
7576
7677
  created_at?: string;
7577
7678
  updated_at?: string;
@@ -7648,7 +7749,7 @@ type paths = {
7648
7749
  * Search entities within collection(s)
7649
7750
  * @description Search for entities within one or more collections using semantic text search.
7650
7751
  *
7651
- * Provide either `collection_pi` for a single collection or `collection_pis` for multiple collections (searched in parallel).
7752
+ * Provide either `collection_pi` for a single collection or `collection_ids` for multiple collections (searched in parallel).
7652
7753
  *
7653
7754
  * Use `per_collection_limit` to ensure result diversity when searching multiple collections.
7654
7755
  *
@@ -7677,10 +7778,10 @@ type paths = {
7677
7778
  requestBody?: {
7678
7779
  content: {
7679
7780
  "application/json": {
7680
- /** @description Single collection PI to search within */
7681
- collection_pi?: string;
7682
- /** @description Multiple collection PIs to search (max 20) */
7683
- collection_pis?: string[];
7781
+ /** @description Single collection ID to search within */
7782
+ collection_id?: string;
7783
+ /** @description Multiple collection IDs to search (max 20) */
7784
+ collection_ids?: string[];
7684
7785
  /** @description Search query text */
7685
7786
  query: string;
7686
7787
  /**
@@ -7690,6 +7791,56 @@ type paths = {
7690
7791
  limit?: number;
7691
7792
  /** @description Filter by entity types */
7692
7793
  types?: string[];
7794
+ /**
7795
+ * @description Filter by indexed metadata properties.
7796
+ *
7797
+ * **Filterable Properties:**
7798
+ * Only underscore-prefixed properties (`_year`, `_class`, etc.) are indexed as filterable metadata.
7799
+ *
7800
+ * **Operators:**
7801
+ * | Operator | Description | Example |
7802
+ * |----------|-------------|---------|
7803
+ * | `$eq` | Equals | `{ "_year": { "$eq": 1905 } }` |
7804
+ * | `$ne` | Not equals | `{ "_class": { "$ne": "draft" } }` |
7805
+ * | `$gt` | Greater than | `{ "_year": { "$gt": 1900 } }` |
7806
+ * | `$gte` | Greater than or equal | `{ "_year": { "$gte": 1900 } }` |
7807
+ * | `$lt` | Less than | `{ "_year": { "$lt": 2000 } }` |
7808
+ * | `$lte` | Less than or equal | `{ "_year": { "$lte": 2000 } }` |
7809
+ * | `$in` | In array | `{ "_class": { "$in": ["letter", "memo"] } }` |
7810
+ * | `$nin` | Not in array | `{ "_class": { "$nin": ["draft"] } }` |
7811
+ * | `$exists` | Property exists | `{ "_ocr_text": { "$exists": true } }` |
7812
+ *
7813
+ * **Logical Operators:**
7814
+ * | Operator | Description | Example |
7815
+ * |----------|-------------|---------|
7816
+ * | `$and` | All conditions must match | `{ "$and": [{ "_year": { "$gt": 1900 } }, { "_year": { "$lt": 2000 } }] }` |
7817
+ * | `$or` | Any condition must match | `{ "$or": [{ "_class": "letter" }, { "_class": "memo" }] }` |
7818
+ *
7819
+ * **Built-in Fields (always available):**
7820
+ * - `type` - Entity type
7821
+ * - `created_at` - ISO timestamp string
7822
+ * - `updated_at` - ISO timestamp string
7823
+ *
7824
+ * **Example - Find letters from 1800-1900:**
7825
+ * ```json
7826
+ * {
7827
+ * "$and": [
7828
+ * { "type": { "$eq": "letter" } },
7829
+ * { "_year": { "$gte": 1800 } },
7830
+ * { "_year": { "$lte": 1900 } }
7831
+ * ]
7832
+ * }
7833
+ * ```
7834
+ * @example {
7835
+ * "_year": {
7836
+ * "$gt": 1800
7837
+ * },
7838
+ * "type": "letter"
7839
+ * }
7840
+ */
7841
+ filter?: {
7842
+ [key: string]: unknown;
7843
+ };
7693
7844
  /** @description Max results per collection for diversity */
7694
7845
  per_collection_limit?: number;
7695
7846
  /**
@@ -7710,18 +7861,18 @@ type paths = {
7710
7861
  content: {
7711
7862
  "application/json": {
7712
7863
  results: {
7713
- pi: string;
7864
+ id: string;
7714
7865
  label: string;
7715
7866
  type: string;
7716
7867
  score: number;
7717
- collection_pi: string;
7868
+ collection_id: string;
7718
7869
  created_at?: string;
7719
7870
  updated_at?: string;
7720
7871
  entity_preview?: components["schemas"]["EntityPreview"] & unknown;
7721
7872
  entity?: components["schemas"]["EntityResponse"] & unknown;
7722
7873
  }[];
7723
7874
  metadata: {
7724
- collection_pis: string[];
7875
+ collection_ids: string[];
7725
7876
  query: string;
7726
7877
  collections_searched: number;
7727
7878
  result_count: number;
@@ -7833,6 +7984,56 @@ type paths = {
7833
7984
  limit?: number;
7834
7985
  /** @description Filter by entity types */
7835
7986
  types?: string[];
7987
+ /**
7988
+ * @description Filter by indexed metadata properties.
7989
+ *
7990
+ * **Filterable Properties:**
7991
+ * Only underscore-prefixed properties (`_year`, `_class`, etc.) are indexed as filterable metadata.
7992
+ *
7993
+ * **Operators:**
7994
+ * | Operator | Description | Example |
7995
+ * |----------|-------------|---------|
7996
+ * | `$eq` | Equals | `{ "_year": { "$eq": 1905 } }` |
7997
+ * | `$ne` | Not equals | `{ "_class": { "$ne": "draft" } }` |
7998
+ * | `$gt` | Greater than | `{ "_year": { "$gt": 1900 } }` |
7999
+ * | `$gte` | Greater than or equal | `{ "_year": { "$gte": 1900 } }` |
8000
+ * | `$lt` | Less than | `{ "_year": { "$lt": 2000 } }` |
8001
+ * | `$lte` | Less than or equal | `{ "_year": { "$lte": 2000 } }` |
8002
+ * | `$in` | In array | `{ "_class": { "$in": ["letter", "memo"] } }` |
8003
+ * | `$nin` | Not in array | `{ "_class": { "$nin": ["draft"] } }` |
8004
+ * | `$exists` | Property exists | `{ "_ocr_text": { "$exists": true } }` |
8005
+ *
8006
+ * **Logical Operators:**
8007
+ * | Operator | Description | Example |
8008
+ * |----------|-------------|---------|
8009
+ * | `$and` | All conditions must match | `{ "$and": [{ "_year": { "$gt": 1900 } }, { "_year": { "$lt": 2000 } }] }` |
8010
+ * | `$or` | Any condition must match | `{ "$or": [{ "_class": "letter" }, { "_class": "memo" }] }` |
8011
+ *
8012
+ * **Built-in Fields (always available):**
8013
+ * - `type` - Entity type
8014
+ * - `created_at` - ISO timestamp string
8015
+ * - `updated_at` - ISO timestamp string
8016
+ *
8017
+ * **Example - Find letters from 1800-1900:**
8018
+ * ```json
8019
+ * {
8020
+ * "$and": [
8021
+ * { "type": { "$eq": "letter" } },
8022
+ * { "_year": { "$gte": 1800 } },
8023
+ * { "_year": { "$lte": 1900 } }
8024
+ * ]
8025
+ * }
8026
+ * ```
8027
+ * @example {
8028
+ * "_year": {
8029
+ * "$gt": 1800
8030
+ * },
8031
+ * "type": "letter"
8032
+ * }
8033
+ */
8034
+ filter?: {
8035
+ [key: string]: unknown;
8036
+ };
7836
8037
  /**
7837
8038
  * @description Number of collections to search
7838
8039
  * @default 10
@@ -7861,11 +8062,11 @@ type paths = {
7861
8062
  content: {
7862
8063
  "application/json": {
7863
8064
  results: {
7864
- pi: string;
8065
+ id: string;
7865
8066
  label: string;
7866
8067
  type: string;
7867
8068
  score: number;
7868
- collection_pi: string;
8069
+ collection_id: string;
7869
8070
  created_at?: string;
7870
8071
  updated_at?: string;
7871
8072
  entity_preview?: components["schemas"]["EntityPreview"] & unknown;
@@ -8598,10 +8799,10 @@ type components = {
8598
8799
  */
8599
8800
  type: "user";
8600
8801
  /**
8601
- * @description User entity PI (persistent identifier)
8802
+ * @description User entity ID
8602
8803
  * @example 01J1SHMAE10000000000000000
8603
8804
  */
8604
- pi: string;
8805
+ id: string;
8605
8806
  /**
8606
8807
  * @description How this identity was authenticated
8607
8808
  * @example jwt
@@ -8642,10 +8843,10 @@ type components = {
8642
8843
  */
8643
8844
  type: "agent";
8644
8845
  /**
8645
- * @description Agent entity PI (persistent identifier)
8846
+ * @description Agent entity ID
8646
8847
  * @example 01J1AGENTID000000000000000
8647
8848
  */
8648
- pi: string;
8849
+ id: string;
8649
8850
  /**
8650
8851
  * @description How this identity was authenticated
8651
8852
  * @example api_key
@@ -8653,10 +8854,10 @@ type components = {
8653
8854
  */
8654
8855
  auth_method: "api_key";
8655
8856
  /**
8656
- * @description Entity PI of the agent owner
8857
+ * @description Entity ID of the agent owner
8657
8858
  * @example 01J1OWNERID0000000000000000
8658
8859
  */
8659
- owner_pi: string;
8860
+ owner_id: string;
8660
8861
  /**
8661
8862
  * @description API key prefix
8662
8863
  * @example ak_xyz9
@@ -8860,10 +9061,10 @@ type components = {
8860
9061
  };
8861
9062
  UserCollectionItem: {
8862
9063
  /**
8863
- * @description Collection persistent identifier
9064
+ * @description Collection ID
8864
9065
  * @example 01JCOLLECTION123456789AB
8865
9066
  */
8866
- pi: string;
9067
+ id: string;
8867
9068
  /**
8868
9069
  * @description Collection label/name
8869
9070
  * @example My Research Collection
@@ -8906,7 +9107,7 @@ type components = {
8906
9107
  * "id": "01KDETYWYWM0MJVKM8DK3AEXPY",
8907
9108
  * "type": "file",
8908
9109
  * "label": "Research Paper.pdf",
8909
- * "collection_pi": "01JCOLLECTION123456789AB",
9110
+ * "collection_id": "01JCOLLECTION123456789AB",
8910
9111
  * "description_preview": "A comprehensive study on distributed systems architecture...",
8911
9112
  * "created_at": "2026-01-12T00:00:00.000Z",
8912
9113
  * "updated_at": "2026-01-12T10:30:00.000Z"
@@ -8932,7 +9133,7 @@ type components = {
8932
9133
  * @description Collection ID this entity belongs to
8933
9134
  * @example 01JCOLLECTION123456789ABCD
8934
9135
  */
8935
- collection_pi?: string;
9136
+ collection_id?: string;
8936
9137
  /**
8937
9138
  * @description Truncated description (max 200 chars + "...")
8938
9139
  * @example This document contains research findings from the 2025 study on entity management systems. It covers key architectural decisions and performance benchmarks...
@@ -8956,10 +9157,10 @@ type components = {
8956
9157
  };
8957
9158
  SearchResultItem: {
8958
9159
  /**
8959
- * @description Entity persistent identifier
9160
+ * @description Entity ID
8960
9161
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
8961
9162
  */
8962
- pi: string;
9163
+ id: string;
8963
9164
  /**
8964
9165
  * @description Entity type
8965
9166
  * @example file
@@ -8974,7 +9175,7 @@ type components = {
8974
9175
  * @description Collection this entity belongs to (null for public-domain)
8975
9176
  * @example 01JCOLLECTION123456789AB
8976
9177
  */
8977
- collection_pi: string | null;
9178
+ collection_id: string | null;
8978
9179
  /**
8979
9180
  * @description Relevance score (0-1, higher is better)
8980
9181
  * @example 0.87
@@ -9424,8 +9625,8 @@ type components = {
9424
9625
  entity_id: string;
9425
9626
  };
9426
9627
  CollectionEntitySummary: {
9427
- /** @description Entity persistent identifier */
9428
- pi: string;
9628
+ /** @description Entity ID */
9629
+ id: string;
9429
9630
  /**
9430
9631
  * @description Entity type
9431
9632
  * @example document
@@ -9808,6 +10009,11 @@ type components = {
9808
10009
  */
9809
10010
  peer?: string;
9810
10011
  }[];
10012
+ /**
10013
+ * @description Wait for collection index update before returning. Use when checking index immediately after update.
10014
+ * @default false
10015
+ */
10016
+ sync_index: boolean;
9811
10017
  };
9812
10018
  EntityDeletedResponse: {
9813
10019
  /**
@@ -9852,6 +10058,11 @@ type components = {
9852
10058
  * @example Duplicate entry
9853
10059
  */
9854
10060
  reason?: string;
10061
+ /**
10062
+ * @description Wait for collection index removal before returning. Use when checking index immediately after deletion.
10063
+ * @default false
10064
+ */
10065
+ sync_index: boolean;
9855
10066
  };
9856
10067
  CascadeDeletedEntity: {
9857
10068
  /**
@@ -9996,7 +10207,7 @@ type components = {
9996
10207
  * @description Entity ID (ULID format)
9997
10208
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
9998
10209
  */
9999
- pi: string;
10210
+ id: string;
10000
10211
  /** @description Entity label */
10001
10212
  label: string;
10002
10213
  /** @description Entity type */
@@ -11335,7 +11546,7 @@ type components = {
11335
11546
  * @example {
11336
11547
  * "extract": {
11337
11548
  * "klados": {
11338
- * "pi": "01KKLADOSA12345678901234",
11549
+ * "id": "01KKLADOSA12345678901234",
11339
11550
  * "type": "klados"
11340
11551
  * },
11341
11552
  * "then": {
@@ -11344,7 +11555,7 @@ type components = {
11344
11555
  * },
11345
11556
  * "summarize": {
11346
11557
  * "klados": {
11347
- * "pi": "01KKLADOSB12345678901234",
11558
+ * "id": "01KKLADOSB12345678901234",
11348
11559
  * "type": "klados"
11349
11560
  * },
11350
11561
  * "then": {
@@ -11359,12 +11570,17 @@ type components = {
11359
11570
  * KladosRef
11360
11571
  * @description Reference to the klados entity to invoke for this step
11361
11572
  * @example {
11362
- * "pi": "01KEXAMPLE123456789012345",
11573
+ * "id": "01KEXAMPLE123456789012345",
11363
11574
  * "type": "klados",
11364
11575
  * "label": "OCR Processor"
11365
11576
  * }
11366
11577
  */
11367
11578
  klados: {
11579
+ id: string;
11580
+ type?: string;
11581
+ label?: string;
11582
+ description?: string;
11583
+ } | {
11368
11584
  pi: string;
11369
11585
  type?: string;
11370
11586
  label?: string;
@@ -11518,7 +11734,7 @@ type components = {
11518
11734
  * @example {
11519
11735
  * "extract": {
11520
11736
  * "klados": {
11521
- * "pi": "01KKLADOSA12345678901234",
11737
+ * "id": "01KKLADOSA12345678901234",
11522
11738
  * "type": "klados"
11523
11739
  * },
11524
11740
  * "then": {
@@ -11527,7 +11743,7 @@ type components = {
11527
11743
  * },
11528
11744
  * "summarize": {
11529
11745
  * "klados": {
11530
- * "pi": "01KKLADOSB12345678901234",
11746
+ * "id": "01KKLADOSB12345678901234",
11531
11747
  * "type": "klados"
11532
11748
  * },
11533
11749
  * "then": {
@@ -11542,12 +11758,17 @@ type components = {
11542
11758
  * KladosRef
11543
11759
  * @description Reference to the klados entity to invoke for this step
11544
11760
  * @example {
11545
- * "pi": "01KEXAMPLE123456789012345",
11761
+ * "id": "01KEXAMPLE123456789012345",
11546
11762
  * "type": "klados",
11547
11763
  * "label": "OCR Processor"
11548
11764
  * }
11549
11765
  */
11550
11766
  klados: {
11767
+ id: string;
11768
+ type?: string;
11769
+ label?: string;
11770
+ description?: string;
11771
+ } | {
11551
11772
  pi: string;
11552
11773
  type?: string;
11553
11774
  label?: string;
@@ -11755,7 +11976,7 @@ type components = {
11755
11976
  * @description Entity ID that changed
11756
11977
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11757
11978
  */
11758
- pi: string;
11979
+ entity_id: string;
11759
11980
  /**
11760
11981
  * @description New manifest CID
11761
11982
  * @example bafyreibug443cnd4endcwinwttw3c3dzmcl2ikht64xzn5qg56bix3usfy
@@ -11783,27 +12004,27 @@ type components = {
11783
12004
  };
11784
12005
  /**
11785
12006
  * @example {
11786
- * "subject_pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
12007
+ * "subject_id": "01KE4ZY69F9R40E88PK9S0TQRQ",
11787
12008
  * "subject_label": "Project Folder",
11788
12009
  * "subject_type": "folder",
11789
12010
  * "subject_preview": {
11790
12011
  * "id": "01KE4ZY69F9R40E88PK9S0TQRQ",
11791
12012
  * "type": "folder",
11792
12013
  * "label": "Project Folder",
11793
- * "collection_pi": "01JCOLLECTION123456789ABCD",
12014
+ * "collection_id": "01JCOLLECTION123456789ABCD",
11794
12015
  * "description_preview": "Main project folder containing research documents...",
11795
12016
  * "created_at": "2025-01-10T08:00:00.000Z",
11796
12017
  * "updated_at": "2025-01-18T16:45:00.000Z"
11797
12018
  * },
11798
12019
  * "predicate": "contains",
11799
- * "object_pi": "01KE506KZGD8M2P1XK3VNQT4YR",
12020
+ * "object_id": "01KE506KZGD8M2P1XK3VNQT4YR",
11800
12021
  * "object_label": "Research Paper.pdf",
11801
12022
  * "object_type": "file",
11802
12023
  * "object_preview": {
11803
12024
  * "id": "01KE506KZGD8M2P1XK3VNQT4YR",
11804
12025
  * "type": "file",
11805
12026
  * "label": "Research Paper.pdf",
11806
- * "collection_pi": "01JCOLLECTION123456789ABCD",
12027
+ * "collection_id": "01JCOLLECTION123456789ABCD",
11807
12028
  * "description_preview": "Analysis of entity management patterns and best practices...",
11808
12029
  * "created_at": "2025-01-15T10:00:00.000Z",
11809
12030
  * "updated_at": "2025-01-20T14:30:00.000Z"
@@ -11815,7 +12036,7 @@ type components = {
11815
12036
  * @description Source entity PI
11816
12037
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11817
12038
  */
11818
- subject_pi: string;
12039
+ subject_id: string;
11819
12040
  /** @description Source entity label */
11820
12041
  subject_label: string;
11821
12042
  /** @description Source entity type */
@@ -11828,7 +12049,7 @@ type components = {
11828
12049
  * @description Target entity PI
11829
12050
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11830
12051
  */
11831
- object_pi: string;
12052
+ object_id: string;
11832
12053
  /** @description Target entity label */
11833
12054
  object_label: string;
11834
12055
  /** @description Target entity type */
@@ -11841,12 +12062,12 @@ type components = {
11841
12062
  * @description Entity ID (ULID format)
11842
12063
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11843
12064
  */
11844
- source_pi: string;
12065
+ source_id: string;
11845
12066
  /**
11846
12067
  * @description Entity ID (ULID format)
11847
12068
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11848
12069
  */
11849
- target_pi: string;
12070
+ target_id: string;
11850
12071
  /** @description Path length (number of hops) */
11851
12072
  length: number;
11852
12073
  edges: components["schemas"]["PathEdge"][];
@@ -11863,14 +12084,14 @@ type components = {
11863
12084
  * "01KE4ZY69F9R40E88PK9S0TQRQ"
11864
12085
  * ]
11865
12086
  */
11866
- source_pis: string[];
12087
+ source_ids: string[];
11867
12088
  /**
11868
12089
  * @description Target entity PIs
11869
12090
  * @example [
11870
12091
  * "01KE506KZGD8M2P1XK3VNQT4YR"
11871
12092
  * ]
11872
12093
  */
11873
- target_pis: string[];
12094
+ target_ids: string[];
11874
12095
  /**
11875
12096
  * @description Maximum path depth (1-4)
11876
12097
  * @default 4
@@ -11893,8 +12114,8 @@ type components = {
11893
12114
  };
11894
12115
  /**
11895
12116
  * @example {
11896
- * "source_pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
11897
- * "target_pi": "01KE506KZGD8M2P1XK3VNQT4YR",
12117
+ * "source_id": "01KE4ZY69F9R40E88PK9S0TQRQ",
12118
+ * "target_id": "01KE506KZGD8M2P1XK3VNQT4YR",
11898
12119
  * "target_label": "Research Paper.pdf",
11899
12120
  * "target_type": "file",
11900
12121
  * "length": 1,
@@ -11903,7 +12124,7 @@ type components = {
11903
12124
  * "id": "01KE506KZGD8M2P1XK3VNQT4YR",
11904
12125
  * "type": "file",
11905
12126
  * "label": "Research Paper.pdf",
11906
- * "collection_pi": "01JCOLLECTION123456789ABCD",
12127
+ * "collection_id": "01JCOLLECTION123456789ABCD",
11907
12128
  * "description_preview": "Analysis of entity management patterns and best practices...",
11908
12129
  * "created_at": "2025-01-15T10:00:00.000Z",
11909
12130
  * "updated_at": "2025-01-20T14:30:00.000Z"
@@ -11915,12 +12136,12 @@ type components = {
11915
12136
  * @description Entity ID (ULID format)
11916
12137
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11917
12138
  */
11918
- source_pi: string;
12139
+ source_id: string;
11919
12140
  /**
11920
12141
  * @description Entity ID (ULID format)
11921
12142
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11922
12143
  */
11923
- target_pi: string;
12144
+ target_id: string;
11924
12145
  target_label: string;
11925
12146
  target_type: string;
11926
12147
  /** @description Path length (number of hops) */
@@ -11941,7 +12162,7 @@ type components = {
11941
12162
  * "01KE4ZY69F9R40E88PK9S0TQRQ"
11942
12163
  * ]
11943
12164
  */
11944
- source_pis: string[];
12165
+ source_ids: string[];
11945
12166
  /**
11946
12167
  * @description Target entity type to find
11947
12168
  * @example file
@@ -11971,7 +12192,7 @@ type components = {
11971
12192
  * @example {
11972
12193
  * "direction": "outgoing",
11973
12194
  * "predicate": "contains",
11974
- * "peer_pi": "01KE506KZGD8M2P1XK3VNQT4YR",
12195
+ * "peer_id": "01KE506KZGD8M2P1XK3VNQT4YR",
11975
12196
  * "peer_type": "file",
11976
12197
  * "peer_label": "Research Paper.pdf",
11977
12198
  * "properties": {},
@@ -11979,7 +12200,7 @@ type components = {
11979
12200
  * "id": "01KE506KZGD8M2P1XK3VNQT4YR",
11980
12201
  * "type": "file",
11981
12202
  * "label": "Research Paper.pdf",
11982
- * "collection_pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
12203
+ * "collection_id": "01KE4ZY69F9R40E88PK9S0TQRQ",
11983
12204
  * "description_preview": "Analysis of entity management patterns and best practices...",
11984
12205
  * "created_at": "2025-01-15T10:00:00.000Z",
11985
12206
  * "updated_at": "2025-01-20T14:30:00.000Z"
@@ -11994,7 +12215,7 @@ type components = {
11994
12215
  * @description Entity ID (ULID format)
11995
12216
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
11996
12217
  */
11997
- peer_pi: string;
12218
+ peer_id: string;
11998
12219
  peer_type: string;
11999
12220
  peer_label: string;
12000
12221
  properties: {
@@ -12005,17 +12226,17 @@ type components = {
12005
12226
  };
12006
12227
  /**
12007
12228
  * @example {
12008
- * "pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
12229
+ * "id": "01KE4ZY69F9R40E88PK9S0TQRQ",
12009
12230
  * "type": "folder",
12010
12231
  * "label": "Project Folder",
12011
- * "collection_pi": "01JCOLLECTION123456789ABCD",
12232
+ * "collection_id": "01JCOLLECTION123456789ABCD",
12012
12233
  * "created_at": "2025-01-10T08:00:00.000Z",
12013
12234
  * "updated_at": "2025-01-18T16:45:00.000Z",
12014
12235
  * "relationships": [
12015
12236
  * {
12016
12237
  * "direction": "outgoing",
12017
12238
  * "predicate": "contains",
12018
- * "peer_pi": "01KE506KZGD8M2P1XK3VNQT4YR",
12239
+ * "peer_id": "01KE506KZGD8M2P1XK3VNQT4YR",
12019
12240
  * "peer_type": "file",
12020
12241
  * "peer_label": "Research Paper.pdf",
12021
12242
  * "properties": {},
@@ -12023,7 +12244,7 @@ type components = {
12023
12244
  * "id": "01KE506KZGD8M2P1XK3VNQT4YR",
12024
12245
  * "type": "file",
12025
12246
  * "label": "Research Paper.pdf",
12026
- * "collection_pi": "01JCOLLECTION123456789ABCD",
12247
+ * "collection_id": "01JCOLLECTION123456789ABCD",
12027
12248
  * "description_preview": "Analysis of entity management patterns and best practices...",
12028
12249
  * "created_at": "2025-01-15T10:00:00.000Z",
12029
12250
  * "updated_at": "2025-01-20T14:30:00.000Z"
@@ -12037,10 +12258,10 @@ type components = {
12037
12258
  * @description Entity ID (ULID format)
12038
12259
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
12039
12260
  */
12040
- pi: string;
12261
+ id: string;
12041
12262
  type: string;
12042
12263
  label: string;
12043
- collection_pi: string | null;
12264
+ collection_id: string | null;
12044
12265
  /** Format: date-time */
12045
12266
  created_at: string;
12046
12267
  /** Format: date-time */
@@ -12089,15 +12310,15 @@ type components = {
12089
12310
  /**
12090
12311
  * @description Query result entity with optional expansion data
12091
12312
  * @example {
12092
- * "pi": "01KE4ZY69F9R40E88PK9S0TQRQ",
12313
+ * "id": "01KE4ZY69F9R40E88PK9S0TQRQ",
12093
12314
  * "type": "person",
12094
12315
  * "label": "Albert Einstein",
12095
- * "collection_pi": "01JCOLL_RESEARCH",
12316
+ * "collection_id": "01JCOLL_RESEARCH",
12096
12317
  * "preview_data": {
12097
12318
  * "id": "01KE4ZY69F9R40E88PK9S0TQRQ",
12098
12319
  * "type": "person",
12099
12320
  * "label": "Albert Einstein",
12100
- * "collection_pi": "01JCOLL_RESEARCH",
12321
+ * "collection_id": "01JCOLL_RESEARCH",
12101
12322
  * "description_preview": "German-born theoretical physicist who developed the theory of relativity...",
12102
12323
  * "created_at": "2025-01-15T10:00:00.000Z",
12103
12324
  * "updated_at": "2025-01-20T14:30:00.000Z"
@@ -12109,13 +12330,13 @@ type components = {
12109
12330
  * @description Entity ID (ULID format)
12110
12331
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
12111
12332
  */
12112
- pi: string;
12333
+ id: string;
12113
12334
  /** @example person */
12114
12335
  type: string;
12115
12336
  /** @example Albert Einstein */
12116
12337
  label: string;
12117
12338
  /** @example 01JCOLL_RESEARCH */
12118
- collection_pi: string | null;
12339
+ collection_id: string | null;
12119
12340
  preview_data?: components["schemas"]["EntityPreview"] & unknown;
12120
12341
  full_entity?: components["schemas"]["EntityResponse"] & unknown;
12121
12342
  };
@@ -12160,6 +12381,26 @@ type components = {
12160
12381
  * @enum {string}
12161
12382
  */
12162
12383
  expand?: "none" | "preview" | "full";
12384
+ /**
12385
+ * @description Filter by indexed metadata properties during semantic search.
12386
+ *
12387
+ * Only underscore-prefixed properties (`_year`, `_class`, etc.) are indexed as filterable metadata.
12388
+ *
12389
+ * **Operators:** `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`, `$in`, `$nin`, `$exists`, `$and`, `$or`
12390
+ *
12391
+ * **Example - Find letters from the 1800s:**
12392
+ * ```json
12393
+ * { "_year": { "$gte": 1800, "$lte": 1899 } }
12394
+ * ```
12395
+ * @example {
12396
+ * "_year": {
12397
+ * "$gt": 1800
12398
+ * }
12399
+ * }
12400
+ */
12401
+ filter?: {
12402
+ [key: string]: unknown;
12403
+ };
12163
12404
  };
12164
12405
  MessageTooLargeDetails: {
12165
12406
  /** @enum {string} */
@@ -12323,7 +12564,7 @@ type components = {
12323
12564
  * @description Entity ID (ULID format)
12324
12565
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
12325
12566
  */
12326
- pi: string;
12567
+ id: string;
12327
12568
  /**
12328
12569
  * @description Entity version number
12329
12570
  * @example 1
@@ -12356,7 +12597,7 @@ type components = {
12356
12597
  * @description Entity ID (ULID format)
12357
12598
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
12358
12599
  */
12359
- pi: string;
12600
+ id: string;
12360
12601
  /**
12361
12602
  * @description Entity version number
12362
12603
  * @example 1
@@ -12403,7 +12644,7 @@ type components = {
12403
12644
  * @description Entity ID (ULID format)
12404
12645
  * @example 01KDETYWYWM0MJVKM8DK3AEXPY
12405
12646
  */
12406
- pi: string;
12647
+ id: string;
12407
12648
  /**
12408
12649
  * @description Entity version number
12409
12650
  * @example 1