@naturali/sdk 0.136.0 → 0.137.0

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.
package/dist/index.d.mts CHANGED
@@ -422,6 +422,8 @@ type ErrorResponse = {
422
422
  * Key-value labels on a resource. A flat object of string values — an array, a nested object or a number is rejected with `400 VALIDATION_FAILED`, never coerced. Keys are opaque and stored verbatim, so `cost_center` and `costCenter` are two different tags. Matched by JSONB containment wherever tags are read: the `?tags=` filter and knowledge search.
423
423
  *
424
424
  * Keys beginning `system.` are reserved: the platform writes them to record which conversation, actor, agent and role a row came from, and a write naming one is refused with `400 RESERVED_TAG_KEY`. They are read and filtered like any other tag.
425
+ *
426
+ * The bag is bounded, because every pair reaches the IAM context of every access check on the resource: at most 50 keys, each key at most 128 characters and each value at most 256. A write past a bound — including a merge that would grow the stored bag past the key count — is `400 VALIDATION_FAILED` with `meta.limit` naming the bound it crossed. `system.*` keys are the platform's and do not count against the 50.
425
427
  */
426
428
  type TagBag = {
427
429
  [key: string]: string;
@@ -1165,6 +1167,10 @@ type UpdateAgentRequest = {
1165
1167
  * Optional tag for the config version this write archives (e.g. `pre-tone-change`). Annotates the version only — it is not stored on the agent and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes nothing, since no version is created.
1166
1168
  */
1167
1169
  version_label?: string | null;
1170
+ /**
1171
+ * Refuses the write unless the resource is at this version.
1172
+ */
1173
+ expected_version?: ExpectedVersion;
1168
1174
  };
1169
1175
  type CreateAgentGenerationRequest = {
1170
1176
  messages: Array<{
@@ -1210,9 +1216,7 @@ type CreateAgentGenerationRequest = {
1210
1216
  /**
1211
1217
  * Caller-supplied key/value metadata attached to the generation record for per-run audit attribution (e.g. the knowledge-corpus version that produced this action). Round-trips verbatim when the generation is fetched via the generations API. The bag is caller-owned and no key is reserved: server-owned state (usage attribution, the served agent version, the model route's record, the extraction summary) lives in its own top-level generation fields and cannot be written from here. Use the request's own `action_id` field to set the usage-attribution label.
1212
1218
  */
1213
- metadata?: {
1214
- [key: string]: unknown;
1215
- } | null;
1219
+ metadata?: NullableMetadataBag;
1216
1220
  /**
1217
1221
  * Per-generation knowledge retrieval override. Array filters (memory_store_ids, document_ids, document_paths) are unioned with the agent's stored knowledge_config; `tags` pairs are merged with the override winning per key; scalar fields (min_score, rrf_k, recency_half_life_days, limit) use the per-generation value when present.
1218
1222
  */
@@ -1578,6 +1582,20 @@ type ToolMcpConfig = {
1578
1582
  [key: string]: string;
1579
1583
  } | null;
1580
1584
  } | null;
1585
+ /**
1586
+ * The version the caller believes the resource holds. When the resource is at any other version the write is refused with `409 VERSION_CONFLICT` and nothing is written; `meta.current_version` on that response names the version in force.
1587
+ *
1588
+ * Omit it to write unconditionally. Omitting it does not make the write unordered: two writes that reach the server together are still serialized, and the one whose version was taken first is refused the same way. What the field adds is refusing a write whose author read the resource some time ago and has not seen what happened since.
1589
+ *
1590
+ * The `If-Match` header carries the same precondition for a client that prefers the HTTP spelling. Sending both with different versions is `400 VALIDATION_FAILED`.
1591
+ */
1592
+ type ExpectedVersion = number | null;
1593
+ /**
1594
+ * A `MetadataBag` on a field where `null` is meaningful — a full-replacement update that clears the bag, or a record whose bag was never set.
1595
+ */
1596
+ type NullableMetadataBag = {
1597
+ [key: string]: unknown;
1598
+ } | null;
1581
1599
  type ProviderPrice = {
1582
1600
  /**
1583
1601
  * Public ID of the price row
@@ -2523,9 +2541,7 @@ type ConversationMessageRecord = {
2523
2541
  /**
2524
2542
  * Optional structured metadata attached to the message
2525
2543
  */
2526
- metadata?: {
2527
- [key: string]: unknown;
2528
- } | null;
2544
+ metadata?: NullableMetadataBag;
2529
2545
  /**
2530
2546
  * Full text content of the message
2531
2547
  */
@@ -2581,6 +2597,42 @@ type GenerateConversationMessageResponse = ({
2581
2597
  } & GenerateConversationMessageCompleted) | ({
2582
2598
  status: 'requires_action';
2583
2599
  } & GenerateConversationMessageRequiresAction);
2600
+ /**
2601
+ * An immutable archive of a document's content and annotations at one version.
2602
+ */
2603
+ type DocumentVersion = {
2604
+ /**
2605
+ * Public ID of the archived version
2606
+ */
2607
+ id?: string;
2608
+ /**
2609
+ * Public ID of the document this version belongs to
2610
+ */
2611
+ document_id?: string;
2612
+ /**
2613
+ * The archived version number
2614
+ */
2615
+ version?: number;
2616
+ /**
2617
+ * The document's versioned surface as it stood at this version: its `content`, `title`, `path`, `metadata`, `tags` and chunk configuration. A full snapshot rather than a diff, because what a restore has to reproduce is what a run read — which is a read by version, and a diff chain would have to be replayed to answer it.
2618
+ *
2619
+ * A withdrawal is archived as a version too, carrying `withdrawn: true` and no content. Restoring one is refused; restore the version before it.
2620
+ *
2621
+ * Deliberately open rather than a fixed schema: an archive written by an earlier release of the runtime reflects the document surface **of its own time**, so it may carry fields the current API no longer documents.
2622
+ */
2623
+ config?: {
2624
+ [key: string]: unknown;
2625
+ };
2626
+ /**
2627
+ * Optional human tag for this version, e.g. `pre-correction`. Set from the `version_label` of the write that archived it, or generated for a restore or a withdrawal.
2628
+ */
2629
+ label?: string | null;
2630
+ /**
2631
+ * Public ID of the user whose write produced this version; null for a write with no request user behind it.
2632
+ */
2633
+ created_by?: string | null;
2634
+ created_at?: Date;
2635
+ };
2584
2636
  type DocumentRecord = {
2585
2637
  /**
2586
2638
  * Document ID
@@ -2611,9 +2663,13 @@ type DocumentRecord = {
2611
2663
  */
2612
2664
  size?: number;
2613
2665
  /**
2614
- * Ingestion lifecycle state. `pending` — enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see the `error` field on `GET /documents/{id}/status`).
2666
+ * Ingestion lifecycle state. `pending` — enqueued; `processing` — chunks being extracted and embedded; `ready` — fully indexed; `failed` — processing error (see the `error` field on `GET /documents/{id}/status`); `withdrawn` — taken out of listings and search, with its chunks dropped, and restorable from an earlier version.
2615
2667
  */
2616
- status?: 'pending' | 'processing' | 'ready' | 'failed';
2668
+ status?: 'pending' | 'processing' | 'ready' | 'failed' | 'withdrawn';
2669
+ /**
2670
+ * The document's content version, starting at 1. Every write that changes the content or its annotations archives the state it replaced and increments this.
2671
+ */
2672
+ version?: number;
2617
2673
  /**
2618
2674
  * Text content (only present on getDocument, and only when status is ready)
2619
2675
  */
@@ -2630,9 +2686,32 @@ type DocumentRecord = {
2630
2686
  * Overlap in characters between consecutive windows used when `chunk_strategy=size`. Absent otherwise.
2631
2687
  */
2632
2688
  chunk_overlap?: number;
2689
+ /**
2690
+ * The typed edges this document asserts about others, on a single document read. Absent from a listing, which is a page of documents rather than of edges.
2691
+ */
2692
+ relations?: Array<DocumentRelation>;
2633
2693
  created_at?: Date;
2634
2694
  updated_at?: Date;
2635
2695
  };
2696
+ /**
2697
+ * A typed edge one document asserts about another, within one project.
2698
+ */
2699
+ type DocumentRelation = {
2700
+ id?: string;
2701
+ /**
2702
+ * What the asserting document claims: it was `derived_from` the other, `supersedes` it, or `cites` it.
2703
+ */
2704
+ type?: 'derived_from' | 'supersedes' | 'cites';
2705
+ /**
2706
+ * The document that asserts the edge
2707
+ */
2708
+ from_document_id?: string;
2709
+ /**
2710
+ * The document the edge points at
2711
+ */
2712
+ to_document_id?: string;
2713
+ created_at?: Date;
2714
+ };
2636
2715
  type IngestedDocumentRecord = DocumentRecord & {
2637
2716
  /**
2638
2717
  * Number of chunks created from the file.
@@ -2669,6 +2748,14 @@ type DocumentStatusRecord = {
2669
2748
  */
2670
2749
  error?: string | null;
2671
2750
  };
2751
+ /**
2752
+ * Caller-owned annotations on a resource, stored as the object they were written as: the types a value was written with are the types a read returns, so a filter can ask an ordering question about a number. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
2753
+ *
2754
+ * No key is reserved, and that is the point: every piece of state the platform owns lives in its own typed column, so nothing written here reaches platform state. The platform never reads the bag — it is not an IAM context, not a policy input and not part of a prompt — which is what separates it from a tag bag.
2755
+ */
2756
+ type MetadataBag = {
2757
+ [key: string]: unknown;
2758
+ };
2672
2759
  /**
2673
2760
  * Response containing generated embeddings. Fields present depend on whether `input` or `inputs` was provided.
2674
2761
  */
@@ -2809,9 +2896,7 @@ type DatasetItem = {
2809
2896
  dataset_id?: string;
2810
2897
  input?: DatasetItemInput;
2811
2898
  expected_output?: string | null;
2812
- metadata?: {
2813
- [key: string]: unknown;
2814
- } | null;
2899
+ metadata?: NullableMetadataBag;
2815
2900
  /**
2816
2901
  * The generation this item was curated from. A curated item is a deliberate fixture: erasing the source generation neither deletes nor mutates it.
2817
2902
  */
@@ -2907,9 +2992,7 @@ type EvalRun = {
2907
2992
  /**
2908
2993
  * The caller-owned key/value metadata supplied when the run was started, returned verbatim. Null when the run was started without any (a trigger-started run included — see `trigger_id` for that provenance). The server writes nothing here.
2909
2994
  */
2910
- metadata?: {
2911
- [key: string]: unknown;
2912
- } | null;
2995
+ metadata?: NullableMetadataBag;
2913
2996
  started_at?: Date | null;
2914
2997
  finished_at?: Date | null;
2915
2998
  created_at?: Date;
@@ -3014,10 +3097,7 @@ type UploadFileBase64Request = {
3014
3097
  * MIME type of the file
3015
3098
  */
3016
3099
  content_type?: string;
3017
- /**
3018
- * JSON string with additional metadata
3019
- */
3020
- metadata?: string;
3100
+ metadata?: MetadataBag;
3021
3101
  };
3022
3102
  /**
3023
3103
  * Stored file metadata
@@ -3047,10 +3127,7 @@ type FileRecord = {
3047
3127
  * File size in bytes
3048
3128
  */
3049
3129
  size?: number | null;
3050
- /**
3051
- * JSON string with additional metadata
3052
- */
3053
- metadata?: string | null;
3130
+ metadata?: NullableMetadataBag;
3054
3131
  tags?: TagBag;
3055
3132
  /**
3056
3133
  * Creation timestamp
@@ -3061,6 +3138,10 @@ type FileRecord = {
3061
3138
  */
3062
3139
  updated_at?: Date;
3063
3140
  };
3141
+ /**
3142
+ * A `MetadataBag` as JSON text. A multipart field carries text, so the object travels serialized on those surfaces and is parsed on arrival; a JSON body carries the object itself. Text that is not a JSON object is `400 VALIDATION_FAILED`.
3143
+ */
3144
+ type MetadataBagText = string;
3064
3145
  /**
3065
3146
  * A formation template supplied as either a JSON object or a YAML/JSON string. When a string is provided the server parses it with a YAML parser (JSON is valid YAML) before processing.
3066
3147
  *
@@ -3091,9 +3172,7 @@ type FormationTemplate = {
3091
3172
  * Arbitrary metadata attached to the template. Supports the same substitution as `outputs`: `{ "ref": "logicalId" }` resolves to a created resource's physical ID, and `{ "param": "ParamName" }` / `{ "sub": "text ${ParamName}" }` embed parameter values. The raw expressions are preserved here; the resolved values from the last deploy are exposed on the formation's `resolved_metadata` field.
3092
3173
  *
3093
3174
  */
3094
- metadata?: {
3095
- [key: string]: unknown;
3096
- } | null;
3175
+ metadata?: NullableMetadataBag;
3097
3176
  };
3098
3177
  type ParameterDeclaration = {
3099
3178
  /**
@@ -3537,9 +3616,7 @@ type DatasetItemResourceProperties = {
3537
3616
  /**
3538
3617
  * Free-form tags on the case, e.g. `{"topic": "billing"}`
3539
3618
  */
3540
- metadata?: {
3541
- [key: string]: unknown;
3542
- } | null;
3619
+ metadata?: NullableMetadataBag;
3543
3620
  };
3544
3621
  /**
3545
3622
  * Binds an agent under test to a dataset and the scorers its outputs are judged by. `pass_threshold` is the pass rate a run must reach for its `passed` verdict — the gate an agent-version promotion consumes.
@@ -3591,9 +3668,7 @@ type DocumentResourceProperties = {
3591
3668
  /**
3592
3669
  * Arbitrary metadata key-value pairs
3593
3670
  */
3594
- metadata?: {
3595
- [key: string]: unknown;
3596
- } | null;
3671
+ metadata?: NullableMetadataBag;
3597
3672
  /**
3598
3673
  * Tag key-value pairs for filtering
3599
3674
  */
@@ -3662,9 +3737,7 @@ type MemoryResourceProperties = {
3662
3737
  /**
3663
3738
  * Arbitrary structured metadata attached to the memory
3664
3739
  */
3665
- metadata?: {
3666
- [key: string]: unknown;
3667
- } | null;
3740
+ metadata?: NullableMetadataBag;
3668
3741
  };
3669
3742
  /**
3670
3743
  * Declares a model route within the formation's project: a named, ordered list of provider+model failover targets with retry and circuit-breaker configuration. Consumers reference it through their own `model_route_id`, or inherit it as the project's `default_model_route_id`.
@@ -3803,9 +3876,9 @@ type FileResourceProperties = {
3803
3876
  */
3804
3877
  size?: number | null;
3805
3878
  /**
3806
- * JSON string with additional metadata
3879
+ * Caller-owned annotations on the file, stored as the object they were written as; `null` clears the bag. Keys are stored and returned verbatim in the casing supplied.
3807
3880
  */
3808
- metadata?: string | null;
3881
+ metadata?: NullableMetadataBag;
3809
3882
  };
3810
3883
  /**
3811
3884
  * Creates an encrypted secret within the formation's project.
@@ -3845,7 +3918,7 @@ type SessionResourceProperties = {
3845
3918
  */
3846
3919
  inactivity_ttl_seconds?: number;
3847
3920
  /**
3848
- * Optional context object passed to tool calls
3921
+ * Optional context object passed to tool calls. Write-only: no read of a session returns it.
3849
3922
  */
3850
3923
  tool_context?: {
3851
3924
  [key: string]: unknown;
@@ -3900,9 +3973,7 @@ type IngestionRuleResourceProperties = {
3900
3973
  /**
3901
3974
  * Arbitrary JSON metadata
3902
3975
  */
3903
- metadata?: {
3904
- [key: string]: unknown;
3905
- } | null;
3976
+ metadata?: NullableMetadataBag;
3906
3977
  };
3907
3978
  /**
3908
3979
  * Declares what a memory store accepts from completed agent turns: a selector, an event, and a handler. With neither `agent_id` nor `tool_id` the built-in extractor runs, configurable through `prompt`, `ai_provider_id` and `model`. See the Memory Rules section of the Memories module docs.
@@ -4023,6 +4094,25 @@ type WorkflowResourceProperties = {
4023
4094
  [key: string]: unknown;
4024
4095
  } | null;
4025
4096
  };
4097
+ /**
4098
+ * Declares what `metadata` must satisfy for one resource type under one selector, so a template ships the corpus and the rule governing it together. `resource_type` is immutable: changing it in a template is a delete and a create.
4099
+ */
4100
+ type MetadataSchemaResourceProperties = {
4101
+ /**
4102
+ * The resource whose metadata this declaration governs.
4103
+ */
4104
+ resource_type: 'document';
4105
+ /**
4106
+ * The selector a `document` declaration must carry: the directory it governs, matched on a path boundary.
4107
+ */
4108
+ path_prefix?: string;
4109
+ /**
4110
+ * A JSON Schema, stored as written.
4111
+ */
4112
+ schema: {
4113
+ [key: string]: unknown;
4114
+ };
4115
+ };
4026
4116
  /**
4027
4117
  * Creates a quota — a project-scoped cap that blocks (`enforce`) or reports (`monitor`) when a windowed aggregate is exceeded. `requests` quotas are enforced by the request middleware; `tokens`/`cost_usd` quotas at the pre-generation check. Mirrors the quotas REST contract; `scope`, `metric`, `window`, and `meter_type` are immutable after creation (only `limit`, `mode`, and `on_unpriced` update).
4028
4118
  */
@@ -4103,7 +4193,7 @@ type GuardrailResourceProperties = {
4103
4193
  };
4104
4194
  type ResourceDeclaration = {
4105
4195
  /**
4106
- * Resource type. The types this API accepts are `ai_provider`, `tool`, `agent`, `actor`, `conversation`, `dataset`, `dataset_item`, `document`, `file`, `guardrail`, `ingestion_rule`, `memory_store`, `memory`, `memory_rule`, `model_route`, `eval`, `orchestration`, `quota`, `secret`, `session`, `trigger` and `workflow` — plus two naturali registers itself and handles through its own lifecycle: `channel`, taking the same property names the channels API takes (its credential properties are write-only, so a tenant credential never lands in the resource ledger), and `naturali_ai_provider`, which takes a `default_model` from the model catalog and provisions a provider running on naturali's own model access (it carries no credential of yours, so it accepts none). A template naming any other type is refused with `400 unsupported_resource_type` before it reaches the runtime — including the runtime's own `api_key`, `chat`, `policy`, `project_price` and `webhook` types, which this API does not expose.
4196
+ * Resource type. The types this API accepts are `ai_provider`, `tool`, `agent`, `actor`, `conversation`, `dataset`, `dataset_item`, `document`, `file`, `guardrail`, `ingestion_rule`, `memory_store`, `memory`, `memory_rule`, `metadata_schema`, `model_route`, `eval`, `orchestration`, `quota`, `secret`, `session`, `trigger` and `workflow` — plus two naturali registers itself and handles through its own lifecycle: `channel`, taking the same property names the channels API takes (its credential properties are write-only, so a tenant credential never lands in the resource ledger), and `naturali_ai_provider`, which takes a `default_model` from the model catalog and provisions a provider running on naturali's own model access (it carries no credential of yours, so it accepts none). A template naming any other type is refused with `400 unsupported_resource_type` before it reaches the runtime — including the runtime's own `api_key`, `chat`, `policy`, `project_price` and `webhook` types, which this API does not expose.
4107
4197
  *
4108
4198
  * This is deliberately not an enum: a deployment operator can register additional resource types backed by their own handler, and those are declared here exactly like a built-in one. The set a given deployment accepts is authoritative in the server, which rejects an unregistered type with `VALIDATION_FAILED` and lists what it does support.
4109
4199
  *
@@ -4125,9 +4215,7 @@ type ResourceDeclaration = {
4125
4215
  *
4126
4216
  */
4127
4217
  deletion_policy?: 'delete' | 'retain';
4128
- metadata?: {
4129
- [key: string]: unknown;
4130
- } | null;
4218
+ metadata?: NullableMetadataBag;
4131
4219
  };
4132
4220
  type FormationResource = {
4133
4221
  /**
@@ -4184,9 +4272,7 @@ type Formation = {
4184
4272
  * Static annotations stored on the formation record (supplied at create/update). Not a substitution site — `sub`/`param`/`ref` expressions are rejected. Use the template's top-level `metadata` block for deploy-time substitution (see `resolved_metadata`).
4185
4273
  *
4186
4274
  */
4187
- metadata?: {
4188
- [key: string]: unknown;
4189
- } | null;
4275
+ metadata?: NullableMetadataBag;
4190
4276
  /**
4191
4277
  * The template's top-level `metadata` block after parameter (`sub`/`param`) and resource (`ref`) substitution at the last deploy. Null when the template declares no metadata.
4192
4278
  *
@@ -4524,9 +4610,7 @@ type Generation = {
4524
4610
  * Caller-owned key/value annotations, attached at create time (via the `metadata` field on the create-agent-generation request) or afterwards (via the update-generation request), and returned verbatim. The server writes nothing here: every piece of state it owns — usage attribution, the served agent version, the route's record, the extraction summary, internal recovery state — is a field of its own, so no key written here can reach platform state. Keys are never transformed, and no key is reserved.
4525
4611
  *
4526
4612
  */
4527
- metadata?: {
4528
- [key: string]: unknown;
4529
- } | null;
4613
+ metadata?: NullableMetadataBag;
4530
4614
  /**
4531
4615
  * When the generation's content was purged. Non-null means `metadata`, `error`, `extraction` and the internal recovery state have been cleared, while the usage/audit skeleton — ids, timestamps, status, stop reason and the attribution fields — is preserved.
4532
4616
  *
@@ -4549,9 +4633,7 @@ type UpdateGenerationRequest = {
4549
4633
  * Caller-supplied key/value metadata to shallow-merge into the generation record's caller-owned `metadata` bag. No key is reserved: server-owned state lives in its own top-level fields and cannot be written from here.
4550
4634
  *
4551
4635
  */
4552
- metadata: {
4553
- [key: string]: unknown;
4554
- };
4636
+ metadata: MetadataBag;
4555
4637
  };
4556
4638
  /**
4557
4639
  * One tool call the model made during a step.
@@ -4700,11 +4782,11 @@ type MemoryAssertion = {
4700
4782
  id?: string;
4701
4783
  memory_store_id?: string;
4702
4784
  /**
4703
- * The memory this assertion resolved into: the new memory for `created` and `superseded`, the existing memory that matched for `skipped`. Null only once that memory has been deleted.
4785
+ * The memory this assertion resolved into: the new memory for `created` and `superseded`, the existing memory that matched for `skipped`, the memory withdrawn for `retracted`. Null only once that memory has been deleted.
4704
4786
  */
4705
4787
  memory_id?: string | null;
4706
4788
  /**
4707
- * The memory this assertion retired, on a `superseded` outcome; null otherwise. Read back from `memories.superseded_by_memory_id` rather than stored here, because validity lives on the memory — where every read filters it — and exactly one memory is superseded per assertion.
4789
+ * The memory this assertion retired, on a `superseded` outcome; null otherwise, a retraction included — it retires its own memory, which `memory_id` already names. Read back from `memories.superseded_by_memory_id` rather than stored here, because validity lives on the memory — where every read filters it — and exactly one memory is superseded per assertion.
4708
4790
  */
4709
4791
  superseded_memory_id?: string | null;
4710
4792
  /**
@@ -4729,15 +4811,15 @@ type MemoryAssertion = {
4729
4811
  principal_type?: string;
4730
4812
  principal_id?: string;
4731
4813
  /**
4732
- * What the write resolved to. `created` is a distinct fact, `superseded` is the same fact changed (the top match was invalidated and replaced), `skipped` is a fact already known.
4814
+ * What the write resolved to. `created` is a distinct fact, `superseded` is the same fact changed (the top match was invalidated and replaced), `skipped` is a fact already known, `retracted` is a fact that stopped holding with nothing replacing it.
4733
4815
  */
4734
- outcome?: 'created' | 'superseded' | 'skipped';
4816
+ outcome?: 'created' | 'superseded' | 'skipped' | 'retracted';
4735
4817
  /**
4736
- * The cosine similarity the outcome was decided against — the top match's, or the declared target's when `declared` is true, where it decides nothing and only records how far apart the two statements were. Null when there was nothing to compare against, or when the content could not be embedded.
4818
+ * The cosine similarity the outcome was decided against — the top match's, or the declared target's when `declared` is true, where it decides nothing and only records how far apart the two statements were. Null when there was nothing to compare against, when the content could not be embedded, and on a `retracted` outcome, which compares nothing.
4737
4819
  */
4738
4820
  similarity?: number | null;
4739
4821
  /**
4740
- * Whether the write named the memory it replaced (`supersedes` on create) instead of the thresholds choosing one. Always false on a `created` or `skipped` outcome.
4822
+ * Whether the write named the memory it replaced (`supersedes` on create) instead of the thresholds choosing one. Always false on a `created`, `skipped` or `retracted` outcome.
4741
4823
  */
4742
4824
  declared?: boolean;
4743
4825
  created_at?: Date;
@@ -4948,6 +5030,10 @@ type UpdateGuardrailRequest = {
4948
5030
  * Optional tag for the config version this write archives (e.g. `pre-tightening`). Annotates the version only — it is not stored on the guardrail and is not part of the config, so labelling a change is never itself a change. Ignored when the write changes no policy, since no version is created.
4949
5031
  */
4950
5032
  version_label?: string;
5033
+ /**
5034
+ * Refuses the write unless the resource is at this version.
5035
+ */
5036
+ expected_version?: ExpectedVersion;
4951
5037
  };
4952
5038
  type IngestionRule = {
4953
5039
  id?: string;
@@ -4964,9 +5050,7 @@ type IngestionRule = {
4964
5050
  chunk_strategy?: string | null;
4965
5051
  chunk_size?: number | null;
4966
5052
  chunk_overlap?: number | null;
4967
- metadata?: {
4968
- [key: string]: unknown;
4969
- } | null;
5053
+ metadata?: NullableMetadataBag;
4970
5054
  created_at?: Date;
4971
5055
  updated_at?: Date;
4972
5056
  };
@@ -5019,9 +5103,7 @@ type DocumentKnowledgeResult = {
5019
5103
  /**
5020
5104
  * Arbitrary metadata attached to the document, returned verbatim in the casing it was written with at create/update time (e.g. a key written as `strapiDocumentId` is returned as `strapiDocumentId`, not `strapi_document_id`) — it is not converted between snake_case and camelCase like other response fields.
5021
5105
  */
5022
- metadata?: {
5023
- [key: string]: unknown;
5024
- };
5106
+ metadata?: MetadataBag;
5025
5107
  tags?: TagBag;
5026
5108
  /**
5027
5109
  * Full text content of the document
@@ -5108,6 +5190,16 @@ type MemoryKnowledgeResult = {
5108
5190
  */
5109
5191
  updated_at: Date;
5110
5192
  };
5193
+ /**
5194
+ * Narrows results by the `metadata` bag. Each key is a field; its value is either a value to match exactly, or an object naming one or more operators.
5195
+ *
5196
+ * Equality and `in` match the stored value exactly, so `3` and `"3"` are different filters.
5197
+ *
5198
+ * `gt`, `gte`, `lt` and `lte` order the field against the operand, and the operand's own JSON type says which comparison is meant: a number orders numerically, a string lexicographically. They work on any field, in any scope. A document whose field holds another type is excluded from the comparison rather than erroring on it, so a range never fails on a bag that happens to hold text where another holds a number. An operand that is neither a number nor a string — a boolean, `null`, a list, an object — has no ordering and is `400 VALIDATION_FAILED`, naming the field in `meta.field`.
5199
+ */
5200
+ type MetadataFilter = {
5201
+ [key: string]: unknown;
5202
+ };
5111
5203
  type Memory = {
5112
5204
  id?: string;
5113
5205
  memory_store_id?: string;
@@ -5130,17 +5222,19 @@ type Memory = {
5130
5222
  /**
5131
5223
  * Arbitrary structured metadata attached to the memory
5132
5224
  */
5133
- metadata?: {
5134
- [key: string]: unknown;
5135
- } | null;
5225
+ metadata?: NullableMetadataBag;
5136
5226
  /**
5137
- * When the memory was superseded. Null means the memory is currently valid. Invalidated memories are excluded from listing, from write deduplication, and from knowledge search, but remain readable by ID — with their original text — for audit.
5227
+ * When the memory stopped holding, whether a supersede replaced it or a retraction withdrew it. Null means the memory is currently valid. Invalidated memories are excluded from listing, from write deduplication, and from knowledge search, but remain readable by ID — with their original text — for audit.
5138
5228
  */
5139
5229
  invalidated_at?: Date | null;
5140
5230
  /**
5141
- * The memory that replaced this one, when it was superseded. Null for valid memories.
5231
+ * The memory that replaced this one, when it was superseded. Null for a valid memory and for a retracted one, which nothing replaced.
5142
5232
  */
5143
5233
  superseded_by_memory_id?: string | null;
5234
+ /**
5235
+ * The memory's write version, starting at 1 and incremented on every update. States a precondition against it with `expected_version` or `If-Match` on `PUT /memories/{memory_id}`.
5236
+ */
5237
+ version?: number;
5144
5238
  created_at?: Date;
5145
5239
  updated_at?: Date;
5146
5240
  };
@@ -5193,6 +5287,29 @@ type MemoryStore = {
5193
5287
  created_at?: Date;
5194
5288
  updated_at?: Date;
5195
5289
  };
5290
+ type MetadataSchemaRecord = {
5291
+ /**
5292
+ * Public ID (mdschema_ prefix)
5293
+ */
5294
+ id?: string;
5295
+ project_id?: string;
5296
+ /**
5297
+ * The resource whose metadata this declaration governs.
5298
+ */
5299
+ resource_type?: 'document';
5300
+ /**
5301
+ * The selector, in the field its resource type is addressed by. A document's is the directory it is filed under.
5302
+ */
5303
+ path_prefix?: string;
5304
+ /**
5305
+ * The declared JSON Schema, as written.
5306
+ */
5307
+ schema?: {
5308
+ [key: string]: unknown;
5309
+ };
5310
+ created_at?: Date;
5311
+ updated_at?: Date;
5312
+ };
5196
5313
  type ModelRouteTarget = {
5197
5314
  /**
5198
5315
  * AI provider in the route's project
@@ -5585,6 +5702,10 @@ type UpdateOrchestrationRequest = {
5585
5702
  * Optional tag for the version this write archives, e.g. `pre-rewire`. Ignored when the write changes no graph field, since no version is archived.
5586
5703
  */
5587
5704
  version_label?: string;
5705
+ /**
5706
+ * Refuses the write unless the resource is at this version.
5707
+ */
5708
+ expected_version?: ExpectedVersion;
5588
5709
  };
5589
5710
  /**
5590
5711
  * An immutable archive of an orchestration's graph at one version.
@@ -5690,9 +5811,7 @@ type OrchestrationRun = {
5690
5811
  /**
5691
5812
  * The caller-owned key/value metadata supplied at run creation, returned verbatim. Null when the run was started without any. The server writes nothing here and no key is reserved; the bag is never merged into `state`, so nothing in it reaches the graph.
5692
5813
  */
5693
- metadata?: {
5694
- [key: string]: unknown;
5695
- } | null;
5814
+ metadata?: NullableMetadataBag;
5696
5815
  /**
5697
5816
  * The deduplication key the run was started under, unique within the project and claimed for as long as the run record exists. Null for a run started without one, which every platform-started run is.
5698
5817
  */
@@ -5861,7 +5980,7 @@ type StartOrchestrationRunRequest = {
5861
5980
  /**
5862
5981
  * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call made by an agent node of this run — including the agents of any child run a `loop` or `sub_orchestration` node starts. The header name is `X-Naturali-Context-` plus the key verbatim; no character is re-cased.
5863
5982
  *
5864
- * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. It is **write-only**: a run is a record every principal who may read runs can read, and a credential in it is not theirs to see, so it is never returned on one. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
5983
+ * The bag is stored on the run and re-read on every step, so it survives an `awaiting_input` pause, a `sleeping` wait, a background worker drive and a crash redrive. It is **write-only**: a run is a record every principal who may read runs can read, and a credential in it is not theirs to see, so it is never returned on one. It also does not outlive the run: reaching a terminal status (`succeeded`, `failed`, `cancelled` or `expired`) clears it. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY` and no run is created.
5865
5984
  *
5866
5985
  * The reserved identity keys (`session_id`, `actor_id`, `actor_external_id`) are stripped at generation time — a caller cannot address them from here.
5867
5986
  */
@@ -5875,9 +5994,7 @@ type StartOrchestrationRunRequest = {
5875
5994
  *
5876
5995
  * It is **not** merged into run state: no graph node sees it, and an `input_schema` never has to tolerate it — which is what makes it the place for an infrastructural label, rather than `input`. Keys are never transformed. It is not inherited by the child runs a `loop` or `sub_orchestration` node starts; each child carries whatever the graph gives it, which today is nothing.
5877
5996
  */
5878
- metadata?: {
5879
- [key: string]: unknown;
5880
- };
5997
+ metadata?: MetadataBag;
5881
5998
  /**
5882
5999
  * Deduplication key, unique within the project, that makes a retry of an ambiguous failure safe. The first request under a key starts the run and answers `201`; any later request carrying the same key answers `200` with that same run, whatever state it has reached — including a retry that arrives while the original is still running.
5883
6000
  *
@@ -5901,6 +6018,24 @@ type ValidateOrchestrationRequest = {
5901
6018
  [key: string]: unknown;
5902
6019
  } | null;
5903
6020
  };
6021
+ type OrchestrationValidationError = {
6022
+ /**
6023
+ * Location of the issue (e.g. nodes[1].input_mapping.val).
6024
+ */
6025
+ path?: string;
6026
+ /**
6027
+ * Human-readable description of the issue.
6028
+ */
6029
+ message?: string;
6030
+ };
6031
+ type OrchestrationValidationResult = {
6032
+ /**
6033
+ * True when there are no blocking errors.
6034
+ */
6035
+ valid: boolean;
6036
+ errors: Array<OrchestrationValidationError>;
6037
+ warnings: Array<OrchestrationValidationError>;
6038
+ };
5904
6039
  type Project = {
5905
6040
  /**
5906
6041
  * Public project ID (proj_ prefix).
@@ -6495,12 +6630,6 @@ type SessionRecord = {
6495
6630
  generating_at?: Date | null;
6496
6631
  created_at?: Date;
6497
6632
  updated_at?: Date;
6498
- /**
6499
- * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call in this session. The header name is the deployment's configured context prefix (`X-Naturali-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
6500
- */
6501
- tool_context?: {
6502
- [key: string]: string;
6503
- } | null;
6504
6633
  /**
6505
6634
  * Number of seconds of inactivity after which the session expires. 0 means the session never expires.
6506
6635
  */
@@ -6574,7 +6703,7 @@ type CreateSessionRequest = {
6574
6703
  */
6575
6704
  auto_generate?: boolean;
6576
6705
  /**
6577
- * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call in this session. The header name is the deployment's configured context prefix (`X-Naturali-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
6706
+ * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call in this session. The header name is the deployment's configured context prefix (`X-Naturali-Context-` by default) plus the key verbatim — no character is re-cased. Keys are stored exactly as sent and never case-converted. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`. `session_id`, `actor_id` and `actor_external_id` are server-derived and dropped from the stored bag, in any casing. Write-only: no read of a session returns it. It also does not outlive the session: closing or expiring it clears the bag.
6578
6707
  */
6579
6708
  tool_context?: {
6580
6709
  [key: string]: string;
@@ -6603,7 +6732,7 @@ type UpdateSessionRequest = {
6603
6732
  */
6604
6733
  auto_generate?: boolean;
6605
6734
  /**
6606
- * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call in this session. The header name is the deployment's configured context prefix (`X-Naturali-Context-` by default) plus the key verbatim — no character is re-cased. Keys are never case-converted — they round-trip exactly as sent. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`.
6735
+ * Key-value pairs forwarded as `X-Naturali-Context-<key>` headers on every `http` and `mcp` tool call in this session. The header name is the deployment's configured context prefix (`X-Naturali-Context-` by default) plus the key verbatim — no character is re-cased. Keys are stored exactly as sent and never case-converted. A key that is not a valid HTTP header name, or two keys that map to the same header, are rejected with `400 INVALID_TOOL_CONTEXT_KEY`. `session_id`, `actor_id` and `actor_external_id` are server-derived and dropped from the stored bag, in any casing. Write-only: no read of a session returns it. It also does not outlive the session: closing or expiring it clears the bag.
6607
6736
  */
6608
6737
  tool_context?: {
6609
6738
  [key: string]: string;
@@ -6750,9 +6879,7 @@ type Task = {
6750
6879
  /**
6751
6880
  * The caller-owned key/value metadata supplied when the task was created, returned verbatim. Null when the task was created without any. Unlike `payload` it is invisible to guards and to `payload_writes`, so it is the place for an attribution label rather than task data.
6752
6881
  */
6753
- metadata?: {
6754
- [key: string]: unknown;
6755
- } | null;
6882
+ metadata?: NullableMetadataBag;
6756
6883
  /**
6757
6884
  * Server-owned. The result of the current state's last completed dispatch, overwritten on every dispatch. Read-only — exposed to transition guards and `on_complete`/`payload_writes` expressions as `task.last_result`, a namespace a caller cannot write.
6758
6885
  */
@@ -6847,9 +6974,7 @@ type CreateTaskRequest = {
6847
6974
  *
6848
6975
  * Prefer this over `payload` for anything that is not task data: `payload` is read by every guard as `task.payload` and may be written by the workflow's declared `payload_writes`, so a label parked there is neither invisible to the state machine nor safe from it. A non-object is rejected with `400 VALIDATION_FAILED` and no task is created.
6849
6976
  */
6850
- metadata?: {
6851
- [key: string]: unknown;
6852
- };
6977
+ metadata?: MetadataBag;
6853
6978
  };
6854
6979
  type UpdateTaskRequest = {
6855
6980
  title?: string;
@@ -7286,6 +7411,14 @@ type TriggerFiring = {
7286
7411
  error?: {
7287
7412
  [key: string]: unknown;
7288
7413
  } | null;
7414
+ /**
7415
+ * `<event_id>:<trigger_id>` for an `event` firing, null for every other source. The same event reaching the same trigger twice produces one firing under this key, so a consumer reading firings can recognise a redelivery.
7416
+ */
7417
+ idempotency_key?: string | null;
7418
+ /**
7419
+ * Dispatch attempts started. Above 1 means an earlier attempt was interrupted before it recorded a result and the firing was redelivered — not that the target refused it, which is recorded terminally in `error` and never retried.
7420
+ */
7421
+ attempts?: number;
7289
7422
  started_at?: Date | null;
7290
7423
  completed_at?: Date | null;
7291
7424
  created_at?: Date;
@@ -7657,6 +7790,10 @@ type UpdateWorkflowRequest = {
7657
7790
  * Optional tag for the version this write archives, e.g. `pre-rewire`. Ignored when the write changes no definition field, since no version is archived.
7658
7791
  */
7659
7792
  version_label?: string;
7793
+ /**
7794
+ * Refuses the write unless the resource is at this version.
7795
+ */
7796
+ expected_version?: ExpectedVersion;
7660
7797
  };
7661
7798
  /**
7662
7799
  * An immutable archive of a workflow's state machine at one version.
@@ -7723,10 +7860,7 @@ type FileRecordWritable = {
7723
7860
  * File size in bytes
7724
7861
  */
7725
7862
  size?: number | null;
7726
- /**
7727
- * JSON string with additional metadata
7728
- */
7729
- metadata?: string | null;
7863
+ metadata?: NullableMetadataBag;
7730
7864
  tags?: TagBag;
7731
7865
  /**
7732
7866
  * Creation timestamp
@@ -7759,6 +7893,10 @@ type Cursor = string;
7759
7893
  *
7760
7894
  */
7761
7895
  type Identifier = string;
7896
+ /**
7897
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
7898
+ */
7899
+ type IfMatchVersion = string;
7762
7900
  /**
7763
7901
  * API key public ID (key_ prefix).
7764
7902
  */
@@ -7799,6 +7937,10 @@ type MessagesLimit = number;
7799
7937
  * Number of messages to skip.
7800
7938
  */
7801
7939
  type Offset = number;
7940
+ /**
7941
+ * A `MetadataFilter` as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
7942
+ */
7943
+ type MetadataQuery = string;
7802
7944
  /**
7803
7945
  * Exception item ID
7804
7946
  */
@@ -7961,6 +8103,59 @@ type ListActivityResponses = {
7961
8103
  };
7962
8104
  };
7963
8105
  type ListActivityResponse = ListActivityResponses[keyof ListActivityResponses];
8106
+ type ExportActivityData = {
8107
+ body?: never;
8108
+ path: {
8109
+ /**
8110
+ * Project public ID (proj_ prefix).
8111
+ */
8112
+ project_id: string;
8113
+ };
8114
+ query?: {
8115
+ /**
8116
+ * Only entries of this kind
8117
+ */
8118
+ kind?: string;
8119
+ /**
8120
+ * Only entries of this severity
8121
+ */
8122
+ severity?: string;
8123
+ /**
8124
+ * Only entries an agent produced
8125
+ */
8126
+ agent_id?: string;
8127
+ /**
8128
+ * Only entries a generation produced
8129
+ */
8130
+ generation_id?: string;
8131
+ /**
8132
+ * Only entries an orchestration run produced
8133
+ */
8134
+ orchestration_run_id?: string;
8135
+ };
8136
+ url: '/v1/projects/{project_id}/activity/export';
8137
+ };
8138
+ type ExportActivityErrors = {
8139
+ /**
8140
+ * `project_id` is required
8141
+ */
8142
+ 400: unknown;
8143
+ /**
8144
+ * Unauthorized
8145
+ */
8146
+ 401: unknown;
8147
+ /**
8148
+ * Forbidden
8149
+ */
8150
+ 403: unknown;
8151
+ };
8152
+ type ExportActivityResponses = {
8153
+ /**
8154
+ * A newline-delimited stream of activity entries. Each line is a JSON object with the same fields as `ActivityEntry`.
8155
+ */
8156
+ 200: string;
8157
+ };
8158
+ type ExportActivityResponse = ExportActivityResponses[keyof ExportActivityResponses];
7964
8159
  type ListActorsData = {
7965
8160
  body?: never;
7966
8161
  path: {
@@ -8968,6 +9163,12 @@ type GetAgentResponses = {
8968
9163
  type GetAgentResponse = GetAgentResponses[keyof GetAgentResponses];
8969
9164
  type PatchAgentData = {
8970
9165
  body: UpdateAgentRequest;
9166
+ headers?: {
9167
+ /**
9168
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
9169
+ */
9170
+ 'If-Match'?: string;
9171
+ };
8971
9172
  path: {
8972
9173
  /**
8973
9174
  * Project public ID (proj_ prefix).
@@ -11716,11 +11917,9 @@ type AddConversationMessageData = {
11716
11917
  */
11717
11918
  position?: number;
11718
11919
  /**
11719
- * Optional structured metadata to attach to the message (e.g. phone number, channel). Stored as-is and injected into the AI prompt context.
11920
+ * Caller-owned annotations on the message (e.g. a phone number, a channel), stored as sent and returned verbatim. The platform does not read the bag, so nothing in it reaches the model: a value the model should see belongs in `message`.
11720
11921
  */
11721
- metadata?: {
11722
- [key: string]: unknown;
11723
- } | null;
11922
+ metadata?: NullableMetadataBag;
11724
11923
  };
11725
11924
  path: {
11726
11925
  /**
@@ -11999,11 +12198,23 @@ type ListDocumentsData = {
11999
12198
  * Only documents filed under this directory. The prefix is a path boundary, not a substring: `/reports` returns `/reports/q1.txt` and never `/reports-archive/q1.txt`, and `/` selects the whole project. A leading slash is optional and a trailing one is ignored, so `reports`, `/reports` and `/reports/` are the same filter. `%` and `_` are literal characters, not wildcards.
12000
12199
  */
12001
12200
  path_prefix?: string;
12201
+ /**
12202
+ * Include withdrawn documents. A withdrawn document leaves every default read and is not in the knowledge index at all — its chunks are dropped when it is withdrawn — so this shows it in the listing but never in a search.
12203
+ */
12204
+ include_withdrawn?: boolean;
12205
+ /**
12206
+ * Only documents related to this one, on either side of the edge: what it points at, and what points at it. An id with no relations narrows the listing to nothing.
12207
+ */
12208
+ related_to?: string;
12002
12209
  /**
12003
12210
  * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
12004
12211
  *
12005
12212
  */
12006
12213
  tags?: Array<string>;
12214
+ /**
12215
+ * A `MetadataFilter` as JSON, url-encoded. It travels as JSON rather than as `key:value` pairs because the match is exact and a query string cannot otherwise say whether `3` is the number or the string.
12216
+ */
12217
+ metadata?: string;
12007
12218
  /**
12008
12219
  * Maximum number of results to return
12009
12220
  */
@@ -12053,9 +12264,7 @@ type CreateDocumentData = {
12053
12264
  /**
12054
12265
  * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
12055
12266
  */
12056
- metadata?: {
12057
- [key: string]: unknown;
12058
- };
12267
+ metadata?: MetadataBag;
12059
12268
  tags?: TagBag;
12060
12269
  /**
12061
12270
  * How to split the content into embeddable chunks. `whole` (default) stores the content as a single chunk; `size` splits into fixed-size character windows with overlap. `page` is equivalent to `whole` for plain text.
@@ -12177,26 +12386,63 @@ type IngestDocumentResponses = {
12177
12386
  202: IngestedDocumentRecord;
12178
12387
  };
12179
12388
  type IngestDocumentResponse = IngestDocumentResponses[keyof IngestDocumentResponses];
12180
- type DeleteDocumentData = {
12389
+ type ExportDocumentsData = {
12181
12390
  body?: never;
12182
12391
  path: {
12183
12392
  /**
12184
12393
  * Project public ID (proj_ prefix).
12185
12394
  */
12186
12395
  project_id: string;
12396
+ };
12397
+ query?: {
12187
12398
  /**
12188
- * Document ID
12399
+ * Only documents filed under this directory. The prefix is a path boundary, not a substring, exactly as on the listing.
12189
12400
  */
12190
- document_id: string;
12401
+ path_prefix?: string;
12191
12402
  };
12192
- query?: never;
12193
- url: '/v1/projects/{project_id}/documents/{document_id}';
12403
+ url: '/v1/projects/{project_id}/documents/export';
12194
12404
  };
12195
- type DeleteDocumentErrors = {
12405
+ type ExportDocumentsErrors = {
12196
12406
  /**
12197
- * Unauthorized
12407
+ * `project_id` is required
12198
12408
  */
12199
- 401: ErrorResponse;
12409
+ 400: unknown;
12410
+ /**
12411
+ * Unauthorized
12412
+ */
12413
+ 401: unknown;
12414
+ /**
12415
+ * Forbidden
12416
+ */
12417
+ 403: unknown;
12418
+ };
12419
+ type ExportDocumentsResponses = {
12420
+ /**
12421
+ * A newline-delimited stream of documents. Each line is a JSON object with the same fields as `Document`.
12422
+ */
12423
+ 200: string;
12424
+ };
12425
+ type ExportDocumentsResponse = ExportDocumentsResponses[keyof ExportDocumentsResponses];
12426
+ type DeleteDocumentData = {
12427
+ body?: never;
12428
+ path: {
12429
+ /**
12430
+ * Project public ID (proj_ prefix).
12431
+ */
12432
+ project_id: string;
12433
+ /**
12434
+ * Document ID
12435
+ */
12436
+ document_id: string;
12437
+ };
12438
+ query?: never;
12439
+ url: '/v1/projects/{project_id}/documents/{document_id}';
12440
+ };
12441
+ type DeleteDocumentErrors = {
12442
+ /**
12443
+ * Unauthorized
12444
+ */
12445
+ 401: ErrorResponse;
12200
12446
  /**
12201
12447
  * Forbidden
12202
12448
  */
@@ -12266,12 +12512,20 @@ type UpdateDocumentData = {
12266
12512
  */
12267
12513
  path?: string | null;
12268
12514
  /**
12269
- * Arbitrary metadata object. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
12515
+ * Arbitrary metadata object, replacing the stored bag; `null` clears it. Unlike other body fields, keys are stored and returned verbatim in the casing supplied — they are not converted between snake_case and camelCase.
12270
12516
  */
12271
- metadata?: {
12272
- [key: string]: unknown;
12273
- };
12517
+ metadata?: NullableMetadataBag;
12274
12518
  tags?: TagBag;
12519
+ /**
12520
+ * Refuses the write unless the document is at this version.
12521
+ */
12522
+ expected_version?: ExpectedVersion;
12523
+ };
12524
+ headers?: {
12525
+ /**
12526
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
12527
+ */
12528
+ 'If-Match'?: string;
12275
12529
  };
12276
12530
  path: {
12277
12531
  /**
@@ -12308,149 +12562,127 @@ type UpdateDocumentResponses = {
12308
12562
  200: DocumentRecord;
12309
12563
  };
12310
12564
  type UpdateDocumentResponse = UpdateDocumentResponses[keyof UpdateDocumentResponses];
12311
- type GetDocumentStatusData = {
12565
+ type ListDocumentRelationsData = {
12312
12566
  body?: never;
12313
12567
  path: {
12314
12568
  /**
12315
12569
  * Project public ID (proj_ prefix).
12316
12570
  */
12317
12571
  project_id: string;
12318
- /**
12319
- * Document ID
12320
- */
12321
12572
  document_id: string;
12322
12573
  };
12323
12574
  query?: never;
12324
- url: '/v1/projects/{project_id}/documents/{document_id}/status';
12575
+ url: '/v1/projects/{project_id}/documents/{document_id}/relations';
12325
12576
  };
12326
- type GetDocumentStatusErrors = {
12577
+ type ListDocumentRelationsErrors = {
12327
12578
  /**
12328
12579
  * Unauthorized
12329
12580
  */
12330
- 401: ErrorResponse;
12581
+ 401: unknown;
12331
12582
  /**
12332
12583
  * Forbidden
12333
12584
  */
12334
- 403: ErrorResponse;
12585
+ 403: unknown;
12335
12586
  /**
12336
12587
  * Document not found
12337
12588
  */
12338
- 404: ErrorResponse;
12589
+ 404: unknown;
12339
12590
  };
12340
- type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
12341
- type GetDocumentStatusResponses = {
12591
+ type ListDocumentRelationsResponses = {
12342
12592
  /**
12343
- * Document ingestion status
12593
+ * The document's relations
12344
12594
  */
12345
- 200: DocumentStatusRecord;
12595
+ 200: {
12596
+ data?: Array<DocumentRelation>;
12597
+ };
12346
12598
  };
12347
- type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
12348
- type ReingestDocumentData = {
12349
- body?: {
12350
- /**
12351
- * How to split the source into chunks. Defaults to `page`.
12352
- */
12353
- chunk_strategy?: 'page' | 'whole' | 'size';
12599
+ type ListDocumentRelationsResponse = ListDocumentRelationsResponses[keyof ListDocumentRelationsResponses];
12600
+ type CreateDocumentRelationData = {
12601
+ body: {
12354
12602
  /**
12355
- * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
12603
+ * What this document claims about the other
12356
12604
  */
12357
- chunk_size?: number;
12605
+ type: 'derived_from' | 'supersedes' | 'cites';
12358
12606
  /**
12359
- * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
12607
+ * The document the edge points at. Must be in the same project, and visible to the caller.
12360
12608
  */
12361
- chunk_overlap?: number;
12609
+ to_document_id: string;
12362
12610
  };
12363
12611
  path: {
12364
12612
  /**
12365
12613
  * Project public ID (proj_ prefix).
12366
12614
  */
12367
12615
  project_id: string;
12368
- /**
12369
- * Document ID
12370
- */
12371
12616
  document_id: string;
12372
12617
  };
12373
- query?: {
12374
- /**
12375
- * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
12376
- */
12377
- wait?: boolean;
12378
- };
12379
- url: '/v1/projects/{project_id}/documents/{document_id}/ingest';
12618
+ query?: never;
12619
+ url: '/v1/projects/{project_id}/documents/{document_id}/relations';
12380
12620
  };
12381
- type ReingestDocumentErrors = {
12621
+ type CreateDocumentRelationErrors = {
12382
12622
  /**
12383
- * Unauthorized
12623
+ * An undeclared `type`, a `to_document_id` that is not a document id, a document relating to itself, or a target in another project
12384
12624
  */
12385
- 401: ErrorResponse;
12625
+ 400: unknown;
12386
12626
  /**
12387
- * Forbidden
12627
+ * Unauthorized
12388
12628
  */
12389
- 403: ErrorResponse;
12629
+ 401: unknown;
12390
12630
  /**
12391
- * Document not found
12631
+ * Forbidden
12392
12632
  */
12393
- 404: ErrorResponse;
12633
+ 403: unknown;
12394
12634
  /**
12395
- * The project's `storage_bytes` quota is exceeded (`QUOTA_STORAGE_EXCEEDED`). Delete stored content, or raise the quota — no window reset clears a stored total, so no `Retry-After` is sent.
12635
+ * Either document was not found
12396
12636
  */
12397
- 409: ErrorResponse;
12637
+ 404: unknown;
12398
12638
  /**
12399
- * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
12639
+ * That relation is already asserted
12400
12640
  */
12401
- 413: ErrorResponse;
12641
+ 409: unknown;
12402
12642
  };
12403
- type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
12404
- type ReingestDocumentResponses = {
12643
+ type CreateDocumentRelationResponses = {
12405
12644
  /**
12406
- * Re-ingestion completed synchronously (only when `?wait=true`).
12407
- */
12408
- 201: IngestedDocumentRecord;
12409
- /**
12410
- * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}/status`.
12645
+ * The asserted relation
12411
12646
  */
12412
- 202: IngestedDocumentRecord;
12647
+ 201: DocumentRelation;
12413
12648
  };
12414
- type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
12415
- type GetDocumentTagsData = {
12649
+ type CreateDocumentRelationResponse = CreateDocumentRelationResponses[keyof CreateDocumentRelationResponses];
12650
+ type DeleteDocumentRelationData = {
12416
12651
  body?: never;
12417
12652
  path: {
12418
12653
  /**
12419
12654
  * Project public ID (proj_ prefix).
12420
12655
  */
12421
12656
  project_id: string;
12422
- /**
12423
- * Document ID
12424
- */
12425
12657
  document_id: string;
12658
+ relation_id: string;
12426
12659
  };
12427
12660
  query?: never;
12428
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
12661
+ url: '/v1/projects/{project_id}/documents/{document_id}/relations/{relation_id}';
12429
12662
  };
12430
- type GetDocumentTagsErrors = {
12663
+ type DeleteDocumentRelationErrors = {
12431
12664
  /**
12432
12665
  * Unauthorized
12433
12666
  */
12434
- 401: ErrorResponse;
12667
+ 401: unknown;
12435
12668
  /**
12436
12669
  * Forbidden
12437
12670
  */
12438
- 403: ErrorResponse;
12671
+ 403: unknown;
12439
12672
  /**
12440
- * Document not found
12673
+ * Document or relation not found
12441
12674
  */
12442
- 404: ErrorResponse;
12675
+ 404: unknown;
12443
12676
  };
12444
- type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
12445
- type GetDocumentTagsResponses = {
12677
+ type DeleteDocumentRelationResponses = {
12446
12678
  /**
12447
- * Document tags
12679
+ * Relation retracted
12448
12680
  */
12449
- 200: TagBag;
12681
+ 204: void;
12450
12682
  };
12451
- type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
12452
- type MergeDocumentTagsData = {
12453
- body: TagBag;
12683
+ type DeleteDocumentRelationResponse = DeleteDocumentRelationResponses[keyof DeleteDocumentRelationResponses];
12684
+ type GetDocumentStatusData = {
12685
+ body?: never;
12454
12686
  path: {
12455
12687
  /**
12456
12688
  * Project public ID (proj_ prefix).
@@ -12462,9 +12694,9 @@ type MergeDocumentTagsData = {
12462
12694
  document_id: string;
12463
12695
  };
12464
12696
  query?: never;
12465
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
12697
+ url: '/v1/projects/{project_id}/documents/{document_id}/status';
12466
12698
  };
12467
- type MergeDocumentTagsErrors = {
12699
+ type GetDocumentStatusErrors = {
12468
12700
  /**
12469
12701
  * Unauthorized
12470
12702
  */
@@ -12478,74 +12710,44 @@ type MergeDocumentTagsErrors = {
12478
12710
  */
12479
12711
  404: ErrorResponse;
12480
12712
  };
12481
- type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
12482
- type MergeDocumentTagsResponses = {
12713
+ type GetDocumentStatusError = GetDocumentStatusErrors[keyof GetDocumentStatusErrors];
12714
+ type GetDocumentStatusResponses = {
12483
12715
  /**
12484
- * Tags merged
12716
+ * Document ingestion status
12485
12717
  */
12486
- 200: TagBag;
12718
+ 200: DocumentStatusRecord;
12487
12719
  };
12488
- type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
12489
- type ReplaceDocumentTagsData = {
12490
- body: TagBag;
12491
- path: {
12720
+ type GetDocumentStatusResponse = GetDocumentStatusResponses[keyof GetDocumentStatusResponses];
12721
+ type WithdrawDocumentData = {
12722
+ body?: {
12492
12723
  /**
12493
- * Project public ID (proj_ prefix).
12724
+ * Optional tag for the tombstone version this write archives.
12494
12725
  */
12495
- project_id: string;
12726
+ version_label?: string | null;
12496
12727
  /**
12497
- * Document ID
12728
+ * Refuses the withdrawal unless the document is at this version.
12498
12729
  */
12499
- document_id: string;
12730
+ expected_version?: ExpectedVersion;
12500
12731
  };
12501
- query?: never;
12502
- url: '/v1/projects/{project_id}/documents/{document_id}/tags';
12503
- };
12504
- type ReplaceDocumentTagsErrors = {
12505
- /**
12506
- * Unauthorized
12507
- */
12508
- 401: ErrorResponse;
12509
- /**
12510
- * Forbidden
12511
- */
12512
- 403: ErrorResponse;
12513
- /**
12514
- * Document not found
12515
- */
12516
- 404: ErrorResponse;
12517
- };
12518
- type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
12519
- type ReplaceDocumentTagsResponses = {
12520
- /**
12521
- * Tags replaced
12522
- */
12523
- 200: TagBag;
12524
- };
12525
- type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
12526
- type CreateEmbeddingsData = {
12527
- body: {
12528
- /**
12529
- * Single text to embed.
12530
- */
12531
- input?: string;
12732
+ headers?: {
12532
12733
  /**
12533
- * Batch of texts to embed. At most 256 per request — each input is one call to the embedding model, so a larger batch is refused (`VALIDATION_FAILED`) rather than queued. Split it across requests.
12734
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
12534
12735
  */
12535
- inputs?: Array<string>;
12736
+ 'If-Match'?: string;
12536
12737
  };
12537
12738
  path: {
12538
12739
  /**
12539
12740
  * Project public ID (proj_ prefix).
12540
12741
  */
12541
12742
  project_id: string;
12743
+ document_id: string;
12542
12744
  };
12543
12745
  query?: never;
12544
- url: '/v1/projects/{project_id}/embeddings';
12746
+ url: '/v1/projects/{project_id}/documents/{document_id}/withdraw';
12545
12747
  };
12546
- type CreateEmbeddingsErrors = {
12748
+ type WithdrawDocumentErrors = {
12547
12749
  /**
12548
- * Invalid request body
12750
+ * Bad Request — the document is filed under the reserved root
12549
12751
  */
12550
12752
  400: ErrorResponse;
12551
12753
  /**
@@ -12553,29 +12755,34 @@ type CreateEmbeddingsErrors = {
12553
12755
  */
12554
12756
  401: ErrorResponse;
12555
12757
  /**
12556
- * The caller cannot write to the named `project_id`
12758
+ * Forbidden
12557
12759
  */
12558
12760
  403: ErrorResponse;
12559
12761
  /**
12560
- * Embedding service not configured
12762
+ * Document not found
12561
12763
  */
12562
- 503: ErrorResponse;
12764
+ 404: ErrorResponse;
12765
+ /**
12766
+ * Conflict — already withdrawn, or the version moved
12767
+ */
12768
+ 409: ErrorResponse;
12563
12769
  };
12564
- type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
12565
- type CreateEmbeddingsResponses = {
12770
+ type WithdrawDocumentError = WithdrawDocumentErrors[keyof WithdrawDocumentErrors];
12771
+ type WithdrawDocumentResponses = {
12566
12772
  /**
12567
- * Embeddings generated successfully
12773
+ * The withdrawn document
12568
12774
  */
12569
- 200: EmbeddingsResponse;
12775
+ 200: DocumentRecord;
12570
12776
  };
12571
- type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
12572
- type ListDatasetsData = {
12777
+ type WithdrawDocumentResponse = WithdrawDocumentResponses[keyof WithdrawDocumentResponses];
12778
+ type ListDocumentVersionsData = {
12573
12779
  body?: never;
12574
12780
  path: {
12575
12781
  /**
12576
12782
  * Project public ID (proj_ prefix).
12577
12783
  */
12578
12784
  project_id: string;
12785
+ document_id: string;
12579
12786
  };
12580
12787
  query?: {
12581
12788
  /**
@@ -12587,75 +12794,429 @@ type ListDatasetsData = {
12587
12794
  */
12588
12795
  offset?: number;
12589
12796
  };
12590
- url: '/v1/projects/{project_id}/datasets';
12797
+ url: '/v1/projects/{project_id}/documents/{document_id}/versions';
12591
12798
  };
12592
- type ListDatasetsErrors = {
12799
+ type ListDocumentVersionsErrors = {
12593
12800
  /**
12594
12801
  * Unauthorized
12595
12802
  */
12596
- 401: unknown;
12803
+ 401: ErrorResponse;
12597
12804
  /**
12598
12805
  * Forbidden
12599
12806
  */
12600
- 403: unknown;
12807
+ 403: ErrorResponse;
12601
12808
  /**
12602
- * Internal server error
12809
+ * Document not found
12603
12810
  */
12604
- 500: unknown;
12811
+ 404: ErrorResponse;
12605
12812
  };
12606
- type ListDatasetsResponses = {
12813
+ type ListDocumentVersionsError = ListDocumentVersionsErrors[keyof ListDocumentVersionsErrors];
12814
+ type ListDocumentVersionsResponses = {
12607
12815
  /**
12608
- * List of datasets
12816
+ * List of document versions, newest first
12609
12817
  */
12610
12818
  200: {
12611
- data: Array<Dataset>;
12819
+ data: Array<DocumentVersion>;
12612
12820
  total: number;
12613
12821
  limit: number;
12614
12822
  offset: number;
12615
12823
  };
12616
12824
  };
12617
- type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
12618
- type CreateDatasetData = {
12619
- body: {
12620
- /**
12621
- * Unique name within the project
12622
- */
12623
- name: string;
12624
- /**
12625
- * What this suite covers
12626
- */
12627
- description?: string | null;
12628
- };
12825
+ type ListDocumentVersionsResponse = ListDocumentVersionsResponses[keyof ListDocumentVersionsResponses];
12826
+ type GetDocumentVersionData = {
12827
+ body?: never;
12629
12828
  path: {
12630
12829
  /**
12631
12830
  * Project public ID (proj_ prefix).
12632
12831
  */
12633
12832
  project_id: string;
12833
+ document_id: string;
12834
+ version: number;
12634
12835
  };
12635
12836
  query?: never;
12636
- url: '/v1/projects/{project_id}/datasets';
12837
+ url: '/v1/projects/{project_id}/documents/{document_id}/versions/{version}';
12637
12838
  };
12638
- type CreateDatasetErrors = {
12839
+ type GetDocumentVersionErrors = {
12639
12840
  /**
12640
- * Bad request (missing or invalid name)
12841
+ * Bad Request — version is not a positive integer
12641
12842
  */
12642
- 400: unknown;
12843
+ 400: ErrorResponse;
12643
12844
  /**
12644
12845
  * Unauthorized
12645
12846
  */
12646
- 401: unknown;
12847
+ 401: ErrorResponse;
12647
12848
  /**
12648
12849
  * Forbidden
12649
12850
  */
12650
- 403: unknown;
12851
+ 403: ErrorResponse;
12651
12852
  /**
12652
- * A dataset with that name already exists in the project
12853
+ * Not found
12653
12854
  */
12654
- 409: unknown;
12855
+ 404: ErrorResponse;
12856
+ };
12857
+ type GetDocumentVersionError = GetDocumentVersionErrors[keyof GetDocumentVersionErrors];
12858
+ type GetDocumentVersionResponses = {
12655
12859
  /**
12656
- * Internal server error
12860
+ * Archived document version
12657
12861
  */
12658
- 500: unknown;
12862
+ 200: DocumentVersion;
12863
+ };
12864
+ type GetDocumentVersionResponse = GetDocumentVersionResponses[keyof GetDocumentVersionResponses];
12865
+ type RestoreDocumentVersionData = {
12866
+ body?: {
12867
+ /**
12868
+ * Optional tag for the version this restore archives. Defaults to `restored from v<version>`.
12869
+ */
12870
+ label?: string | null;
12871
+ };
12872
+ path: {
12873
+ /**
12874
+ * Project public ID (proj_ prefix).
12875
+ */
12876
+ project_id: string;
12877
+ document_id: string;
12878
+ version: number;
12879
+ };
12880
+ query?: never;
12881
+ url: '/v1/projects/{project_id}/documents/{document_id}/versions/{version}/restore';
12882
+ };
12883
+ type RestoreDocumentVersionErrors = {
12884
+ /**
12885
+ * Bad Request — invalid version, or the version is a withdrawal
12886
+ */
12887
+ 400: ErrorResponse;
12888
+ /**
12889
+ * Unauthorized
12890
+ */
12891
+ 401: ErrorResponse;
12892
+ /**
12893
+ * Forbidden
12894
+ */
12895
+ 403: ErrorResponse;
12896
+ /**
12897
+ * Document or version not found
12898
+ */
12899
+ 404: ErrorResponse;
12900
+ };
12901
+ type RestoreDocumentVersionError = RestoreDocumentVersionErrors[keyof RestoreDocumentVersionErrors];
12902
+ type RestoreDocumentVersionResponses = {
12903
+ /**
12904
+ * The document, at its new version
12905
+ */
12906
+ 200: DocumentRecord;
12907
+ };
12908
+ type RestoreDocumentVersionResponse = RestoreDocumentVersionResponses[keyof RestoreDocumentVersionResponses];
12909
+ type ReingestDocumentData = {
12910
+ body?: {
12911
+ /**
12912
+ * How to split the source into chunks. Defaults to `page`.
12913
+ */
12914
+ chunk_strategy?: 'page' | 'whole' | 'size';
12915
+ /**
12916
+ * Window size in characters when `chunk_strategy=size`. Defaults to 1000.
12917
+ */
12918
+ chunk_size?: number;
12919
+ /**
12920
+ * Overlap in characters between consecutive windows when `chunk_strategy=size`. Defaults to 200.
12921
+ */
12922
+ chunk_overlap?: number;
12923
+ };
12924
+ path: {
12925
+ /**
12926
+ * Project public ID (proj_ prefix).
12927
+ */
12928
+ project_id: string;
12929
+ /**
12930
+ * Document ID
12931
+ */
12932
+ document_id: string;
12933
+ };
12934
+ query?: {
12935
+ /**
12936
+ * When omitted or `false` (default), processing runs in the background and `202 Accepted` is returned immediately with `status=pending`. Pass `true` to block until processing completes and receive `201 Created` with `status=ready`.
12937
+ */
12938
+ wait?: boolean;
12939
+ };
12940
+ url: '/v1/projects/{project_id}/documents/{document_id}/ingest';
12941
+ };
12942
+ type ReingestDocumentErrors = {
12943
+ /**
12944
+ * Unauthorized
12945
+ */
12946
+ 401: ErrorResponse;
12947
+ /**
12948
+ * Forbidden
12949
+ */
12950
+ 403: ErrorResponse;
12951
+ /**
12952
+ * Document not found
12953
+ */
12954
+ 404: ErrorResponse;
12955
+ /**
12956
+ * The project's `storage_bytes` quota is exceeded (`QUOTA_STORAGE_EXCEEDED`). Delete stored content, or raise the quota — no window reset clears a stored total, so no `Retry-After` is sent.
12957
+ */
12958
+ 409: ErrorResponse;
12959
+ /**
12960
+ * The file is too large to re-ingest synchronously (`?wait=true`). Retry in background mode.
12961
+ */
12962
+ 413: ErrorResponse;
12963
+ };
12964
+ type ReingestDocumentError = ReingestDocumentErrors[keyof ReingestDocumentErrors];
12965
+ type ReingestDocumentResponses = {
12966
+ /**
12967
+ * Re-ingestion completed synchronously (only when `?wait=true`).
12968
+ */
12969
+ 201: IngestedDocumentRecord;
12970
+ /**
12971
+ * Re-ingestion accepted. The document was reset to `status=pending` and processing runs in the background. Poll `GET /v1/projects/{project_id}/documents/{document_id}/status`.
12972
+ */
12973
+ 202: IngestedDocumentRecord;
12974
+ };
12975
+ type ReingestDocumentResponse = ReingestDocumentResponses[keyof ReingestDocumentResponses];
12976
+ type GetDocumentTagsData = {
12977
+ body?: never;
12978
+ path: {
12979
+ /**
12980
+ * Project public ID (proj_ prefix).
12981
+ */
12982
+ project_id: string;
12983
+ /**
12984
+ * Document ID
12985
+ */
12986
+ document_id: string;
12987
+ };
12988
+ query?: never;
12989
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
12990
+ };
12991
+ type GetDocumentTagsErrors = {
12992
+ /**
12993
+ * Unauthorized
12994
+ */
12995
+ 401: ErrorResponse;
12996
+ /**
12997
+ * Forbidden
12998
+ */
12999
+ 403: ErrorResponse;
13000
+ /**
13001
+ * Document not found
13002
+ */
13003
+ 404: ErrorResponse;
13004
+ };
13005
+ type GetDocumentTagsError = GetDocumentTagsErrors[keyof GetDocumentTagsErrors];
13006
+ type GetDocumentTagsResponses = {
13007
+ /**
13008
+ * Document tags
13009
+ */
13010
+ 200: TagBag;
13011
+ };
13012
+ type GetDocumentTagsResponse = GetDocumentTagsResponses[keyof GetDocumentTagsResponses];
13013
+ type MergeDocumentTagsData = {
13014
+ body: TagBag;
13015
+ path: {
13016
+ /**
13017
+ * Project public ID (proj_ prefix).
13018
+ */
13019
+ project_id: string;
13020
+ /**
13021
+ * Document ID
13022
+ */
13023
+ document_id: string;
13024
+ };
13025
+ query?: never;
13026
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
13027
+ };
13028
+ type MergeDocumentTagsErrors = {
13029
+ /**
13030
+ * Unauthorized
13031
+ */
13032
+ 401: ErrorResponse;
13033
+ /**
13034
+ * Forbidden
13035
+ */
13036
+ 403: ErrorResponse;
13037
+ /**
13038
+ * Document not found
13039
+ */
13040
+ 404: ErrorResponse;
13041
+ };
13042
+ type MergeDocumentTagsError = MergeDocumentTagsErrors[keyof MergeDocumentTagsErrors];
13043
+ type MergeDocumentTagsResponses = {
13044
+ /**
13045
+ * Tags merged
13046
+ */
13047
+ 200: TagBag;
13048
+ };
13049
+ type MergeDocumentTagsResponse = MergeDocumentTagsResponses[keyof MergeDocumentTagsResponses];
13050
+ type ReplaceDocumentTagsData = {
13051
+ body: TagBag;
13052
+ path: {
13053
+ /**
13054
+ * Project public ID (proj_ prefix).
13055
+ */
13056
+ project_id: string;
13057
+ /**
13058
+ * Document ID
13059
+ */
13060
+ document_id: string;
13061
+ };
13062
+ query?: never;
13063
+ url: '/v1/projects/{project_id}/documents/{document_id}/tags';
13064
+ };
13065
+ type ReplaceDocumentTagsErrors = {
13066
+ /**
13067
+ * Unauthorized
13068
+ */
13069
+ 401: ErrorResponse;
13070
+ /**
13071
+ * Forbidden
13072
+ */
13073
+ 403: ErrorResponse;
13074
+ /**
13075
+ * Document not found
13076
+ */
13077
+ 404: ErrorResponse;
13078
+ };
13079
+ type ReplaceDocumentTagsError = ReplaceDocumentTagsErrors[keyof ReplaceDocumentTagsErrors];
13080
+ type ReplaceDocumentTagsResponses = {
13081
+ /**
13082
+ * Tags replaced
13083
+ */
13084
+ 200: TagBag;
13085
+ };
13086
+ type ReplaceDocumentTagsResponse = ReplaceDocumentTagsResponses[keyof ReplaceDocumentTagsResponses];
13087
+ type CreateEmbeddingsData = {
13088
+ body: {
13089
+ /**
13090
+ * Single text to embed.
13091
+ */
13092
+ input?: string;
13093
+ /**
13094
+ * Batch of texts to embed. At most 256 per request — each input is one call to the embedding model, so a larger batch is refused (`VALIDATION_FAILED`) rather than queued. Split it across requests.
13095
+ */
13096
+ inputs?: Array<string>;
13097
+ };
13098
+ path: {
13099
+ /**
13100
+ * Project public ID (proj_ prefix).
13101
+ */
13102
+ project_id: string;
13103
+ };
13104
+ query?: never;
13105
+ url: '/v1/projects/{project_id}/embeddings';
13106
+ };
13107
+ type CreateEmbeddingsErrors = {
13108
+ /**
13109
+ * Invalid request body
13110
+ */
13111
+ 400: ErrorResponse;
13112
+ /**
13113
+ * Unauthorized
13114
+ */
13115
+ 401: ErrorResponse;
13116
+ /**
13117
+ * The caller cannot write to the named `project_id`
13118
+ */
13119
+ 403: ErrorResponse;
13120
+ /**
13121
+ * Embedding service not configured
13122
+ */
13123
+ 503: ErrorResponse;
13124
+ };
13125
+ type CreateEmbeddingsError = CreateEmbeddingsErrors[keyof CreateEmbeddingsErrors];
13126
+ type CreateEmbeddingsResponses = {
13127
+ /**
13128
+ * Embeddings generated successfully
13129
+ */
13130
+ 200: EmbeddingsResponse;
13131
+ };
13132
+ type CreateEmbeddingsResponse = CreateEmbeddingsResponses[keyof CreateEmbeddingsResponses];
13133
+ type ListDatasetsData = {
13134
+ body?: never;
13135
+ path: {
13136
+ /**
13137
+ * Project public ID (proj_ prefix).
13138
+ */
13139
+ project_id: string;
13140
+ };
13141
+ query?: {
13142
+ /**
13143
+ * Maximum number of results to return
13144
+ */
13145
+ limit?: number;
13146
+ /**
13147
+ * Number of results to skip
13148
+ */
13149
+ offset?: number;
13150
+ };
13151
+ url: '/v1/projects/{project_id}/datasets';
13152
+ };
13153
+ type ListDatasetsErrors = {
13154
+ /**
13155
+ * Unauthorized
13156
+ */
13157
+ 401: unknown;
13158
+ /**
13159
+ * Forbidden
13160
+ */
13161
+ 403: unknown;
13162
+ /**
13163
+ * Internal server error
13164
+ */
13165
+ 500: unknown;
13166
+ };
13167
+ type ListDatasetsResponses = {
13168
+ /**
13169
+ * List of datasets
13170
+ */
13171
+ 200: {
13172
+ data: Array<Dataset>;
13173
+ total: number;
13174
+ limit: number;
13175
+ offset: number;
13176
+ };
13177
+ };
13178
+ type ListDatasetsResponse = ListDatasetsResponses[keyof ListDatasetsResponses];
13179
+ type CreateDatasetData = {
13180
+ body: {
13181
+ /**
13182
+ * Unique name within the project
13183
+ */
13184
+ name: string;
13185
+ /**
13186
+ * What this suite covers
13187
+ */
13188
+ description?: string | null;
13189
+ };
13190
+ path: {
13191
+ /**
13192
+ * Project public ID (proj_ prefix).
13193
+ */
13194
+ project_id: string;
13195
+ };
13196
+ query?: never;
13197
+ url: '/v1/projects/{project_id}/datasets';
13198
+ };
13199
+ type CreateDatasetErrors = {
13200
+ /**
13201
+ * Bad request (missing or invalid name)
13202
+ */
13203
+ 400: unknown;
13204
+ /**
13205
+ * Unauthorized
13206
+ */
13207
+ 401: unknown;
13208
+ /**
13209
+ * Forbidden
13210
+ */
13211
+ 403: unknown;
13212
+ /**
13213
+ * A dataset with that name already exists in the project
13214
+ */
13215
+ 409: unknown;
13216
+ /**
13217
+ * Internal server error
13218
+ */
13219
+ 500: unknown;
12659
13220
  };
12660
13221
  type CreateDatasetResponses = {
12661
13222
  /**
@@ -12843,9 +13404,7 @@ type CreateDatasetItemData = {
12843
13404
  /**
12844
13405
  * Free-form tags, opaque to the platform
12845
13406
  */
12846
- metadata?: {
12847
- [key: string]: unknown;
12848
- } | null;
13407
+ metadata?: NullableMetadataBag;
12849
13408
  };
12850
13409
  path: {
12851
13410
  /**
@@ -12902,9 +13461,7 @@ type CreateDatasetItemFromGenerationData = {
12902
13461
  /**
12903
13462
  * Free-form tags, opaque to the platform
12904
13463
  */
12905
- metadata?: {
12906
- [key: string]: unknown;
12907
- } | null;
13464
+ metadata?: NullableMetadataBag;
12908
13465
  };
12909
13466
  path: {
12910
13467
  /**
@@ -12992,9 +13549,7 @@ type UpdateDatasetItemData = {
12992
13549
  body: {
12993
13550
  input?: DatasetItemInput;
12994
13551
  expected_output?: string | null;
12995
- metadata?: {
12996
- [key: string]: unknown;
12997
- } | null;
13552
+ metadata?: NullableMetadataBag;
12998
13553
  };
12999
13554
  path: {
13000
13555
  /**
@@ -13333,9 +13888,7 @@ type StartEvalRunData = {
13333
13888
  *
13334
13889
  * The bag is caller-owned and no key is reserved: everything the platform decides about a run (`status`, `agent_version`, `baseline_run_id`, `aggregate_scores`, `passed`, the counts) is a field of its own and cannot be written from here. Nothing in the scoring path reads it. A non-object is rejected with `400 VALIDATION_FAILED` and no run is created.
13335
13890
  */
13336
- metadata?: {
13337
- [key: string]: unknown;
13338
- };
13891
+ metadata?: MetadataBag;
13339
13892
  /**
13340
13893
  * Key/value context forwarded to every item's generation, so an agent whose tools authorize through `tool_context` is scored against the configuration it runs in production rather than with an empty bag. Each key is forwarded as one `X-Naturali-Context-<key>` header and resolves any `{{context:<key>}}` token in a bound tool's headers or `preset_parameters`.
13341
13894
  *
@@ -13776,10 +14329,7 @@ type CreateFileData = {
13776
14329
  * File size in bytes
13777
14330
  */
13778
14331
  size?: number | null;
13779
- /**
13780
- * JSON string with additional metadata
13781
- */
13782
- metadata?: string;
14332
+ metadata?: MetadataBag;
13783
14333
  };
13784
14334
  path: {
13785
14335
  /**
@@ -13826,10 +14376,7 @@ type UploadFileData = {
13826
14376
  * Original / download name. Optional; defaults to the uploaded file's name.
13827
14377
  */
13828
14378
  filename?: string;
13829
- /**
13830
- * Additional metadata as a JSON string
13831
- */
13832
- metadata?: string;
14379
+ metadata?: MetadataBagText;
13833
14380
  };
13834
14381
  path: {
13835
14382
  /**
@@ -14021,9 +14568,9 @@ type DownloadFileResponse = DownloadFileResponses[keyof DownloadFileResponses];
14021
14568
  type UpdateFileMetadataData = {
14022
14569
  body: {
14023
14570
  /**
14024
- * New metadata as a JSON string
14571
+ * Replaces the stored bag; `null` clears it.
14025
14572
  */
14026
- metadata?: string;
14573
+ metadata?: NullableMetadataBag;
14027
14574
  /**
14028
14575
  * New directory — moves the file. The resulting path (prefix + filename) must be unique within the project.
14029
14576
  */
@@ -14385,9 +14932,7 @@ type CreateFormationData = {
14385
14932
  * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
14386
14933
  *
14387
14934
  */
14388
- metadata?: {
14389
- [key: string]: unknown;
14390
- } | null;
14935
+ metadata?: NullableMetadataBag;
14391
14936
  };
14392
14937
  path: {
14393
14938
  /**
@@ -14510,9 +15055,7 @@ type UpdateFormationData = {
14510
15055
  * Static annotations stored on the formation record. This field is NOT a substitution site: `sub`/`param`/`ref` expressions are rejected with 400 (`FORMATION_INVALID_METADATA`). For deploy-time substitution use the template's top-level `metadata` block, which is resolved into `resolved_metadata`.
14511
15056
  *
14512
15057
  */
14513
- metadata?: {
14514
- [key: string]: unknown;
14515
- } | null;
15058
+ metadata?: NullableMetadataBag;
14516
15059
  };
14517
15060
  path: {
14518
15061
  /**
@@ -14973,6 +15516,12 @@ type GetGuardrailResponses = {
14973
15516
  type GetGuardrailResponse = GetGuardrailResponses[keyof GetGuardrailResponses];
14974
15517
  type UpdateGuardrailData = {
14975
15518
  body: UpdateGuardrailRequest;
15519
+ headers?: {
15520
+ /**
15521
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
15522
+ */
15523
+ 'If-Match'?: string;
15524
+ };
14976
15525
  path: {
14977
15526
  /**
14978
15527
  * Project public ID (proj_ prefix).
@@ -15280,9 +15829,7 @@ type CreateIngestionRuleData = {
15280
15829
  /**
15281
15830
  * Arbitrary JSON metadata
15282
15831
  */
15283
- metadata?: {
15284
- [key: string]: unknown;
15285
- };
15832
+ metadata?: MetadataBag;
15286
15833
  };
15287
15834
  path: {
15288
15835
  /**
@@ -15414,9 +15961,7 @@ type UpdateIngestionRuleData = {
15414
15961
  chunk_strategy?: 'page' | 'whole' | 'size' | null;
15415
15962
  chunk_size?: number | null;
15416
15963
  chunk_overlap?: number | null;
15417
- metadata?: {
15418
- [key: string]: unknown;
15419
- } | null;
15964
+ metadata?: NullableMetadataBag;
15420
15965
  };
15421
15966
  path: {
15422
15967
  /**
@@ -15506,6 +16051,10 @@ type SearchKnowledgeData = {
15506
16051
  * Filter results to documents and memories whose `tags` contain every one of these key-value pairs (exact, case-sensitive match). Scopes both stores, so passing it alone searches both — as `query` does. For memories it matches at memory granularity: a memory is returned when its parent memory store's tags match or its own do.
15507
16052
  */
15508
16053
  tags?: TagBag;
16054
+ /**
16055
+ * Filter document results by their `metadata` bag. A document-store filter: a memory carries no such bag, so passing it alone searches documents, as `document_paths` does.
16056
+ */
16057
+ metadata?: MetadataFilter;
15509
16058
  };
15510
16059
  path: {
15511
16060
  /**
@@ -15567,7 +16116,7 @@ type ListMemoriesData = {
15567
16116
  */
15568
16117
  offset?: number;
15569
16118
  /**
15570
- * Include invalidated (superseded) memories. They are excluded by default; set this to audit the supersede history.
16119
+ * Include invalidated memories — superseded or retracted. They are excluded by default; set this to audit what a store once held.
15571
16120
  */
15572
16121
  include_invalidated?: boolean;
15573
16122
  };
@@ -15628,9 +16177,7 @@ type CreateMemoryData = {
15628
16177
  /**
15629
16178
  * Arbitrary structured metadata attached to the memory
15630
16179
  */
15631
- metadata?: {
15632
- [key: string]: unknown;
15633
- };
16180
+ metadata?: MetadataBag;
15634
16181
  /**
15635
16182
  * The memory this write replaces, named outright. The declaration outranks the thresholds in both directions: the target is retired and the write returns `superseded` however similar or distant the two texts are. This is what reaches a contradiction cosine cannot see ("The office is in Lisbon" then "We closed the Lisbon office"). The target must be a still-valid memory in the same memory store, and the caller needs `memories:UpdateMemory` on it as well as `memories:CreateMemory` on the store.
15636
16183
  */
@@ -15771,15 +16318,71 @@ type UpdateMemoryData = {
15771
16318
  */
15772
16319
  content?: string;
15773
16320
  /**
15774
- * Replaces the memory's tags. Pass null or an empty object to clear.
16321
+ * Replaces the memory's tags. Pass null or an empty object to clear.
16322
+ */
16323
+ tags?: NullableTagBag;
16324
+ /**
16325
+ * Replaces the memory's metadata. Pass null to clear.
16326
+ */
16327
+ metadata?: NullableMetadataBag;
16328
+ /**
16329
+ * Refuses the write unless the memory is at this version.
16330
+ */
16331
+ expected_version?: ExpectedVersion;
16332
+ };
16333
+ headers?: {
16334
+ /**
16335
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
16336
+ */
16337
+ 'If-Match'?: string;
16338
+ };
16339
+ path: {
16340
+ /**
16341
+ * Project public ID (proj_ prefix).
16342
+ */
16343
+ project_id: string;
16344
+ memory_id: string;
16345
+ };
16346
+ query?: never;
16347
+ url: '/v1/projects/{project_id}/memories/{memory_id}';
16348
+ };
16349
+ type UpdateMemoryErrors = {
16350
+ /**
16351
+ * Unauthorized
16352
+ */
16353
+ 401: unknown;
16354
+ /**
16355
+ * Forbidden
16356
+ */
16357
+ 403: unknown;
16358
+ /**
16359
+ * Memory store or memory not found
16360
+ */
16361
+ 404: unknown;
16362
+ /**
16363
+ * Internal server error
16364
+ */
16365
+ 500: unknown;
16366
+ };
16367
+ type UpdateMemoryResponses = {
16368
+ /**
16369
+ * Memory updated
16370
+ */
16371
+ 200: Memory;
16372
+ };
16373
+ type UpdateMemoryResponse = UpdateMemoryResponses[keyof UpdateMemoryResponses];
16374
+ type RetractMemoryData = {
16375
+ body?: {
16376
+ /**
16377
+ * Refuses the retraction unless the memory is at this version.
15775
16378
  */
15776
- tags?: NullableTagBag;
16379
+ expected_version?: ExpectedVersion;
16380
+ };
16381
+ headers?: {
15777
16382
  /**
15778
- * Replaces the memory's metadata. Pass null to clear.
16383
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
15779
16384
  */
15780
- metadata?: {
15781
- [key: string]: unknown;
15782
- } | null;
16385
+ 'If-Match'?: string;
15783
16386
  };
15784
16387
  path: {
15785
16388
  /**
@@ -15789,9 +16392,9 @@ type UpdateMemoryData = {
15789
16392
  memory_id: string;
15790
16393
  };
15791
16394
  query?: never;
15792
- url: '/v1/projects/{project_id}/memories/{memory_id}';
16395
+ url: '/v1/projects/{project_id}/memories/{memory_id}/retract';
15793
16396
  };
15794
- type UpdateMemoryErrors = {
16397
+ type RetractMemoryErrors = {
15795
16398
  /**
15796
16399
  * Unauthorized
15797
16400
  */
@@ -15804,18 +16407,22 @@ type UpdateMemoryErrors = {
15804
16407
  * Memory store or memory not found
15805
16408
  */
15806
16409
  404: unknown;
16410
+ /**
16411
+ * Conflict — the memory is already invalidated, or the version moved
16412
+ */
16413
+ 409: unknown;
15807
16414
  /**
15808
16415
  * Internal server error
15809
16416
  */
15810
16417
  500: unknown;
15811
16418
  };
15812
- type UpdateMemoryResponses = {
16419
+ type RetractMemoryResponses = {
15813
16420
  /**
15814
- * Memory updated
16421
+ * The retracted memory
15815
16422
  */
15816
16423
  200: Memory;
15817
16424
  };
15818
- type UpdateMemoryResponse = UpdateMemoryResponses[keyof UpdateMemoryResponses];
16425
+ type RetractMemoryResponse = RetractMemoryResponses[keyof RetractMemoryResponses];
15819
16426
  type ListMemoryAssertionsData = {
15820
16427
  body?: never;
15821
16428
  path: {
@@ -16193,36 +16800,276 @@ type UpdateMemoryRuleData = {
16193
16800
  body: {
16194
16801
  on?: MemoryRuleEvent;
16195
16802
  /**
16196
- * Send `null` to widen the rule to every agent in the project
16803
+ * Send `null` to widen the rule to every agent in the project
16804
+ */
16805
+ source_agent_ids?: Array<string> | null;
16806
+ agent_id?: string | null;
16807
+ tool_id?: string | null;
16808
+ action?: string | null;
16809
+ preset_parameters?: {
16810
+ [key: string]: unknown;
16811
+ } | null;
16812
+ prompt?: string | null;
16813
+ ai_provider_id?: string | null;
16814
+ model?: string | null;
16815
+ enabled?: boolean;
16816
+ };
16817
+ path: {
16818
+ /**
16819
+ * Project public ID (proj_ prefix).
16820
+ */
16821
+ project_id: string;
16822
+ /**
16823
+ * Memory rule ID
16824
+ */
16825
+ memory_rule_id: string;
16826
+ };
16827
+ query?: never;
16828
+ url: '/v1/projects/{project_id}/memory-rules/{memory_rule_id}';
16829
+ };
16830
+ type UpdateMemoryRuleErrors = {
16831
+ /**
16832
+ * Validation failed
16833
+ */
16834
+ 400: unknown;
16835
+ /**
16836
+ * Unauthorized
16837
+ */
16838
+ 401: unknown;
16839
+ /**
16840
+ * Forbidden
16841
+ */
16842
+ 403: unknown;
16843
+ /**
16844
+ * Memory rule not found
16845
+ */
16846
+ 404: unknown;
16847
+ };
16848
+ type UpdateMemoryRuleResponses = {
16849
+ /**
16850
+ * Memory rule updated
16851
+ */
16852
+ 200: MemoryRule;
16853
+ };
16854
+ type UpdateMemoryRuleResponse = UpdateMemoryRuleResponses[keyof UpdateMemoryRuleResponses];
16855
+ type ListMemoryStoresData = {
16856
+ body?: never;
16857
+ path: {
16858
+ /**
16859
+ * Project public ID (proj_ prefix).
16860
+ */
16861
+ project_id: string;
16862
+ };
16863
+ query?: {
16864
+ /**
16865
+ * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
16866
+ *
16867
+ */
16868
+ tags?: Array<string>;
16869
+ /**
16870
+ * Maximum number of results to return
16871
+ */
16872
+ limit?: number;
16873
+ /**
16874
+ * Number of results to skip
16875
+ */
16876
+ offset?: number;
16877
+ };
16878
+ url: '/v1/projects/{project_id}/memory-stores';
16879
+ };
16880
+ type ListMemoryStoresErrors = {
16881
+ /**
16882
+ * Unauthorized
16883
+ */
16884
+ 401: unknown;
16885
+ /**
16886
+ * Forbidden
16887
+ */
16888
+ 403: unknown;
16889
+ /**
16890
+ * Internal server error
16891
+ */
16892
+ 500: unknown;
16893
+ };
16894
+ type ListMemoryStoresResponses = {
16895
+ /**
16896
+ * List of memory stores
16897
+ */
16898
+ 200: {
16899
+ data: Array<MemoryStore>;
16900
+ total: number;
16901
+ limit: number;
16902
+ offset: number;
16903
+ };
16904
+ };
16905
+ type ListMemoryStoresResponse = ListMemoryStoresResponses[keyof ListMemoryStoresResponses];
16906
+ type CreateMemoryStoreData = {
16907
+ body: {
16908
+ /**
16909
+ * Memory store name
16910
+ */
16911
+ name: string;
16912
+ /**
16913
+ * Optional description
16914
+ */
16915
+ description?: string;
16916
+ /**
16917
+ * Optional key-value tags. Scopes the memory store in knowledge search, where every requested pair must match exactly.
16918
+ */
16919
+ tags?: TagBag;
16920
+ /**
16921
+ * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /v1/projects/{project_id}/memories` call may override it; the agent tool and the post-turn rule never can.
16922
+ */
16923
+ duplicate_threshold?: number | null;
16924
+ /**
16925
+ * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
16926
+ */
16927
+ supersede_threshold?: number | null;
16928
+ };
16929
+ path: {
16930
+ /**
16931
+ * Project public ID (proj_ prefix).
16932
+ */
16933
+ project_id: string;
16934
+ };
16935
+ query?: never;
16936
+ url: '/v1/projects/{project_id}/memory-stores';
16937
+ };
16938
+ type CreateMemoryStoreErrors = {
16939
+ /**
16940
+ * Bad request — a missing required field, a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold`.
16941
+ */
16942
+ 400: unknown;
16943
+ /**
16944
+ * Unauthorized
16945
+ */
16946
+ 401: unknown;
16947
+ /**
16948
+ * Forbidden
16949
+ */
16950
+ 403: unknown;
16951
+ /**
16952
+ * Internal server error
16953
+ */
16954
+ 500: unknown;
16955
+ };
16956
+ type CreateMemoryStoreResponses = {
16957
+ /**
16958
+ * Memory store created
16959
+ */
16960
+ 201: MemoryStore;
16961
+ };
16962
+ type CreateMemoryStoreResponse = CreateMemoryStoreResponses[keyof CreateMemoryStoreResponses];
16963
+ type DeleteMemoryStoreData = {
16964
+ body?: never;
16965
+ path: {
16966
+ /**
16967
+ * Project public ID (proj_ prefix).
16968
+ */
16969
+ project_id: string;
16970
+ memory_store_id: string;
16971
+ };
16972
+ query?: never;
16973
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
16974
+ };
16975
+ type DeleteMemoryStoreErrors = {
16976
+ /**
16977
+ * Unauthorized
16978
+ */
16979
+ 401: unknown;
16980
+ /**
16981
+ * Forbidden
16982
+ */
16983
+ 403: unknown;
16984
+ /**
16985
+ * Memory store not found
16986
+ */
16987
+ 404: unknown;
16988
+ /**
16989
+ * Internal server error
16990
+ */
16991
+ 500: unknown;
16992
+ };
16993
+ type DeleteMemoryStoreResponses = {
16994
+ /**
16995
+ * Memory store deleted
16996
+ */
16997
+ 204: void;
16998
+ };
16999
+ type DeleteMemoryStoreResponse = DeleteMemoryStoreResponses[keyof DeleteMemoryStoreResponses];
17000
+ type GetMemoryStoreData = {
17001
+ body?: never;
17002
+ path: {
17003
+ /**
17004
+ * Project public ID (proj_ prefix).
17005
+ */
17006
+ project_id: string;
17007
+ memory_store_id: string;
17008
+ };
17009
+ query?: never;
17010
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
17011
+ };
17012
+ type GetMemoryStoreErrors = {
17013
+ /**
17014
+ * Unauthorized
17015
+ */
17016
+ 401: unknown;
17017
+ /**
17018
+ * Forbidden
17019
+ */
17020
+ 403: unknown;
17021
+ /**
17022
+ * Memory store not found
17023
+ */
17024
+ 404: unknown;
17025
+ /**
17026
+ * Internal server error
17027
+ */
17028
+ 500: unknown;
17029
+ };
17030
+ type GetMemoryStoreResponses = {
17031
+ /**
17032
+ * Memory store found
17033
+ */
17034
+ 200: MemoryStore;
17035
+ };
17036
+ type GetMemoryStoreResponse = GetMemoryStoreResponses[keyof GetMemoryStoreResponses];
17037
+ type UpdateMemoryStoreData = {
17038
+ body: {
17039
+ /**
17040
+ * Memory store name
17041
+ */
17042
+ name?: string;
17043
+ /**
17044
+ * Optional description
16197
17045
  */
16198
- source_agent_ids?: Array<string> | null;
16199
- agent_id?: string | null;
16200
- tool_id?: string | null;
16201
- action?: string | null;
16202
- preset_parameters?: {
16203
- [key: string]: unknown;
16204
- } | null;
16205
- prompt?: string | null;
16206
- ai_provider_id?: string | null;
16207
- model?: string | null;
16208
- enabled?: boolean;
17046
+ description?: string | null;
17047
+ /**
17048
+ * Optional key-value tags. Replaces the stored bag; `null` clears it.
17049
+ */
17050
+ tags?: NullableTagBag;
17051
+ /**
17052
+ * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /v1/projects/{project_id}/memories` call may override it; the agent tool and the post-turn rule never can.
17053
+ */
17054
+ duplicate_threshold?: number | null;
17055
+ /**
17056
+ * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
17057
+ */
17058
+ supersede_threshold?: number | null;
16209
17059
  };
16210
17060
  path: {
16211
17061
  /**
16212
17062
  * Project public ID (proj_ prefix).
16213
17063
  */
16214
17064
  project_id: string;
16215
- /**
16216
- * Memory rule ID
16217
- */
16218
- memory_rule_id: string;
17065
+ memory_store_id: string;
16219
17066
  };
16220
17067
  query?: never;
16221
- url: '/v1/projects/{project_id}/memory-rules/{memory_rule_id}';
17068
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
16222
17069
  };
16223
- type UpdateMemoryRuleErrors = {
17070
+ type UpdateMemoryStoreErrors = {
16224
17071
  /**
16225
- * Validation failed
17072
+ * Bad request — a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold` once the stored values this request does not replace are applied.
16226
17073
  */
16227
17074
  400: unknown;
16228
17075
  /**
@@ -16234,31 +17081,47 @@ type UpdateMemoryRuleErrors = {
16234
17081
  */
16235
17082
  403: unknown;
16236
17083
  /**
16237
- * Memory rule not found
17084
+ * Memory store not found
16238
17085
  */
16239
17086
  404: unknown;
17087
+ /**
17088
+ * Internal server error
17089
+ */
17090
+ 500: unknown;
16240
17091
  };
16241
- type UpdateMemoryRuleResponses = {
17092
+ type UpdateMemoryStoreResponses = {
16242
17093
  /**
16243
- * Memory rule updated
17094
+ * Memory store updated
16244
17095
  */
16245
- 200: MemoryRule;
17096
+ 200: MemoryStore;
16246
17097
  };
16247
- type UpdateMemoryRuleResponse = UpdateMemoryRuleResponses[keyof UpdateMemoryRuleResponses];
16248
- type ListMemoryStoresData = {
17098
+ type UpdateMemoryStoreResponse = UpdateMemoryStoreResponses[keyof UpdateMemoryStoreResponses];
17099
+ type ListMemoryStoreAssertionsData = {
16249
17100
  body?: never;
16250
17101
  path: {
16251
17102
  /**
16252
17103
  * Project public ID (proj_ prefix).
16253
17104
  */
16254
17105
  project_id: string;
17106
+ memory_store_id: string;
16255
17107
  };
16256
17108
  query?: {
16257
17109
  /**
16258
- * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
16259
- *
17110
+ * Only assertions that came through this door.
16260
17111
  */
16261
- tags?: Array<string>;
17112
+ mechanism?: 'tool' | 'rule' | 'api' | 'formation';
17113
+ /**
17114
+ * Only assertions that resolved this way.
17115
+ */
17116
+ outcome?: 'created' | 'superseded' | 'skipped';
17117
+ /**
17118
+ * Only assertions made during this generation. A generation that does not exist matches nothing rather than widening to the whole store.
17119
+ */
17120
+ generation_id?: string;
17121
+ /**
17122
+ * Only assertions recorded at or after this instant.
17123
+ */
17124
+ since?: Date;
16262
17125
  /**
16263
17126
  * Maximum number of results to return
16264
17127
  */
@@ -16268,9 +17131,13 @@ type ListMemoryStoresData = {
16268
17131
  */
16269
17132
  offset?: number;
16270
17133
  };
16271
- url: '/v1/projects/{project_id}/memory-stores';
17134
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/assertions';
16272
17135
  };
16273
- type ListMemoryStoresErrors = {
17136
+ type ListMemoryStoreAssertionsErrors = {
17137
+ /**
17138
+ * An unknown `mechanism` or `outcome`, or a `since` that is not a timestamp
17139
+ */
17140
+ 400: unknown;
16274
17141
  /**
16275
17142
  * Unauthorized
16276
17143
  */
@@ -16279,60 +17146,89 @@ type ListMemoryStoresErrors = {
16279
17146
  * Forbidden
16280
17147
  */
16281
17148
  403: unknown;
17149
+ /**
17150
+ * Memory store not found
17151
+ */
17152
+ 404: unknown;
16282
17153
  /**
16283
17154
  * Internal server error
16284
17155
  */
16285
17156
  500: unknown;
16286
17157
  };
16287
- type ListMemoryStoresResponses = {
17158
+ type ListMemoryStoreAssertionsResponses = {
16288
17159
  /**
16289
- * List of memory stores
17160
+ * List of assertions
16290
17161
  */
16291
17162
  200: {
16292
- data: Array<MemoryStore>;
17163
+ data: Array<MemoryAssertion>;
16293
17164
  total: number;
16294
17165
  limit: number;
16295
17166
  offset: number;
16296
17167
  };
16297
17168
  };
16298
- type ListMemoryStoresResponse = ListMemoryStoresResponses[keyof ListMemoryStoresResponses];
16299
- type CreateMemoryStoreData = {
16300
- body: {
16301
- /**
16302
- * Memory store name
16303
- */
16304
- name: string;
17169
+ type ListMemoryStoreAssertionsResponse = ListMemoryStoreAssertionsResponses[keyof ListMemoryStoreAssertionsResponses];
17170
+ type ExportMemoriesData = {
17171
+ body?: never;
17172
+ path: {
16305
17173
  /**
16306
- * Optional description
17174
+ * Project public ID (proj_ prefix).
16307
17175
  */
16308
- description?: string;
17176
+ project_id: string;
16309
17177
  /**
16310
- * Optional key-value tags. Scopes the memory store in knowledge search, where every requested pair must match exactly.
17178
+ * Memory store whose memories are exported
16311
17179
  */
16312
- tags?: TagBag;
17180
+ memory_store_id: string;
17181
+ };
17182
+ query?: {
16313
17183
  /**
16314
- * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /v1/projects/{project_id}/memories` call may override it; the agent tool and the post-turn rule never can.
17184
+ * Include memories that were retracted or superseded
16315
17185
  */
16316
- duplicate_threshold?: number | null;
17186
+ include_invalidated?: boolean;
16317
17187
  /**
16318
- * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
17188
+ * Filter by tag pairs, written `key:value` (split on the first colon, so a value may contain colons). Repeat the parameter for several pairs; **all** must be present with exactly that value.
17189
+ *
16319
17190
  */
16320
- supersede_threshold?: number | null;
17191
+ tags?: Array<string>;
16321
17192
  };
17193
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/export';
17194
+ };
17195
+ type ExportMemoriesErrors = {
17196
+ /**
17197
+ * Unauthorized
17198
+ */
17199
+ 401: unknown;
17200
+ /**
17201
+ * Forbidden
17202
+ */
17203
+ 403: unknown;
17204
+ /**
17205
+ * Memory store not found
17206
+ */
17207
+ 404: unknown;
17208
+ };
17209
+ type ExportMemoriesResponses = {
17210
+ /**
17211
+ * A newline-delimited stream of memories. Each line is a JSON object with the same fields as `Memory`.
17212
+ */
17213
+ 200: string;
17214
+ };
17215
+ type ExportMemoriesResponse = ExportMemoriesResponses[keyof ExportMemoriesResponses];
17216
+ type GetMemoryStoreTagsData = {
17217
+ body?: never;
16322
17218
  path: {
16323
17219
  /**
16324
17220
  * Project public ID (proj_ prefix).
16325
17221
  */
16326
17222
  project_id: string;
17223
+ /**
17224
+ * Memory store ID
17225
+ */
17226
+ memory_store_id: string;
16327
17227
  };
16328
17228
  query?: never;
16329
- url: '/v1/projects/{project_id}/memory-stores';
17229
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
16330
17230
  };
16331
- type CreateMemoryStoreErrors = {
16332
- /**
16333
- * Bad request — a missing required field, a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold`.
16334
- */
16335
- 400: unknown;
17231
+ type GetMemoryStoreTagsErrors = {
16336
17232
  /**
16337
17233
  * Unauthorized
16338
17234
  */
@@ -16342,30 +17238,37 @@ type CreateMemoryStoreErrors = {
16342
17238
  */
16343
17239
  403: unknown;
16344
17240
  /**
16345
- * Internal server error
17241
+ * Memory store not found
16346
17242
  */
16347
- 500: unknown;
17243
+ 404: unknown;
16348
17244
  };
16349
- type CreateMemoryStoreResponses = {
17245
+ type GetMemoryStoreTagsResponses = {
16350
17246
  /**
16351
- * Memory store created
17247
+ * Memory store tags
16352
17248
  */
16353
- 201: MemoryStore;
17249
+ 200: TagBag;
16354
17250
  };
16355
- type CreateMemoryStoreResponse = CreateMemoryStoreResponses[keyof CreateMemoryStoreResponses];
16356
- type DeleteMemoryStoreData = {
16357
- body?: never;
17251
+ type GetMemoryStoreTagsResponse = GetMemoryStoreTagsResponses[keyof GetMemoryStoreTagsResponses];
17252
+ type MergeMemoryStoreTagsData = {
17253
+ body: TagBag;
16358
17254
  path: {
16359
17255
  /**
16360
17256
  * Project public ID (proj_ prefix).
16361
17257
  */
16362
17258
  project_id: string;
17259
+ /**
17260
+ * Memory store ID
17261
+ */
16363
17262
  memory_store_id: string;
16364
17263
  };
16365
17264
  query?: never;
16366
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
17265
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
16367
17266
  };
16368
- type DeleteMemoryStoreErrors = {
17267
+ type MergeMemoryStoreTagsErrors = {
17268
+ /**
17269
+ * Body is not an object of string values
17270
+ */
17271
+ 400: unknown;
16369
17272
  /**
16370
17273
  * Unauthorized
16371
17274
  */
@@ -16378,31 +17281,34 @@ type DeleteMemoryStoreErrors = {
16378
17281
  * Memory store not found
16379
17282
  */
16380
17283
  404: unknown;
16381
- /**
16382
- * Internal server error
16383
- */
16384
- 500: unknown;
16385
17284
  };
16386
- type DeleteMemoryStoreResponses = {
17285
+ type MergeMemoryStoreTagsResponses = {
16387
17286
  /**
16388
- * Memory store deleted
17287
+ * Tags merged
16389
17288
  */
16390
- 204: void;
17289
+ 200: TagBag;
16391
17290
  };
16392
- type DeleteMemoryStoreResponse = DeleteMemoryStoreResponses[keyof DeleteMemoryStoreResponses];
16393
- type GetMemoryStoreData = {
16394
- body?: never;
17291
+ type MergeMemoryStoreTagsResponse = MergeMemoryStoreTagsResponses[keyof MergeMemoryStoreTagsResponses];
17292
+ type ReplaceMemoryStoreTagsData = {
17293
+ body: TagBag;
16395
17294
  path: {
16396
17295
  /**
16397
17296
  * Project public ID (proj_ prefix).
16398
17297
  */
16399
17298
  project_id: string;
17299
+ /**
17300
+ * Memory store ID
17301
+ */
16400
17302
  memory_store_id: string;
16401
17303
  };
16402
17304
  query?: never;
16403
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
17305
+ url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
16404
17306
  };
16405
- type GetMemoryStoreErrors = {
17307
+ type ReplaceMemoryStoreTagsErrors = {
17308
+ /**
17309
+ * Body is not an object of string values
17310
+ */
17311
+ 400: unknown;
16406
17312
  /**
16407
17313
  * Unauthorized
16408
17314
  */
@@ -16415,267 +17321,290 @@ type GetMemoryStoreErrors = {
16415
17321
  * Memory store not found
16416
17322
  */
16417
17323
  404: unknown;
16418
- /**
16419
- * Internal server error
16420
- */
16421
- 500: unknown;
16422
17324
  };
16423
- type GetMemoryStoreResponses = {
17325
+ type ReplaceMemoryStoreTagsResponses = {
16424
17326
  /**
16425
- * Memory store found
17327
+ * Tags replaced
16426
17328
  */
16427
- 200: MemoryStore;
17329
+ 200: TagBag;
16428
17330
  };
16429
- type GetMemoryStoreResponse = GetMemoryStoreResponses[keyof GetMemoryStoreResponses];
16430
- type UpdateMemoryStoreData = {
16431
- body: {
17331
+ type ReplaceMemoryStoreTagsResponse = ReplaceMemoryStoreTagsResponses[keyof ReplaceMemoryStoreTagsResponses];
17332
+ type ListMetadataSchemasData = {
17333
+ body?: never;
17334
+ path: {
16432
17335
  /**
16433
- * Memory store name
17336
+ * Project public ID (proj_ prefix).
16434
17337
  */
16435
- name?: string;
17338
+ project_id: string;
17339
+ };
17340
+ query?: {
16436
17341
  /**
16437
- * Optional description
17342
+ * Return only the declarations governing this resource.
16438
17343
  */
16439
- description?: string | null;
17344
+ resource_type?: 'document';
17345
+ /**
17346
+ * Maximum number of results to return
17347
+ */
17348
+ limit?: number;
17349
+ /**
17350
+ * Number of results to skip
17351
+ */
17352
+ offset?: number;
17353
+ };
17354
+ url: '/v1/projects/{project_id}/metadata-schemas';
17355
+ };
17356
+ type ListMetadataSchemasErrors = {
17357
+ /**
17358
+ * Unauthorized
17359
+ */
17360
+ 401: ErrorResponse;
17361
+ /**
17362
+ * Forbidden
17363
+ */
17364
+ 403: ErrorResponse;
17365
+ };
17366
+ type ListMetadataSchemasError = ListMetadataSchemasErrors[keyof ListMetadataSchemasErrors];
17367
+ type ListMetadataSchemasResponses = {
17368
+ /**
17369
+ * The declarations in scope
17370
+ */
17371
+ 200: {
17372
+ data: Array<MetadataSchemaRecord>;
17373
+ total: number;
17374
+ limit: number;
17375
+ offset: number;
17376
+ };
17377
+ };
17378
+ type ListMetadataSchemasResponse = ListMetadataSchemasResponses[keyof ListMetadataSchemasResponses];
17379
+ type CreateMetadataSchemaData = {
17380
+ body: {
16440
17381
  /**
16441
- * Optional key-value tags. Replaces the stored bag; `null` clears it.
17382
+ * The resource whose metadata this declaration governs. A type appears here once its write path reads the registry, so a declaration always has a door that enforces it.
16442
17383
  */
16443
- tags?: NullableTagBag;
17384
+ resource_type: 'document';
16444
17385
  /**
16445
- * The store's dedup policy: cosine similarity at or above which an incoming fact is already known and the write is skipped. `null` (the default) uses the algorithm constant `0.95`. A single `POST /v1/projects/{project_id}/memories` call may override it; the agent tool and the post-turn rule never can.
17386
+ * The selector a `document` declaration must carry: the directory it governs.
16446
17387
  */
16447
- duplicate_threshold?: number | null;
17388
+ path_prefix?: string;
16448
17389
  /**
16449
- * Cosine similarity at or above which an incoming fact restates a known one that has changed: the matched memory is invalidated and replaced. `null` (the default) uses the algorithm constant `0.90`. Must be lower than the effective `duplicate_threshold`, or the write is rejected with `400 VALIDATION_FAILED` — equal makes `superseded` unreachable and inverted swallows `skipped`.
17390
+ * A JSON Schema. Its keywords are its own vocabulary and are stored as written.
16450
17391
  */
16451
- supersede_threshold?: number | null;
17392
+ schema: {
17393
+ [key: string]: unknown;
17394
+ };
16452
17395
  };
16453
17396
  path: {
16454
17397
  /**
16455
17398
  * Project public ID (proj_ prefix).
16456
17399
  */
16457
17400
  project_id: string;
16458
- memory_store_id: string;
16459
17401
  };
16460
17402
  query?: never;
16461
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}';
17403
+ url: '/v1/projects/{project_id}/metadata-schemas';
16462
17404
  };
16463
- type UpdateMemoryStoreErrors = {
17405
+ type CreateMetadataSchemaErrors = {
16464
17406
  /**
16465
- * Bad request — a threshold outside `[0, 1]`, or a pair that is not `supersede_threshold < duplicate_threshold` once the stored values this request does not replace are applied.
17407
+ * Bad Request — unknown `resource_type`, a missing or unusable selector, the reserved root, or a schema that is not valid JSON Schema
16466
17408
  */
16467
- 400: unknown;
17409
+ 400: ErrorResponse;
16468
17410
  /**
16469
17411
  * Unauthorized
16470
17412
  */
16471
- 401: unknown;
17413
+ 401: ErrorResponse;
16472
17414
  /**
16473
17415
  * Forbidden
16474
17416
  */
16475
- 403: unknown;
16476
- /**
16477
- * Memory store not found
16478
- */
16479
- 404: unknown;
17417
+ 403: ErrorResponse;
16480
17418
  /**
16481
- * Internal server error
17419
+ * Conflict — this selector is already declared for this type
16482
17420
  */
16483
- 500: unknown;
17421
+ 409: ErrorResponse;
16484
17422
  };
16485
- type UpdateMemoryStoreResponses = {
17423
+ type CreateMetadataSchemaError = CreateMetadataSchemaErrors[keyof CreateMetadataSchemaErrors];
17424
+ type CreateMetadataSchemaResponses = {
16486
17425
  /**
16487
- * Memory store updated
17426
+ * The declaration
16488
17427
  */
16489
- 200: MemoryStore;
17428
+ 201: MetadataSchemaRecord;
16490
17429
  };
16491
- type UpdateMemoryStoreResponse = UpdateMemoryStoreResponses[keyof UpdateMemoryStoreResponses];
16492
- type ListMemoryStoreAssertionsData = {
16493
- body?: never;
16494
- path: {
16495
- /**
16496
- * Project public ID (proj_ prefix).
16497
- */
16498
- project_id: string;
16499
- memory_store_id: string;
16500
- };
16501
- query?: {
16502
- /**
16503
- * Only assertions that came through this door.
16504
- */
16505
- mechanism?: 'tool' | 'rule' | 'api' | 'formation';
16506
- /**
16507
- * Only assertions that resolved this way.
16508
- */
16509
- outcome?: 'created' | 'superseded' | 'skipped';
16510
- /**
16511
- * Only assertions made during this generation. A generation that does not exist matches nothing rather than widening to the whole store.
16512
- */
16513
- generation_id?: string;
17430
+ type CreateMetadataSchemaResponse = CreateMetadataSchemaResponses[keyof CreateMetadataSchemaResponses];
17431
+ type ValidateMetadataData = {
17432
+ body: {
16514
17433
  /**
16515
- * Only assertions recorded at or after this instant.
17434
+ * The path the document would be filed at, which decides which declaration governs it.
16516
17435
  */
16517
- since?: Date;
17436
+ path: string;
16518
17437
  /**
16519
- * Maximum number of results to return
17438
+ * The bag to judge. Absent or `null` is judged as an empty bag.
16520
17439
  */
16521
- limit?: number;
17440
+ metadata?: NullableMetadataBag;
17441
+ };
17442
+ path: {
16522
17443
  /**
16523
- * Number of results to skip
17444
+ * Project public ID (proj_ prefix).
16524
17445
  */
16525
- offset?: number;
17446
+ project_id: string;
16526
17447
  };
16527
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/assertions';
17448
+ query?: never;
17449
+ url: '/v1/projects/{project_id}/metadata-schemas/validate';
16528
17450
  };
16529
- type ListMemoryStoreAssertionsErrors = {
16530
- /**
16531
- * An unknown `mechanism` or `outcome`, or a `since` that is not a timestamp
16532
- */
16533
- 400: unknown;
17451
+ type ValidateMetadataErrors = {
16534
17452
  /**
16535
17453
  * Unauthorized
16536
17454
  */
16537
- 401: unknown;
17455
+ 401: ErrorResponse;
16538
17456
  /**
16539
17457
  * Forbidden
16540
17458
  */
16541
- 403: unknown;
16542
- /**
16543
- * Memory store not found
16544
- */
16545
- 404: unknown;
16546
- /**
16547
- * Internal server error
16548
- */
16549
- 500: unknown;
17459
+ 403: ErrorResponse;
16550
17460
  };
16551
- type ListMemoryStoreAssertionsResponses = {
17461
+ type ValidateMetadataError = ValidateMetadataErrors[keyof ValidateMetadataErrors];
17462
+ type ValidateMetadataResponses = {
16552
17463
  /**
16553
- * List of assertions
17464
+ * The verdict
16554
17465
  */
16555
17466
  200: {
16556
- data: Array<MemoryAssertion>;
16557
- total: number;
16558
- limit: number;
16559
- offset: number;
17467
+ /**
17468
+ * Whether a write of this metadata at this path would be accepted.
17469
+ */
17470
+ valid: boolean;
17471
+ resource_type: 'document';
17472
+ /**
17473
+ * The declaration that would refuse it; `null` when the metadata is accepted or nothing governs the path.
17474
+ */
17475
+ metadata_schema_id: string | null;
17476
+ /**
17477
+ * The refusing declaration's selector.
17478
+ */
17479
+ path_prefix: string | null;
17480
+ /**
17481
+ * What the metadata violates, field by field.
17482
+ */
17483
+ error: string | null;
16560
17484
  };
16561
17485
  };
16562
- type ListMemoryStoreAssertionsResponse = ListMemoryStoreAssertionsResponses[keyof ListMemoryStoreAssertionsResponses];
16563
- type GetMemoryStoreTagsData = {
17486
+ type ValidateMetadataResponse = ValidateMetadataResponses[keyof ValidateMetadataResponses];
17487
+ type DeleteMetadataSchemaData = {
16564
17488
  body?: never;
16565
17489
  path: {
16566
17490
  /**
16567
17491
  * Project public ID (proj_ prefix).
16568
17492
  */
16569
17493
  project_id: string;
16570
- /**
16571
- * Memory store ID
16572
- */
16573
- memory_store_id: string;
17494
+ metadata_schema_id: string;
16574
17495
  };
16575
17496
  query?: never;
16576
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
17497
+ url: '/v1/projects/{project_id}/metadata-schemas/{metadata_schema_id}';
16577
17498
  };
16578
- type GetMemoryStoreTagsErrors = {
17499
+ type DeleteMetadataSchemaErrors = {
16579
17500
  /**
16580
17501
  * Unauthorized
16581
17502
  */
16582
- 401: unknown;
17503
+ 401: ErrorResponse;
16583
17504
  /**
16584
17505
  * Forbidden
16585
17506
  */
16586
- 403: unknown;
17507
+ 403: ErrorResponse;
16587
17508
  /**
16588
- * Memory store not found
17509
+ * Not found
16589
17510
  */
16590
- 404: unknown;
17511
+ 404: ErrorResponse;
16591
17512
  };
16592
- type GetMemoryStoreTagsResponses = {
17513
+ type DeleteMetadataSchemaError = DeleteMetadataSchemaErrors[keyof DeleteMetadataSchemaErrors];
17514
+ type DeleteMetadataSchemaResponses = {
16593
17515
  /**
16594
- * Memory store tags
17516
+ * Deleted
16595
17517
  */
16596
- 200: TagBag;
17518
+ 204: void;
16597
17519
  };
16598
- type GetMemoryStoreTagsResponse = GetMemoryStoreTagsResponses[keyof GetMemoryStoreTagsResponses];
16599
- type MergeMemoryStoreTagsData = {
16600
- body: TagBag;
17520
+ type DeleteMetadataSchemaResponse = DeleteMetadataSchemaResponses[keyof DeleteMetadataSchemaResponses];
17521
+ type GetMetadataSchemaData = {
17522
+ body?: never;
16601
17523
  path: {
16602
17524
  /**
16603
17525
  * Project public ID (proj_ prefix).
16604
17526
  */
16605
17527
  project_id: string;
16606
- /**
16607
- * Memory store ID
16608
- */
16609
- memory_store_id: string;
17528
+ metadata_schema_id: string;
16610
17529
  };
16611
17530
  query?: never;
16612
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
17531
+ url: '/v1/projects/{project_id}/metadata-schemas/{metadata_schema_id}';
16613
17532
  };
16614
- type MergeMemoryStoreTagsErrors = {
16615
- /**
16616
- * Body is not an object of string values
16617
- */
16618
- 400: unknown;
17533
+ type GetMetadataSchemaErrors = {
16619
17534
  /**
16620
17535
  * Unauthorized
16621
17536
  */
16622
- 401: unknown;
17537
+ 401: ErrorResponse;
16623
17538
  /**
16624
17539
  * Forbidden
16625
17540
  */
16626
- 403: unknown;
17541
+ 403: ErrorResponse;
16627
17542
  /**
16628
- * Memory store not found
17543
+ * Not found
16629
17544
  */
16630
- 404: unknown;
17545
+ 404: ErrorResponse;
16631
17546
  };
16632
- type MergeMemoryStoreTagsResponses = {
17547
+ type GetMetadataSchemaError = GetMetadataSchemaErrors[keyof GetMetadataSchemaErrors];
17548
+ type GetMetadataSchemaResponses = {
16633
17549
  /**
16634
- * Tags merged
17550
+ * The declaration
16635
17551
  */
16636
- 200: TagBag;
17552
+ 200: MetadataSchemaRecord;
16637
17553
  };
16638
- type MergeMemoryStoreTagsResponse = MergeMemoryStoreTagsResponses[keyof MergeMemoryStoreTagsResponses];
16639
- type ReplaceMemoryStoreTagsData = {
16640
- body: TagBag;
17554
+ type GetMetadataSchemaResponse = GetMetadataSchemaResponses[keyof GetMetadataSchemaResponses];
17555
+ type UpdateMetadataSchemaData = {
17556
+ body: {
17557
+ /**
17558
+ * The declaration's new selector.
17559
+ */
17560
+ path_prefix?: string;
17561
+ /**
17562
+ * Replaces the declared JSON Schema.
17563
+ */
17564
+ schema?: {
17565
+ [key: string]: unknown;
17566
+ };
17567
+ };
16641
17568
  path: {
16642
17569
  /**
16643
17570
  * Project public ID (proj_ prefix).
16644
17571
  */
16645
17572
  project_id: string;
16646
- /**
16647
- * Memory store ID
16648
- */
16649
- memory_store_id: string;
17573
+ metadata_schema_id: string;
16650
17574
  };
16651
17575
  query?: never;
16652
- url: '/v1/projects/{project_id}/memory-stores/{memory_store_id}/tags';
17576
+ url: '/v1/projects/{project_id}/metadata-schemas/{metadata_schema_id}';
16653
17577
  };
16654
- type ReplaceMemoryStoreTagsErrors = {
17578
+ type UpdateMetadataSchemaErrors = {
16655
17579
  /**
16656
- * Body is not an object of string values
17580
+ * Bad Request — an unusable selector, or a schema that is not valid JSON Schema
16657
17581
  */
16658
- 400: unknown;
17582
+ 400: ErrorResponse;
16659
17583
  /**
16660
17584
  * Unauthorized
16661
17585
  */
16662
- 401: unknown;
17586
+ 401: ErrorResponse;
16663
17587
  /**
16664
17588
  * Forbidden
16665
17589
  */
16666
- 403: unknown;
17590
+ 403: ErrorResponse;
16667
17591
  /**
16668
- * Memory store not found
17592
+ * Not found
16669
17593
  */
16670
- 404: unknown;
17594
+ 404: ErrorResponse;
17595
+ /**
17596
+ * Conflict — this selector is already declared for this type
17597
+ */
17598
+ 409: ErrorResponse;
16671
17599
  };
16672
- type ReplaceMemoryStoreTagsResponses = {
17600
+ type UpdateMetadataSchemaError = UpdateMetadataSchemaErrors[keyof UpdateMetadataSchemaErrors];
17601
+ type UpdateMetadataSchemaResponses = {
16673
17602
  /**
16674
- * Tags replaced
17603
+ * The declaration
16675
17604
  */
16676
- 200: TagBag;
17605
+ 200: MetadataSchemaRecord;
16677
17606
  };
16678
- type ReplaceMemoryStoreTagsResponse = ReplaceMemoryStoreTagsResponses[keyof ReplaceMemoryStoreTagsResponses];
17607
+ type UpdateMetadataSchemaResponse = UpdateMetadataSchemaResponses[keyof UpdateMetadataSchemaResponses];
16679
17608
  type ListModelRoutesData = {
16680
17609
  body?: never;
16681
17610
  path: {
@@ -17085,7 +18014,7 @@ type ValidateOrchestrationResponses = {
17085
18014
  /**
17086
18015
  * Validation result
17087
18016
  */
17088
- 200: ValidationResult;
18017
+ 200: OrchestrationValidationResult;
17089
18018
  };
17090
18019
  type ValidateOrchestrationResponse = ValidateOrchestrationResponses[keyof ValidateOrchestrationResponses];
17091
18020
  type GetQueueStatsData = {
@@ -17190,6 +18119,12 @@ type GetOrchestrationResponses = {
17190
18119
  type GetOrchestrationResponse = GetOrchestrationResponses[keyof GetOrchestrationResponses];
17191
18120
  type UpdateOrchestrationData = {
17192
18121
  body: UpdateOrchestrationRequest;
18122
+ headers?: {
18123
+ /**
18124
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
18125
+ */
18126
+ 'If-Match'?: string;
18127
+ };
17193
18128
  path: {
17194
18129
  /**
17195
18130
  * Project public ID (proj_ prefix).
@@ -21093,6 +22028,12 @@ type GetWorkflowResponses = {
21093
22028
  type GetWorkflowResponse = GetWorkflowResponses[keyof GetWorkflowResponses];
21094
22029
  type UpdateWorkflowData = {
21095
22030
  body: UpdateWorkflowRequest;
22031
+ headers?: {
22032
+ /**
22033
+ * The version the caller believes the resource holds, as an entity tag (`3` or `"3"`). Equivalent to `expected_version` in the request body; `*` states no precondition beyond the resource existing. A mismatch is `409 VERSION_CONFLICT`.
22034
+ */
22035
+ 'If-Match'?: string;
22036
+ };
21096
22037
  path: {
21097
22038
  /**
21098
22039
  * Project public ID (proj_ prefix).
@@ -21279,6 +22220,12 @@ export declare class Activity {
21279
22220
  * Returns activity entries for a project, newest first, filterable by kind, severity, agent, generation and orchestration run — every filter composable with the rest. Paginated with an opaque cursor rather than offset/limit — pass the previous page's `next_cursor` to fetch the next one; a `null` `next_cursor` means there is no more data.
21280
22221
  */
21281
22222
  static listActivity<ThrowOnError extends boolean = false>(options: Options<ListActivityData, ThrowOnError>): RequestResult<ListActivityResponses, ListActivityErrors, ThrowOnError>;
22223
+ /**
22224
+ * Export the activity feed as NDJSON
22225
+ *
22226
+ * Streams a project's activity entries as newline-delimited JSON — one entry object per line, **oldest first**, where the feed itself reads newest first: a feed answers what just happened, and a file is read start to end. `project_id` is required: the export is per-project by design. Filters behave exactly as they do on the list endpoint.
22227
+ */
22228
+ static exportActivity<ThrowOnError extends boolean = false>(options: Options<ExportActivityData, ThrowOnError>): RequestResult<ExportActivityResponses, ExportActivityErrors, ThrowOnError>;
21282
22229
  }
21283
22230
  export declare class Actors {
21284
22231
  /**
@@ -22012,6 +22959,12 @@ export declare class Documents {
22012
22959
  *
22013
22960
  */
22014
22961
  static ingestDocument<ThrowOnError extends boolean = false>(options: Options<IngestDocumentData, ThrowOnError>): RequestResult<IngestDocumentResponses, IngestDocumentErrors, ThrowOnError>;
22962
+ /**
22963
+ * Export documents as NDJSON
22964
+ *
22965
+ * Streams a project's documents as newline-delimited JSON — one document object per line, oldest first — for archiving the corpus or shipping it into another system. `project_id` is required: the export is per-project by design. The rows are the rows the listing returns for the same caller, so a policy that hides a document hides it here too, and withdrawn documents and the reserved `/.system/` root are left out.
22966
+ */
22967
+ static exportDocuments<ThrowOnError extends boolean = false>(options: Options<ExportDocumentsData, ThrowOnError>): RequestResult<ExportDocumentsResponses, ExportDocumentsErrors, ThrowOnError>;
22015
22968
  /**
22016
22969
  * Delete a document
22017
22970
  *
@@ -22030,6 +22983,26 @@ export declare class Documents {
22030
22983
  * Updates document content, title, path, metadata, or tags. Supplying `path` moves the document to a new logical path within the project.
22031
22984
  */
22032
22985
  static updateDocument<ThrowOnError extends boolean = false>(options: Options<UpdateDocumentData, ThrowOnError>): RequestResult<UpdateDocumentResponses, UpdateDocumentErrors, ThrowOnError>;
22986
+ /**
22987
+ * List a document's relations
22988
+ *
22989
+ * Returns the typed edges this document asserts about others, oldest first. An edge is owned by the document it leaves, so this is what the document claims — use `?related_to=` on the listing to find what claims something about it.
22990
+ */
22991
+ static listDocumentRelations<ThrowOnError extends boolean = false>(options: Options<ListDocumentRelationsData, ThrowOnError>): RequestResult<ListDocumentRelationsResponses, ListDocumentRelationsErrors, ThrowOnError>;
22992
+ /**
22993
+ * Assert a relation
22994
+ *
22995
+ * Asserts a typed edge from this document to another in the same project. Asserting the same edge twice is `409`: an edge is a fact, and the second assertion is the same fact.
22996
+ *
22997
+ * Writing an edge is a write of the asserting document (`documents:UpdateDocument`); the document it points at is unchanged, which is what lets an agent record what its own report derives from without being able to make another report claim anything.
22998
+ */
22999
+ static createDocumentRelation<ThrowOnError extends boolean = false>(options: Options<CreateDocumentRelationData, ThrowOnError>): RequestResult<CreateDocumentRelationResponses, CreateDocumentRelationErrors, ThrowOnError>;
23000
+ /**
23001
+ * Retract a relation
23002
+ *
23003
+ * Removes an edge this document asserts. Both documents are left as they are — retracting a claim is not a change to what it was about.
23004
+ */
23005
+ static deleteDocumentRelation<ThrowOnError extends boolean = false>(options: Options<DeleteDocumentRelationData, ThrowOnError>): RequestResult<DeleteDocumentRelationResponses, DeleteDocumentRelationErrors, ThrowOnError>;
22033
23006
  /**
22034
23007
  * Get document ingestion status
22035
23008
  *
@@ -22042,6 +23015,42 @@ export declare class Documents {
22042
23015
  *
22043
23016
  */
22044
23017
  static getDocumentStatus<ThrowOnError extends boolean = false>(options: Options<GetDocumentStatusData, ThrowOnError>): RequestResult<GetDocumentStatusResponses, GetDocumentStatusErrors, ThrowOnError>;
23018
+ /**
23019
+ * Withdraw a document
23020
+ *
23021
+ * Takes a document out of every default read while keeping its history. The withdrawal is archived as a **tombstone version**, so one mechanism answers what a document holds now and there is no second lifecycle flag for a reader to miss.
23022
+ *
23023
+ * Its chunks are dropped from the knowledge index, so a withdrawn document costs a live search nothing. The content is not lost with them: it is in the version before the tombstone, which [`POST /v1/projects/{project_id}/documents/{document_id}/versions/{version}/restore`](/docs/api/documents/restore-document-version) re-chunks from.
23024
+ *
23025
+ * `DELETE` stays what it is — permanent, and it removes the backing file. Withdrawal is the reversible act. It does not apply under `/.system/`: a platform-written document keeps the owning module's lifecycle.
23026
+ *
23027
+ */
23028
+ static withdrawDocument<ThrowOnError extends boolean = false>(options: Options<WithdrawDocumentData, ThrowOnError>): RequestResult<WithdrawDocumentResponses, WithdrawDocumentErrors, ThrowOnError>;
23029
+ /**
23030
+ * List a document's content versions
23031
+ *
23032
+ * Returns the document's archived states, newest first. A version is written on create and on every subsequent write that changes the content or its annotations, and a withdrawal is archived as a version carrying no content.
23033
+ *
23034
+ */
23035
+ static listDocumentVersions<ThrowOnError extends boolean = false>(options: Options<ListDocumentVersionsData, ThrowOnError>): RequestResult<ListDocumentVersionsResponses, ListDocumentVersionsErrors, ThrowOnError>;
23036
+ /**
23037
+ * Fetch an archived document version
23038
+ *
23039
+ * Returns the exact content and annotations the document held at a given version, which is what lets a run that cited a version read what it read.
23040
+ *
23041
+ */
23042
+ static getDocumentVersion<ThrowOnError extends boolean = false>(options: Options<GetDocumentVersionData, ThrowOnError>): RequestResult<GetDocumentVersionResponses, GetDocumentVersionErrors, ThrowOnError>;
23043
+ /**
23044
+ * Restore an archived document version
23045
+ *
23046
+ * Writes an archived version's content and annotations back as the document's live state, which archives them again as a **new** version rather than rewinding the counter — so a run citing any version in between still resolves.
23047
+ *
23048
+ * The restore runs through the ordinary update path, so the content is re-chunked and re-embedded; restoring the state the document already holds is a no-op and archives nothing. Restoring any content version of a withdrawn document brings it back into listings and search.
23049
+ *
23050
+ * A tombstone version has no content, so naming one is `400 VALIDATION_FAILED`: restore the version before it instead.
23051
+ *
23052
+ */
23053
+ static restoreDocumentVersion<ThrowOnError extends boolean = false>(options: Options<RestoreDocumentVersionData, ThrowOnError>): RequestResult<RestoreDocumentVersionResponses, RestoreDocumentVersionErrors, ThrowOnError>;
22045
23054
  /**
22046
23055
  * Re-ingest an existing document
22047
23056
  *
@@ -22583,6 +23592,17 @@ export declare class Memories {
22583
23592
  * Updates an existing memory. Regenerates the embedding if content changes.
22584
23593
  */
22585
23594
  static updateMemory<ThrowOnError extends boolean = false>(options: Options<UpdateMemoryData, ThrowOnError>): RequestResult<UpdateMemoryResponses, UpdateMemoryErrors, ThrowOnError>;
23595
+ /**
23596
+ * Retract a memory
23597
+ *
23598
+ * Retires a fact that stopped holding with nothing replacing it. The memory leaves the default listing, [knowledge search](/docs/api/knowledge/search-knowledge) and write deduplication, so restating the fact later lands as a new memory.
23599
+ *
23600
+ * It is an invalidation with no successor, which is what tells it apart from a supersede: `invalidated_at` is set and `superseded_by_memory_id` stays null. The retraction is appended to the assertion ledger with outcome `retracted`, so who withdrew the fact is part of the record.
23601
+ *
23602
+ * The memory stays readable by id, with its text and its assertions. `DELETE` remains the way to remove it outright.
23603
+ *
23604
+ */
23605
+ static retractMemory<ThrowOnError extends boolean = false>(options: Options<RetractMemoryData, ThrowOnError>): RequestResult<RetractMemoryResponses, RetractMemoryErrors, ThrowOnError>;
22586
23606
  /**
22587
23607
  * List a memory's assertions
22588
23608
  *
@@ -22677,6 +23697,12 @@ export declare class MemoryStores {
22677
23697
  * Returns the store's write ledger, newest first: one row per write attempt, skips included. This is how "which write path is filling this store?" is asked — a question no column on a memory row could answer, because a skipped write produced no memory at all.
22678
23698
  */
22679
23699
  static listMemoryStoreAssertions<ThrowOnError extends boolean = false>(options: Options<ListMemoryStoreAssertionsData, ThrowOnError>): RequestResult<ListMemoryStoreAssertionsResponses, ListMemoryStoreAssertionsErrors, ThrowOnError>;
23700
+ /**
23701
+ * Export a memory store's memories as NDJSON
23702
+ *
23703
+ * Streams one store's memories as newline-delimited JSON — one memory object per line, oldest first. Invalidated memories (retracted or superseded) are left out unless `include_invalidated` asks for them, so the file holds what the store currently asserts. The rows are the rows the listing returns for the same caller.
23704
+ */
23705
+ static exportMemories<ThrowOnError extends boolean = false>(options: Options<ExportMemoriesData, ThrowOnError>): RequestResult<ExportMemoriesResponses, ExportMemoriesErrors, ThrowOnError>;
22680
23706
  /**
22681
23707
  * Get memory store tags
22682
23708
  *
@@ -22696,6 +23722,50 @@ export declare class MemoryStores {
22696
23722
  */
22697
23723
  static replaceMemoryStoreTags<ThrowOnError extends boolean = false>(options: Options<ReplaceMemoryStoreTagsData, ThrowOnError>): RequestResult<ReplaceMemoryStoreTagsResponses, ReplaceMemoryStoreTagsErrors, ThrowOnError>;
22698
23724
  }
23725
+ export declare class MetadataSchemas {
23726
+ /**
23727
+ * List metadata schemas
23728
+ *
23729
+ * Returns the declarations in scope, oldest first. `resource_type` narrows them to one governed resource.
23730
+ */
23731
+ static listMetadataSchemas<ThrowOnError extends boolean = false>(options: Options<ListMetadataSchemasData, ThrowOnError>): RequestResult<ListMetadataSchemasResponses, ListMetadataSchemasErrors, ThrowOnError>;
23732
+ /**
23733
+ * Declare a metadata schema
23734
+ *
23735
+ * Declares what `metadata` must satisfy for one resource type under one selector. A document is selected by `path_prefix`, matched on a path boundary: `/reports` covers `/reports/q1.txt` and never `/reports-archive/q1.txt`.
23736
+ *
23737
+ * The schema is compiled here, so one JSON Schema cannot parse is refused rather than stored — a stored one would be a rule that silently governs nothing. One selector has one schema per resource type; a second declaration of the same one is `409 NAME_CONFLICT`. The reserved root `/.system` cannot be governed: a platform-written document carries no caller metadata.
23738
+ *
23739
+ */
23740
+ static createMetadataSchema<ThrowOnError extends boolean = false>(options: Options<CreateMetadataSchemaData, ThrowOnError>): RequestResult<CreateMetadataSchemaResponses, CreateMetadataSchemaErrors, ThrowOnError>;
23741
+ /**
23742
+ * Check metadata against what is declared
23743
+ *
23744
+ * Answers what a write would be told, without writing: a caller preparing a batch learns which declaration would refuse it, and why, before it sends anything.
23745
+ *
23746
+ * It reports; it does not enforce. The refusal itself lives in each resource's own write path, because a check a writer has to call is advisory and the writer who skips it is the one the rule exists for.
23747
+ *
23748
+ */
23749
+ static validateMetadata<ThrowOnError extends boolean = false>(options: Options<ValidateMetadataData, ThrowOnError>): RequestResult<ValidateMetadataResponses, ValidateMetadataErrors, ThrowOnError>;
23750
+ /**
23751
+ * Delete a metadata schema
23752
+ *
23753
+ * Removes the declaration. Documents already stored keep the metadata they hold — the rule governed writes, not rows.
23754
+ */
23755
+ static deleteMetadataSchema<ThrowOnError extends boolean = false>(options: Options<DeleteMetadataSchemaData, ThrowOnError>): RequestResult<DeleteMetadataSchemaResponses, DeleteMetadataSchemaErrors, ThrowOnError>;
23756
+ /**
23757
+ * Get a metadata schema
23758
+ *
23759
+ * Returns one declaration by id.
23760
+ */
23761
+ static getMetadataSchema<ThrowOnError extends boolean = false>(options: Options<GetMetadataSchemaData, ThrowOnError>): RequestResult<GetMetadataSchemaResponses, GetMetadataSchemaErrors, ThrowOnError>;
23762
+ /**
23763
+ * Update a metadata schema
23764
+ *
23765
+ * Changes the schema, the selector, or both. `resource_type` is fixed at creation: it decides the selector's spelling and which write path reads the row, so changing it would silently repoint the declaration at a different door — delete it and declare again instead.
23766
+ */
23767
+ static updateMetadataSchema<ThrowOnError extends boolean = false>(options: Options<UpdateMetadataSchemaData, ThrowOnError>): RequestResult<UpdateMetadataSchemaResponses, UpdateMetadataSchemaErrors, ThrowOnError>;
23768
+ }
22699
23769
  export declare class ModelRoutes {
22700
23770
  /**
22701
23771
  * List model routes
@@ -23596,6 +24666,7 @@ export declare class NaturaliClient {
23596
24666
  readonly memories: typeof Memories;
23597
24667
  readonly memoryRules: typeof MemoryRules;
23598
24668
  readonly memoryStores: typeof MemoryStores;
24669
+ readonly metadataSchemas: typeof MetadataSchemas;
23599
24670
  readonly modelRoutes: typeof ModelRoutes;
23600
24671
  readonly quotas: typeof Quotas;
23601
24672
  readonly models: typeof Models;
@@ -23615,4 +24686,4 @@ export declare class NaturaliClient {
23615
24686
  constructor({ token, headers }?: NaturaliClientOptions);
23616
24687
  }
23617
24688
  //#endregion
23618
- export type { AbortAgentReleaseData, AbortAgentReleaseError, AbortAgentReleaseErrors, AbortAgentReleaseResponse, AbortAgentReleaseResponses, AcceptedGenerationResponse, AcknowledgeExceptionData, AcknowledgeExceptionErrors, AcknowledgeExceptionResponse, AcknowledgeExceptionResponses, Acknowledgement, ActivityEntry, ActorRecord, ActorResourceProperties, AddConversationMessageData, AddConversationMessageError, AddConversationMessageErrors, AddConversationMessageResponse, AddConversationMessageResponses, AddProjectMemberData, AddProjectMemberError, AddProjectMemberErrors, AddProjectMemberResponse, AddProjectMemberResponses, AddSessionMessageData, AddSessionMessageError, AddSessionMessageErrors, AddSessionMessageRequest, AddSessionMessageResponse, AddSessionMessageResponse2, AddSessionMessageResponses, AddSessionMessageSaved, Address, AddressActionSet, AddressList, AdminUser, AdminUserPage, Agent, AgentBoundaryPolicy, AgentBoundaryPolicyStatement, AgentGenerationResponse, AgentRelease, AgentResourceProperties, AgentStepRule, AgentStopCondition, AgentVersion, AggregateScores, AiProviderResourceProperties, ApiKeyCreate, ApiKeyCreated, ApiKeyId, ApiKeyList, ApiKeyRecord, ApiKeyUpdate, ApprovalId, ApprovalItem, ApprovalRecurrenceGroup, ApproveApprovalData, ApproveApprovalErrors, ApproveApprovalResponse, ApproveApprovalResponses, AssistantChannel, AssistantGrant, AssistantGrantList, AssistantLinkPreview, AssistantLinkRedeem, AssistantScope, AuditEntry, AuthSession, BaselineComparison, CallToolData, CallToolError, CallToolErrors, CallToolRequest, CallToolResponses, CancelEvalRunData, CancelEvalRunErrors, CancelEvalRunResponse, CancelEvalRunResponses, CancelOrchestrationRunData, CancelOrchestrationRunErrors, CancelOrchestrationRunResponse, CancelOrchestrationRunResponses, Chain, ChainId, Channel, ChannelCreate, ChannelDefaultAction, ChannelDefaultActionInput, ChannelId, ChannelKind, ChannelKindList, ChannelList, ChannelPredicate, ChannelRoute, ChannelRouteList, ChannelRouteWrite, ChannelSurface, ChannelUpdate, ClientOptions, ContainsScorer, Conversation, ConversationId, ConversationList, ConversationMessage, ConversationMessageList, ConversationMessageRecord, ConversationRecord, ConversationResourceProperties, CreateActorData, CreateActorError, CreateActorErrors, CreateActorResponse, CreateActorResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentGenerationData, CreateAgentGenerationError, CreateAgentGenerationErrors, CreateAgentGenerationRequest, CreateAgentGenerationResponse, CreateAgentGenerationResponses, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAiProviderData, CreateAiProviderErrors, CreateAiProviderResponse, CreateAiProviderResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateChannelData, CreateChannelError, CreateChannelErrors, CreateChannelResponse, CreateChannelResponses, CreateChannelRouteData, CreateChannelRouteError, CreateChannelRouteErrors, CreateChannelRouteResponse, CreateChannelRouteResponses, CreateConversationData, CreateConversationError, CreateConversationErrors, CreateConversationResponse, CreateConversationResponses, CreateDatasetData, CreateDatasetErrors, CreateDatasetItemData, CreateDatasetItemErrors, CreateDatasetItemFromGenerationData, CreateDatasetItemFromGenerationErrors, CreateDatasetItemFromGenerationResponse, CreateDatasetItemFromGenerationResponses, CreateDatasetItemResponse, CreateDatasetItemResponses, CreateDatasetResponse, CreateDatasetResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentResponse, CreateDocumentResponses, CreateEmbeddingsData, CreateEmbeddingsError, CreateEmbeddingsErrors, CreateEmbeddingsResponse, CreateEmbeddingsResponses, CreateEvalData, CreateEvalErrors, CreateEvalResponse, CreateEvalResponses, CreateFileData, CreateFileError, CreateFileErrors, CreateFileResponse, CreateFileResponses, CreateFormationData, CreateFormationErrors, CreateFormationResponse, CreateFormationResponses, CreateGuardrailData, CreateGuardrailError, CreateGuardrailErrors, CreateGuardrailRequest, CreateGuardrailResponse, CreateGuardrailResponses, CreateIngestionRuleData, CreateIngestionRuleErrors, CreateIngestionRuleResponse, CreateIngestionRuleResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponse, CreateMemoryResponses, CreateMemoryRuleData, CreateMemoryRuleErrors, CreateMemoryRuleResponse, CreateMemoryRuleResponses, CreateMemoryStoreData, CreateMemoryStoreErrors, CreateMemoryStoreResponse, CreateMemoryStoreResponses, CreateModelRouteData, CreateModelRouteErrors, CreateModelRouteResponse, CreateModelRouteResponses, CreateOrchestrationData, CreateOrchestrationErrors, CreateOrchestrationRequest, CreateOrchestrationResponse, CreateOrchestrationResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateProjectUsageThresholdData, CreateProjectUsageThresholdError, CreateProjectUsageThresholdErrors, CreateProjectUsageThresholdResponse, CreateProjectUsageThresholdResponses, CreateQuotaData, CreateQuotaErrors, CreateQuotaResponse, CreateQuotaResponses, CreateSecretData, CreateSecretErrors, CreateSecretResponse, CreateSecretResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionRequest, CreateSessionResponse, CreateSessionResponses, CreateTaskData, CreateTaskErrors, CreateTaskRequest, CreateTaskResponse, CreateTaskResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolRequest, CreateToolResponse, CreateToolResponses, CreateTriggerData, CreateTriggerErrors, CreateTriggerRequest, CreateTriggerResponse, CreateTriggerResponses, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowRequest, CreateWorkflowResponse, CreateWorkflowResponses, CreditEntry, CreditEntryPage, CreditGrant, CreditGrantResult, Cursor, Dataset, DatasetItem, DatasetItemInput, DatasetItemResourceProperties, DatasetResourceProperties, DeleteActorData, DeleteActorError, DeleteActorErrors, DeleteActorResponse, DeleteActorResponses, DeleteAddressData, DeleteAddressError, DeleteAddressErrors, DeleteAddressResponse, DeleteAddressResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAiProviderData, DeleteAiProviderErrors, DeleteAiProviderResponse, DeleteAiProviderResponses, DeleteApiKeyData, DeleteApiKeyError, DeleteApiKeyErrors, DeleteApiKeyResponse, DeleteApiKeyResponses, DeleteChannelData, DeleteChannelError, DeleteChannelErrors, DeleteChannelResponse, DeleteChannelResponses, DeleteChannelRouteData, DeleteChannelRouteError, DeleteChannelRouteErrors, DeleteChannelRouteResponse, DeleteChannelRouteResponses, DeleteConversationData, DeleteConversationError, DeleteConversationErrors, DeleteConversationResponse, DeleteConversationResponses, DeleteDatasetData, DeleteDatasetErrors, DeleteDatasetItemData, DeleteDatasetItemErrors, DeleteDatasetItemResponse, DeleteDatasetItemResponses, DeleteDatasetResponse, DeleteDatasetResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEvalData, DeleteEvalErrors, DeleteEvalResponse, DeleteEvalResponses, DeleteFileData, DeleteFileError, DeleteFileErrors, DeleteFileResponse, DeleteFileResponses, DeleteFormationData, DeleteFormationErrors, DeleteFormationResponse, DeleteFormationResponses, DeleteGuardrailData, DeleteGuardrailError, DeleteGuardrailErrors, DeleteGuardrailResponse, DeleteGuardrailResponses, DeleteIngestionRuleData, DeleteIngestionRuleErrors, DeleteIngestionRuleResponse, DeleteIngestionRuleResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponse, DeleteMemoryResponses, DeleteMemoryRuleData, DeleteMemoryRuleErrors, DeleteMemoryRuleResponse, DeleteMemoryRuleResponses, DeleteMemoryStoreData, DeleteMemoryStoreErrors, DeleteMemoryStoreResponse, DeleteMemoryStoreResponses, DeleteModelRouteData, DeleteModelRouteErrors, DeleteModelRouteResponse, DeleteModelRouteResponses, DeleteOrchestrationData, DeleteOrchestrationErrors, DeleteOrchestrationResponse, DeleteOrchestrationResponses, DeleteProjectData, DeleteProjectError, DeleteProjectErrors, DeleteProjectResponse, DeleteProjectResponses, DeleteProjectUsageThresholdData, DeleteProjectUsageThresholdError, DeleteProjectUsageThresholdErrors, DeleteProjectUsageThresholdResponse, DeleteProjectUsageThresholdResponses, DeleteQuotaData, DeleteQuotaErrors, DeleteQuotaResponse, DeleteQuotaResponses, DeleteSecretData, DeleteSecretErrors, DeleteSecretResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteTaskData, DeleteTaskErrors, DeleteTaskResponse, DeleteTaskResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteTriggerData, DeleteTriggerErrors, DeleteTriggerResponse, DeleteTriggerResponses, DeleteWebhookData, DeleteWebhookError, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DeliveryId, DiscordModes, DocumentKnowledgeResult, DocumentMessageContent, DocumentRecord, DocumentResourceProperties, DocumentStatusRecord, DownloadFileBase64Data, DownloadFileBase64Error, DownloadFileBase64Errors, DownloadFileBase64Response, DownloadFileBase64Responses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, EmbeddingSimilarityScorer, EmbeddingsResponse, ErrorResponse, Eval, EvalResourceProperties, EvalResult, EvalRun, EvaluateGuardrailData, EvaluateGuardrailError, EvaluateGuardrailErrors, EvaluateGuardrailResponse, EvaluateGuardrailResponses, Event, EventSubscription, EventType, ExactMatchScorer, ExceptionId, ExceptionItem, ExportAuditEntriesData, ExportAuditEntriesErrors, ExportAuditEntriesResponse, ExportAuditEntriesResponses, FileRecord, FileRecordWritable, FileResourceProperties, FireTriggerData, FireTriggerErrors, FireTriggerRequest, FireTriggerResponse, FireTriggerResponses, Force, ForkSessionData, ForkSessionError, ForkSessionErrors, ForkSessionRequest, ForkSessionResponse, ForkSessionResponses, Formation, FormationError, FormationEvent, FormationOperation, FormationResource, FormationTemplate, FormationTemplateInput, GenerateConversationMessageCompleted, GenerateConversationMessageData, GenerateConversationMessageError, GenerateConversationMessageErrors, GenerateConversationMessageRequiresAction, GenerateConversationMessageResponse, GenerateConversationMessageResponse2, GenerateConversationMessageResponses, GenerateSessionRequest, GenerateSessionResponse, GenerateSessionResponseData, GenerateSessionResponseError, GenerateSessionResponseErrors, GenerateSessionResponseResponse, GenerateSessionResponseResponses, Generation, GenerationTranscript, GetActorData, GetActorError, GetActorErrors, GetActorResponse, GetActorResponses, GetActorTagsData, GetActorTagsError, GetActorTagsErrors, GetActorTagsResponse, GetActorTagsResponses, GetAddressData, GetAddressError, GetAddressErrors, GetAddressResponse, GetAddressResponses, GetAdminPriceBookData, GetAdminPriceBookError, GetAdminPriceBookErrors, GetAdminPriceBookResponse, GetAdminPriceBookResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentVersionData, GetAgentVersionError, GetAgentVersionErrors, GetAgentVersionResponse, GetAgentVersionResponses, GetAiProviderData, GetAiProviderErrors, GetAiProviderPricesData, GetAiProviderPricesErrors, GetAiProviderPricesResponse, GetAiProviderPricesResponses, GetAiProviderResponse, GetAiProviderResponses, GetApiKeyData, GetApiKeyError, GetApiKeyErrors, GetApiKeyResponse, GetApiKeyResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponse, GetApprovalResponses, GetAuditEntryData, GetAuditEntryErrors, GetAuditEntryResponse, GetAuditEntryResponses, GetChainData, GetChainErrors, GetChainResponse, GetChainResponses, GetChannelConversationData, GetChannelConversationError, GetChannelConversationErrors, GetChannelConversationResponse, GetChannelConversationResponses, GetChannelData, GetChannelError, GetChannelErrors, GetChannelResponse, GetChannelResponses, GetChannelRouteData, GetChannelRouteError, GetChannelRouteErrors, GetChannelRouteResponse, GetChannelRouteResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationTagsData, GetConversationTagsError, GetConversationTagsErrors, GetConversationTagsResponse, GetConversationTagsResponses, GetCurrentUserBillingData, GetCurrentUserBillingError, GetCurrentUserBillingErrors, GetCurrentUserBillingResponse, GetCurrentUserBillingResponses, GetCurrentUserData, GetCurrentUserError, GetCurrentUserErrors, GetCurrentUserResponse, GetCurrentUserResponses, GetCurrentUserUsageData, GetCurrentUserUsageError, GetCurrentUserUsageErrors, GetCurrentUserUsageResponse, GetCurrentUserUsageResponses, GetDatasetData, GetDatasetErrors, GetDatasetResponse, GetDatasetResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentResponse, GetDocumentResponses, GetDocumentStatusData, GetDocumentStatusError, GetDocumentStatusErrors, GetDocumentStatusResponse, GetDocumentStatusResponses, GetDocumentTagsData, GetDocumentTagsError, GetDocumentTagsErrors, GetDocumentTagsResponse, GetDocumentTagsResponses, GetEvalData, GetEvalErrors, GetEvalResponse, GetEvalResponses, GetEvalRunData, GetEvalRunErrors, GetEvalRunResponse, GetEvalRunResponses, GetExceptionData, GetExceptionErrors, GetExceptionResponse, GetExceptionResponses, GetFileData, GetFileError, GetFileErrors, GetFileResponse, GetFileResponses, GetFileTagsData, GetFileTagsError, GetFileTagsErrors, GetFileTagsResponse, GetFileTagsResponses, GetFormationData, GetFormationErrors, GetFormationResponse, GetFormationResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetGenerationTranscriptData, GetGenerationTranscriptError, GetGenerationTranscriptErrors, GetGenerationTranscriptResponse, GetGenerationTranscriptResponses, GetGuardrailData, GetGuardrailError, GetGuardrailErrors, GetGuardrailResponse, GetGuardrailResponses, GetGuardrailVersionData, GetGuardrailVersionError, GetGuardrailVersionErrors, GetGuardrailVersionResponse, GetGuardrailVersionResponses, GetIngestionRuleData, GetIngestionRuleErrors, GetIngestionRuleResponse, GetIngestionRuleResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponse, GetMemoryResponses, GetMemoryRuleData, GetMemoryRuleErrors, GetMemoryRuleResponse, GetMemoryRuleResponses, GetMemoryStoreData, GetMemoryStoreErrors, GetMemoryStoreResponse, GetMemoryStoreResponses, GetMemoryStoreTagsData, GetMemoryStoreTagsErrors, GetMemoryStoreTagsResponse, GetMemoryStoreTagsResponses, GetMemoryTagsData, GetMemoryTagsErrors, GetMemoryTagsResponse, GetMemoryTagsResponses, GetModelData, GetModelError, GetModelErrors, GetModelResponse, GetModelResponses, GetModelRouteData, GetModelRouteErrors, GetModelRouteResponse, GetModelRouteResponses, GetOrchestrationData, GetOrchestrationErrors, GetOrchestrationResponse, GetOrchestrationResponses, GetOrchestrationRunData, GetOrchestrationRunErrors, GetOrchestrationRunResponse, GetOrchestrationRunResponses, GetOrchestrationVersionData, GetOrchestrationVersionErrors, GetOrchestrationVersionResponse, GetOrchestrationVersionResponses, GetProjectData, GetProjectError, GetProjectErrors, GetProjectResponse, GetProjectResponses, GetProjectUsageData, GetProjectUsageError, GetProjectUsageErrors, GetProjectUsageReceiptData, GetProjectUsageReceiptError, GetProjectUsageReceiptErrors, GetProjectUsageReceiptResponse, GetProjectUsageReceiptResponses, GetProjectUsageResponse, GetProjectUsageResponses, GetQueueStatsData, GetQueueStatsErrors, GetQueueStatsResponse, GetQueueStatsResponses, GetQuotaData, GetQuotaErrors, GetQuotaResponse, GetQuotaResponses, GetSecretData, GetSecretErrors, GetSecretResponse, GetSecretResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSessionTagsData, GetSessionTagsError, GetSessionTagsErrors, GetSessionTagsResponse, GetSessionTagsResponses, GetTaskData, GetTaskErrors, GetTaskHistoryData, GetTaskHistoryErrors, GetTaskHistoryResponse, GetTaskHistoryResponses, GetTaskResponse, GetTaskResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTraceData, GetTraceError, GetTraceErrors, GetTraceResponse, GetTraceResponses, GetTraceTreeData, GetTraceTreeError, GetTraceTreeErrors, GetTraceTreeResponse, GetTraceTreeResponses, GetTriggerData, GetTriggerErrors, GetTriggerFiringData, GetTriggerFiringErrors, GetTriggerFiringResponse, GetTriggerFiringResponses, GetTriggerResponse, GetTriggerResponses, GetTriggerSecretData, GetTriggerSecretErrors, GetTriggerSecretResponse, GetTriggerSecretResponses, GetWebhookData, GetWebhookDeliveryData, GetWebhookDeliveryError, GetWebhookDeliveryErrors, GetWebhookDeliveryResponse, GetWebhookDeliveryResponses, GetWebhookError, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, GetWorkflowVersionData, GetWorkflowVersionErrors, GetWorkflowVersionResponse, GetWorkflowVersionResponses, GrantId, GrantUserCreditData, GrantUserCreditError, GrantUserCreditErrors, GrantUserCreditResponse, GrantUserCreditResponses, GrantUserPlanData, GrantUserPlanError, GrantUserPlanErrors, GrantUserPlanResponse, GrantUserPlanResponses, GrantableProjectRole, Guardrail, GuardrailDocument, GuardrailEvaluation, GuardrailResourceProperties, GuardrailVersion, HumanInputRequest, Identifier, IngestDocumentData, IngestDocumentError, IngestDocumentErrors, IngestDocumentResponse, IngestDocumentResponses, IngestedDocumentRecord, IngestionRule, IngestionRuleResourceProperties, JsonLogicScorer, KnowledgeResult, Limit, LinkToken, ListActivityData, ListActivityErrors, ListActivityResponse, ListActivityResponses, ListActorsData, ListActorsError, ListActorsErrors, ListActorsResponse, ListActorsResponses, ListAddressConversationsData, ListAddressConversationsError, ListAddressConversationsErrors, ListAddressConversationsResponse, ListAddressConversationsResponses, ListAddressesData, ListAddressesError, ListAddressesErrors, ListAddressesResponse, ListAddressesResponses, ListAgentVersionsData, ListAgentVersionsError, ListAgentVersionsErrors, ListAgentVersionsResponse, ListAgentVersionsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAiProviderModelsData, ListAiProviderModelsErrors, ListAiProviderModelsResponse, ListAiProviderModelsResponses, ListAiProvidersData, ListAiProvidersErrors, ListAiProvidersResponse, ListAiProvidersResponses, ListApiKeysData, ListApiKeysError, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListApprovalRecurrencesData, ListApprovalRecurrencesErrors, ListApprovalRecurrencesResponse, ListApprovalRecurrencesResponses, ListApprovalsData, ListApprovalsErrors, ListApprovalsResponse, ListApprovalsResponses, ListAssistantGrantsData, ListAssistantGrantsError, ListAssistantGrantsErrors, ListAssistantGrantsResponse, ListAssistantGrantsResponses, ListAuditEntriesData, ListAuditEntriesErrors, ListAuditEntriesResponse, ListAuditEntriesResponses, ListChainsData, ListChainsErrors, ListChainsResponse, ListChainsResponses, ListChannelConversationMessagesData, ListChannelConversationMessagesError, ListChannelConversationMessagesErrors, ListChannelConversationMessagesResponse, ListChannelConversationMessagesResponses, ListChannelConversationsData, ListChannelConversationsError, ListChannelConversationsErrors, ListChannelConversationsResponse, ListChannelConversationsResponses, ListChannelKindsData, ListChannelKindsError, ListChannelKindsErrors, ListChannelKindsResponse, ListChannelKindsResponses, ListChannelRoutesData, ListChannelRoutesError, ListChannelRoutesErrors, ListChannelRoutesResponse, ListChannelRoutesResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListConversationMessagesData, ListConversationMessagesError, ListConversationMessagesErrors, ListConversationMessagesResponse, ListConversationMessagesResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListDatasetItemsData, ListDatasetItemsErrors, ListDatasetItemsResponse, ListDatasetItemsResponses, ListDatasetsData, ListDatasetsErrors, ListDatasetsResponse, ListDatasetsResponses, ListDocumentsData, ListDocumentsError, ListDocumentsErrors, ListDocumentsResponse, ListDocumentsResponses, ListEvalResultsData, ListEvalResultsErrors, ListEvalResultsResponse, ListEvalResultsResponses, ListEvalRunsData, ListEvalRunsErrors, ListEvalRunsResponse, ListEvalRunsResponses, ListEvalsData, ListEvalsErrors, ListEvalsResponse, ListEvalsResponses, ListExceptionsData, ListExceptionsErrors, ListExceptionsResponse, ListExceptionsResponses, ListFilesData, ListFilesError, ListFilesErrors, ListFilesResponse, ListFilesResponses, ListFormationEventsData, ListFormationEventsErrors, ListFormationEventsResponse, ListFormationEventsResponses, ListFormationsData, ListFormationsErrors, ListFormationsResponse, ListFormationsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListGuardrailVersionsData, ListGuardrailVersionsError, ListGuardrailVersionsErrors, ListGuardrailVersionsResponse, ListGuardrailVersionsResponses, ListGuardrailsData, ListGuardrailsError, ListGuardrailsErrors, ListGuardrailsResponse, ListGuardrailsResponses, ListIngestionRulesData, ListIngestionRulesErrors, ListIngestionRulesResponse, ListIngestionRulesResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponse, ListMemoriesResponses, ListMemoryAssertionsData, ListMemoryAssertionsErrors, ListMemoryAssertionsResponse, ListMemoryAssertionsResponses, ListMemoryRulesData, ListMemoryRulesErrors, ListMemoryRulesResponse, ListMemoryRulesResponses, ListMemoryStoreAssertionsData, ListMemoryStoreAssertionsErrors, ListMemoryStoreAssertionsResponse, ListMemoryStoreAssertionsResponses, ListMemoryStoresData, ListMemoryStoresErrors, ListMemoryStoresResponse, ListMemoryStoresResponses, ListModelRoutesData, ListModelRoutesErrors, ListModelRoutesResponse, ListModelRoutesResponses, ListModelsData, ListModelsError, ListModelsErrors, ListModelsResponse, ListModelsResponses, ListOrchestrationRunsData, ListOrchestrationRunsErrors, ListOrchestrationRunsResponse, ListOrchestrationRunsResponses, ListOrchestrationVersionsData, ListOrchestrationVersionsErrors, ListOrchestrationVersionsResponse, ListOrchestrationVersionsResponses, ListOrchestrationsData, ListOrchestrationsErrors, ListOrchestrationsResponse, ListOrchestrationsResponses, ListProjectChannelRoutesData, ListProjectChannelRoutesError, ListProjectChannelRoutesErrors, ListProjectChannelRoutesResponse, ListProjectChannelRoutesResponses, ListProjectMembersData, ListProjectMembersError, ListProjectMembersErrors, ListProjectMembersResponse, ListProjectMembersResponses, ListProjectUsageEventsData, ListProjectUsageEventsError, ListProjectUsageEventsErrors, ListProjectUsageEventsResponse, ListProjectUsageEventsResponses, ListProjectUsageThresholdsData, ListProjectUsageThresholdsError, ListProjectUsageThresholdsErrors, ListProjectUsageThresholdsResponse, ListProjectUsageThresholdsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListQuotasData, ListQuotasErrors, ListQuotasResponse, ListQuotasResponses, ListSecretsData, ListSecretsErrors, ListSecretsResponse, ListSecretsResponses, ListSessionForksData, ListSessionForksError, ListSessionForksErrors, ListSessionForksResponse, ListSessionForksResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListTasksData, ListTasksErrors, ListTasksResponse, ListTasksResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListTracesData, ListTracesError, ListTracesErrors, ListTracesResponse, ListTracesResponses, ListTriggerFiringsData, ListTriggerFiringsErrors, ListTriggerFiringsResponse, ListTriggerFiringsResponses, ListTriggersData, ListTriggersErrors, ListTriggersResponse, ListTriggersResponses, ListUserCreditsData, ListUserCreditsError, ListUserCreditsErrors, ListUserCreditsResponse, ListUserCreditsResponses, ListUserPlanHistoryData, ListUserPlanHistoryError, ListUserPlanHistoryErrors, ListUserPlanHistoryResponse, ListUserPlanHistoryResponses, ListUsersData, ListUsersError, ListUsersErrors, ListUsersResponse, ListUsersResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowVersionsData, ListWorkflowVersionsErrors, ListWorkflowVersionsResponse, ListWorkflowVersionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, LlmJudgeScorer, LogoutData, LogoutError, LogoutErrors, LogoutRequest, LogoutResponse, LogoutResponses, Memory, MemoryAssertion, MemoryKnowledgeResult, MemoryResourceProperties, MemoryRule, MemoryRuleEvent, MemoryRuleResourceProperties, MemoryStore, MemoryStoreResourceProperties, MemoryWriteResult, MergeActorTagsData, MergeActorTagsError, MergeActorTagsErrors, MergeActorTagsResponse, MergeActorTagsResponses, MergeConversationTagsData, MergeConversationTagsError, MergeConversationTagsErrors, MergeConversationTagsResponse, MergeConversationTagsResponses, MergeDocumentTagsData, MergeDocumentTagsError, MergeDocumentTagsErrors, MergeDocumentTagsResponse, MergeDocumentTagsResponses, MergeFileTagsData, MergeFileTagsError, MergeFileTagsErrors, MergeFileTagsResponse, MergeFileTagsResponses, MergeMemoryStoreTagsData, MergeMemoryStoreTagsErrors, MergeMemoryStoreTagsResponse, MergeMemoryStoreTagsResponses, MergeMemoryTagsData, MergeMemoryTagsErrors, MergeMemoryTagsResponse, MergeMemoryTagsResponses, MergeSessionTagsData, MergeSessionTagsError, MergeSessionTagsErrors, MergeSessionTagsResponse, MergeSessionTagsResponses, MessagesLimit, Model, ModelList, ModelName, ModelRoute, ModelRouteResourceProperties, ModelRouteTarget, NaturaliClientOptions, NodeExecution, NullableTagBag, Offset, OpenChannelConversationData, OpenChannelConversationError, OpenChannelConversationErrors, OpenChannelConversationResponse, OpenChannelConversationResponses, Options, Orchestration, OrchestrationEdge, OrchestrationId, OrchestrationNode, OrchestrationResourceProperties, OrchestrationRun, OrchestrationRunId, OrchestrationVersion, OutputSchemaScorer, ParameterDeclaration, PatchAgentData, PatchAgentError, PatchAgentErrors, PatchAgentResponse, PatchAgentResponses, PauseOrchestrationRunData, PauseOrchestrationRunErrors, PauseOrchestrationRunRequest, PauseOrchestrationRunResponse, PauseOrchestrationRunResponses, PauseTaskData, PauseTaskErrors, PauseTaskRequest, PauseTaskResponse, PauseTaskResponses, PlanChange, PlanEvent, PlanEventPage, PlanFormationData, PlanFormationErrors, PlanFormationResponse, PlanFormationResponses, PlanResult, PreviewAssistantLinkData, PreviewAssistantLinkError, PreviewAssistantLinkErrors, PreviewAssistantLinkResponse, PreviewAssistantLinkResponses, Price, PriceBook, Project, ProjectCreate, ProjectId, ProjectList, ProjectMember, ProjectMemberCreate, ProjectMemberList, ProjectMemberUpdate, ProjectRole, ProjectRuns, ProjectUpdate, ProjectUsage, ProjectUsageDistinct, ProjectUsageEvent, ProjectUsageEventPage, ProjectUsageFilters, ProjectUsageGroups, ProjectUsageReceipt, PromoteAgentReleaseData, PromoteAgentReleaseError, PromoteAgentReleaseErrors, PromoteAgentReleaseResponse, PromoteAgentReleaseResponses, ProviderModelsResponse, ProviderPrice, ProviderPricesResponse, PurgeGenerationContentData, PurgeGenerationContentError, PurgeGenerationContentErrors, PurgeGenerationContentResponse, PurgeGenerationContentResponses, PurgeTraceContentData, PurgeTraceContentError, PurgeTraceContentErrors, PurgeTraceContentResponse, PurgeTraceContentResponses, QueueStats, Quota, QuotaResourceProperties, RedeemAssistantLinkData, RedeemAssistantLinkError, RedeemAssistantLinkErrors, RedeemAssistantLinkResponse, RedeemAssistantLinkResponses, RedeliverWebhookDeliveryData, RedeliverWebhookDeliveryError, RedeliverWebhookDeliveryErrors, RedeliverWebhookDeliveryResponse, RedeliverWebhookDeliveryResponses, RefreshRequest, RefreshSessionData, RefreshSessionError, RefreshSessionErrors, RefreshSessionResponse, RefreshSessionResponses, ReingestDocumentData, ReingestDocumentError, ReingestDocumentErrors, ReingestDocumentResponse, ReingestDocumentResponses, RejectApprovalData, RejectApprovalErrors, RejectApprovalResponse, RejectApprovalResponses, RemoveConversationMessageData, RemoveConversationMessageError, RemoveConversationMessageErrors, RemoveConversationMessageResponse, RemoveConversationMessageResponses, RemoveProjectMemberData, RemoveProjectMemberError, RemoveProjectMemberErrors, RemoveProjectMemberResponse, RemoveProjectMemberResponses, ReplaceActorTagsData, ReplaceActorTagsError, ReplaceActorTagsErrors, ReplaceActorTagsResponse, ReplaceActorTagsResponses, ReplaceConversationTagsData, ReplaceConversationTagsError, ReplaceConversationTagsErrors, ReplaceConversationTagsResponse, ReplaceConversationTagsResponses, ReplaceDocumentTagsData, ReplaceDocumentTagsError, ReplaceDocumentTagsErrors, ReplaceDocumentTagsResponse, ReplaceDocumentTagsResponses, ReplaceFileTagsData, ReplaceFileTagsError, ReplaceFileTagsErrors, ReplaceFileTagsResponse, ReplaceFileTagsResponses, ReplaceMemoryStoreTagsData, ReplaceMemoryStoreTagsErrors, ReplaceMemoryStoreTagsResponse, ReplaceMemoryStoreTagsResponses, ReplaceMemoryTagsData, ReplaceMemoryTagsErrors, ReplaceMemoryTagsResponse, ReplaceMemoryTagsResponses, ReplaceSessionTagsData, ReplaceSessionTagsError, ReplaceSessionTagsErrors, ReplaceSessionTagsResponse, ReplaceSessionTagsResponses, RequestSignInCodeData, RequestSignInCodeError, RequestSignInCodeErrors, RequestSignInCodeResponse, RequestSignInCodeResponses, RequiredAction, ResolveExceptionData, ResolveExceptionErrors, ResolveExceptionResponse, ResolveExceptionResponses, ResourceDeclaration, RestoreAgentVersionData, RestoreAgentVersionError, RestoreAgentVersionErrors, RestoreAgentVersionRequest, RestoreAgentVersionResponse, RestoreAgentVersionResponses, RestoreGuardrailVersionData, RestoreGuardrailVersionError, RestoreGuardrailVersionErrors, RestoreGuardrailVersionRequest, RestoreGuardrailVersionResponse, RestoreGuardrailVersionResponses, RestoreOrchestrationVersionData, RestoreOrchestrationVersionErrors, RestoreOrchestrationVersionRequest, RestoreOrchestrationVersionResponse, RestoreOrchestrationVersionResponses, RestoreWorkflowVersionData, RestoreWorkflowVersionErrors, RestoreWorkflowVersionRequest, RestoreWorkflowVersionResponse, RestoreWorkflowVersionResponses, ResumeOrchestrationRunData, ResumeOrchestrationRunErrors, ResumeOrchestrationRunResponse, ResumeOrchestrationRunResponses, ResumeTaskData, ResumeTaskErrors, ResumeTaskResponse, ResumeTaskResponses, RevokeAssistantGrantData, RevokeAssistantGrantError, RevokeAssistantGrantErrors, RevokeAssistantGrantResponse, RevokeAssistantGrantResponses, RotateApiKeyData, RotateApiKeyError, RotateApiKeyErrors, RotateApiKeyResponse, RotateApiKeyResponses, RotateTriggerSecretData, RotateTriggerSecretErrors, RotateTriggerSecretResponse, RotateTriggerSecretResponses, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, RouteId, ScorerResult, Scorers, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SecretResourceProperties, SendSessionMessageResponse, SessionId, SessionRecord, SessionResourceProperties, SetAddressActionData, SetAddressActionError, SetAddressActionErrors, SetAddressActionResponse, SetAddressActionResponses, SetAgentReleaseData, SetAgentReleaseError, SetAgentReleaseErrors, SetAgentReleaseRequest, SetAgentReleaseResponse, SetAgentReleaseResponses, SignInCodeRequest, SignInCodeVerify, StartEvalRunData, StartEvalRunErrors, StartEvalRunResponse, StartEvalRunResponses, StartOrchestrationRunData, StartOrchestrationRunErrors, StartOrchestrationRunRequest, StartOrchestrationRunResponse, StartOrchestrationRunResponses, SubmitAgentToolOutputsData, SubmitAgentToolOutputsError, SubmitAgentToolOutputsErrors, SubmitAgentToolOutputsResponse, SubmitAgentToolOutputsResponses, SubmitHumanInputData, SubmitHumanInputErrors, SubmitHumanInputResponse, SubmitHumanInputResponses, SubmitSessionToolOutputsData, SubmitSessionToolOutputsError, SubmitSessionToolOutputsErrors, SubmitSessionToolOutputsRequest, SubmitSessionToolOutputsResponse, SubmitSessionToolOutputsResponses, SubmitToolOutputsRequest, TagBag, TagsQuery, Task, TaskTransition, Tool, ToolBinding, ToolExecuteAuthConfig, ToolExecuteConfig, ToolMcpConfig, ToolOutputMessageContent, ToolResourceProperties, ToolScorer, Trace, TraceTreeNode, TranscriptStep, TranscriptToolCall, TranscriptToolResult, TransitionTaskData, TransitionTaskErrors, TransitionTaskRequest, TransitionTaskResponse, TransitionTaskResponses, Trigger, TriggerFiring, TriggerFiringListResponse, TriggerResourceProperties, TriggerSecretResponse, TriggerWithSecret, UnauthorizedFormationAction, UpdateActorData, UpdateActorError, UpdateActorErrors, UpdateActorResponse, UpdateActorResponses, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateAiProviderData, UpdateAiProviderErrors, UpdateAiProviderPricesData, UpdateAiProviderPricesErrors, UpdateAiProviderPricesResponse, UpdateAiProviderPricesResponses, UpdateAiProviderResponses, UpdateApiKeyData, UpdateApiKeyError, UpdateApiKeyErrors, UpdateApiKeyResponse, UpdateApiKeyResponses, UpdateChannelData, UpdateChannelError, UpdateChannelErrors, UpdateChannelResponse, UpdateChannelResponses, UpdateChannelRouteData, UpdateChannelRouteError, UpdateChannelRouteErrors, UpdateChannelRouteResponse, UpdateChannelRouteResponses, UpdateConversationData, UpdateConversationError, UpdateConversationErrors, UpdateConversationResponse, UpdateConversationResponses, UpdateCurrentUserData, UpdateCurrentUserError, UpdateCurrentUserErrors, UpdateCurrentUserResponse, UpdateCurrentUserResponses, UpdateDatasetData, UpdateDatasetErrors, UpdateDatasetItemData, UpdateDatasetItemErrors, UpdateDatasetItemResponse, UpdateDatasetItemResponses, UpdateDatasetResponse, UpdateDatasetResponses, UpdateDocumentData, UpdateDocumentError, UpdateDocumentErrors, UpdateDocumentResponse, UpdateDocumentResponses, UpdateEvalData, UpdateEvalErrors, UpdateEvalResponse, UpdateEvalResponses, UpdateFileMetadataData, UpdateFileMetadataError, UpdateFileMetadataErrors, UpdateFileMetadataResponse, UpdateFileMetadataResponses, UpdateFormationData, UpdateFormationErrors, UpdateFormationResponse, UpdateFormationResponses, UpdateGenerationData, UpdateGenerationError, UpdateGenerationErrors, UpdateGenerationRequest, UpdateGenerationResponse, UpdateGenerationResponses, UpdateGuardrailData, UpdateGuardrailError, UpdateGuardrailErrors, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateGuardrailResponses, UpdateIngestionRuleData, UpdateIngestionRuleErrors, UpdateIngestionRuleResponse, UpdateIngestionRuleResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponse, UpdateMemoryResponses, UpdateMemoryRuleData, UpdateMemoryRuleErrors, UpdateMemoryRuleResponse, UpdateMemoryRuleResponses, UpdateMemoryStoreData, UpdateMemoryStoreErrors, UpdateMemoryStoreResponse, UpdateMemoryStoreResponses, UpdateModelRouteData, UpdateModelRouteErrors, UpdateModelRouteResponse, UpdateModelRouteResponses, UpdateOrchestrationData, UpdateOrchestrationErrors, UpdateOrchestrationRequest, UpdateOrchestrationResponse, UpdateOrchestrationResponses, UpdateProjectData, UpdateProjectError, UpdateProjectErrors, UpdateProjectMemberData, UpdateProjectMemberError, UpdateProjectMemberErrors, UpdateProjectMemberResponse, UpdateProjectMemberResponses, UpdateProjectResponse, UpdateProjectResponses, UpdateQuotaData, UpdateQuotaErrors, UpdateQuotaResponse, UpdateQuotaResponses, UpdateSecretData, UpdateSecretErrors, UpdateSecretResponses, UpdateSessionData, UpdateSessionError, UpdateSessionErrors, UpdateSessionRequest, UpdateSessionResponse, UpdateSessionResponses, UpdateTaskData, UpdateTaskErrors, UpdateTaskRequest, UpdateTaskResponse, UpdateTaskResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolRequest, UpdateToolResponse, UpdateToolResponses, UpdateTriggerData, UpdateTriggerErrors, UpdateTriggerRequest, UpdateTriggerResponse, UpdateTriggerResponses, UpdateUserRolesData, UpdateUserRolesError, UpdateUserRolesErrors, UpdateUserRolesResponse, UpdateUserRolesResponses, UpdateWebhookData, UpdateWebhookError, UpdateWebhookErrors, UpdateWebhookResponse, UpdateWebhookResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowRequest, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadFileBase64Data, UploadFileBase64Error, UploadFileBase64Errors, UploadFileBase64Request, UploadFileBase64Response, UploadFileBase64Responses, UploadFileData, UploadFileError, UploadFileErrors, UploadFileResponse, UploadFileResponses, UpsertProviderPricesRequest, UsageActionId, UsageActorId, UsageAgentId, UsageAiProviderId, UsageComponent, UsageComponents, UsageEventComponent, UsageGenerationId, UsageGroup, UsageMeterType, UsageOrchestrationId, UsageOrchestrationRunId, UsageSessionId, UsageSource, UsageThreshold, UsageThresholdCreate, UsageTokens, UsageTotals, UsageTraceId, UsageTriggerId, User, UserBilling, UserPlanGrant, UserRolesUpdate, UserUpdate, UserUsage, ValidateFormationData, ValidateFormationErrors, ValidateFormationResponse, ValidateFormationResponses, ValidateOrchestrationData, ValidateOrchestrationErrors, ValidateOrchestrationRequest, ValidateOrchestrationResponse, ValidateOrchestrationResponses, ValidationError, ValidationResult, VerifySignInCodeData, VerifySignInCodeError, VerifySignInCodeErrors, VerifySignInCodeResponse, VerifySignInCodeResponses, Webhook, WebhookCreate, WebhookDelivery, WebhookDeliveryList, WebhookId, WebhookList, WebhookUpdate, WebhookWithSecret, Workflow, WorkflowResourceProperties, WorkflowState, WorkflowTransition, WorkflowVersion };
24689
+ export type { AbortAgentReleaseData, AbortAgentReleaseError, AbortAgentReleaseErrors, AbortAgentReleaseResponse, AbortAgentReleaseResponses, AcceptedGenerationResponse, AcknowledgeExceptionData, AcknowledgeExceptionErrors, AcknowledgeExceptionResponse, AcknowledgeExceptionResponses, Acknowledgement, ActivityEntry, ActorRecord, ActorResourceProperties, AddConversationMessageData, AddConversationMessageError, AddConversationMessageErrors, AddConversationMessageResponse, AddConversationMessageResponses, AddProjectMemberData, AddProjectMemberError, AddProjectMemberErrors, AddProjectMemberResponse, AddProjectMemberResponses, AddSessionMessageData, AddSessionMessageError, AddSessionMessageErrors, AddSessionMessageRequest, AddSessionMessageResponse, AddSessionMessageResponse2, AddSessionMessageResponses, AddSessionMessageSaved, Address, AddressActionSet, AddressList, AdminUser, AdminUserPage, Agent, AgentBoundaryPolicy, AgentBoundaryPolicyStatement, AgentGenerationResponse, AgentRelease, AgentResourceProperties, AgentStepRule, AgentStopCondition, AgentVersion, AggregateScores, AiProviderResourceProperties, ApiKeyCreate, ApiKeyCreated, ApiKeyId, ApiKeyList, ApiKeyRecord, ApiKeyUpdate, ApprovalId, ApprovalItem, ApprovalRecurrenceGroup, ApproveApprovalData, ApproveApprovalErrors, ApproveApprovalResponse, ApproveApprovalResponses, AssistantChannel, AssistantGrant, AssistantGrantList, AssistantLinkPreview, AssistantLinkRedeem, AssistantScope, AuditEntry, AuthSession, BaselineComparison, CallToolData, CallToolError, CallToolErrors, CallToolRequest, CallToolResponses, CancelEvalRunData, CancelEvalRunErrors, CancelEvalRunResponse, CancelEvalRunResponses, CancelOrchestrationRunData, CancelOrchestrationRunErrors, CancelOrchestrationRunResponse, CancelOrchestrationRunResponses, Chain, ChainId, Channel, ChannelCreate, ChannelDefaultAction, ChannelDefaultActionInput, ChannelId, ChannelKind, ChannelKindList, ChannelList, ChannelPredicate, ChannelRoute, ChannelRouteList, ChannelRouteWrite, ChannelSurface, ChannelUpdate, ClientOptions, ContainsScorer, Conversation, ConversationId, ConversationList, ConversationMessage, ConversationMessageList, ConversationMessageRecord, ConversationRecord, ConversationResourceProperties, CreateActorData, CreateActorError, CreateActorErrors, CreateActorResponse, CreateActorResponses, CreateAgentData, CreateAgentError, CreateAgentErrors, CreateAgentGenerationData, CreateAgentGenerationError, CreateAgentGenerationErrors, CreateAgentGenerationRequest, CreateAgentGenerationResponse, CreateAgentGenerationResponses, CreateAgentRequest, CreateAgentResponse, CreateAgentResponses, CreateAiProviderData, CreateAiProviderErrors, CreateAiProviderResponse, CreateAiProviderResponses, CreateApiKeyData, CreateApiKeyError, CreateApiKeyErrors, CreateApiKeyResponse, CreateApiKeyResponses, CreateChannelData, CreateChannelError, CreateChannelErrors, CreateChannelResponse, CreateChannelResponses, CreateChannelRouteData, CreateChannelRouteError, CreateChannelRouteErrors, CreateChannelRouteResponse, CreateChannelRouteResponses, CreateConversationData, CreateConversationError, CreateConversationErrors, CreateConversationResponse, CreateConversationResponses, CreateDatasetData, CreateDatasetErrors, CreateDatasetItemData, CreateDatasetItemErrors, CreateDatasetItemFromGenerationData, CreateDatasetItemFromGenerationErrors, CreateDatasetItemFromGenerationResponse, CreateDatasetItemFromGenerationResponses, CreateDatasetItemResponse, CreateDatasetItemResponses, CreateDatasetResponse, CreateDatasetResponses, CreateDocumentData, CreateDocumentError, CreateDocumentErrors, CreateDocumentRelationData, CreateDocumentRelationErrors, CreateDocumentRelationResponse, CreateDocumentRelationResponses, CreateDocumentResponse, CreateDocumentResponses, CreateEmbeddingsData, CreateEmbeddingsError, CreateEmbeddingsErrors, CreateEmbeddingsResponse, CreateEmbeddingsResponses, CreateEvalData, CreateEvalErrors, CreateEvalResponse, CreateEvalResponses, CreateFileData, CreateFileError, CreateFileErrors, CreateFileResponse, CreateFileResponses, CreateFormationData, CreateFormationErrors, CreateFormationResponse, CreateFormationResponses, CreateGuardrailData, CreateGuardrailError, CreateGuardrailErrors, CreateGuardrailRequest, CreateGuardrailResponse, CreateGuardrailResponses, CreateIngestionRuleData, CreateIngestionRuleErrors, CreateIngestionRuleResponse, CreateIngestionRuleResponses, CreateMemoryData, CreateMemoryErrors, CreateMemoryResponse, CreateMemoryResponses, CreateMemoryRuleData, CreateMemoryRuleErrors, CreateMemoryRuleResponse, CreateMemoryRuleResponses, CreateMemoryStoreData, CreateMemoryStoreErrors, CreateMemoryStoreResponse, CreateMemoryStoreResponses, CreateMetadataSchemaData, CreateMetadataSchemaError, CreateMetadataSchemaErrors, CreateMetadataSchemaResponse, CreateMetadataSchemaResponses, CreateModelRouteData, CreateModelRouteErrors, CreateModelRouteResponse, CreateModelRouteResponses, CreateOrchestrationData, CreateOrchestrationErrors, CreateOrchestrationRequest, CreateOrchestrationResponse, CreateOrchestrationResponses, CreateProjectData, CreateProjectError, CreateProjectErrors, CreateProjectResponse, CreateProjectResponses, CreateProjectUsageThresholdData, CreateProjectUsageThresholdError, CreateProjectUsageThresholdErrors, CreateProjectUsageThresholdResponse, CreateProjectUsageThresholdResponses, CreateQuotaData, CreateQuotaErrors, CreateQuotaResponse, CreateQuotaResponses, CreateSecretData, CreateSecretErrors, CreateSecretResponse, CreateSecretResponses, CreateSessionData, CreateSessionError, CreateSessionErrors, CreateSessionRequest, CreateSessionResponse, CreateSessionResponses, CreateTaskData, CreateTaskErrors, CreateTaskRequest, CreateTaskResponse, CreateTaskResponses, CreateToolData, CreateToolError, CreateToolErrors, CreateToolRequest, CreateToolResponse, CreateToolResponses, CreateTriggerData, CreateTriggerErrors, CreateTriggerRequest, CreateTriggerResponse, CreateTriggerResponses, CreateWebhookData, CreateWebhookError, CreateWebhookErrors, CreateWebhookResponse, CreateWebhookResponses, CreateWorkflowData, CreateWorkflowErrors, CreateWorkflowRequest, CreateWorkflowResponse, CreateWorkflowResponses, CreditEntry, CreditEntryPage, CreditGrant, CreditGrantResult, Cursor, Dataset, DatasetItem, DatasetItemInput, DatasetItemResourceProperties, DatasetResourceProperties, DeleteActorData, DeleteActorError, DeleteActorErrors, DeleteActorResponse, DeleteActorResponses, DeleteAddressData, DeleteAddressError, DeleteAddressErrors, DeleteAddressResponse, DeleteAddressResponses, DeleteAgentData, DeleteAgentError, DeleteAgentErrors, DeleteAgentResponse, DeleteAgentResponses, DeleteAiProviderData, DeleteAiProviderErrors, DeleteAiProviderResponse, DeleteAiProviderResponses, DeleteApiKeyData, DeleteApiKeyError, DeleteApiKeyErrors, DeleteApiKeyResponse, DeleteApiKeyResponses, DeleteChannelData, DeleteChannelError, DeleteChannelErrors, DeleteChannelResponse, DeleteChannelResponses, DeleteChannelRouteData, DeleteChannelRouteError, DeleteChannelRouteErrors, DeleteChannelRouteResponse, DeleteChannelRouteResponses, DeleteConversationData, DeleteConversationError, DeleteConversationErrors, DeleteConversationResponse, DeleteConversationResponses, DeleteDatasetData, DeleteDatasetErrors, DeleteDatasetItemData, DeleteDatasetItemErrors, DeleteDatasetItemResponse, DeleteDatasetItemResponses, DeleteDatasetResponse, DeleteDatasetResponses, DeleteDocumentData, DeleteDocumentError, DeleteDocumentErrors, DeleteDocumentRelationData, DeleteDocumentRelationErrors, DeleteDocumentRelationResponse, DeleteDocumentRelationResponses, DeleteDocumentResponse, DeleteDocumentResponses, DeleteEvalData, DeleteEvalErrors, DeleteEvalResponse, DeleteEvalResponses, DeleteFileData, DeleteFileError, DeleteFileErrors, DeleteFileResponse, DeleteFileResponses, DeleteFormationData, DeleteFormationErrors, DeleteFormationResponse, DeleteFormationResponses, DeleteGuardrailData, DeleteGuardrailError, DeleteGuardrailErrors, DeleteGuardrailResponse, DeleteGuardrailResponses, DeleteIngestionRuleData, DeleteIngestionRuleErrors, DeleteIngestionRuleResponse, DeleteIngestionRuleResponses, DeleteMemoryData, DeleteMemoryErrors, DeleteMemoryResponse, DeleteMemoryResponses, DeleteMemoryRuleData, DeleteMemoryRuleErrors, DeleteMemoryRuleResponse, DeleteMemoryRuleResponses, DeleteMemoryStoreData, DeleteMemoryStoreErrors, DeleteMemoryStoreResponse, DeleteMemoryStoreResponses, DeleteMetadataSchemaData, DeleteMetadataSchemaError, DeleteMetadataSchemaErrors, DeleteMetadataSchemaResponse, DeleteMetadataSchemaResponses, DeleteModelRouteData, DeleteModelRouteErrors, DeleteModelRouteResponse, DeleteModelRouteResponses, DeleteOrchestrationData, DeleteOrchestrationErrors, DeleteOrchestrationResponse, DeleteOrchestrationResponses, DeleteProjectData, DeleteProjectError, DeleteProjectErrors, DeleteProjectResponse, DeleteProjectResponses, DeleteProjectUsageThresholdData, DeleteProjectUsageThresholdError, DeleteProjectUsageThresholdErrors, DeleteProjectUsageThresholdResponse, DeleteProjectUsageThresholdResponses, DeleteQuotaData, DeleteQuotaErrors, DeleteQuotaResponse, DeleteQuotaResponses, DeleteSecretData, DeleteSecretErrors, DeleteSecretResponses, DeleteSessionData, DeleteSessionError, DeleteSessionErrors, DeleteSessionResponse, DeleteSessionResponses, DeleteTaskData, DeleteTaskErrors, DeleteTaskResponse, DeleteTaskResponses, DeleteToolData, DeleteToolError, DeleteToolErrors, DeleteToolResponse, DeleteToolResponses, DeleteTriggerData, DeleteTriggerErrors, DeleteTriggerResponse, DeleteTriggerResponses, DeleteWebhookData, DeleteWebhookError, DeleteWebhookErrors, DeleteWebhookResponse, DeleteWebhookResponses, DeleteWorkflowData, DeleteWorkflowErrors, DeleteWorkflowResponse, DeleteWorkflowResponses, DeliveryId, DiscordModes, DocumentKnowledgeResult, DocumentMessageContent, DocumentRecord, DocumentRelation, DocumentResourceProperties, DocumentStatusRecord, DocumentVersion, DownloadFileBase64Data, DownloadFileBase64Error, DownloadFileBase64Errors, DownloadFileBase64Response, DownloadFileBase64Responses, DownloadFileData, DownloadFileError, DownloadFileErrors, DownloadFileResponse, DownloadFileResponses, EmbeddingSimilarityScorer, EmbeddingsResponse, ErrorResponse, Eval, EvalResourceProperties, EvalResult, EvalRun, EvaluateGuardrailData, EvaluateGuardrailError, EvaluateGuardrailErrors, EvaluateGuardrailResponse, EvaluateGuardrailResponses, Event, EventSubscription, EventType, ExactMatchScorer, ExceptionId, ExceptionItem, ExpectedVersion, ExportActivityData, ExportActivityErrors, ExportActivityResponse, ExportActivityResponses, ExportAuditEntriesData, ExportAuditEntriesErrors, ExportAuditEntriesResponse, ExportAuditEntriesResponses, ExportDocumentsData, ExportDocumentsErrors, ExportDocumentsResponse, ExportDocumentsResponses, ExportMemoriesData, ExportMemoriesErrors, ExportMemoriesResponse, ExportMemoriesResponses, FileRecord, FileRecordWritable, FileResourceProperties, FireTriggerData, FireTriggerErrors, FireTriggerRequest, FireTriggerResponse, FireTriggerResponses, Force, ForkSessionData, ForkSessionError, ForkSessionErrors, ForkSessionRequest, ForkSessionResponse, ForkSessionResponses, Formation, FormationError, FormationEvent, FormationOperation, FormationResource, FormationTemplate, FormationTemplateInput, GenerateConversationMessageCompleted, GenerateConversationMessageData, GenerateConversationMessageError, GenerateConversationMessageErrors, GenerateConversationMessageRequiresAction, GenerateConversationMessageResponse, GenerateConversationMessageResponse2, GenerateConversationMessageResponses, GenerateSessionRequest, GenerateSessionResponse, GenerateSessionResponseData, GenerateSessionResponseError, GenerateSessionResponseErrors, GenerateSessionResponseResponse, GenerateSessionResponseResponses, Generation, GenerationTranscript, GetActorData, GetActorError, GetActorErrors, GetActorResponse, GetActorResponses, GetActorTagsData, GetActorTagsError, GetActorTagsErrors, GetActorTagsResponse, GetActorTagsResponses, GetAddressData, GetAddressError, GetAddressErrors, GetAddressResponse, GetAddressResponses, GetAdminPriceBookData, GetAdminPriceBookError, GetAdminPriceBookErrors, GetAdminPriceBookResponse, GetAdminPriceBookResponses, GetAgentData, GetAgentError, GetAgentErrors, GetAgentResponse, GetAgentResponses, GetAgentVersionData, GetAgentVersionError, GetAgentVersionErrors, GetAgentVersionResponse, GetAgentVersionResponses, GetAiProviderData, GetAiProviderErrors, GetAiProviderPricesData, GetAiProviderPricesErrors, GetAiProviderPricesResponse, GetAiProviderPricesResponses, GetAiProviderResponse, GetAiProviderResponses, GetApiKeyData, GetApiKeyError, GetApiKeyErrors, GetApiKeyResponse, GetApiKeyResponses, GetApprovalData, GetApprovalErrors, GetApprovalResponse, GetApprovalResponses, GetAuditEntryData, GetAuditEntryErrors, GetAuditEntryResponse, GetAuditEntryResponses, GetChainData, GetChainErrors, GetChainResponse, GetChainResponses, GetChannelConversationData, GetChannelConversationError, GetChannelConversationErrors, GetChannelConversationResponse, GetChannelConversationResponses, GetChannelData, GetChannelError, GetChannelErrors, GetChannelResponse, GetChannelResponses, GetChannelRouteData, GetChannelRouteError, GetChannelRouteErrors, GetChannelRouteResponse, GetChannelRouteResponses, GetConversationData, GetConversationError, GetConversationErrors, GetConversationResponse, GetConversationResponses, GetConversationTagsData, GetConversationTagsError, GetConversationTagsErrors, GetConversationTagsResponse, GetConversationTagsResponses, GetCurrentUserBillingData, GetCurrentUserBillingError, GetCurrentUserBillingErrors, GetCurrentUserBillingResponse, GetCurrentUserBillingResponses, GetCurrentUserData, GetCurrentUserError, GetCurrentUserErrors, GetCurrentUserResponse, GetCurrentUserResponses, GetCurrentUserUsageData, GetCurrentUserUsageError, GetCurrentUserUsageErrors, GetCurrentUserUsageResponse, GetCurrentUserUsageResponses, GetDatasetData, GetDatasetErrors, GetDatasetResponse, GetDatasetResponses, GetDocumentData, GetDocumentError, GetDocumentErrors, GetDocumentResponse, GetDocumentResponses, GetDocumentStatusData, GetDocumentStatusError, GetDocumentStatusErrors, GetDocumentStatusResponse, GetDocumentStatusResponses, GetDocumentTagsData, GetDocumentTagsError, GetDocumentTagsErrors, GetDocumentTagsResponse, GetDocumentTagsResponses, GetDocumentVersionData, GetDocumentVersionError, GetDocumentVersionErrors, GetDocumentVersionResponse, GetDocumentVersionResponses, GetEvalData, GetEvalErrors, GetEvalResponse, GetEvalResponses, GetEvalRunData, GetEvalRunErrors, GetEvalRunResponse, GetEvalRunResponses, GetExceptionData, GetExceptionErrors, GetExceptionResponse, GetExceptionResponses, GetFileData, GetFileError, GetFileErrors, GetFileResponse, GetFileResponses, GetFileTagsData, GetFileTagsError, GetFileTagsErrors, GetFileTagsResponse, GetFileTagsResponses, GetFormationData, GetFormationErrors, GetFormationResponse, GetFormationResponses, GetGenerationData, GetGenerationError, GetGenerationErrors, GetGenerationResponse, GetGenerationResponses, GetGenerationTranscriptData, GetGenerationTranscriptError, GetGenerationTranscriptErrors, GetGenerationTranscriptResponse, GetGenerationTranscriptResponses, GetGuardrailData, GetGuardrailError, GetGuardrailErrors, GetGuardrailResponse, GetGuardrailResponses, GetGuardrailVersionData, GetGuardrailVersionError, GetGuardrailVersionErrors, GetGuardrailVersionResponse, GetGuardrailVersionResponses, GetIngestionRuleData, GetIngestionRuleErrors, GetIngestionRuleResponse, GetIngestionRuleResponses, GetMemoryData, GetMemoryErrors, GetMemoryResponse, GetMemoryResponses, GetMemoryRuleData, GetMemoryRuleErrors, GetMemoryRuleResponse, GetMemoryRuleResponses, GetMemoryStoreData, GetMemoryStoreErrors, GetMemoryStoreResponse, GetMemoryStoreResponses, GetMemoryStoreTagsData, GetMemoryStoreTagsErrors, GetMemoryStoreTagsResponse, GetMemoryStoreTagsResponses, GetMemoryTagsData, GetMemoryTagsErrors, GetMemoryTagsResponse, GetMemoryTagsResponses, GetMetadataSchemaData, GetMetadataSchemaError, GetMetadataSchemaErrors, GetMetadataSchemaResponse, GetMetadataSchemaResponses, GetModelData, GetModelError, GetModelErrors, GetModelResponse, GetModelResponses, GetModelRouteData, GetModelRouteErrors, GetModelRouteResponse, GetModelRouteResponses, GetOrchestrationData, GetOrchestrationErrors, GetOrchestrationResponse, GetOrchestrationResponses, GetOrchestrationRunData, GetOrchestrationRunErrors, GetOrchestrationRunResponse, GetOrchestrationRunResponses, GetOrchestrationVersionData, GetOrchestrationVersionErrors, GetOrchestrationVersionResponse, GetOrchestrationVersionResponses, GetProjectData, GetProjectError, GetProjectErrors, GetProjectResponse, GetProjectResponses, GetProjectUsageData, GetProjectUsageError, GetProjectUsageErrors, GetProjectUsageReceiptData, GetProjectUsageReceiptError, GetProjectUsageReceiptErrors, GetProjectUsageReceiptResponse, GetProjectUsageReceiptResponses, GetProjectUsageResponse, GetProjectUsageResponses, GetQueueStatsData, GetQueueStatsErrors, GetQueueStatsResponse, GetQueueStatsResponses, GetQuotaData, GetQuotaErrors, GetQuotaResponse, GetQuotaResponses, GetSecretData, GetSecretErrors, GetSecretResponse, GetSecretResponses, GetSessionData, GetSessionError, GetSessionErrors, GetSessionResponse, GetSessionResponses, GetSessionTagsData, GetSessionTagsError, GetSessionTagsErrors, GetSessionTagsResponse, GetSessionTagsResponses, GetTaskData, GetTaskErrors, GetTaskHistoryData, GetTaskHistoryErrors, GetTaskHistoryResponse, GetTaskHistoryResponses, GetTaskResponse, GetTaskResponses, GetToolData, GetToolError, GetToolErrors, GetToolResponse, GetToolResponses, GetTraceData, GetTraceError, GetTraceErrors, GetTraceResponse, GetTraceResponses, GetTraceTreeData, GetTraceTreeError, GetTraceTreeErrors, GetTraceTreeResponse, GetTraceTreeResponses, GetTriggerData, GetTriggerErrors, GetTriggerFiringData, GetTriggerFiringErrors, GetTriggerFiringResponse, GetTriggerFiringResponses, GetTriggerResponse, GetTriggerResponses, GetTriggerSecretData, GetTriggerSecretErrors, GetTriggerSecretResponse, GetTriggerSecretResponses, GetWebhookData, GetWebhookDeliveryData, GetWebhookDeliveryError, GetWebhookDeliveryErrors, GetWebhookDeliveryResponse, GetWebhookDeliveryResponses, GetWebhookError, GetWebhookErrors, GetWebhookResponse, GetWebhookResponses, GetWorkflowData, GetWorkflowErrors, GetWorkflowResponse, GetWorkflowResponses, GetWorkflowVersionData, GetWorkflowVersionErrors, GetWorkflowVersionResponse, GetWorkflowVersionResponses, GrantId, GrantUserCreditData, GrantUserCreditError, GrantUserCreditErrors, GrantUserCreditResponse, GrantUserCreditResponses, GrantUserPlanData, GrantUserPlanError, GrantUserPlanErrors, GrantUserPlanResponse, GrantUserPlanResponses, GrantableProjectRole, Guardrail, GuardrailDocument, GuardrailEvaluation, GuardrailResourceProperties, GuardrailVersion, HumanInputRequest, Identifier, IfMatchVersion, IngestDocumentData, IngestDocumentError, IngestDocumentErrors, IngestDocumentResponse, IngestDocumentResponses, IngestedDocumentRecord, IngestionRule, IngestionRuleResourceProperties, JsonLogicScorer, KnowledgeResult, Limit, LinkToken, ListActivityData, ListActivityErrors, ListActivityResponse, ListActivityResponses, ListActorsData, ListActorsError, ListActorsErrors, ListActorsResponse, ListActorsResponses, ListAddressConversationsData, ListAddressConversationsError, ListAddressConversationsErrors, ListAddressConversationsResponse, ListAddressConversationsResponses, ListAddressesData, ListAddressesError, ListAddressesErrors, ListAddressesResponse, ListAddressesResponses, ListAgentVersionsData, ListAgentVersionsError, ListAgentVersionsErrors, ListAgentVersionsResponse, ListAgentVersionsResponses, ListAgentsData, ListAgentsError, ListAgentsErrors, ListAgentsResponse, ListAgentsResponses, ListAiProviderModelsData, ListAiProviderModelsErrors, ListAiProviderModelsResponse, ListAiProviderModelsResponses, ListAiProvidersData, ListAiProvidersErrors, ListAiProvidersResponse, ListAiProvidersResponses, ListApiKeysData, ListApiKeysError, ListApiKeysErrors, ListApiKeysResponse, ListApiKeysResponses, ListApprovalRecurrencesData, ListApprovalRecurrencesErrors, ListApprovalRecurrencesResponse, ListApprovalRecurrencesResponses, ListApprovalsData, ListApprovalsErrors, ListApprovalsResponse, ListApprovalsResponses, ListAssistantGrantsData, ListAssistantGrantsError, ListAssistantGrantsErrors, ListAssistantGrantsResponse, ListAssistantGrantsResponses, ListAuditEntriesData, ListAuditEntriesErrors, ListAuditEntriesResponse, ListAuditEntriesResponses, ListChainsData, ListChainsErrors, ListChainsResponse, ListChainsResponses, ListChannelConversationMessagesData, ListChannelConversationMessagesError, ListChannelConversationMessagesErrors, ListChannelConversationMessagesResponse, ListChannelConversationMessagesResponses, ListChannelConversationsData, ListChannelConversationsError, ListChannelConversationsErrors, ListChannelConversationsResponse, ListChannelConversationsResponses, ListChannelKindsData, ListChannelKindsError, ListChannelKindsErrors, ListChannelKindsResponse, ListChannelKindsResponses, ListChannelRoutesData, ListChannelRoutesError, ListChannelRoutesErrors, ListChannelRoutesResponse, ListChannelRoutesResponses, ListChannelsData, ListChannelsError, ListChannelsErrors, ListChannelsResponse, ListChannelsResponses, ListConversationMessagesData, ListConversationMessagesError, ListConversationMessagesErrors, ListConversationMessagesResponse, ListConversationMessagesResponses, ListConversationsData, ListConversationsError, ListConversationsErrors, ListConversationsResponse, ListConversationsResponses, ListDatasetItemsData, ListDatasetItemsErrors, ListDatasetItemsResponse, ListDatasetItemsResponses, ListDatasetsData, ListDatasetsErrors, ListDatasetsResponse, ListDatasetsResponses, ListDocumentRelationsData, ListDocumentRelationsErrors, ListDocumentRelationsResponse, ListDocumentRelationsResponses, ListDocumentVersionsData, ListDocumentVersionsError, ListDocumentVersionsErrors, ListDocumentVersionsResponse, ListDocumentVersionsResponses, ListDocumentsData, ListDocumentsError, ListDocumentsErrors, ListDocumentsResponse, ListDocumentsResponses, ListEvalResultsData, ListEvalResultsErrors, ListEvalResultsResponse, ListEvalResultsResponses, ListEvalRunsData, ListEvalRunsErrors, ListEvalRunsResponse, ListEvalRunsResponses, ListEvalsData, ListEvalsErrors, ListEvalsResponse, ListEvalsResponses, ListExceptionsData, ListExceptionsErrors, ListExceptionsResponse, ListExceptionsResponses, ListFilesData, ListFilesError, ListFilesErrors, ListFilesResponse, ListFilesResponses, ListFormationEventsData, ListFormationEventsErrors, ListFormationEventsResponse, ListFormationEventsResponses, ListFormationsData, ListFormationsErrors, ListFormationsResponse, ListFormationsResponses, ListGenerationsData, ListGenerationsError, ListGenerationsErrors, ListGenerationsResponse, ListGenerationsResponses, ListGuardrailVersionsData, ListGuardrailVersionsError, ListGuardrailVersionsErrors, ListGuardrailVersionsResponse, ListGuardrailVersionsResponses, ListGuardrailsData, ListGuardrailsError, ListGuardrailsErrors, ListGuardrailsResponse, ListGuardrailsResponses, ListIngestionRulesData, ListIngestionRulesErrors, ListIngestionRulesResponse, ListIngestionRulesResponses, ListMemoriesData, ListMemoriesErrors, ListMemoriesResponse, ListMemoriesResponses, ListMemoryAssertionsData, ListMemoryAssertionsErrors, ListMemoryAssertionsResponse, ListMemoryAssertionsResponses, ListMemoryRulesData, ListMemoryRulesErrors, ListMemoryRulesResponse, ListMemoryRulesResponses, ListMemoryStoreAssertionsData, ListMemoryStoreAssertionsErrors, ListMemoryStoreAssertionsResponse, ListMemoryStoreAssertionsResponses, ListMemoryStoresData, ListMemoryStoresErrors, ListMemoryStoresResponse, ListMemoryStoresResponses, ListMetadataSchemasData, ListMetadataSchemasError, ListMetadataSchemasErrors, ListMetadataSchemasResponse, ListMetadataSchemasResponses, ListModelRoutesData, ListModelRoutesErrors, ListModelRoutesResponse, ListModelRoutesResponses, ListModelsData, ListModelsError, ListModelsErrors, ListModelsResponse, ListModelsResponses, ListOrchestrationRunsData, ListOrchestrationRunsErrors, ListOrchestrationRunsResponse, ListOrchestrationRunsResponses, ListOrchestrationVersionsData, ListOrchestrationVersionsErrors, ListOrchestrationVersionsResponse, ListOrchestrationVersionsResponses, ListOrchestrationsData, ListOrchestrationsErrors, ListOrchestrationsResponse, ListOrchestrationsResponses, ListProjectChannelRoutesData, ListProjectChannelRoutesError, ListProjectChannelRoutesErrors, ListProjectChannelRoutesResponse, ListProjectChannelRoutesResponses, ListProjectMembersData, ListProjectMembersError, ListProjectMembersErrors, ListProjectMembersResponse, ListProjectMembersResponses, ListProjectUsageEventsData, ListProjectUsageEventsError, ListProjectUsageEventsErrors, ListProjectUsageEventsResponse, ListProjectUsageEventsResponses, ListProjectUsageThresholdsData, ListProjectUsageThresholdsError, ListProjectUsageThresholdsErrors, ListProjectUsageThresholdsResponse, ListProjectUsageThresholdsResponses, ListProjectsData, ListProjectsError, ListProjectsErrors, ListProjectsResponse, ListProjectsResponses, ListQuotasData, ListQuotasErrors, ListQuotasResponse, ListQuotasResponses, ListSecretsData, ListSecretsErrors, ListSecretsResponse, ListSecretsResponses, ListSessionForksData, ListSessionForksError, ListSessionForksErrors, ListSessionForksResponse, ListSessionForksResponses, ListSessionsData, ListSessionsError, ListSessionsErrors, ListSessionsResponse, ListSessionsResponses, ListTasksData, ListTasksErrors, ListTasksResponse, ListTasksResponses, ListToolsData, ListToolsError, ListToolsErrors, ListToolsResponse, ListToolsResponses, ListTracesData, ListTracesError, ListTracesErrors, ListTracesResponse, ListTracesResponses, ListTriggerFiringsData, ListTriggerFiringsErrors, ListTriggerFiringsResponse, ListTriggerFiringsResponses, ListTriggersData, ListTriggersErrors, ListTriggersResponse, ListTriggersResponses, ListUserCreditsData, ListUserCreditsError, ListUserCreditsErrors, ListUserCreditsResponse, ListUserCreditsResponses, ListUserPlanHistoryData, ListUserPlanHistoryError, ListUserPlanHistoryErrors, ListUserPlanHistoryResponse, ListUserPlanHistoryResponses, ListUsersData, ListUsersError, ListUsersErrors, ListUsersResponse, ListUsersResponses, ListWebhookDeliveriesData, ListWebhookDeliveriesError, ListWebhookDeliveriesErrors, ListWebhookDeliveriesResponse, ListWebhookDeliveriesResponses, ListWebhooksData, ListWebhooksError, ListWebhooksErrors, ListWebhooksResponse, ListWebhooksResponses, ListWorkflowVersionsData, ListWorkflowVersionsErrors, ListWorkflowVersionsResponse, ListWorkflowVersionsResponses, ListWorkflowsData, ListWorkflowsErrors, ListWorkflowsResponse, ListWorkflowsResponses, LlmJudgeScorer, LogoutData, LogoutError, LogoutErrors, LogoutRequest, LogoutResponse, LogoutResponses, Memory, MemoryAssertion, MemoryKnowledgeResult, MemoryResourceProperties, MemoryRule, MemoryRuleEvent, MemoryRuleResourceProperties, MemoryStore, MemoryStoreResourceProperties, MemoryWriteResult, MergeActorTagsData, MergeActorTagsError, MergeActorTagsErrors, MergeActorTagsResponse, MergeActorTagsResponses, MergeConversationTagsData, MergeConversationTagsError, MergeConversationTagsErrors, MergeConversationTagsResponse, MergeConversationTagsResponses, MergeDocumentTagsData, MergeDocumentTagsError, MergeDocumentTagsErrors, MergeDocumentTagsResponse, MergeDocumentTagsResponses, MergeFileTagsData, MergeFileTagsError, MergeFileTagsErrors, MergeFileTagsResponse, MergeFileTagsResponses, MergeMemoryStoreTagsData, MergeMemoryStoreTagsErrors, MergeMemoryStoreTagsResponse, MergeMemoryStoreTagsResponses, MergeMemoryTagsData, MergeMemoryTagsErrors, MergeMemoryTagsResponse, MergeMemoryTagsResponses, MergeSessionTagsData, MergeSessionTagsError, MergeSessionTagsErrors, MergeSessionTagsResponse, MergeSessionTagsResponses, MessagesLimit, MetadataBag, MetadataBagText, MetadataFilter, MetadataQuery, MetadataSchemaRecord, MetadataSchemaResourceProperties, Model, ModelList, ModelName, ModelRoute, ModelRouteResourceProperties, ModelRouteTarget, NaturaliClientOptions, NodeExecution, NullableMetadataBag, NullableTagBag, Offset, OpenChannelConversationData, OpenChannelConversationError, OpenChannelConversationErrors, OpenChannelConversationResponse, OpenChannelConversationResponses, Options, Orchestration, OrchestrationEdge, OrchestrationId, OrchestrationNode, OrchestrationResourceProperties, OrchestrationRun, OrchestrationRunId, OrchestrationValidationError, OrchestrationValidationResult, OrchestrationVersion, OutputSchemaScorer, ParameterDeclaration, PatchAgentData, PatchAgentError, PatchAgentErrors, PatchAgentResponse, PatchAgentResponses, PauseOrchestrationRunData, PauseOrchestrationRunErrors, PauseOrchestrationRunRequest, PauseOrchestrationRunResponse, PauseOrchestrationRunResponses, PauseTaskData, PauseTaskErrors, PauseTaskRequest, PauseTaskResponse, PauseTaskResponses, PlanChange, PlanEvent, PlanEventPage, PlanFormationData, PlanFormationErrors, PlanFormationResponse, PlanFormationResponses, PlanResult, PreviewAssistantLinkData, PreviewAssistantLinkError, PreviewAssistantLinkErrors, PreviewAssistantLinkResponse, PreviewAssistantLinkResponses, Price, PriceBook, Project, ProjectCreate, ProjectId, ProjectList, ProjectMember, ProjectMemberCreate, ProjectMemberList, ProjectMemberUpdate, ProjectRole, ProjectRuns, ProjectUpdate, ProjectUsage, ProjectUsageDistinct, ProjectUsageEvent, ProjectUsageEventPage, ProjectUsageFilters, ProjectUsageGroups, ProjectUsageReceipt, PromoteAgentReleaseData, PromoteAgentReleaseError, PromoteAgentReleaseErrors, PromoteAgentReleaseResponse, PromoteAgentReleaseResponses, ProviderModelsResponse, ProviderPrice, ProviderPricesResponse, PurgeGenerationContentData, PurgeGenerationContentError, PurgeGenerationContentErrors, PurgeGenerationContentResponse, PurgeGenerationContentResponses, PurgeTraceContentData, PurgeTraceContentError, PurgeTraceContentErrors, PurgeTraceContentResponse, PurgeTraceContentResponses, QueueStats, Quota, QuotaResourceProperties, RedeemAssistantLinkData, RedeemAssistantLinkError, RedeemAssistantLinkErrors, RedeemAssistantLinkResponse, RedeemAssistantLinkResponses, RedeliverWebhookDeliveryData, RedeliverWebhookDeliveryError, RedeliverWebhookDeliveryErrors, RedeliverWebhookDeliveryResponse, RedeliverWebhookDeliveryResponses, RefreshRequest, RefreshSessionData, RefreshSessionError, RefreshSessionErrors, RefreshSessionResponse, RefreshSessionResponses, ReingestDocumentData, ReingestDocumentError, ReingestDocumentErrors, ReingestDocumentResponse, ReingestDocumentResponses, RejectApprovalData, RejectApprovalErrors, RejectApprovalResponse, RejectApprovalResponses, RemoveConversationMessageData, RemoveConversationMessageError, RemoveConversationMessageErrors, RemoveConversationMessageResponse, RemoveConversationMessageResponses, RemoveProjectMemberData, RemoveProjectMemberError, RemoveProjectMemberErrors, RemoveProjectMemberResponse, RemoveProjectMemberResponses, ReplaceActorTagsData, ReplaceActorTagsError, ReplaceActorTagsErrors, ReplaceActorTagsResponse, ReplaceActorTagsResponses, ReplaceConversationTagsData, ReplaceConversationTagsError, ReplaceConversationTagsErrors, ReplaceConversationTagsResponse, ReplaceConversationTagsResponses, ReplaceDocumentTagsData, ReplaceDocumentTagsError, ReplaceDocumentTagsErrors, ReplaceDocumentTagsResponse, ReplaceDocumentTagsResponses, ReplaceFileTagsData, ReplaceFileTagsError, ReplaceFileTagsErrors, ReplaceFileTagsResponse, ReplaceFileTagsResponses, ReplaceMemoryStoreTagsData, ReplaceMemoryStoreTagsErrors, ReplaceMemoryStoreTagsResponse, ReplaceMemoryStoreTagsResponses, ReplaceMemoryTagsData, ReplaceMemoryTagsErrors, ReplaceMemoryTagsResponse, ReplaceMemoryTagsResponses, ReplaceSessionTagsData, ReplaceSessionTagsError, ReplaceSessionTagsErrors, ReplaceSessionTagsResponse, ReplaceSessionTagsResponses, RequestSignInCodeData, RequestSignInCodeError, RequestSignInCodeErrors, RequestSignInCodeResponse, RequestSignInCodeResponses, RequiredAction, ResolveExceptionData, ResolveExceptionErrors, ResolveExceptionResponse, ResolveExceptionResponses, ResourceDeclaration, RestoreAgentVersionData, RestoreAgentVersionError, RestoreAgentVersionErrors, RestoreAgentVersionRequest, RestoreAgentVersionResponse, RestoreAgentVersionResponses, RestoreDocumentVersionData, RestoreDocumentVersionError, RestoreDocumentVersionErrors, RestoreDocumentVersionResponse, RestoreDocumentVersionResponses, RestoreGuardrailVersionData, RestoreGuardrailVersionError, RestoreGuardrailVersionErrors, RestoreGuardrailVersionRequest, RestoreGuardrailVersionResponse, RestoreGuardrailVersionResponses, RestoreOrchestrationVersionData, RestoreOrchestrationVersionErrors, RestoreOrchestrationVersionRequest, RestoreOrchestrationVersionResponse, RestoreOrchestrationVersionResponses, RestoreWorkflowVersionData, RestoreWorkflowVersionErrors, RestoreWorkflowVersionRequest, RestoreWorkflowVersionResponse, RestoreWorkflowVersionResponses, ResumeOrchestrationRunData, ResumeOrchestrationRunErrors, ResumeOrchestrationRunResponse, ResumeOrchestrationRunResponses, ResumeTaskData, ResumeTaskErrors, ResumeTaskResponse, ResumeTaskResponses, RetractMemoryData, RetractMemoryErrors, RetractMemoryResponse, RetractMemoryResponses, RevokeAssistantGrantData, RevokeAssistantGrantError, RevokeAssistantGrantErrors, RevokeAssistantGrantResponse, RevokeAssistantGrantResponses, RotateApiKeyData, RotateApiKeyError, RotateApiKeyErrors, RotateApiKeyResponse, RotateApiKeyResponses, RotateTriggerSecretData, RotateTriggerSecretErrors, RotateTriggerSecretResponse, RotateTriggerSecretResponses, RotateWebhookSecretData, RotateWebhookSecretError, RotateWebhookSecretErrors, RotateWebhookSecretResponse, RotateWebhookSecretResponses, RouteId, ScorerResult, Scorers, SearchKnowledgeData, SearchKnowledgeError, SearchKnowledgeErrors, SearchKnowledgeResponse, SearchKnowledgeResponses, SecretResourceProperties, SendSessionMessageResponse, SessionId, SessionRecord, SessionResourceProperties, SetAddressActionData, SetAddressActionError, SetAddressActionErrors, SetAddressActionResponse, SetAddressActionResponses, SetAgentReleaseData, SetAgentReleaseError, SetAgentReleaseErrors, SetAgentReleaseRequest, SetAgentReleaseResponse, SetAgentReleaseResponses, SignInCodeRequest, SignInCodeVerify, StartEvalRunData, StartEvalRunErrors, StartEvalRunResponse, StartEvalRunResponses, StartOrchestrationRunData, StartOrchestrationRunErrors, StartOrchestrationRunRequest, StartOrchestrationRunResponse, StartOrchestrationRunResponses, SubmitAgentToolOutputsData, SubmitAgentToolOutputsError, SubmitAgentToolOutputsErrors, SubmitAgentToolOutputsResponse, SubmitAgentToolOutputsResponses, SubmitHumanInputData, SubmitHumanInputErrors, SubmitHumanInputResponse, SubmitHumanInputResponses, SubmitSessionToolOutputsData, SubmitSessionToolOutputsError, SubmitSessionToolOutputsErrors, SubmitSessionToolOutputsRequest, SubmitSessionToolOutputsResponse, SubmitSessionToolOutputsResponses, SubmitToolOutputsRequest, TagBag, TagsQuery, Task, TaskTransition, Tool, ToolBinding, ToolExecuteAuthConfig, ToolExecuteConfig, ToolMcpConfig, ToolOutputMessageContent, ToolResourceProperties, ToolScorer, Trace, TraceTreeNode, TranscriptStep, TranscriptToolCall, TranscriptToolResult, TransitionTaskData, TransitionTaskErrors, TransitionTaskRequest, TransitionTaskResponse, TransitionTaskResponses, Trigger, TriggerFiring, TriggerFiringListResponse, TriggerResourceProperties, TriggerSecretResponse, TriggerWithSecret, UnauthorizedFormationAction, UpdateActorData, UpdateActorError, UpdateActorErrors, UpdateActorResponse, UpdateActorResponses, UpdateAgentData, UpdateAgentError, UpdateAgentErrors, UpdateAgentRequest, UpdateAgentResponse, UpdateAgentResponses, UpdateAiProviderData, UpdateAiProviderErrors, UpdateAiProviderPricesData, UpdateAiProviderPricesErrors, UpdateAiProviderPricesResponse, UpdateAiProviderPricesResponses, UpdateAiProviderResponses, UpdateApiKeyData, UpdateApiKeyError, UpdateApiKeyErrors, UpdateApiKeyResponse, UpdateApiKeyResponses, UpdateChannelData, UpdateChannelError, UpdateChannelErrors, UpdateChannelResponse, UpdateChannelResponses, UpdateChannelRouteData, UpdateChannelRouteError, UpdateChannelRouteErrors, UpdateChannelRouteResponse, UpdateChannelRouteResponses, UpdateConversationData, UpdateConversationError, UpdateConversationErrors, UpdateConversationResponse, UpdateConversationResponses, UpdateCurrentUserData, UpdateCurrentUserError, UpdateCurrentUserErrors, UpdateCurrentUserResponse, UpdateCurrentUserResponses, UpdateDatasetData, UpdateDatasetErrors, UpdateDatasetItemData, UpdateDatasetItemErrors, UpdateDatasetItemResponse, UpdateDatasetItemResponses, UpdateDatasetResponse, UpdateDatasetResponses, UpdateDocumentData, UpdateDocumentError, UpdateDocumentErrors, UpdateDocumentResponse, UpdateDocumentResponses, UpdateEvalData, UpdateEvalErrors, UpdateEvalResponse, UpdateEvalResponses, UpdateFileMetadataData, UpdateFileMetadataError, UpdateFileMetadataErrors, UpdateFileMetadataResponse, UpdateFileMetadataResponses, UpdateFormationData, UpdateFormationErrors, UpdateFormationResponse, UpdateFormationResponses, UpdateGenerationData, UpdateGenerationError, UpdateGenerationErrors, UpdateGenerationRequest, UpdateGenerationResponse, UpdateGenerationResponses, UpdateGuardrailData, UpdateGuardrailError, UpdateGuardrailErrors, UpdateGuardrailRequest, UpdateGuardrailResponse, UpdateGuardrailResponses, UpdateIngestionRuleData, UpdateIngestionRuleErrors, UpdateIngestionRuleResponse, UpdateIngestionRuleResponses, UpdateMemoryData, UpdateMemoryErrors, UpdateMemoryResponse, UpdateMemoryResponses, UpdateMemoryRuleData, UpdateMemoryRuleErrors, UpdateMemoryRuleResponse, UpdateMemoryRuleResponses, UpdateMemoryStoreData, UpdateMemoryStoreErrors, UpdateMemoryStoreResponse, UpdateMemoryStoreResponses, UpdateMetadataSchemaData, UpdateMetadataSchemaError, UpdateMetadataSchemaErrors, UpdateMetadataSchemaResponse, UpdateMetadataSchemaResponses, UpdateModelRouteData, UpdateModelRouteErrors, UpdateModelRouteResponse, UpdateModelRouteResponses, UpdateOrchestrationData, UpdateOrchestrationErrors, UpdateOrchestrationRequest, UpdateOrchestrationResponse, UpdateOrchestrationResponses, UpdateProjectData, UpdateProjectError, UpdateProjectErrors, UpdateProjectMemberData, UpdateProjectMemberError, UpdateProjectMemberErrors, UpdateProjectMemberResponse, UpdateProjectMemberResponses, UpdateProjectResponse, UpdateProjectResponses, UpdateQuotaData, UpdateQuotaErrors, UpdateQuotaResponse, UpdateQuotaResponses, UpdateSecretData, UpdateSecretErrors, UpdateSecretResponses, UpdateSessionData, UpdateSessionError, UpdateSessionErrors, UpdateSessionRequest, UpdateSessionResponse, UpdateSessionResponses, UpdateTaskData, UpdateTaskErrors, UpdateTaskRequest, UpdateTaskResponse, UpdateTaskResponses, UpdateToolData, UpdateToolError, UpdateToolErrors, UpdateToolRequest, UpdateToolResponse, UpdateToolResponses, UpdateTriggerData, UpdateTriggerErrors, UpdateTriggerRequest, UpdateTriggerResponse, UpdateTriggerResponses, UpdateUserRolesData, UpdateUserRolesError, UpdateUserRolesErrors, UpdateUserRolesResponse, UpdateUserRolesResponses, UpdateWebhookData, UpdateWebhookError, UpdateWebhookErrors, UpdateWebhookResponse, UpdateWebhookResponses, UpdateWorkflowData, UpdateWorkflowErrors, UpdateWorkflowRequest, UpdateWorkflowResponse, UpdateWorkflowResponses, UploadFileBase64Data, UploadFileBase64Error, UploadFileBase64Errors, UploadFileBase64Request, UploadFileBase64Response, UploadFileBase64Responses, UploadFileData, UploadFileError, UploadFileErrors, UploadFileResponse, UploadFileResponses, UpsertProviderPricesRequest, UsageActionId, UsageActorId, UsageAgentId, UsageAiProviderId, UsageComponent, UsageComponents, UsageEventComponent, UsageGenerationId, UsageGroup, UsageMeterType, UsageOrchestrationId, UsageOrchestrationRunId, UsageSessionId, UsageSource, UsageThreshold, UsageThresholdCreate, UsageTokens, UsageTotals, UsageTraceId, UsageTriggerId, User, UserBilling, UserPlanGrant, UserRolesUpdate, UserUpdate, UserUsage, ValidateFormationData, ValidateFormationErrors, ValidateFormationResponse, ValidateFormationResponses, ValidateMetadataData, ValidateMetadataError, ValidateMetadataErrors, ValidateMetadataResponse, ValidateMetadataResponses, ValidateOrchestrationData, ValidateOrchestrationErrors, ValidateOrchestrationRequest, ValidateOrchestrationResponse, ValidateOrchestrationResponses, ValidationError, ValidationResult, VerifySignInCodeData, VerifySignInCodeError, VerifySignInCodeErrors, VerifySignInCodeResponse, VerifySignInCodeResponses, Webhook, WebhookCreate, WebhookDelivery, WebhookDeliveryList, WebhookId, WebhookList, WebhookUpdate, WebhookWithSecret, WithdrawDocumentData, WithdrawDocumentError, WithdrawDocumentErrors, WithdrawDocumentResponse, WithdrawDocumentResponses, Workflow, WorkflowResourceProperties, WorkflowState, WorkflowTransition, WorkflowVersion };