@naturali/sdk 0.39.0 → 0.40.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.cjs +15 -15
- package/dist/index.d.cts +91 -91
- package/dist/index.d.mts +91 -91
- package/dist/index.mjs +15 -15
- package/package.json +2 -2
package/dist/index.d.cts
CHANGED
|
@@ -336,7 +336,7 @@ type ClientOptions = {
|
|
|
336
336
|
};
|
|
337
337
|
type Agent = {
|
|
338
338
|
/**
|
|
339
|
-
* Public agent ID (agent_ prefix) — the
|
|
339
|
+
* Public agent ID (agent_ prefix) — the runtime agent id.
|
|
340
340
|
*/
|
|
341
341
|
id: string;
|
|
342
342
|
project_id: string;
|
|
@@ -392,7 +392,7 @@ type AgentCreate = {
|
|
|
392
392
|
*/
|
|
393
393
|
name?: string;
|
|
394
394
|
/**
|
|
395
|
-
* Model string
|
|
395
|
+
* Model string the runtime sends (see /v1/models provider_model). Defaults to the provider's default model.
|
|
396
396
|
*/
|
|
397
397
|
model?: string;
|
|
398
398
|
/**
|
|
@@ -816,7 +816,7 @@ type Channel = {
|
|
|
816
816
|
* the optional `modes` opting into the gateway flows. Discord runs over
|
|
817
817
|
* the Gateway, so the bot token is kept in naturali's encrypted store
|
|
818
818
|
* (the worker must present it to authenticate its WebSocket) rather than
|
|
819
|
-
* as a
|
|
819
|
+
* as a secret on the runtime; deployments without `CHANNEL_TOKEN_KEY` configured
|
|
820
820
|
* return `501`.
|
|
821
821
|
*
|
|
822
822
|
* No credential value is ever returned.
|
|
@@ -939,7 +939,7 @@ type ChannelBindingSet = {
|
|
|
939
939
|
status?: 'active' | 'disabled';
|
|
940
940
|
};
|
|
941
941
|
/**
|
|
942
|
-
* One contact's dialogue on a channel — naturali-native, keyed by (channel, contact identity) so the same identifier never opens two conversations, and mapped 1:1 to the
|
|
942
|
+
* One contact's dialogue on a channel — naturali-native, keyed by (channel, contact identity) so the same identifier never opens two conversations, and mapped 1:1 to the runtime session that carries the message history. `contact_id` is who the dialogue is with (see the Contacts API); a merge moves it without disturbing the identity that keys the dialogue.
|
|
943
943
|
*
|
|
944
944
|
*/
|
|
945
945
|
type Conversation = {
|
|
@@ -961,12 +961,12 @@ type Conversation = {
|
|
|
961
961
|
*/
|
|
962
962
|
contact_identifier: string | null;
|
|
963
963
|
/**
|
|
964
|
-
* The
|
|
964
|
+
* The runtime actor the contact speaks as. Null when the contact has not needed one yet.
|
|
965
965
|
*
|
|
966
966
|
*/
|
|
967
967
|
actor_id: string | null;
|
|
968
968
|
/**
|
|
969
|
-
* The
|
|
969
|
+
* The runtime session this conversation maps 1:1 to.
|
|
970
970
|
*/
|
|
971
971
|
session_id: string;
|
|
972
972
|
created_at: Date;
|
|
@@ -980,11 +980,11 @@ type ConversationList = {
|
|
|
980
980
|
next_cursor: string | null;
|
|
981
981
|
};
|
|
982
982
|
/**
|
|
983
|
-
* One message in the conversation's transcript, as
|
|
983
|
+
* One message in the conversation's transcript, as the runtime records it.
|
|
984
984
|
*/
|
|
985
985
|
type ConversationMessage = {
|
|
986
986
|
/**
|
|
987
|
-
* The
|
|
987
|
+
* The runtime document holding the message text.
|
|
988
988
|
*/
|
|
989
989
|
document_id?: string | null;
|
|
990
990
|
role?: 'user' | 'assistant' | 'system' | null;
|
|
@@ -1037,7 +1037,7 @@ type Contact = {
|
|
|
1037
1037
|
[key: string]: unknown;
|
|
1038
1038
|
} | null;
|
|
1039
1039
|
/**
|
|
1040
|
-
* The
|
|
1040
|
+
* The runtime actor the contact speaks as — one per contact, created on first need. Memory hangs off it.
|
|
1041
1041
|
*
|
|
1042
1042
|
*/
|
|
1043
1043
|
actor_id: string | null;
|
|
@@ -1127,7 +1127,7 @@ type ContactConversation = {
|
|
|
1127
1127
|
contact_id: string;
|
|
1128
1128
|
contact_identity_id: string;
|
|
1129
1129
|
/**
|
|
1130
|
-
* The
|
|
1130
|
+
* The runtime session this conversation maps 1:1 to.
|
|
1131
1131
|
*/
|
|
1132
1132
|
session_id: string;
|
|
1133
1133
|
created_at: Date;
|
|
@@ -1264,7 +1264,7 @@ type GenerationResult = {
|
|
|
1264
1264
|
}> | null;
|
|
1265
1265
|
};
|
|
1266
1266
|
/**
|
|
1267
|
-
* A stored generation record — one model loop an agent ran, as
|
|
1267
|
+
* A stored generation record — one model loop an agent ran, as the runtime recorded it. This is what a read returns; `GenerationResult` is what running one returns.
|
|
1268
1268
|
* The record carries no prompt or completion text: the transcript belongs to the session that ran the turn, and the step-level detail to the trace.
|
|
1269
1269
|
*
|
|
1270
1270
|
*/
|
|
@@ -1454,7 +1454,7 @@ type KnowledgeCollectionList = {
|
|
|
1454
1454
|
};
|
|
1455
1455
|
type KnowledgeDocument = {
|
|
1456
1456
|
/**
|
|
1457
|
-
* Public document ID (doc_ prefix) — the
|
|
1457
|
+
* Public document ID (doc_ prefix) — the runtime document id.
|
|
1458
1458
|
*/
|
|
1459
1459
|
id: string;
|
|
1460
1460
|
collection_id: string;
|
|
@@ -1546,7 +1546,7 @@ type Model = {
|
|
|
1546
1546
|
id: string;
|
|
1547
1547
|
display_name: string;
|
|
1548
1548
|
/**
|
|
1549
|
-
*
|
|
1549
|
+
* The provider slug that serves the model.
|
|
1550
1550
|
*/
|
|
1551
1551
|
provider: string;
|
|
1552
1552
|
/**
|
|
@@ -1554,10 +1554,10 @@ type Model = {
|
|
|
1554
1554
|
*/
|
|
1555
1555
|
vendor: string;
|
|
1556
1556
|
/**
|
|
1557
|
-
* The exact model string
|
|
1557
|
+
* The exact model string the runtime sends to the provider — a cross-region inference-profile id (us.…) when the model is profile-only.
|
|
1558
1558
|
*
|
|
1559
1559
|
*/
|
|
1560
|
-
|
|
1560
|
+
provider_model: string;
|
|
1561
1561
|
/**
|
|
1562
1562
|
* Accepted input modalities.
|
|
1563
1563
|
*/
|
|
@@ -1657,13 +1657,13 @@ type ProjectList = {
|
|
|
1657
1657
|
};
|
|
1658
1658
|
type Provider = {
|
|
1659
1659
|
/**
|
|
1660
|
-
* Public provider ID (aip_ prefix) — the
|
|
1660
|
+
* Public provider ID (aip_ prefix) — the provider id on the runtime.
|
|
1661
1661
|
*/
|
|
1662
1662
|
id: string;
|
|
1663
1663
|
project_id: string;
|
|
1664
1664
|
name: string;
|
|
1665
1665
|
/**
|
|
1666
|
-
*
|
|
1666
|
+
* The provider slug.
|
|
1667
1667
|
*/
|
|
1668
1668
|
provider: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'gateway' | 'custom';
|
|
1669
1669
|
default_model: string;
|
|
@@ -1682,7 +1682,7 @@ type Provider = {
|
|
|
1682
1682
|
};
|
|
1683
1683
|
/**
|
|
1684
1684
|
* Two modes, selected by `kind` (default `byok`).
|
|
1685
|
-
* `managed` (naturali-keyed, metered at cost on
|
|
1685
|
+
* `managed` (naturali-keyed, metered at cost on the runtime): supply only `model` (a catalog model id offered as managed, e.g. amazon.nova-lite-v1:0) and an optional `name`. No credential — managed providers use naturali's own AWS access, and are metered at raw AWS cost (customer markup is applied later by the naturali cost API).
|
|
1686
1686
|
* `byok`: supply `provider`, `default_model` and `api_key` (+ optional `name`, `base_url`). The credential is stored write-only and never priced.
|
|
1687
1687
|
*
|
|
1688
1688
|
*/
|
|
@@ -1693,11 +1693,11 @@ type ProviderCreate = {
|
|
|
1693
1693
|
*/
|
|
1694
1694
|
model?: string;
|
|
1695
1695
|
/**
|
|
1696
|
-
* BYOK only — the
|
|
1696
|
+
* BYOK only — the provider slug.
|
|
1697
1697
|
*/
|
|
1698
1698
|
provider?: 'openai' | 'anthropic' | 'google' | 'xai' | 'groq' | 'ollama' | 'azure' | 'bedrock' | 'gateway' | 'custom';
|
|
1699
1699
|
/**
|
|
1700
|
-
* BYOK only — model string
|
|
1700
|
+
* BYOK only — model string the runtime sends (see /v1/models provider_model).
|
|
1701
1701
|
*/
|
|
1702
1702
|
default_model?: string;
|
|
1703
1703
|
/**
|
|
@@ -1743,12 +1743,12 @@ type SessionCreate = {
|
|
|
1743
1743
|
*/
|
|
1744
1744
|
name?: string;
|
|
1745
1745
|
/**
|
|
1746
|
-
* The contact the session is for (Contacts API, §6). naturali resolves it to the contact's
|
|
1746
|
+
* The contact the session is for (Contacts API, §6). naturali resolves it to the contact's runtime actor — minting one on first need — so a web or in-app session gets the same continuity, memory and history a channel conversation gets, instead of a throwaway identity per session. When the contact has an `external_id` it rides along in `tool_context` as `actor_external_id`, so the customer's own HTTP tools receive the user reference they already key on; an explicit `tool_context` entry still wins. Mutually exclusive with `actor_id`.
|
|
1747
1747
|
*
|
|
1748
1748
|
*/
|
|
1749
1749
|
contact_id?: string;
|
|
1750
1750
|
/**
|
|
1751
|
-
* Public ID of an existing actor to attach as the user actor. A
|
|
1751
|
+
* Public ID of an existing actor to attach as the user actor. A runtime id showing through the public contract; prefer `contact_id`. Mutually exclusive with it.
|
|
1752
1752
|
*
|
|
1753
1753
|
*/
|
|
1754
1754
|
actor_id?: string;
|
|
@@ -1783,7 +1783,7 @@ type Session = {
|
|
|
1783
1783
|
*/
|
|
1784
1784
|
agent_id: string;
|
|
1785
1785
|
/**
|
|
1786
|
-
* The underlying
|
|
1786
|
+
* The underlying runtime conversation backing the session.
|
|
1787
1787
|
*/
|
|
1788
1788
|
conversation_id?: string | null;
|
|
1789
1789
|
/**
|
|
@@ -2082,7 +2082,7 @@ type McpConfig = {
|
|
|
2082
2082
|
};
|
|
2083
2083
|
type Tool = {
|
|
2084
2084
|
/**
|
|
2085
|
-
* Public tool ID (tool_ prefix) — the
|
|
2085
|
+
* Public tool ID (tool_ prefix) — the runtime tool id.
|
|
2086
2086
|
*/
|
|
2087
2087
|
id: string;
|
|
2088
2088
|
project_id: string;
|
|
@@ -2343,7 +2343,7 @@ type GenerationStatus = 'in_progress' | 'requires_action' | 'completed' | 'faile
|
|
|
2343
2343
|
*/
|
|
2344
2344
|
type CollectionId = string;
|
|
2345
2345
|
/**
|
|
2346
|
-
* Knowledge document public ID (doc_ prefix) — the
|
|
2346
|
+
* Knowledge document public ID (doc_ prefix) — the runtime document id.
|
|
2347
2347
|
*/
|
|
2348
2348
|
type DocumentId = string;
|
|
2349
2349
|
/**
|
|
@@ -2451,7 +2451,7 @@ type CreateAgentErrors = {
|
|
|
2451
2451
|
*/
|
|
2452
2452
|
404: ErrorResponse;
|
|
2453
2453
|
/**
|
|
2454
|
-
* The
|
|
2454
|
+
* The upstream runtime could not complete the operation.
|
|
2455
2455
|
*/
|
|
2456
2456
|
502: ErrorResponse;
|
|
2457
2457
|
};
|
|
@@ -2498,7 +2498,7 @@ type DeleteAgentErrors = {
|
|
|
2498
2498
|
*/
|
|
2499
2499
|
409: ErrorResponse;
|
|
2500
2500
|
/**
|
|
2501
|
-
* The
|
|
2501
|
+
* The upstream runtime could not complete the operation.
|
|
2502
2502
|
*/
|
|
2503
2503
|
502: ErrorResponse;
|
|
2504
2504
|
};
|
|
@@ -2572,7 +2572,7 @@ type UpdateAgentErrors = {
|
|
|
2572
2572
|
*/
|
|
2573
2573
|
404: ErrorResponse;
|
|
2574
2574
|
/**
|
|
2575
|
-
* The
|
|
2575
|
+
* The upstream runtime could not complete the operation.
|
|
2576
2576
|
*/
|
|
2577
2577
|
502: ErrorResponse;
|
|
2578
2578
|
};
|
|
@@ -2929,7 +2929,7 @@ type ListBoardsErrors = {
|
|
|
2929
2929
|
*/
|
|
2930
2930
|
404: ErrorResponse;
|
|
2931
2931
|
/**
|
|
2932
|
-
* The
|
|
2932
|
+
* The upstream runtime could not complete the operation.
|
|
2933
2933
|
*/
|
|
2934
2934
|
502: ErrorResponse;
|
|
2935
2935
|
};
|
|
@@ -2973,7 +2973,7 @@ type CreateBoardErrors = {
|
|
|
2973
2973
|
*/
|
|
2974
2974
|
404: ErrorResponse;
|
|
2975
2975
|
/**
|
|
2976
|
-
* The
|
|
2976
|
+
* The upstream runtime could not complete the operation.
|
|
2977
2977
|
*/
|
|
2978
2978
|
502: ErrorResponse;
|
|
2979
2979
|
};
|
|
@@ -3014,7 +3014,7 @@ type DeleteBoardErrors = {
|
|
|
3014
3014
|
*/
|
|
3015
3015
|
409: ErrorResponse;
|
|
3016
3016
|
/**
|
|
3017
|
-
* The
|
|
3017
|
+
* The upstream runtime could not complete the operation.
|
|
3018
3018
|
*/
|
|
3019
3019
|
502: ErrorResponse;
|
|
3020
3020
|
};
|
|
@@ -3051,7 +3051,7 @@ type GetBoardErrors = {
|
|
|
3051
3051
|
*/
|
|
3052
3052
|
404: ErrorResponse;
|
|
3053
3053
|
/**
|
|
3054
|
-
* The
|
|
3054
|
+
* The upstream runtime could not complete the operation.
|
|
3055
3055
|
*/
|
|
3056
3056
|
502: ErrorResponse;
|
|
3057
3057
|
};
|
|
@@ -3093,7 +3093,7 @@ type UpdateBoardErrors = {
|
|
|
3093
3093
|
*/
|
|
3094
3094
|
404: ErrorResponse;
|
|
3095
3095
|
/**
|
|
3096
|
-
* The
|
|
3096
|
+
* The upstream runtime could not complete the operation.
|
|
3097
3097
|
*/
|
|
3098
3098
|
502: ErrorResponse;
|
|
3099
3099
|
};
|
|
@@ -3183,7 +3183,7 @@ type CreateChannelErrors = {
|
|
|
3183
3183
|
*/
|
|
3184
3184
|
501: ErrorResponse;
|
|
3185
3185
|
/**
|
|
3186
|
-
* The
|
|
3186
|
+
* The upstream runtime could not complete the operation.
|
|
3187
3187
|
*/
|
|
3188
3188
|
502: ErrorResponse;
|
|
3189
3189
|
};
|
|
@@ -3220,7 +3220,7 @@ type DeleteChannelErrors = {
|
|
|
3220
3220
|
*/
|
|
3221
3221
|
404: ErrorResponse;
|
|
3222
3222
|
/**
|
|
3223
|
-
* The
|
|
3223
|
+
* The upstream runtime could not complete the operation.
|
|
3224
3224
|
*/
|
|
3225
3225
|
502: ErrorResponse;
|
|
3226
3226
|
};
|
|
@@ -3294,7 +3294,7 @@ type UpdateChannelErrors = {
|
|
|
3294
3294
|
*/
|
|
3295
3295
|
404: ErrorResponse;
|
|
3296
3296
|
/**
|
|
3297
|
-
* The
|
|
3297
|
+
* The upstream runtime could not complete the operation.
|
|
3298
3298
|
*/
|
|
3299
3299
|
502: ErrorResponse;
|
|
3300
3300
|
};
|
|
@@ -3548,7 +3548,7 @@ type ListChannelConversationMessagesErrors = {
|
|
|
3548
3548
|
*/
|
|
3549
3549
|
404: ErrorResponse;
|
|
3550
3550
|
/**
|
|
3551
|
-
* The
|
|
3551
|
+
* The upstream runtime could not complete the operation.
|
|
3552
3552
|
*/
|
|
3553
3553
|
502: ErrorResponse;
|
|
3554
3554
|
};
|
|
@@ -3692,7 +3692,7 @@ type DeleteContactErrors = {
|
|
|
3692
3692
|
*/
|
|
3693
3693
|
409: ErrorResponse;
|
|
3694
3694
|
/**
|
|
3695
|
-
* The
|
|
3695
|
+
* The upstream runtime could not complete the operation.
|
|
3696
3696
|
*/
|
|
3697
3697
|
502: ErrorResponse;
|
|
3698
3698
|
};
|
|
@@ -3926,7 +3926,7 @@ type MergeContactErrors = {
|
|
|
3926
3926
|
*/
|
|
3927
3927
|
409: ErrorResponse;
|
|
3928
3928
|
/**
|
|
3929
|
-
* The
|
|
3929
|
+
* The upstream runtime could not complete the operation.
|
|
3930
3930
|
*/
|
|
3931
3931
|
502: ErrorResponse;
|
|
3932
3932
|
};
|
|
@@ -4004,7 +4004,7 @@ type RevertContactMergeErrors = {
|
|
|
4004
4004
|
*/
|
|
4005
4005
|
409: ErrorResponse;
|
|
4006
4006
|
/**
|
|
4007
|
-
* The
|
|
4007
|
+
* The upstream runtime could not complete the operation.
|
|
4008
4008
|
*/
|
|
4009
4009
|
502: ErrorResponse;
|
|
4010
4010
|
};
|
|
@@ -4058,7 +4058,7 @@ type ListAgentGenerationsErrors = {
|
|
|
4058
4058
|
*/
|
|
4059
4059
|
404: ErrorResponse;
|
|
4060
4060
|
/**
|
|
4061
|
-
* The
|
|
4061
|
+
* The upstream runtime could not complete the operation.
|
|
4062
4062
|
*/
|
|
4063
4063
|
502: ErrorResponse;
|
|
4064
4064
|
};
|
|
@@ -4105,7 +4105,7 @@ type CreateGenerationErrors = {
|
|
|
4105
4105
|
*/
|
|
4106
4106
|
404: ErrorResponse;
|
|
4107
4107
|
/**
|
|
4108
|
-
* The
|
|
4108
|
+
* The upstream runtime could not complete the operation.
|
|
4109
4109
|
*/
|
|
4110
4110
|
502: ErrorResponse;
|
|
4111
4111
|
};
|
|
@@ -4143,7 +4143,7 @@ type GetGenerationErrors = {
|
|
|
4143
4143
|
*/
|
|
4144
4144
|
404: ErrorResponse;
|
|
4145
4145
|
/**
|
|
4146
|
-
* The
|
|
4146
|
+
* The upstream runtime could not complete the operation.
|
|
4147
4147
|
*/
|
|
4148
4148
|
502: ErrorResponse;
|
|
4149
4149
|
};
|
|
@@ -4180,7 +4180,7 @@ type GetGenerationUsageErrors = {
|
|
|
4180
4180
|
*/
|
|
4181
4181
|
404: ErrorResponse;
|
|
4182
4182
|
/**
|
|
4183
|
-
* The
|
|
4183
|
+
* The upstream runtime could not complete the operation.
|
|
4184
4184
|
*/
|
|
4185
4185
|
502: ErrorResponse;
|
|
4186
4186
|
};
|
|
@@ -4413,7 +4413,7 @@ type QueryKnowledgeCollectionErrors = {
|
|
|
4413
4413
|
*/
|
|
4414
4414
|
404: ErrorResponse;
|
|
4415
4415
|
/**
|
|
4416
|
-
* The
|
|
4416
|
+
* The upstream runtime could not complete the operation.
|
|
4417
4417
|
*/
|
|
4418
4418
|
502: ErrorResponse;
|
|
4419
4419
|
};
|
|
@@ -4459,7 +4459,7 @@ type ListKnowledgeDocumentsErrors = {
|
|
|
4459
4459
|
*/
|
|
4460
4460
|
404: ErrorResponse;
|
|
4461
4461
|
/**
|
|
4462
|
-
* The
|
|
4462
|
+
* The upstream runtime could not complete the operation.
|
|
4463
4463
|
*/
|
|
4464
4464
|
502: ErrorResponse;
|
|
4465
4465
|
};
|
|
@@ -4506,7 +4506,7 @@ type CreateKnowledgeDocumentErrors = {
|
|
|
4506
4506
|
*/
|
|
4507
4507
|
404: ErrorResponse;
|
|
4508
4508
|
/**
|
|
4509
|
-
* The
|
|
4509
|
+
* The upstream runtime could not complete the operation.
|
|
4510
4510
|
*/
|
|
4511
4511
|
502: ErrorResponse;
|
|
4512
4512
|
};
|
|
@@ -4530,7 +4530,7 @@ type DeleteKnowledgeDocumentData = {
|
|
|
4530
4530
|
*/
|
|
4531
4531
|
collection_id: string;
|
|
4532
4532
|
/**
|
|
4533
|
-
* Knowledge document public ID (doc_ prefix) — the
|
|
4533
|
+
* Knowledge document public ID (doc_ prefix) — the runtime document id.
|
|
4534
4534
|
*/
|
|
4535
4535
|
document_id: string;
|
|
4536
4536
|
};
|
|
@@ -4547,7 +4547,7 @@ type DeleteKnowledgeDocumentErrors = {
|
|
|
4547
4547
|
*/
|
|
4548
4548
|
404: ErrorResponse;
|
|
4549
4549
|
/**
|
|
4550
|
-
* The
|
|
4550
|
+
* The upstream runtime could not complete the operation.
|
|
4551
4551
|
*/
|
|
4552
4552
|
502: ErrorResponse;
|
|
4553
4553
|
};
|
|
@@ -4571,7 +4571,7 @@ type GetKnowledgeDocumentData = {
|
|
|
4571
4571
|
*/
|
|
4572
4572
|
collection_id: string;
|
|
4573
4573
|
/**
|
|
4574
|
-
* Knowledge document public ID (doc_ prefix) — the
|
|
4574
|
+
* Knowledge document public ID (doc_ prefix) — the runtime document id.
|
|
4575
4575
|
*/
|
|
4576
4576
|
document_id: string;
|
|
4577
4577
|
};
|
|
@@ -4588,7 +4588,7 @@ type GetKnowledgeDocumentErrors = {
|
|
|
4588
4588
|
*/
|
|
4589
4589
|
404: ErrorResponse;
|
|
4590
4590
|
/**
|
|
4591
|
-
* The
|
|
4591
|
+
* The upstream runtime could not complete the operation.
|
|
4592
4592
|
*/
|
|
4593
4593
|
502: ErrorResponse;
|
|
4594
4594
|
};
|
|
@@ -4612,7 +4612,7 @@ type ReingestKnowledgeDocumentData = {
|
|
|
4612
4612
|
*/
|
|
4613
4613
|
collection_id: string;
|
|
4614
4614
|
/**
|
|
4615
|
-
* Knowledge document public ID (doc_ prefix) — the
|
|
4615
|
+
* Knowledge document public ID (doc_ prefix) — the runtime document id.
|
|
4616
4616
|
*/
|
|
4617
4617
|
document_id: string;
|
|
4618
4618
|
};
|
|
@@ -4629,7 +4629,7 @@ type ReingestKnowledgeDocumentErrors = {
|
|
|
4629
4629
|
*/
|
|
4630
4630
|
404: ErrorResponse;
|
|
4631
4631
|
/**
|
|
4632
|
-
* The
|
|
4632
|
+
* The upstream runtime could not complete the operation.
|
|
4633
4633
|
*/
|
|
4634
4634
|
502: ErrorResponse;
|
|
4635
4635
|
};
|
|
@@ -4658,7 +4658,7 @@ type ListModelsData = {
|
|
|
4658
4658
|
*/
|
|
4659
4659
|
vendor?: string;
|
|
4660
4660
|
/**
|
|
4661
|
-
* Filter by the
|
|
4661
|
+
* Filter by the provider slug that serves the model.
|
|
4662
4662
|
*/
|
|
4663
4663
|
provider?: string;
|
|
4664
4664
|
/**
|
|
@@ -4811,7 +4811,7 @@ type DeleteProjectErrors = {
|
|
|
4811
4811
|
*/
|
|
4812
4812
|
404: ErrorResponse;
|
|
4813
4813
|
/**
|
|
4814
|
-
* The project still has dependent resources
|
|
4814
|
+
* The project still has dependent resources on the runtime (retry with `force=true`).
|
|
4815
4815
|
*/
|
|
4816
4816
|
409: ErrorResponse;
|
|
4817
4817
|
};
|
|
@@ -4996,7 +4996,7 @@ type CreateProviderErrors = {
|
|
|
4996
4996
|
*/
|
|
4997
4997
|
404: ErrorResponse;
|
|
4998
4998
|
/**
|
|
4999
|
-
* The
|
|
4999
|
+
* The upstream runtime could not complete the operation.
|
|
5000
5000
|
*/
|
|
5001
5001
|
502: ErrorResponse;
|
|
5002
5002
|
};
|
|
@@ -5043,7 +5043,7 @@ type DeleteProviderErrors = {
|
|
|
5043
5043
|
*/
|
|
5044
5044
|
409: ErrorResponse;
|
|
5045
5045
|
/**
|
|
5046
|
-
* The
|
|
5046
|
+
* The upstream runtime could not complete the operation.
|
|
5047
5047
|
*/
|
|
5048
5048
|
502: ErrorResponse;
|
|
5049
5049
|
};
|
|
@@ -5117,7 +5117,7 @@ type UpdateProviderErrors = {
|
|
|
5117
5117
|
*/
|
|
5118
5118
|
404: ErrorResponse;
|
|
5119
5119
|
/**
|
|
5120
|
-
* The
|
|
5120
|
+
* The upstream runtime could not complete the operation.
|
|
5121
5121
|
*/
|
|
5122
5122
|
502: ErrorResponse;
|
|
5123
5123
|
};
|
|
@@ -5164,7 +5164,7 @@ type CreateSessionErrors = {
|
|
|
5164
5164
|
*/
|
|
5165
5165
|
404: ErrorResponse;
|
|
5166
5166
|
/**
|
|
5167
|
-
* The
|
|
5167
|
+
* The upstream runtime could not complete the operation.
|
|
5168
5168
|
*/
|
|
5169
5169
|
502: ErrorResponse;
|
|
5170
5170
|
};
|
|
@@ -5205,7 +5205,7 @@ type GetSessionErrors = {
|
|
|
5205
5205
|
*/
|
|
5206
5206
|
404: ErrorResponse;
|
|
5207
5207
|
/**
|
|
5208
|
-
* The
|
|
5208
|
+
* The upstream runtime could not complete the operation.
|
|
5209
5209
|
*/
|
|
5210
5210
|
502: ErrorResponse;
|
|
5211
5211
|
};
|
|
@@ -5250,7 +5250,7 @@ type AddSessionMessageErrors = {
|
|
|
5250
5250
|
*/
|
|
5251
5251
|
404: ErrorResponse;
|
|
5252
5252
|
/**
|
|
5253
|
-
* The
|
|
5253
|
+
* The upstream runtime could not complete the operation.
|
|
5254
5254
|
*/
|
|
5255
5255
|
502: ErrorResponse;
|
|
5256
5256
|
};
|
|
@@ -5308,7 +5308,7 @@ type GenerateSessionResponseErrors = {
|
|
|
5308
5308
|
*/
|
|
5309
5309
|
410: ErrorResponse;
|
|
5310
5310
|
/**
|
|
5311
|
-
* The
|
|
5311
|
+
* The upstream runtime could not complete the operation.
|
|
5312
5312
|
*/
|
|
5313
5313
|
502: ErrorResponse;
|
|
5314
5314
|
};
|
|
@@ -5370,7 +5370,7 @@ type ListTasksErrors = {
|
|
|
5370
5370
|
*/
|
|
5371
5371
|
404: ErrorResponse;
|
|
5372
5372
|
/**
|
|
5373
|
-
* The
|
|
5373
|
+
* The upstream runtime could not complete the operation.
|
|
5374
5374
|
*/
|
|
5375
5375
|
502: ErrorResponse;
|
|
5376
5376
|
};
|
|
@@ -5413,7 +5413,7 @@ type CreateTaskErrors = {
|
|
|
5413
5413
|
*/
|
|
5414
5414
|
404: ErrorResponse;
|
|
5415
5415
|
/**
|
|
5416
|
-
* The
|
|
5416
|
+
* The upstream runtime could not complete the operation.
|
|
5417
5417
|
*/
|
|
5418
5418
|
502: ErrorResponse;
|
|
5419
5419
|
};
|
|
@@ -5450,7 +5450,7 @@ type DeleteTaskErrors = {
|
|
|
5450
5450
|
*/
|
|
5451
5451
|
404: ErrorResponse;
|
|
5452
5452
|
/**
|
|
5453
|
-
* The
|
|
5453
|
+
* The upstream runtime could not complete the operation.
|
|
5454
5454
|
*/
|
|
5455
5455
|
502: ErrorResponse;
|
|
5456
5456
|
};
|
|
@@ -5487,7 +5487,7 @@ type GetTaskErrors = {
|
|
|
5487
5487
|
*/
|
|
5488
5488
|
404: ErrorResponse;
|
|
5489
5489
|
/**
|
|
5490
|
-
* The
|
|
5490
|
+
* The upstream runtime could not complete the operation.
|
|
5491
5491
|
*/
|
|
5492
5492
|
502: ErrorResponse;
|
|
5493
5493
|
};
|
|
@@ -5528,7 +5528,7 @@ type UpdateTaskErrors = {
|
|
|
5528
5528
|
*/
|
|
5529
5529
|
404: ErrorResponse;
|
|
5530
5530
|
/**
|
|
5531
|
-
* The
|
|
5531
|
+
* The upstream runtime could not complete the operation.
|
|
5532
5532
|
*/
|
|
5533
5533
|
502: ErrorResponse;
|
|
5534
5534
|
};
|
|
@@ -5573,7 +5573,7 @@ type TransitionTaskErrors = {
|
|
|
5573
5573
|
*/
|
|
5574
5574
|
409: ErrorResponse;
|
|
5575
5575
|
/**
|
|
5576
|
-
* The
|
|
5576
|
+
* The upstream runtime could not complete the operation.
|
|
5577
5577
|
*/
|
|
5578
5578
|
502: ErrorResponse;
|
|
5579
5579
|
};
|
|
@@ -5610,7 +5610,7 @@ type ListTaskTransitionsErrors = {
|
|
|
5610
5610
|
*/
|
|
5611
5611
|
404: ErrorResponse;
|
|
5612
5612
|
/**
|
|
5613
|
-
* The
|
|
5613
|
+
* The upstream runtime could not complete the operation.
|
|
5614
5614
|
*/
|
|
5615
5615
|
502: ErrorResponse;
|
|
5616
5616
|
};
|
|
@@ -5691,7 +5691,7 @@ type CreateToolErrors = {
|
|
|
5691
5691
|
*/
|
|
5692
5692
|
404: ErrorResponse;
|
|
5693
5693
|
/**
|
|
5694
|
-
* The
|
|
5694
|
+
* The upstream runtime could not complete the operation.
|
|
5695
5695
|
*/
|
|
5696
5696
|
502: ErrorResponse;
|
|
5697
5697
|
};
|
|
@@ -5732,7 +5732,7 @@ type DeleteToolErrors = {
|
|
|
5732
5732
|
*/
|
|
5733
5733
|
409: ErrorResponse;
|
|
5734
5734
|
/**
|
|
5735
|
-
* The
|
|
5735
|
+
* The upstream runtime could not complete the operation.
|
|
5736
5736
|
*/
|
|
5737
5737
|
502: ErrorResponse;
|
|
5738
5738
|
};
|
|
@@ -5806,7 +5806,7 @@ type UpdateToolErrors = {
|
|
|
5806
5806
|
*/
|
|
5807
5807
|
404: ErrorResponse;
|
|
5808
5808
|
/**
|
|
5809
|
-
* The
|
|
5809
|
+
* The upstream runtime could not complete the operation.
|
|
5810
5810
|
*/
|
|
5811
5811
|
502: ErrorResponse;
|
|
5812
5812
|
};
|
|
@@ -5852,7 +5852,7 @@ type ListTracesErrors = {
|
|
|
5852
5852
|
*/
|
|
5853
5853
|
404: ErrorResponse;
|
|
5854
5854
|
/**
|
|
5855
|
-
* The
|
|
5855
|
+
* The upstream runtime could not complete the operation.
|
|
5856
5856
|
*/
|
|
5857
5857
|
502: ErrorResponse;
|
|
5858
5858
|
};
|
|
@@ -5889,7 +5889,7 @@ type GetTraceErrors = {
|
|
|
5889
5889
|
*/
|
|
5890
5890
|
404: ErrorResponse;
|
|
5891
5891
|
/**
|
|
5892
|
-
* The
|
|
5892
|
+
* The upstream runtime could not complete the operation.
|
|
5893
5893
|
*/
|
|
5894
5894
|
502: ErrorResponse;
|
|
5895
5895
|
};
|
|
@@ -5936,7 +5936,7 @@ type GetTraceTreeErrors = {
|
|
|
5936
5936
|
*/
|
|
5937
5937
|
404: ErrorResponse;
|
|
5938
5938
|
/**
|
|
5939
|
-
* The
|
|
5939
|
+
* The upstream runtime could not complete the operation.
|
|
5940
5940
|
*/
|
|
5941
5941
|
502: ErrorResponse;
|
|
5942
5942
|
};
|
|
@@ -5990,7 +5990,7 @@ type ListTraceGenerationsErrors = {
|
|
|
5990
5990
|
*/
|
|
5991
5991
|
404: ErrorResponse;
|
|
5992
5992
|
/**
|
|
5993
|
-
* The
|
|
5993
|
+
* The upstream runtime could not complete the operation.
|
|
5994
5994
|
*/
|
|
5995
5995
|
502: ErrorResponse;
|
|
5996
5996
|
};
|
|
@@ -6034,7 +6034,7 @@ declare class Agents {
|
|
|
6034
6034
|
/**
|
|
6035
6035
|
* Delete an agent
|
|
6036
6036
|
*
|
|
6037
|
-
* Deletes the backing
|
|
6037
|
+
* Deletes the backing runtime agent. Returns 409 if the agent still has dependent generations or traces — pass `force=true` to delete those along with the agent (destructive and irreversible).
|
|
6038
6038
|
*
|
|
6039
6039
|
*/
|
|
6040
6040
|
static deleteAgent<ThrowOnError extends boolean = false>(options: Options<DeleteAgentData, ThrowOnError>): RequestResult<DeleteAgentResponses, DeleteAgentErrors, ThrowOnError>;
|
|
@@ -6224,7 +6224,7 @@ declare class Channels {
|
|
|
6224
6224
|
/**
|
|
6225
6225
|
* List the channel's conversations
|
|
6226
6226
|
*
|
|
6227
|
-
* A cursor page of the channel's conversations, newest first. A conversation is one contact's dialogue on the channel — the continuity anchor that resumes the same
|
|
6227
|
+
* A cursor page of the channel's conversations, newest first. A conversation is one contact's dialogue on the channel — the continuity anchor that resumes the same runtime session instead of starting fresh per message — so this is the read path for who has talked to the channel and which actor/session their dialogue resolved to.
|
|
6228
6228
|
* Conversations are created by the inbound path (the WhatsApp webhook, the Discord gateway worker) when a real message arrives; there is no way to create one directly.
|
|
6229
6229
|
*
|
|
6230
6230
|
*/
|
|
@@ -6236,7 +6236,7 @@ declare class Channels {
|
|
|
6236
6236
|
/**
|
|
6237
6237
|
* Read a conversation's transcript
|
|
6238
6238
|
*
|
|
6239
|
-
* The conversation's messages, oldest first. naturali stores no message bodies — the dialogue lives in the
|
|
6239
|
+
* The conversation's messages, oldest first. naturali stores no message bodies — the dialogue lives in the runtime session the conversation maps to, so this reads through to the runtime. Pagination is `limit`/`offset` rather than an opaque cursor because the upstream is offset-based over a stable `position` ordering.
|
|
6240
6240
|
*
|
|
6241
6241
|
*/
|
|
6242
6242
|
static listChannelConversationMessages<ThrowOnError extends boolean = false>(options: Options<ListChannelConversationMessagesData, ThrowOnError>): RequestResult<ListChannelConversationMessagesResponses, ListChannelConversationMessagesErrors, ThrowOnError>;
|
|
@@ -6254,14 +6254,14 @@ declare class Contacts {
|
|
|
6254
6254
|
* Create a contact
|
|
6255
6255
|
*
|
|
6256
6256
|
* Record a contact the customer already knows about, optionally with the identifiers it is expected to arrive at.
|
|
6257
|
-
* Optional by design — the inbound path creates contacts on its own. This is for the embedder who has a user in their own system and wants naturali to agree about who that is before the first message, which is what makes `external_id` (and, through it, a session's `tool_context`) useful. No
|
|
6257
|
+
* Optional by design — the inbound path creates contacts on its own. This is for the embedder who has a user in their own system and wants naturali to agree about who that is before the first message, which is what makes `external_id` (and, through it, a session's `tool_context`) useful. No runtime actor is created here; the contact gets one on first need.
|
|
6258
6258
|
*
|
|
6259
6259
|
*/
|
|
6260
6260
|
static createContact<ThrowOnError extends boolean = false>(options: Options<CreateContactData, ThrowOnError>): RequestResult<CreateContactResponses, CreateContactErrors, ThrowOnError>;
|
|
6261
6261
|
/**
|
|
6262
6262
|
* Erase a contact
|
|
6263
6263
|
*
|
|
6264
|
-
* **Erasure (C4/LGPD).** Not a soft delete and not reversible: the contact's sessions — with their messages and media — its
|
|
6264
|
+
* **Erasure (C4/LGPD).** Not a soft delete and not reversible: the contact's sessions — with their messages and media — its runtime actor, its memory container and every identifier it was reachable at are removed, along with the merge records that reference it.
|
|
6265
6265
|
* The upstream deletes happen first, so a failure there aborts before the local pointers are dropped and a retry can still find what is left. A contact that was merged into another cannot be erased directly: its data lives with the survivor, so erase that one.
|
|
6266
6266
|
*
|
|
6267
6267
|
*/
|
|
@@ -6302,7 +6302,7 @@ declare class Contacts {
|
|
|
6302
6302
|
* Merge another contact into this one
|
|
6303
6303
|
*
|
|
6304
6304
|
* Fold `source_contact_id` into this contact — "same human, two identifiers" (C4).
|
|
6305
|
-
* What moves: every identity and every conversation, so the survivor's history is the union of both. What is *shared* rather than moved: agent memory —
|
|
6305
|
+
* What moves: every identity and every conversation, so the survivor's history is the union of both. What is *shared* rather than moved: agent memory — the runtime hangs it off the actor, so the source's actor is re-pointed at the survivor's memory container and both keep answering with one recollection. Existing sessions keep working, which is the point of not rewriting them.
|
|
6306
6306
|
* The source is not deleted: it stays as a tombstone pointing at the survivor, and the returned merge record lists exactly what moved, so the merge can be audited and reverted.
|
|
6307
6307
|
*
|
|
6308
6308
|
*/
|
|
@@ -6334,7 +6334,7 @@ declare class Generations {
|
|
|
6334
6334
|
/**
|
|
6335
6335
|
* Run an agent generation
|
|
6336
6336
|
*
|
|
6337
|
-
* Sends messages to the agent, resolves its tools, and runs the model loop. Returns the final text when `status` is `completed` (plus `object` when the agent has an output schema), or the pending `tool_calls` when `status` is `requires_action`. With `stream: true` the response is a Server-Sent Events stream (Content-Type text/event-stream) proxied from
|
|
6337
|
+
* Sends messages to the agent, resolves its tools, and runs the model loop. Returns the final text when `status` is `completed` (plus `object` when the agent has an output schema), or the pending `tool_calls` when `status` is `requires_action`. With `stream: true` the response is a Server-Sent Events stream (Content-Type text/event-stream) proxied from the runtime instead of a single JSON body.
|
|
6338
6338
|
*
|
|
6339
6339
|
*/
|
|
6340
6340
|
static createGeneration<ThrowOnError extends boolean = false>(options: Options<CreateGenerationData, ThrowOnError>): RequestResult<CreateGenerationResponses, CreateGenerationErrors, ThrowOnError>;
|
|
@@ -6349,7 +6349,7 @@ declare class Generations {
|
|
|
6349
6349
|
/**
|
|
6350
6350
|
* Get a generation's cost
|
|
6351
6351
|
*
|
|
6352
|
-
* What this one generation cost, and the tokens it was charged on — the billing-grade receipt
|
|
6352
|
+
* What this one generation cost, and the tokens it was charged on — the billing-grade receipt the runtime froze at write time, per model line item.
|
|
6353
6353
|
* This is the per-generation grain that `GET /v1/projects/{project_id}/usage` cannot express: that meter buckets a whole project by model, agent, run, day or meter type, and a run can hold more than one generation. Use this to price a single turn, and the project meter to roll spend up.
|
|
6354
6354
|
* `cost_usd` is `null` when nothing was priced — never that the work was free. Only naturali-managed providers are priced; a BYOK generation runs on your own provider account, so it carries no LLM cost here (its tokens are still reported).
|
|
6355
6355
|
* A generation belonging to another project responds `404`, not `403`.
|
|
@@ -6455,7 +6455,7 @@ declare class Projects {
|
|
|
6455
6455
|
/**
|
|
6456
6456
|
* Delete a project
|
|
6457
6457
|
*
|
|
6458
|
-
* Permanently deletes the project and its backing
|
|
6458
|
+
* Permanently deletes the project and its backing runtime project. Fails with 409 if the runtime project still has dependent resources — remove them first, or pass `force=true` to delete the project and all its dependents (agents, providers, tools, sessions, generations, traces). Forcing is destructive and irreversible.
|
|
6459
6459
|
*
|
|
6460
6460
|
*/
|
|
6461
6461
|
static deleteProject<ThrowOnError extends boolean = false>(options: Options<DeleteProjectData, ThrowOnError>): RequestResult<DeleteProjectResponses, DeleteProjectErrors, ThrowOnError>;
|
|
@@ -6472,7 +6472,7 @@ declare class Projects {
|
|
|
6472
6472
|
/**
|
|
6473
6473
|
* Get per-project usage
|
|
6474
6474
|
*
|
|
6475
|
-
* The per-project meter — the re-billing view (A11/C12/P3). Aggregates the project's usage over an optional [from, to] window, bucketed by a single dimension. Costs are the billing-grade cost_usd
|
|
6475
|
+
* The per-project meter — the re-billing view (A11/C12/P3). Aggregates the project's usage over an optional [from, to] window, bucketed by a single dimension. Costs are the billing-grade cost_usd the runtime freezes at write time; null means nothing in the bucket was priced (never that it was free). Only managed providers are priced (on the runtime), so cost reflects managed usage; BYOK usage carries no LLM cost.
|
|
6476
6476
|
*
|
|
6477
6477
|
*/
|
|
6478
6478
|
static getProjectUsage<ThrowOnError extends boolean = false>(options: Options<GetProjectUsageData, ThrowOnError>): RequestResult<GetProjectUsageResponses, GetProjectUsageErrors, ThrowOnError>;
|
|
@@ -6487,14 +6487,14 @@ declare class Providers {
|
|
|
6487
6487
|
/**
|
|
6488
6488
|
* Register a provider (managed or BYOK)
|
|
6489
6489
|
*
|
|
6490
|
-
* Register a managed provider (naturali-keyed, priced on
|
|
6490
|
+
* Register a managed provider (naturali-keyed, priced on the runtime) or a BYOK provider (your credentials, stored write-only and never priced). See ProviderCreate for the fields each mode takes.
|
|
6491
6491
|
*
|
|
6492
6492
|
*/
|
|
6493
6493
|
static createProvider<ThrowOnError extends boolean = false>(options: Options<CreateProviderData, ThrowOnError>): RequestResult<CreateProviderResponses, CreateProviderErrors, ThrowOnError>;
|
|
6494
6494
|
/**
|
|
6495
6495
|
* Delete a provider
|
|
6496
6496
|
*
|
|
6497
|
-
* Deletes the backing
|
|
6497
|
+
* Deletes the backing provider record on the runtime and its secret. Returns 409 if the provider is still referenced by live resources (agents) — detach those first. `force=true` clears only soft dependents (price overrides, usage history); live references always block deletion.
|
|
6498
6498
|
*
|
|
6499
6499
|
*/
|
|
6500
6500
|
static deleteProvider<ThrowOnError extends boolean = false>(options: Options<DeleteProviderData, ThrowOnError>): RequestResult<DeleteProviderResponses, DeleteProviderErrors, ThrowOnError>;
|
|
@@ -6514,14 +6514,14 @@ declare class Sessions {
|
|
|
6514
6514
|
/**
|
|
6515
6515
|
* Open a session
|
|
6516
6516
|
*
|
|
6517
|
-
* Opens a durable session against the agent. The session accumulates messages and is resumable by id; its lifecycle (open / closed / expired) and configuration live in the backing
|
|
6517
|
+
* Opens a durable session against the agent. The session accumulates messages and is resumable by id; its lifecycle (open / closed / expired) and configuration live in the backing runtime session.
|
|
6518
6518
|
*
|
|
6519
6519
|
*/
|
|
6520
6520
|
static createSession<ThrowOnError extends boolean = false>(options: Options<CreateSessionData, ThrowOnError>): RequestResult<CreateSessionResponses, CreateSessionErrors, ThrowOnError>;
|
|
6521
6521
|
/**
|
|
6522
6522
|
* Get a session
|
|
6523
6523
|
*
|
|
6524
|
-
* Returns the session's current state — status, activity timestamps and configuration — read live from the backing
|
|
6524
|
+
* Returns the session's current state — status, activity timestamps and configuration — read live from the backing runtime session, so a resumed session reflects everything that has happened since it was opened.
|
|
6525
6525
|
*
|
|
6526
6526
|
*/
|
|
6527
6527
|
static getSession<ThrowOnError extends boolean = false>(options: Options<GetSessionData, ThrowOnError>): RequestResult<GetSessionResponses, GetSessionErrors, ThrowOnError>;
|
|
@@ -6610,7 +6610,7 @@ declare class Tools {
|
|
|
6610
6610
|
/**
|
|
6611
6611
|
* Delete a tool
|
|
6612
6612
|
*
|
|
6613
|
-
* Deletes the backing
|
|
6613
|
+
* Deletes the backing runtime tool. Returns 409 if the tool is still attached to an agent (detach it first).
|
|
6614
6614
|
*
|
|
6615
6615
|
*/
|
|
6616
6616
|
static deleteTool<ThrowOnError extends boolean = false>(options: Options<DeleteToolData, ThrowOnError>): RequestResult<DeleteToolResponses, DeleteToolErrors, ThrowOnError>;
|