@work-shape/catalyst-asset-schemas 0.8.0-rc.1 → 0.8.0-rc.11
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.ts +2207 -21
- package/dist/index.js +1496 -79
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -4,6 +4,8 @@ import { z } from 'zod';
|
|
|
4
4
|
* The shape of an agent and of a skill as a file holds it. These are the public half of the
|
|
5
5
|
* asset model: a working copy, the command line tool and the instance read the same types.
|
|
6
6
|
*/
|
|
7
|
+
/** The configuration rights reported for an asset; publish applies to draft/published kinds. */
|
|
8
|
+
declare const ASSET_ACCESS_VERBS: readonly ["read", "write", "delete", "publish"];
|
|
7
9
|
declare const localeCodes: readonly ["en", "de"];
|
|
8
10
|
type LocaleCode = (typeof localeCodes)[number];
|
|
9
11
|
type LocalizedStringConfig = string | {
|
|
@@ -27,6 +29,11 @@ interface AgentConfig {
|
|
|
27
29
|
modelBindingId?: string;
|
|
28
30
|
reasoningEffort?: ReasoningEffortConfig;
|
|
29
31
|
fastMode?: boolean;
|
|
32
|
+
/**
|
|
33
|
+
* Whether a run of the agent goes on on its model binding's `fallback` when that binding is
|
|
34
|
+
* rate-limited or down. Unset is on.
|
|
35
|
+
*/
|
|
36
|
+
useModelFallback?: boolean;
|
|
30
37
|
/** Bindings users may pick for this agent in the chat, besides its own `modelBindingId`. */
|
|
31
38
|
userSelectableModelBindingIds?: string[];
|
|
32
39
|
/**
|
|
@@ -36,13 +43,24 @@ interface AgentConfig {
|
|
|
36
43
|
modelReasoningEfforts?: Record<string, ReasoningEffortConfig>;
|
|
37
44
|
maxSteps?: number;
|
|
38
45
|
toolNames: string[];
|
|
46
|
+
/**
|
|
47
|
+
* The other agents this agent may start as subagents with `run_agent`, besides itself. Each
|
|
48
|
+
* is started only where the person may use it in the conversation's workspace.
|
|
49
|
+
*/
|
|
50
|
+
subagentNames?: string[];
|
|
39
51
|
skillNames: string[];
|
|
40
52
|
/**
|
|
41
53
|
* The Knowledge Bases the agent answers from, by id. However many it lists, the agent has one
|
|
42
|
-
* tool over
|
|
54
|
+
* tool over those of tables, `knowledge.query`, and one over those of documents,
|
|
55
|
+
* `knowledge.search`. Missing means none.
|
|
43
56
|
*/
|
|
44
57
|
knowledgeBases?: string[];
|
|
45
58
|
initialPrompts: AgentInitialPromptConfig[];
|
|
59
|
+
/**
|
|
60
|
+
* An agent that ships with the platform: its fields as the release shipped them last. Only
|
|
61
|
+
* the release seed writes it; every other write keeps it as stored.
|
|
62
|
+
*/
|
|
63
|
+
shipped?: Record<string, unknown>;
|
|
46
64
|
}
|
|
47
65
|
interface SkillConfig {
|
|
48
66
|
name: string;
|
|
@@ -122,6 +140,35 @@ interface SkillResourceConfig {
|
|
|
122
140
|
mediaType: SkillResourceMediaType;
|
|
123
141
|
content: string;
|
|
124
142
|
}
|
|
143
|
+
/** Ordered from the narrowest App audience to the widest. */
|
|
144
|
+
declare const APP_AUDIENCES: readonly ["self", "workspace", "instance"];
|
|
145
|
+
|
|
146
|
+
/**
|
|
147
|
+
* The one AWS region the `aws-bedrock` model provider calls. Bedrock's data retention is set to
|
|
148
|
+
* `none` there and nowhere else, and the EU inference profiles route from it to EU regions only.
|
|
149
|
+
*/
|
|
150
|
+
declare const BEDROCK_REGION = "eu-central-1";
|
|
151
|
+
/** The twelve digits of an AWS account id, the provider's `accountId`. */
|
|
152
|
+
declare const AWS_ACCOUNT_ID: RegExp;
|
|
153
|
+
/**
|
|
154
|
+
* Why a model id is not one the `aws-bedrock` provider calls, or undefined for an application
|
|
155
|
+
* inference profile of the configured account in `BEDROCK_REGION`. A profile of another account
|
|
156
|
+
* is refused before anything is sent: the key would be shown to a resource this instance does
|
|
157
|
+
* not own. Usage on Bedrock is attributed to a consumer by its application inference profile and
|
|
158
|
+
* the consumer's credential may call that alone, so a model id or a shared profile is refused.
|
|
159
|
+
* The reason never repeats the id: an ARN holds the account id. The adapter and the CLI that
|
|
160
|
+
* writes the entry apply the same rule.
|
|
161
|
+
*/
|
|
162
|
+
declare function bedrockProfileRefusal(model: string, accountId: string): string | undefined;
|
|
163
|
+
|
|
164
|
+
/**
|
|
165
|
+
* How a release config file that `extends` another is read over it: objects merge key by key,
|
|
166
|
+
* the extending file winning; lists and values replace the base's wholesale. The instance's
|
|
167
|
+
* loader and the CLI that writes release config merge the same way.
|
|
168
|
+
*/
|
|
169
|
+
declare function mergeConfigObjects(base: Record<string, unknown>, overrides: Record<string, unknown>): Record<string, unknown>;
|
|
170
|
+
/** An object a config merges into, not a list or a YAML-derived value such as a Date. */
|
|
171
|
+
declare function isPlainConfigObject(value: unknown): value is Record<string, unknown>;
|
|
125
172
|
|
|
126
173
|
/**
|
|
127
174
|
* The values the HTTP contract of an instance is written with: scopes, actions, error codes
|
|
@@ -135,12 +182,12 @@ declare const FIRST_PARTY_AUTH_SCOPES: readonly ["*", "me:read", "me:delete", "c
|
|
|
135
182
|
type ChatSessionAuthScope = (typeof CHAT_SESSION_AUTH_SCOPES)[number];
|
|
136
183
|
type FirstPartyAuthScope = (typeof FIRST_PARTY_AUTH_SCOPES)[number];
|
|
137
184
|
type OperationScope = Exclude<FirstPartyAuthScope, "*">;
|
|
138
|
-
|
|
185
|
+
/**
|
|
186
|
+
* Every right of the platform, one file per domain under `contract-values/`. The order is kept:
|
|
187
|
+
* `GRANTABLE_ACTIONS` filters it, and the rights dialog lists rights in it.
|
|
188
|
+
*/
|
|
189
|
+
declare const ACTIONS: readonly ["agent.read", "agent.write", "agent.publish", "agent.approve", "agent.delete", "agent.use", "skill.read", "skill.write", "skill.delete", "skill.approve", "connection.read", "connection.use", "connection.write", "connection.delete", "connection.approve", "app.read", "app.write", "app.publish", "app.approve", "app.delete", "app.use", "workflow.read", "workflow.write", "workflow.publish", "workflow.approve", "workflow.delete", "workflow.use", "workflow.read_run_data", "data_store.read", "data_store.write", "data_store.publish", "data_store.delete", "data_store.insert", "data_store.execute", "data_store.records", "knowledge_base.read", "knowledge_base.write", "knowledge_base.ingest", "knowledge_base.publish", "knowledge_base.delete", "knowledge_base.use", "mail_sender.use", "guardrail.read", "guardrail.write", "guardrail.publish", "guardrail.delete", "operations.approve", "feedback.review", "users.manage", "users.delete", "usage.view", "limits.manage", "usage.view_users", "audit.view", "system.view", "jobs.retry", "api_access.manage", "service_principals.manage", "agent_models.manage", "roles.edit_built_in", "assets.release", "builder", "publisher"];
|
|
139
190
|
type PlatformAction = (typeof ACTIONS)[number];
|
|
140
|
-
/** A Namespace prefix: lowercase words joined by single hyphens, ending in one hyphen. */
|
|
141
|
-
declare const NAMESPACE_PREFIX_PATTERN: RegExp;
|
|
142
|
-
declare const NAMESPACE_PREFIX_MIN_LENGTH = 2;
|
|
143
|
-
declare const NAMESPACE_PREFIX_MAX_LENGTH = 32;
|
|
144
191
|
type AppErrorCode = (typeof APP_ERROR_CODES)[number];
|
|
145
192
|
/** The HTTP status every error code answers with. */
|
|
146
193
|
declare const APP_ERROR_STATUS_CODES: Record<AppErrorCode, number>;
|
|
@@ -154,11 +201,11 @@ declare const IDEMPOTENCY_KEY_MAX_LENGTH = 255;
|
|
|
154
201
|
declare const PROVIDER_PORTS: readonly ["models", "mail", "objectStorage", "sandbox", "secrets"];
|
|
155
202
|
type ProviderPort = (typeof PROVIDER_PORTS)[number];
|
|
156
203
|
/**
|
|
157
|
-
* Where a provider processes the data an instance sends it.
|
|
158
|
-
*
|
|
204
|
+
* Where a provider processes the data an instance sends it. Only `eu` admits personal
|
|
205
|
+
* Connections; other short strings describe routes outside that boundary.
|
|
159
206
|
*/
|
|
160
207
|
declare const PROVIDER_REGIONS: readonly ["eu", "global"];
|
|
161
|
-
type ProviderRegion =
|
|
208
|
+
type ProviderRegion = string;
|
|
162
209
|
/**
|
|
163
210
|
* Why a check failed. Product-owned and closed: it is all of a failure that reaches a log, the
|
|
164
211
|
* API or a page, so a provider's own error text, which can repeat a key or an address, cannot.
|
|
@@ -167,7 +214,7 @@ declare const PROVIDER_CHECK_ERROR_CLASSES: readonly ["unreachable", "timeout",
|
|
|
167
214
|
type ProviderCheckErrorClass = (typeof PROVIDER_CHECK_ERROR_CLASSES)[number];
|
|
168
215
|
/**
|
|
169
216
|
* The immutable machine name. It is part of every operation name of the Connection
|
|
170
|
-
* (`connection.<name>.<operation>`), so it holds no dot.
|
|
217
|
+
* (`connection.<name>.<operation>`), so it holds no dot.
|
|
171
218
|
*/
|
|
172
219
|
declare const CONNECTION_NAME_PATTERN: RegExp;
|
|
173
220
|
declare const CONNECTION_NAME_MAX_LENGTH = 64;
|
|
@@ -189,8 +236,16 @@ declare const CONNECTION_HEALTH_STATES: readonly ["unknown", "ok", "failed", "ne
|
|
|
189
236
|
type ConnectionHealth = (typeof CONNECTION_HEALTH_STATES)[number];
|
|
190
237
|
declare const GRANT_HOLDER_KINDS: readonly ["user", "service_principal", "role", "group"];
|
|
191
238
|
type GrantHolderKind = (typeof GRANT_HOLDER_KINDS)[number];
|
|
192
|
-
declare const GRANT_SCOPE_KINDS: readonly ["instance", "workspace", "
|
|
239
|
+
declare const GRANT_SCOPE_KINDS: readonly ["instance", "workspace", "asset"];
|
|
193
240
|
type GrantScopeKind = (typeof GRANT_SCOPE_KINDS)[number];
|
|
241
|
+
/** Where a role's grant lies: the whole instance, one workspace or one asset. */
|
|
242
|
+
declare const ROLE_GRANT_SCOPE_KINDS: readonly ["instance", "workspace", "asset"];
|
|
243
|
+
type RoleGrantScopeKind = (typeof ROLE_GRANT_SCOPE_KINDS)[number];
|
|
244
|
+
/** What a release did to an action of a built-in role's default that waits for a decision. */
|
|
245
|
+
declare const ROLE_PENDING_CHANGES: readonly ["added", "removed"];
|
|
246
|
+
/** The decision on a pending action: apply what the release did, or dismiss it. */
|
|
247
|
+
declare const ROLE_PENDING_DECISIONS: readonly ["apply", "dismiss"];
|
|
248
|
+
type RolePendingDecision = (typeof ROLE_PENDING_DECISIONS)[number];
|
|
194
249
|
declare const GRANT_EFFECTS: readonly ["allow", "deny"];
|
|
195
250
|
type GrantEffect = (typeof GRANT_EFFECTS)[number];
|
|
196
251
|
declare const ACCESS_SOURCES: readonly ["role", "legacy_ref", "grant", "membership"];
|
|
@@ -203,12 +258,34 @@ declare const ADMINISTERED_USER_STATUSES: readonly ["active", "disabled", "delet
|
|
|
203
258
|
type AdministeredUserStatus = (typeof ADMINISTERED_USER_STATUSES)[number];
|
|
204
259
|
declare const SERVICE_PRINCIPAL_STATUSES: readonly ["active", "disabled"];
|
|
205
260
|
type ServicePrincipalStatus = (typeof SERVICE_PRINCIPAL_STATUSES)[number];
|
|
261
|
+
/**
|
|
262
|
+
* When the account a Workflow runs as needs a right its definition names. `publish`: the
|
|
263
|
+
* publish is refused without it. `run`: the step that needs it fails when it runs.
|
|
264
|
+
*/
|
|
265
|
+
declare const WORKFLOW_RIGHT_NEEDED_FOR: readonly ["publish", "run"];
|
|
266
|
+
/** The revision of a publish's Workflow the rights are read from: the one published, or a live child. */
|
|
267
|
+
declare const WORKFLOW_RIGHTS_REVISIONS: readonly ["draft", "published"];
|
|
268
|
+
/** How the account a Workflow names stands: a principal's status, or no principal of the name. */
|
|
269
|
+
declare const WORKFLOW_RUN_ACCOUNT_STATUSES: readonly ["active", "disabled", "unknown"];
|
|
270
|
+
/**
|
|
271
|
+
* Why a reader cannot give an account a right it lacks. `not_grantable`: nobody can give it to
|
|
272
|
+
* an account here. `not_administrator`: giving needs someone who administers technical
|
|
273
|
+
* accounts. `not_held`: the reader does not hold it there. `account_unavailable`: the account
|
|
274
|
+
* is missing or disabled. `asset_unavailable`: no active asset of the name exists.
|
|
275
|
+
*/
|
|
276
|
+
declare const WORKFLOW_RIGHT_REFUSALS: readonly ["not_grantable", "not_administrator", "not_held", "account_unavailable", "asset_unavailable", "not_visible"];
|
|
206
277
|
declare const SERVICE_PRINCIPAL_PERMISSIONS: readonly ["config_assets.read", "config_assets.release"];
|
|
207
278
|
type ServicePrincipalPermission = (typeof SERVICE_PRINCIPAL_PERMISSIONS)[number];
|
|
208
279
|
declare const API_CREDENTIAL_SCOPES: readonly ["config_assets:read", "config_assets:release"];
|
|
209
280
|
type ApiCredentialScope = (typeof API_CREDENTIAL_SCOPES)[number];
|
|
210
281
|
declare const APP_ERROR_CODES: readonly ["BAD_REQUEST", "UNAUTHENTICATED", "FORBIDDEN", "NOT_FOUND", "CONFLICT", "REVISION_CONFLICT", "PRECONDITION_REQUIRED", "TIMEOUT", "VALIDATION_FAILED", "RATE_LIMITED", "POLICY_DENIED", "GUARDRAIL_BLOCKED", "DECLINED", "IDEMPOTENCY_KEY_REUSED", "OPERATION_IN_PROGRESS", "OPERATION_EXPIRED", "OUTPUT_NOT_RETAINED", "INTERNAL"];
|
|
211
282
|
declare const OPERATION_EFFECTS: readonly ["reading", "changing"];
|
|
283
|
+
/** The parts a catalogue entry can bring: tools agents call, or a Knowledge Base source. */
|
|
284
|
+
declare const CATALOGUE_PARTS: readonly ["tools", "source"];
|
|
285
|
+
type CataloguePart = (typeof CATALOGUE_PARTS)[number];
|
|
286
|
+
/** The categories a catalogue entry's card is filed under. */
|
|
287
|
+
declare const CATALOGUE_CATEGORIES: readonly ["mail", "files", "accounting", "databases", "other"];
|
|
288
|
+
type CatalogueCategory = (typeof CATALOGUE_CATEGORIES)[number];
|
|
212
289
|
declare const OPERATION_TARGETS: readonly ["live", "test", "dry_run"];
|
|
213
290
|
type OperationTarget = (typeof OPERATION_TARGETS)[number];
|
|
214
291
|
declare const OPERATION_RUN_STATUSES: readonly ["running", "pending_confirmation", "pending_approval", "done", "failed", "denied", "expired"];
|
|
@@ -225,7 +302,7 @@ declare const APPROVAL_REQUEST_STATUSES: readonly ["pending", "approved", "rejec
|
|
|
225
302
|
type ApprovalRequestStatus = (typeof APPROVAL_REQUEST_STATUSES)[number];
|
|
226
303
|
declare const APPROVAL_CHECK_STATUSES: readonly ["passed", "warned", "blocked"];
|
|
227
304
|
type ApprovalCheckStatus = (typeof APPROVAL_CHECK_STATUSES)[number];
|
|
228
|
-
declare const APPROVAL_EXECUTIONS: readonly ["queued", "done", "failed", "interrupted", "refused", "expired"];
|
|
305
|
+
declare const APPROVAL_EXECUTIONS: readonly ["queued", "done", "failed", "interrupted", "refused", "expired", "held"];
|
|
229
306
|
type ApprovalExecution = (typeof APPROVAL_EXECUTIONS)[number];
|
|
230
307
|
declare const SKILL_CHANGE_TYPES: readonly ["replace", "add", "new_resource"];
|
|
231
308
|
type SkillChangeType = (typeof SKILL_CHANGE_TYPES)[number];
|
|
@@ -247,6 +324,12 @@ declare const CONFIG_ASSET_CHANGE_OPERATIONS: readonly ["create", "update", "del
|
|
|
247
324
|
type ConfigAssetChangeOperation = (typeof CONFIG_ASSET_CHANGE_OPERATIONS)[number];
|
|
248
325
|
declare const AGENT_AVAILABILITY_MODES: readonly ["all", "selected"];
|
|
249
326
|
type AgentAvailabilityMode = (typeof AGENT_AVAILABILITY_MODES)[number];
|
|
327
|
+
/**
|
|
328
|
+
* Who uses an agent where it is available (AGENT-USE-1): everyone who may work there, or only
|
|
329
|
+
* those `agent.use` allows on it. Every agent starts at `everyone`.
|
|
330
|
+
*/
|
|
331
|
+
declare const AGENT_USE_SETTINGS: readonly ["everyone", "granted"];
|
|
332
|
+
type AgentUse = (typeof AGENT_USE_SETTINGS)[number];
|
|
250
333
|
declare const AGENT_EDITABLE_FIELDS: readonly ["displayName", "description", "welcomeMessage", "welcomeSubtitle", "instructions", "modelBindingId", "reasoningEffort", "maxSteps", "toolNames", "skillNames", "knowledgeBases", "initialPrompts"];
|
|
251
334
|
type AgentEditableField = (typeof AGENT_EDITABLE_FIELDS)[number];
|
|
252
335
|
declare const ASSET_REPO_BUNDLE_KINDS: readonly ["full", "incremental"];
|
|
@@ -282,6 +365,9 @@ type OpenaiCompatibleApi = (typeof OPENAI_COMPATIBLE_APIS)[number];
|
|
|
282
365
|
declare const MODEL_PROVIDER_AUTH_MODES: readonly ["bearer", "api-key"];
|
|
283
366
|
type ModelProviderAuthMode = (typeof MODEL_PROVIDER_AUTH_MODES)[number];
|
|
284
367
|
declare const CONVERSATION_VISIBILITIES: readonly ["workspace", "private"];
|
|
368
|
+
/** A conversation a person has, or the run thread of a Child Agent Run. */
|
|
369
|
+
declare const CONVERSATION_KINDS: readonly ["chat", "run_thread"];
|
|
370
|
+
type ConversationKind = (typeof CONVERSATION_KINDS)[number];
|
|
285
371
|
type ConversationVisibility = (typeof CONVERSATION_VISIBILITIES)[number];
|
|
286
372
|
declare const WEB_SOURCE_PROVIDERS: readonly ["openai-native", "serper", "tavily", "firecrawl", "browserbase", "direct"];
|
|
287
373
|
type WebSourceProvider = (typeof WEB_SOURCE_PROVIDERS)[number];
|
|
@@ -293,7 +379,11 @@ declare const ATTACHMENT_CREATE_OUTCOMES: readonly ["created", "already_availabl
|
|
|
293
379
|
type AttachmentCreateOutcome = (typeof ATTACHMENT_CREATE_OUTCOMES)[number];
|
|
294
380
|
declare const STRUCTURED_DATA_REVIEW_REASONS: readonly ["uncertain", "conflicting"];
|
|
295
381
|
type StructuredDataReviewReason = (typeof STRUCTURED_DATA_REVIEW_REASONS)[number];
|
|
296
|
-
|
|
382
|
+
/** Queued: sent as the next turn. Steer: taken in by the author's own running turn (FU-2). */
|
|
383
|
+
declare const FOLLOW_UP_MODES: readonly ["queue", "steer"];
|
|
384
|
+
/** `consumed`: a steer the running turn took in; `dispatched`: started as a turn of its own. */
|
|
385
|
+
declare const FOLLOW_UP_STATUSES: readonly ["pending", "dispatched", "consumed", "cancelled"];
|
|
386
|
+
declare const AGENT_RUN_STATUSES: readonly ["queued", "running", "waiting_for_decision", "waiting_for_subagents", "cancelling", "completed", "cancelled", "failed"];
|
|
297
387
|
type AgentRunStatus = (typeof AGENT_RUN_STATUSES)[number];
|
|
298
388
|
declare const AGENT_RUN_FAILURE_CATEGORIES: readonly ["app_error", "internal_error", "runtime_interrupted", "abort_error", "unknown_error"];
|
|
299
389
|
type AgentRunFailureCategory = (typeof AGENT_RUN_FAILURE_CATEGORIES)[number];
|
|
@@ -301,6 +391,10 @@ declare const TOOL_INPUT_PARSE_ERROR_CODES: readonly ["invalid_json", "invalid_t
|
|
|
301
391
|
type ToolInputParseErrorCode = (typeof TOOL_INPUT_PARSE_ERROR_CODES)[number];
|
|
302
392
|
declare const WAITING_OPERATION_RUN_STATUSES: readonly ["pending_confirmation", "pending_approval"];
|
|
303
393
|
declare const OPERATION_CONFIRMATION_DECISIONS: readonly ["confirm", "decline"];
|
|
394
|
+
/** A person's own value for an operation (OP-6): Always allow, Ask me, Never. */
|
|
395
|
+
declare const PERSON_POLICY_SETTINGS: readonly ["always_allow", "ask", "never"];
|
|
396
|
+
/** How far a changing operation reaches. One that declares none counts as `irreversible`. */
|
|
397
|
+
declare const OPERATION_CHANGE_CLASSES: readonly ["reversible", "irreversible", "outward"];
|
|
304
398
|
declare const TOOL_DECISION_MODES: readonly ["confirm", "approval"];
|
|
305
399
|
declare const TOOL_DECISION_OUTCOMES: readonly ["confirmed", "declined", "expired", "cancelled"];
|
|
306
400
|
declare const TOOL_CALL_STATES: readonly ["input_available", "waiting_for_decision", "output_available", "output_error"];
|
|
@@ -333,8 +427,39 @@ declare const CONNECTION_OPERATION_STATUSES: readonly ["ready", "awaiting_discov
|
|
|
333
427
|
type ConnectionOperationStatus = (typeof CONNECTION_OPERATION_STATUSES)[number];
|
|
334
428
|
declare const CONNECTION_SECRET_STATES: readonly ["set", "not_set", "unreadable"];
|
|
335
429
|
type ConnectionSecretState = (typeof CONNECTION_SECRET_STATES)[number];
|
|
336
|
-
declare const CONNECTOR_TEST_STATUSES: readonly ["ready", "unauthorized", "network_denied", "unavailable"];
|
|
430
|
+
declare const CONNECTOR_TEST_STATUSES: readonly ["ready", "unauthorized", "network_denied", "unavailable", "oauth_required"];
|
|
337
431
|
type ConnectorTestStatus = (typeof CONNECTOR_TEST_STATUSES)[number];
|
|
432
|
+
/** Shared account, or the acting person's own account. */
|
|
433
|
+
declare const CONNECTION_CREDENTIAL_MODES: readonly ["shared", "user"];
|
|
434
|
+
type ConnectionCredentialMode = (typeof CONNECTION_CREDENTIAL_MODES)[number];
|
|
435
|
+
/**
|
|
436
|
+
* The state of a Connection's sign-in. `connected`: calls use it. `needs_reconnect`: the
|
|
437
|
+
* outside system refused it and a new sign-in is needed. `revoked`: someone disconnected it,
|
|
438
|
+
* or its Connection went away.
|
|
439
|
+
*/
|
|
440
|
+
declare const CONNECTION_BINDING_STATES: readonly ["connected", "needs_reconnect", "revoked"];
|
|
441
|
+
type ConnectionBindingState = (typeof CONNECTION_BINDING_STATES)[number];
|
|
442
|
+
/** What a chat Connection proposal's card needs to start setup or sign-in. */
|
|
443
|
+
declare const CONNECTION_PROPOSAL_STATES: readonly ["ready", "needs_setup"];
|
|
444
|
+
type ConnectionProposalState = (typeof CONNECTION_PROPOSAL_STATES)[number];
|
|
445
|
+
declare const CONNECTION_PROPOSAL_BINDING_STATES: readonly ["connected", "needs_reconnect", "not_connected"];
|
|
446
|
+
type ConnectionProposalBindingState = (typeof CONNECTION_PROPOSAL_BINDING_STATES)[number];
|
|
447
|
+
/** What a refused call of a personal Connection needs of its person: a first or a new sign-in. */
|
|
448
|
+
declare const CONNECTION_SIGN_IN_NEEDS: readonly ["not_connected", "needs_reconnect"];
|
|
449
|
+
type ConnectionSignInNeed = (typeof CONNECTION_SIGN_IN_NEEDS)[number];
|
|
450
|
+
/**
|
|
451
|
+
* How a Connection that signs in with OAuth has its client: registered by the platform
|
|
452
|
+
* (Dynamic Client Registration), issued by the provider and named in the settings, or the
|
|
453
|
+
* operator's managed client of release config (`infrastructure.oauthClients`, MS-APP-1).
|
|
454
|
+
*/
|
|
455
|
+
declare const CONNECTION_OAUTH_REGISTRATIONS: readonly ["dcr", "preregistered", "managed"];
|
|
456
|
+
type ConnectionOAuthRegistration = (typeof CONNECTION_OAUTH_REGISTRATIONS)[number];
|
|
457
|
+
/**
|
|
458
|
+
* What the provider answered to the revocation of a sign-in (RFC 7009): it confirmed, it
|
|
459
|
+
* failed or was not reached, or it lists no revocation endpoint and was sent nothing.
|
|
460
|
+
*/
|
|
461
|
+
declare const CONNECTION_PROVIDER_REVOCATIONS: readonly ["confirmed", "failed", "not_offered"];
|
|
462
|
+
type ConnectionProviderRevocation = (typeof CONNECTION_PROVIDER_REVOCATIONS)[number];
|
|
338
463
|
declare const CONNECTION_ORIGINS: readonly ["release", "runtime"];
|
|
339
464
|
type ConnectionOrigin = (typeof CONNECTION_ORIGINS)[number];
|
|
340
465
|
declare const CONNECTION_NETWORKS: readonly ["public", "private"];
|
|
@@ -351,19 +476,111 @@ declare const DATA_STORE_STATUSES: readonly ["provisioning", "ready", "retired"]
|
|
|
351
476
|
type DataStoreStatus = (typeof DATA_STORE_STATUSES)[number];
|
|
352
477
|
declare const DATA_STORE_MIGRATION_OUTCOMES: readonly ["none", "pending", "applied", "failed"];
|
|
353
478
|
type DataStoreMigrationOutcome = (typeof DATA_STORE_MIGRATION_OUTCOMES)[number];
|
|
354
|
-
|
|
479
|
+
/**
|
|
480
|
+
* `unchecked` until the first check; `preparing` while the store a Knowledge Base of documents
|
|
481
|
+
* owns is still being made; then `ok` or `needs_attention`.
|
|
482
|
+
*/
|
|
483
|
+
declare const KNOWLEDGE_BASE_STATUSES: readonly ["unchecked", "preparing", "ok", "needs_attention"];
|
|
355
484
|
type KnowledgeBaseStatus = (typeof KNOWLEDGE_BASE_STATUSES)[number];
|
|
485
|
+
/**
|
|
486
|
+
* The embedding of a Knowledge Base that searches by meaning. `current`: its index embeds with
|
|
487
|
+
* the model it is set to. `reindex_needed`: the index's model is gone from the instance, so
|
|
488
|
+
* search answers by words and titles alone. `reindex_available`: it is set to another model
|
|
489
|
+
* than its index uses. `reindexing`: a new index is being built beside the one search reads.
|
|
490
|
+
* `none`: nothing is embedded yet.
|
|
491
|
+
*/
|
|
492
|
+
declare const KNOWLEDGE_EMBEDDING_STATES: readonly ["current", "reindex_needed", "reindex_available", "reindexing", "none"];
|
|
493
|
+
/**
|
|
494
|
+
* What the page of a Knowledge Base shows of one document. `pending` is added and not yet
|
|
495
|
+
* searchable: waiting for its index job, being indexed or waiting for extraction. `indexed` is
|
|
496
|
+
* found by search. `failed` carries one of `KNOWLEDGE_DOCUMENT_FAILURE_CODES`; Retry puts it
|
|
497
|
+
* back to `pending`.
|
|
498
|
+
*/
|
|
499
|
+
declare const KNOWLEDGE_DOCUMENT_STATES: readonly ["pending", "indexed", "failed"];
|
|
500
|
+
type KnowledgeDocumentState = (typeof KNOWLEDGE_DOCUMENT_STATES)[number];
|
|
501
|
+
/**
|
|
502
|
+
* The largest file a Knowledge Base takes, as document processing takes it. A larger file is
|
|
503
|
+
* refused when it is added, with this limit named.
|
|
504
|
+
*/
|
|
505
|
+
declare const KNOWLEDGE_FILE_MAX_BYTES: number;
|
|
506
|
+
/**
|
|
507
|
+
* Why a document was not indexed. The first five and `knowledge_file_too_many_pages` can also
|
|
508
|
+
* come from the extraction of a PDF or DOCX (`KNOWLEDGE_EXTRACTION_FAILURE_CODES` in core); the
|
|
509
|
+
* rest are the index job's own. The list only gains members.
|
|
510
|
+
*/
|
|
511
|
+
declare const KNOWLEDGE_DOCUMENT_FAILURE_CODES: readonly ["knowledge_file_format_unsupported", "knowledge_file_over_limit", "knowledge_file_unreadable", "knowledge_file_missing", "knowledge_extraction_failed", "knowledge_file_format_unavailable", "knowledge_text_unreadable", "knowledge_text_empty", "knowledge_index_failed", "knowledge_file_too_many_pages", "knowledge_processor_output_invalid", "knowledge_conversion_timeout"];
|
|
512
|
+
type KnowledgeDocumentFailureCode = (typeof KNOWLEDGE_DOCUMENT_FAILURE_CODES)[number];
|
|
513
|
+
/**
|
|
514
|
+
* Why a `pending` document waits, where it waits for something other than its turn. It goes on
|
|
515
|
+
* by itself once the cause is gone.
|
|
516
|
+
*/
|
|
517
|
+
declare const KNOWLEDGE_DOCUMENT_WAIT_CODES: readonly ["knowledge_usage_limit_reached"];
|
|
518
|
+
type KnowledgeDocumentWaitCode = (typeof KNOWLEDGE_DOCUMENT_WAIT_CODES)[number];
|
|
519
|
+
/**
|
|
520
|
+
* Why a synced source of a Knowledge Base, or one item of it, did not come in. Beside the
|
|
521
|
+
* document codes: an item over the size limit or of a format the instance does not read is
|
|
522
|
+
* recorded with `knowledge_file_over_limit` or `knowledge_file_format_unsupported` and never
|
|
523
|
+
* fetched. Spec: Synced sources, Contract freezes (SRC-0).
|
|
524
|
+
*/
|
|
525
|
+
declare const KNOWLEDGE_SOURCE_FAILURE_CODES: readonly ["knowledge_source_unreachable", "knowledge_source_refused", "knowledge_fetch_failed", "knowledge_source_limit_reached", "knowledge_item_invalid", "knowledge_fetch_not_allowed", "knowledge_ingest_cancelled", "knowledge_item_removed"];
|
|
526
|
+
type KnowledgeSourceFailureCode = (typeof KNOWLEDGE_SOURCE_FAILURE_CODES)[number];
|
|
527
|
+
/** The code a failed item of a synced source carries: a source code, or one it shares with a file added by hand. */
|
|
528
|
+
declare const KNOWLEDGE_SOURCE_ITEM_FAILURE_CODES: readonly ["knowledge_source_unreachable", "knowledge_source_refused", "knowledge_fetch_failed", "knowledge_source_limit_reached", "knowledge_item_invalid", "knowledge_fetch_not_allowed", "knowledge_ingest_cancelled", "knowledge_item_removed", "knowledge_file_over_limit", "knowledge_file_format_unsupported"];
|
|
529
|
+
type KnowledgeSourceItemFailureCode = (typeof KNOWLEDGE_SOURCE_ITEM_FAILURE_CODES)[number];
|
|
530
|
+
/**
|
|
531
|
+
* The state of an item of a synced source as the sync keeps it. It ends at `fetched`: from
|
|
532
|
+
* then on the item shows its document's state. `withdrawn` is out of search.
|
|
533
|
+
*/
|
|
534
|
+
declare const KNOWLEDGE_SOURCE_ITEM_STATES: readonly ["discovered", "fetched", "failed", "withdrawn"];
|
|
535
|
+
type KnowledgeSourceItemState = (typeof KNOWLEDGE_SOURCE_ITEM_STATES)[number];
|
|
536
|
+
/**
|
|
537
|
+
* How a sync of a source walks it: `initial` and `full` list every item below its folders,
|
|
538
|
+
* `changes` reads the source's change feed from the stored cursor, and `ingest` is one call
|
|
539
|
+
* of `knowledge.<id>.ingest` from a Workflow into its Workflow-fed source.
|
|
540
|
+
*/
|
|
541
|
+
declare const KNOWLEDGE_SYNC_MODES: readonly ["initial", "changes", "full", "ingest"];
|
|
542
|
+
type KnowledgeSyncMode = (typeof KNOWLEDGE_SYNC_MODES)[number];
|
|
543
|
+
declare const KNOWLEDGE_SYNC_RUN_STATES: readonly ["running", "done", "failed", "superseded"];
|
|
544
|
+
type KnowledgeSyncRunState = (typeof KNOWLEDGE_SYNC_RUN_STATES)[number];
|
|
545
|
+
/** What a sync run counts, in this order wherever it shows them. */
|
|
546
|
+
declare const KNOWLEDGE_SYNC_COUNTS: readonly ["discovered", "added", "changed", "moved", "withdrawn", "failed", "skipped"];
|
|
547
|
+
type KnowledgeSyncCount = (typeof KNOWLEDGE_SYNC_COUNTS)[number];
|
|
548
|
+
/**
|
|
549
|
+
* The ranked lists a search on the built-in backend fuses: cosine distance to the query's
|
|
550
|
+
* embedding, German and English full text, and the words of a document's title and file name.
|
|
551
|
+
*/
|
|
552
|
+
declare const KNOWLEDGE_SEARCH_SIGNALS: readonly ["semantic", "keyword", "title"];
|
|
553
|
+
type KnowledgeSearchSignal = (typeof KNOWLEDGE_SEARCH_SIGNALS)[number];
|
|
356
554
|
declare const DATABASE_RELATION_TYPES: readonly ["table", "view", "materialized_view", "foreign_table"];
|
|
357
555
|
type DatabaseRelationType = (typeof DATABASE_RELATION_TYPES)[number];
|
|
358
|
-
declare const WORKFLOW_RUN_STATUSES: readonly ["queued", "running", "waiting", "done", "failed", "cancelled", "limit_reached"];
|
|
556
|
+
declare const WORKFLOW_RUN_STATUSES: readonly ["continued", "queued", "running", "waiting", "done", "failed", "cancelled", "limit_reached"];
|
|
359
557
|
type WorkflowRunStatus = (typeof WORKFLOW_RUN_STATUSES)[number];
|
|
360
558
|
declare const WORKFLOW_STEP_TYPES: readonly ["trigger", "operation", "loop", "code", "output", "agent", "notify", "workflow"];
|
|
361
559
|
type WorkflowStepType = (typeof WORKFLOW_STEP_TYPES)[number];
|
|
560
|
+
/**
|
|
561
|
+
* The step types this release executes. The engine accepts no definition that names another,
|
|
562
|
+
* and the interface offers no other in its palette (workflow-canvas 9.6). A list of its own, so
|
|
563
|
+
* it can be narrower than `WORKFLOW_STEP_TYPES` while a known type is not run yet.
|
|
564
|
+
*/
|
|
565
|
+
declare const WORKFLOW_EXECUTED_STEP_TYPES: readonly ["trigger", "operation", "loop", "code", "output", "agent", "notify", "workflow"];
|
|
362
566
|
declare const WORKFLOW_RESERVED_STEP_TYPES: readonly ["condition", "parallel"];
|
|
363
567
|
type WorkflowReservedStepType = (typeof WORKFLOW_RESERVED_STEP_TYPES)[number];
|
|
364
568
|
declare const WORKFLOW_TRIGGER_KINDS: readonly ["manual", "schedule", "parent"];
|
|
365
569
|
type WorkflowTriggerKind = (typeof WORKFLOW_TRIGGER_KINDS)[number];
|
|
366
570
|
declare const NOTIFY_CHANNELS: readonly ["inbox", "mail"];
|
|
571
|
+
/**
|
|
572
|
+
* What an operation step's facts name as its source (`stepFacts`, workflow-canvas.md 9.8). A
|
|
573
|
+
* step on `mail.send` names its sender as `mail_sender`, with the sender's icon key as
|
|
574
|
+
* `service` (`MAIL_SENDER_SYSTEM_ICON`, or a Connection's service).
|
|
575
|
+
*/
|
|
576
|
+
declare const WORKFLOW_STEP_SOURCE_KINDS: readonly ["connection", "data_store", "knowledge_base", "workflow", "mail_sender", "other"];
|
|
577
|
+
type WorkflowStepSourceKind = (typeof WORKFLOW_STEP_SOURCE_KINDS)[number];
|
|
578
|
+
/**
|
|
579
|
+
* What an operation a step may call belongs to (`operations.list_callable`, WF-EDIT-3). `other`
|
|
580
|
+
* is an operation of the release.
|
|
581
|
+
*/
|
|
582
|
+
declare const OPERATION_SOURCE_KINDS: readonly ["connection", "data_store", "knowledge_base", "workflow", "other"];
|
|
583
|
+
type OperationSourceKind = (typeof OPERATION_SOURCE_KINDS)[number];
|
|
367
584
|
type NotifyChannel = (typeof NOTIFY_CHANNELS)[number];
|
|
368
585
|
declare const PRINCIPAL_HOLDER_KINDS: readonly ["user", "service_principal"];
|
|
369
586
|
type PrincipalHolderKind = (typeof PRINCIPAL_HOLDER_KINDS)[number];
|
|
@@ -375,13 +592,19 @@ declare const CONNECTION_OPERATION_POLICIES: readonly ["deny", "approval"];
|
|
|
375
592
|
type ConnectionOperationPolicy = (typeof CONNECTION_OPERATION_POLICIES)[number];
|
|
376
593
|
declare const WORKFLOW_RUN_MODES: readonly ["live", "test"];
|
|
377
594
|
type WorkflowRunMode = (typeof WORKFLOW_RUN_MODES)[number];
|
|
595
|
+
/**
|
|
596
|
+
* Which revision of a Workflow a test run an App's draft started ran (DP-1): its draft, for a
|
|
597
|
+
* tester who may write it, or its published revision.
|
|
598
|
+
*/
|
|
599
|
+
declare const WORKFLOW_TEST_REVISIONS: readonly ["draft", "published"];
|
|
600
|
+
type WorkflowTestRevision = (typeof WORKFLOW_TEST_REVISIONS)[number];
|
|
378
601
|
declare const APP_ACTION_CALL_STATUSES: readonly ["done", "pending_approval"];
|
|
379
602
|
type AppActionCallStatus = (typeof APP_ACTION_CALL_STATUSES)[number];
|
|
380
603
|
declare const OPERATIONS_AUDIENCES: readonly ["workflow", "app"];
|
|
381
604
|
type OperationsAudience = (typeof OPERATIONS_AUDIENCES)[number];
|
|
382
605
|
declare const DECIDED_APPROVAL_REQUEST_STATUSES: readonly ["approved", "rejected", "changes_requested", "superseded", "withdrawn", "reverted"];
|
|
383
606
|
type DecidedApprovalRequestStatus = (typeof DECIDED_APPROVAL_REQUEST_STATUSES)[number];
|
|
384
|
-
declare const ENDED_APPROVAL_EXECUTIONS: readonly ["done", "failed", "interrupted", "refused", "expired"];
|
|
607
|
+
declare const ENDED_APPROVAL_EXECUTIONS: readonly ["done", "failed", "interrupted", "refused", "expired", "held"];
|
|
385
608
|
type EndedApprovalExecution = (typeof ENDED_APPROVAL_EXECUTIONS)[number];
|
|
386
609
|
declare const GUARDRAIL_HIT_OUTCOMES: readonly ["warn", "require_approval", "block"];
|
|
387
610
|
type GuardrailHitOutcome = (typeof GUARDRAIL_HIT_OUTCOMES)[number];
|
|
@@ -393,9 +616,16 @@ declare const USER_STATUSES: readonly ["active", "disabled"];
|
|
|
393
616
|
type UserStatus = (typeof USER_STATUSES)[number];
|
|
394
617
|
declare const MESSAGE_FINISH_STATUSES: readonly ["completed", "cancelled"];
|
|
395
618
|
type MessageFinishStatus = (typeof MESSAGE_FINISH_STATUSES)[number];
|
|
619
|
+
/**
|
|
620
|
+
* Why a run went on with its binding's fallback, as the person reads it: the model was
|
|
621
|
+
* overloaded (`rate_limit`) or could not be reached (`unavailable`: a server error, a timeout or
|
|
622
|
+
* a lost connection).
|
|
623
|
+
*/
|
|
624
|
+
declare const MODEL_FALLBACK_REASONS: readonly ["rate_limit", "unavailable"];
|
|
625
|
+
type ModelFallbackReason = (typeof MODEL_FALLBACK_REASONS)[number];
|
|
396
626
|
declare const ENDED_AGENT_RUN_STATUSES: readonly ["completed", "cancelled", "failed"];
|
|
397
627
|
type EndedAgentRunStatus = (typeof ENDED_AGENT_RUN_STATUSES)[number];
|
|
398
|
-
declare const ACTIVE_AGENT_RUN_STATUSES: readonly ["queued", "running", "waiting_for_decision", "cancelling"];
|
|
628
|
+
declare const ACTIVE_AGENT_RUN_STATUSES: readonly ["queued", "running", "waiting_for_decision", "waiting_for_subagents", "cancelling"];
|
|
399
629
|
type ActiveAgentRunStatus = (typeof ACTIVE_AGENT_RUN_STATUSES)[number];
|
|
400
630
|
declare const ARTIFACT_PREVIEW_IMAGE_MIME_TYPES: readonly ["image/png", "image/jpeg", "image/webp"];
|
|
401
631
|
type ArtifactPreviewImageMimeType = (typeof ARTIFACT_PREVIEW_IMAGE_MIME_TYPES)[number];
|
|
@@ -407,13 +637,32 @@ declare const AUDIT_EVENT_STATUSES: readonly ["success", "failed", "denied"];
|
|
|
407
637
|
type AuditEventStatus = (typeof AUDIT_EVENT_STATUSES)[number];
|
|
408
638
|
declare const LISTED_DATA_STORE_STATUSES: readonly ["provisioning", "ready"];
|
|
409
639
|
type ListedDataStoreStatus = (typeof LISTED_DATA_STORE_STATUSES)[number];
|
|
410
|
-
declare const KNOWLEDGE_CHECK_STATUSES: readonly ["ok", "needs_attention"];
|
|
640
|
+
declare const KNOWLEDGE_CHECK_STATUSES: readonly ["preparing", "ok", "needs_attention"];
|
|
411
641
|
type KnowledgeCheckStatus = (typeof KNOWLEDGE_CHECK_STATUSES)[number];
|
|
412
642
|
declare const WORKFLOW_STEP_RUN_STATUSES: readonly ["queued", "running", "waiting", "done", "failed", "cancelled"];
|
|
413
643
|
type WorkflowStepRunStatus = (typeof WORKFLOW_STEP_RUN_STATUSES)[number];
|
|
414
|
-
declare const WORKFLOW_ENDED_STATUSES: readonly ["done", "failed", "cancelled", "limit_reached"];
|
|
644
|
+
declare const WORKFLOW_ENDED_STATUSES: readonly ["continued", "done", "failed", "cancelled", "limit_reached"];
|
|
415
645
|
type WorkflowEndedStatus = (typeof WORKFLOW_ENDED_STATUSES)[number];
|
|
646
|
+
/** A released Managed File keeps its identity; original bytes live at the synced source. */
|
|
647
|
+
declare const MANAGED_FILE_STATUSES: readonly ["available", "released", "deleted"];
|
|
648
|
+
/** A Workflow automates a process unless it fills or processes data. */
|
|
649
|
+
declare const WORKFLOW_KINDS: readonly ["process", "data"];
|
|
650
|
+
type WorkflowKind = (typeof WORKFLOW_KINDS)[number];
|
|
651
|
+
/** Wire formats for a streamed Workflow result dataset. */
|
|
652
|
+
declare const WORKFLOW_DATASET_DOWNLOAD_FORMATS: readonly ["jsonl", "csv"];
|
|
653
|
+
type WorkflowDatasetDownloadFormat = (typeof WORKFLOW_DATASET_DOWNLOAD_FORMATS)[number];
|
|
654
|
+
/** Instance resources whose use may be inherited through workspace availability. */
|
|
655
|
+
declare const WORKSPACE_USE_ASSET_KINDS: readonly ["knowledge_base", "connection"];
|
|
656
|
+
/** Published assets that consume Connections or stored data. Agents hold tools separately. */
|
|
657
|
+
declare const PUBLISHED_DATA_CONSUMER_KINDS: readonly ["app", "workflow", "knowledge_base"];
|
|
658
|
+
type PublishedDataConsumerKind = (typeof PUBLISHED_DATA_CONSUMER_KINDS)[number];
|
|
659
|
+
/** State of a scheduled prompt. */
|
|
660
|
+
declare const SCHEDULED_START_STATES: readonly ["active", "paused"];
|
|
661
|
+
/** Which revision answered an agent preview turn. */
|
|
662
|
+
declare const AGENT_PREVIEW_SOURCES: readonly ["draft", "live"];
|
|
416
663
|
|
|
664
|
+
/** A short operator declaration of where a provider processes data. */
|
|
665
|
+
declare const providerRegionSchema: z.ZodString;
|
|
417
666
|
declare const localizedStringSchema: z.ZodUnion<readonly [z.ZodString, z.ZodObject<{
|
|
418
667
|
en: z.ZodOptional<z.ZodString>;
|
|
419
668
|
de: z.ZodOptional<z.ZodString>;
|
|
@@ -583,6 +832,7 @@ declare const agentConfigSchema: z.ZodObject<{
|
|
|
583
832
|
max: "max";
|
|
584
833
|
}>>;
|
|
585
834
|
fastMode: z.ZodOptional<z.ZodBoolean>;
|
|
835
|
+
useModelFallback: z.ZodOptional<z.ZodBoolean>;
|
|
586
836
|
userSelectableModelBindingIds: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
587
837
|
modelReasoningEfforts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodEnum<{
|
|
588
838
|
none: "none";
|
|
@@ -594,6 +844,7 @@ declare const agentConfigSchema: z.ZodObject<{
|
|
|
594
844
|
}>>>;
|
|
595
845
|
maxSteps: z.ZodOptional<z.ZodNumber>;
|
|
596
846
|
toolNames: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
847
|
+
subagentNames: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
597
848
|
skillNames: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
598
849
|
knowledgeBases: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
599
850
|
initialPrompts: z.ZodDefault<z.ZodArray<z.ZodObject<{
|
|
@@ -606,6 +857,7 @@ declare const agentConfigSchema: z.ZodObject<{
|
|
|
606
857
|
de: z.ZodOptional<z.ZodString>;
|
|
607
858
|
}, z.core.$strict>]>;
|
|
608
859
|
}, z.core.$strip>>>;
|
|
860
|
+
shipped: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
609
861
|
}, z.core.$strip>;
|
|
610
862
|
/** The id of a Workflow, which is the name of its asset: part of `workflow.<id>.start`. */
|
|
611
863
|
declare const WORKFLOW_NAME_PATTERN: RegExp;
|
|
@@ -632,6 +884,15 @@ declare const workflowConfigSchema: z.ZodObject<{
|
|
|
632
884
|
}, z.core.$strict>;
|
|
633
885
|
type WorkflowAssetConfig = z.infer<typeof workflowConfigSchema>;
|
|
634
886
|
|
|
887
|
+
/** Why a reference is refused as a secret name. It never repeats the reference. */
|
|
888
|
+
declare const SECRET_NAME_EXPECTATION = "expected the name of an environment variable such as MODEL_API_KEY (upper-case words joined by underscores, at most 64 characters); the value given does not read as one and looks like a credential value";
|
|
889
|
+
/**
|
|
890
|
+
* True for text that is safe to repeat as the name of a secret: it reads as an environment
|
|
891
|
+
* variable name and not as a credential. Anything else is refused as a name and is never put
|
|
892
|
+
* into a message, a log line or an error. The instance and the CLI apply the same rule.
|
|
893
|
+
*/
|
|
894
|
+
declare function isSecretName(value: string): boolean;
|
|
895
|
+
|
|
635
896
|
/**
|
|
636
897
|
* Why a frontmatter is refused before its fields are read: for an alias, for its depth, or
|
|
637
898
|
* for the size of what it holds beside the name, the title and the description.
|
|
@@ -756,4 +1017,1929 @@ declare class YamlDataError extends Error {
|
|
|
756
1017
|
/** `readYamlData` for a caller that reports a refused file as an error: it throws `YamlDataError`. */
|
|
757
1018
|
declare function loadYamlData(text: string, file: string): unknown;
|
|
758
1019
|
|
|
759
|
-
|
|
1020
|
+
declare const knowledgeSyncInputSchema: z.ZodObject<{
|
|
1021
|
+
source: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
1022
|
+
mode: z.ZodOptional<z.ZodEnum<{
|
|
1023
|
+
full: "full";
|
|
1024
|
+
changes: "changes";
|
|
1025
|
+
}>>;
|
|
1026
|
+
confirm: z.ZodOptional<z.ZodBoolean>;
|
|
1027
|
+
}, z.core.$strict>;
|
|
1028
|
+
type KnowledgeSyncInput = z.infer<typeof knowledgeSyncInputSchema>;
|
|
1029
|
+
/** What a sync run ends with: the result of its Operation Run, and a Workflow step's output. */
|
|
1030
|
+
declare const knowledgeSyncResultSchema: z.ZodObject<{
|
|
1031
|
+
syncRunId: z.ZodString;
|
|
1032
|
+
source: z.ZodString;
|
|
1033
|
+
mode: z.ZodEnum<{
|
|
1034
|
+
full: "full";
|
|
1035
|
+
initial: "initial";
|
|
1036
|
+
changes: "changes";
|
|
1037
|
+
ingest: "ingest";
|
|
1038
|
+
}>;
|
|
1039
|
+
reason: z.ZodOptional<z.ZodEnum<{
|
|
1040
|
+
cursor_expired: "cursor_expired";
|
|
1041
|
+
}>>;
|
|
1042
|
+
state: z.ZodEnum<{
|
|
1043
|
+
failed: "failed";
|
|
1044
|
+
running: "running";
|
|
1045
|
+
done: "done";
|
|
1046
|
+
superseded: "superseded";
|
|
1047
|
+
}>;
|
|
1048
|
+
counts: z.ZodObject<{
|
|
1049
|
+
discovered: z.ZodNumber;
|
|
1050
|
+
added: z.ZodNumber;
|
|
1051
|
+
changed: z.ZodNumber;
|
|
1052
|
+
moved: z.ZodNumber;
|
|
1053
|
+
withdrawn: z.ZodNumber;
|
|
1054
|
+
failed: z.ZodNumber;
|
|
1055
|
+
skipped: z.ZodNumber;
|
|
1056
|
+
}, z.core.$strict>;
|
|
1057
|
+
bytesFetched: z.ZodNumber;
|
|
1058
|
+
failureCode: z.ZodOptional<z.ZodEnum<{
|
|
1059
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1060
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1061
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1062
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1063
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1064
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1065
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1066
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1067
|
+
}>>;
|
|
1068
|
+
startedAt: z.ZodString;
|
|
1069
|
+
endedAt: z.ZodOptional<z.ZodString>;
|
|
1070
|
+
}, z.core.$strict>;
|
|
1071
|
+
type KnowledgeSyncResult = z.infer<typeof knowledgeSyncResultSchema>;
|
|
1072
|
+
/**
|
|
1073
|
+
* What the page shows of an item: its own state up to `fetched`, then its document's.
|
|
1074
|
+
* "Gefunden", "Geladen", "Durchsuchbar", "Fehlgeschlagen", "Entfernt".
|
|
1075
|
+
*/
|
|
1076
|
+
declare const KNOWLEDGE_SOURCE_ITEM_SHOWN_STATES: readonly ["discovered", "fetched", "indexed", "failed", "withdrawn"];
|
|
1077
|
+
type KnowledgeSourceItemShownState = (typeof KNOWLEDGE_SOURCE_ITEM_SHOWN_STATES)[number];
|
|
1078
|
+
/**
|
|
1079
|
+
* A first pass that stopped at 10,000 items and waits for one confirmation (KB-ISO-1b): what the
|
|
1080
|
+
* whole pass holds and what it would cost, estimated from the listed sizes with a factor per
|
|
1081
|
+
* format. Counts and sizes only, never a name.
|
|
1082
|
+
*/
|
|
1083
|
+
declare const knowledgeFirstPassConfirmationSchema: z.ZodObject<{
|
|
1084
|
+
syncRunId: z.ZodString;
|
|
1085
|
+
items: z.ZodNumber;
|
|
1086
|
+
bytes: z.ZodNumber;
|
|
1087
|
+
stop: z.ZodNumber;
|
|
1088
|
+
tokens: z.ZodOptional<z.ZodObject<{
|
|
1089
|
+
min: z.ZodNumber;
|
|
1090
|
+
max: z.ZodNumber;
|
|
1091
|
+
}, z.core.$strict>>;
|
|
1092
|
+
passages: z.ZodOptional<z.ZodObject<{
|
|
1093
|
+
min: z.ZodNumber;
|
|
1094
|
+
max: z.ZodNumber;
|
|
1095
|
+
}, z.core.$strict>>;
|
|
1096
|
+
model: z.ZodOptional<z.ZodString>;
|
|
1097
|
+
cost: z.ZodOptional<z.ZodObject<{
|
|
1098
|
+
min: z.ZodNumber;
|
|
1099
|
+
max: z.ZodNumber;
|
|
1100
|
+
currency: z.ZodString;
|
|
1101
|
+
}, z.core.$strict>>;
|
|
1102
|
+
room: z.ZodOptional<z.ZodBoolean>;
|
|
1103
|
+
storeBytes: z.ZodNumber;
|
|
1104
|
+
addedBytes: z.ZodOptional<z.ZodNumber>;
|
|
1105
|
+
limitBytes: z.ZodOptional<z.ZodNumber>;
|
|
1106
|
+
}, z.core.$strict>;
|
|
1107
|
+
type KnowledgeFirstPassConfirmation = z.infer<typeof knowledgeFirstPassConfirmationSchema>;
|
|
1108
|
+
declare const knowledgeSourcesOutputSchema: z.ZodObject<{
|
|
1109
|
+
sources: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
1110
|
+
id: z.ZodString;
|
|
1111
|
+
connection: z.ZodString;
|
|
1112
|
+
kind: z.ZodOptional<z.ZodLiteral<"connector">>;
|
|
1113
|
+
items: z.ZodObject<{
|
|
1114
|
+
discovered: z.ZodNumber;
|
|
1115
|
+
fetched: z.ZodNumber;
|
|
1116
|
+
indexed: z.ZodNumber;
|
|
1117
|
+
failed: z.ZodNumber;
|
|
1118
|
+
withdrawn: z.ZodNumber;
|
|
1119
|
+
}, z.core.$strict>;
|
|
1120
|
+
failures: z.ZodArray<z.ZodObject<{
|
|
1121
|
+
code: z.ZodUnion<readonly [z.ZodEnum<{
|
|
1122
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1123
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1124
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1125
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1126
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1127
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1128
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1129
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1130
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1131
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1132
|
+
}>, z.ZodEnum<{
|
|
1133
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1134
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1135
|
+
knowledge_file_unreadable: "knowledge_file_unreadable";
|
|
1136
|
+
knowledge_file_missing: "knowledge_file_missing";
|
|
1137
|
+
knowledge_extraction_failed: "knowledge_extraction_failed";
|
|
1138
|
+
knowledge_file_format_unavailable: "knowledge_file_format_unavailable";
|
|
1139
|
+
knowledge_text_unreadable: "knowledge_text_unreadable";
|
|
1140
|
+
knowledge_text_empty: "knowledge_text_empty";
|
|
1141
|
+
knowledge_index_failed: "knowledge_index_failed";
|
|
1142
|
+
knowledge_file_too_many_pages: "knowledge_file_too_many_pages";
|
|
1143
|
+
knowledge_processor_output_invalid: "knowledge_processor_output_invalid";
|
|
1144
|
+
knowledge_conversion_timeout: "knowledge_conversion_timeout";
|
|
1145
|
+
}>]>;
|
|
1146
|
+
count: z.ZodNumber;
|
|
1147
|
+
}, z.core.$strict>>;
|
|
1148
|
+
running: z.ZodOptional<z.ZodObject<{
|
|
1149
|
+
syncRunId: z.ZodString;
|
|
1150
|
+
mode: z.ZodEnum<{
|
|
1151
|
+
full: "full";
|
|
1152
|
+
initial: "initial";
|
|
1153
|
+
changes: "changes";
|
|
1154
|
+
ingest: "ingest";
|
|
1155
|
+
}>;
|
|
1156
|
+
startedAt: z.ZodString;
|
|
1157
|
+
itemsPerMinute: z.ZodOptional<z.ZodNumber>;
|
|
1158
|
+
estimatedEndAt: z.ZodOptional<z.ZodString>;
|
|
1159
|
+
}, z.core.$strict>>;
|
|
1160
|
+
last: z.ZodOptional<z.ZodObject<{
|
|
1161
|
+
syncRunId: z.ZodString;
|
|
1162
|
+
source: z.ZodString;
|
|
1163
|
+
mode: z.ZodEnum<{
|
|
1164
|
+
full: "full";
|
|
1165
|
+
initial: "initial";
|
|
1166
|
+
changes: "changes";
|
|
1167
|
+
ingest: "ingest";
|
|
1168
|
+
}>;
|
|
1169
|
+
reason: z.ZodOptional<z.ZodEnum<{
|
|
1170
|
+
cursor_expired: "cursor_expired";
|
|
1171
|
+
}>>;
|
|
1172
|
+
state: z.ZodEnum<{
|
|
1173
|
+
failed: "failed";
|
|
1174
|
+
running: "running";
|
|
1175
|
+
done: "done";
|
|
1176
|
+
superseded: "superseded";
|
|
1177
|
+
}>;
|
|
1178
|
+
counts: z.ZodObject<{
|
|
1179
|
+
discovered: z.ZodNumber;
|
|
1180
|
+
added: z.ZodNumber;
|
|
1181
|
+
changed: z.ZodNumber;
|
|
1182
|
+
moved: z.ZodNumber;
|
|
1183
|
+
withdrawn: z.ZodNumber;
|
|
1184
|
+
failed: z.ZodNumber;
|
|
1185
|
+
skipped: z.ZodNumber;
|
|
1186
|
+
}, z.core.$strict>;
|
|
1187
|
+
bytesFetched: z.ZodNumber;
|
|
1188
|
+
failureCode: z.ZodOptional<z.ZodEnum<{
|
|
1189
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1190
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1191
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1192
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1193
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1194
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1195
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1196
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1197
|
+
}>>;
|
|
1198
|
+
startedAt: z.ZodString;
|
|
1199
|
+
endedAt: z.ZodOptional<z.ZodString>;
|
|
1200
|
+
}, z.core.$strict>>;
|
|
1201
|
+
confirmation: z.ZodOptional<z.ZodObject<{
|
|
1202
|
+
syncRunId: z.ZodString;
|
|
1203
|
+
items: z.ZodNumber;
|
|
1204
|
+
bytes: z.ZodNumber;
|
|
1205
|
+
stop: z.ZodNumber;
|
|
1206
|
+
tokens: z.ZodOptional<z.ZodObject<{
|
|
1207
|
+
min: z.ZodNumber;
|
|
1208
|
+
max: z.ZodNumber;
|
|
1209
|
+
}, z.core.$strict>>;
|
|
1210
|
+
passages: z.ZodOptional<z.ZodObject<{
|
|
1211
|
+
min: z.ZodNumber;
|
|
1212
|
+
max: z.ZodNumber;
|
|
1213
|
+
}, z.core.$strict>>;
|
|
1214
|
+
model: z.ZodOptional<z.ZodString>;
|
|
1215
|
+
cost: z.ZodOptional<z.ZodObject<{
|
|
1216
|
+
min: z.ZodNumber;
|
|
1217
|
+
max: z.ZodNumber;
|
|
1218
|
+
currency: z.ZodString;
|
|
1219
|
+
}, z.core.$strict>>;
|
|
1220
|
+
room: z.ZodOptional<z.ZodBoolean>;
|
|
1221
|
+
storeBytes: z.ZodNumber;
|
|
1222
|
+
addedBytes: z.ZodOptional<z.ZodNumber>;
|
|
1223
|
+
limitBytes: z.ZodOptional<z.ZodNumber>;
|
|
1224
|
+
}, z.core.$strict>>;
|
|
1225
|
+
lastChangeAt: z.ZodOptional<z.ZodString>;
|
|
1226
|
+
oldestOpenChangeAt: z.ZodOptional<z.ZodString>;
|
|
1227
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1228
|
+
id: z.ZodString;
|
|
1229
|
+
kind: z.ZodLiteral<"workflow">;
|
|
1230
|
+
workflowId: z.ZodString;
|
|
1231
|
+
running: z.ZodOptional<z.ZodObject<{
|
|
1232
|
+
syncRunId: z.ZodString;
|
|
1233
|
+
mode: z.ZodEnum<{
|
|
1234
|
+
full: "full";
|
|
1235
|
+
initial: "initial";
|
|
1236
|
+
changes: "changes";
|
|
1237
|
+
ingest: "ingest";
|
|
1238
|
+
}>;
|
|
1239
|
+
startedAt: z.ZodString;
|
|
1240
|
+
itemsPerMinute: z.ZodOptional<z.ZodNumber>;
|
|
1241
|
+
estimatedEndAt: z.ZodOptional<z.ZodString>;
|
|
1242
|
+
}, z.core.$strict>>;
|
|
1243
|
+
failures: z.ZodArray<z.ZodObject<{
|
|
1244
|
+
code: z.ZodUnion<readonly [z.ZodEnum<{
|
|
1245
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1246
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1247
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1248
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1249
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1250
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1251
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1252
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1253
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1254
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1255
|
+
}>, z.ZodEnum<{
|
|
1256
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1257
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1258
|
+
knowledge_file_unreadable: "knowledge_file_unreadable";
|
|
1259
|
+
knowledge_file_missing: "knowledge_file_missing";
|
|
1260
|
+
knowledge_extraction_failed: "knowledge_extraction_failed";
|
|
1261
|
+
knowledge_file_format_unavailable: "knowledge_file_format_unavailable";
|
|
1262
|
+
knowledge_text_unreadable: "knowledge_text_unreadable";
|
|
1263
|
+
knowledge_text_empty: "knowledge_text_empty";
|
|
1264
|
+
knowledge_index_failed: "knowledge_index_failed";
|
|
1265
|
+
knowledge_file_too_many_pages: "knowledge_file_too_many_pages";
|
|
1266
|
+
knowledge_processor_output_invalid: "knowledge_processor_output_invalid";
|
|
1267
|
+
knowledge_conversion_timeout: "knowledge_conversion_timeout";
|
|
1268
|
+
}>]>;
|
|
1269
|
+
count: z.ZodNumber;
|
|
1270
|
+
}, z.core.$strict>>;
|
|
1271
|
+
items: z.ZodObject<{
|
|
1272
|
+
discovered: z.ZodNumber;
|
|
1273
|
+
fetched: z.ZodNumber;
|
|
1274
|
+
indexed: z.ZodNumber;
|
|
1275
|
+
failed: z.ZodNumber;
|
|
1276
|
+
withdrawn: z.ZodNumber;
|
|
1277
|
+
}, z.core.$strict>;
|
|
1278
|
+
last: z.ZodOptional<z.ZodObject<{
|
|
1279
|
+
syncRunId: z.ZodString;
|
|
1280
|
+
source: z.ZodString;
|
|
1281
|
+
mode: z.ZodEnum<{
|
|
1282
|
+
full: "full";
|
|
1283
|
+
initial: "initial";
|
|
1284
|
+
changes: "changes";
|
|
1285
|
+
ingest: "ingest";
|
|
1286
|
+
}>;
|
|
1287
|
+
reason: z.ZodOptional<z.ZodEnum<{
|
|
1288
|
+
cursor_expired: "cursor_expired";
|
|
1289
|
+
}>>;
|
|
1290
|
+
state: z.ZodEnum<{
|
|
1291
|
+
failed: "failed";
|
|
1292
|
+
running: "running";
|
|
1293
|
+
done: "done";
|
|
1294
|
+
superseded: "superseded";
|
|
1295
|
+
}>;
|
|
1296
|
+
counts: z.ZodObject<{
|
|
1297
|
+
discovered: z.ZodNumber;
|
|
1298
|
+
added: z.ZodNumber;
|
|
1299
|
+
changed: z.ZodNumber;
|
|
1300
|
+
moved: z.ZodNumber;
|
|
1301
|
+
withdrawn: z.ZodNumber;
|
|
1302
|
+
failed: z.ZodNumber;
|
|
1303
|
+
skipped: z.ZodNumber;
|
|
1304
|
+
}, z.core.$strict>;
|
|
1305
|
+
bytesFetched: z.ZodNumber;
|
|
1306
|
+
failureCode: z.ZodOptional<z.ZodEnum<{
|
|
1307
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1308
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1309
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1310
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1311
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1312
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1313
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1314
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1315
|
+
}>>;
|
|
1316
|
+
startedAt: z.ZodString;
|
|
1317
|
+
endedAt: z.ZodOptional<z.ZodString>;
|
|
1318
|
+
}, z.core.$strict>>;
|
|
1319
|
+
confirmation: z.ZodOptional<z.ZodObject<{
|
|
1320
|
+
syncRunId: z.ZodString;
|
|
1321
|
+
items: z.ZodNumber;
|
|
1322
|
+
bytes: z.ZodNumber;
|
|
1323
|
+
stop: z.ZodNumber;
|
|
1324
|
+
tokens: z.ZodOptional<z.ZodObject<{
|
|
1325
|
+
min: z.ZodNumber;
|
|
1326
|
+
max: z.ZodNumber;
|
|
1327
|
+
}, z.core.$strict>>;
|
|
1328
|
+
passages: z.ZodOptional<z.ZodObject<{
|
|
1329
|
+
min: z.ZodNumber;
|
|
1330
|
+
max: z.ZodNumber;
|
|
1331
|
+
}, z.core.$strict>>;
|
|
1332
|
+
model: z.ZodOptional<z.ZodString>;
|
|
1333
|
+
cost: z.ZodOptional<z.ZodObject<{
|
|
1334
|
+
min: z.ZodNumber;
|
|
1335
|
+
max: z.ZodNumber;
|
|
1336
|
+
currency: z.ZodString;
|
|
1337
|
+
}, z.core.$strict>>;
|
|
1338
|
+
room: z.ZodOptional<z.ZodBoolean>;
|
|
1339
|
+
storeBytes: z.ZodNumber;
|
|
1340
|
+
addedBytes: z.ZodOptional<z.ZodNumber>;
|
|
1341
|
+
limitBytes: z.ZodOptional<z.ZodNumber>;
|
|
1342
|
+
}, z.core.$strict>>;
|
|
1343
|
+
lastChangeAt: z.ZodOptional<z.ZodString>;
|
|
1344
|
+
oldestOpenChangeAt: z.ZodOptional<z.ZodString>;
|
|
1345
|
+
}, z.core.$strict>]>>;
|
|
1346
|
+
}, z.core.$strict>;
|
|
1347
|
+
type KnowledgeSourcesOutput = z.infer<typeof knowledgeSourcesOutputSchema>;
|
|
1348
|
+
declare const knowledgeSourceItemsInputSchema: z.ZodObject<{
|
|
1349
|
+
source: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
1350
|
+
state: z.ZodOptional<z.ZodEnum<{
|
|
1351
|
+
failed: "failed";
|
|
1352
|
+
withdrawn: "withdrawn";
|
|
1353
|
+
indexed: "indexed";
|
|
1354
|
+
discovered: "discovered";
|
|
1355
|
+
fetched: "fetched";
|
|
1356
|
+
}>>;
|
|
1357
|
+
failureCode: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
|
|
1358
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1359
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1360
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1361
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1362
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1363
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1364
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1365
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1366
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1367
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1368
|
+
}>, z.ZodEnum<{
|
|
1369
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1370
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1371
|
+
knowledge_file_unreadable: "knowledge_file_unreadable";
|
|
1372
|
+
knowledge_file_missing: "knowledge_file_missing";
|
|
1373
|
+
knowledge_extraction_failed: "knowledge_extraction_failed";
|
|
1374
|
+
knowledge_file_format_unavailable: "knowledge_file_format_unavailable";
|
|
1375
|
+
knowledge_text_unreadable: "knowledge_text_unreadable";
|
|
1376
|
+
knowledge_text_empty: "knowledge_text_empty";
|
|
1377
|
+
knowledge_index_failed: "knowledge_index_failed";
|
|
1378
|
+
knowledge_file_too_many_pages: "knowledge_file_too_many_pages";
|
|
1379
|
+
knowledge_processor_output_invalid: "knowledge_processor_output_invalid";
|
|
1380
|
+
knowledge_conversion_timeout: "knowledge_conversion_timeout";
|
|
1381
|
+
}>]>>;
|
|
1382
|
+
limit: z.ZodOptional<z.ZodCoercedNumber<unknown>>;
|
|
1383
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
1384
|
+
}, z.core.$strict>;
|
|
1385
|
+
type KnowledgeSourceItemsInput = z.infer<typeof knowledgeSourceItemsInputSchema>;
|
|
1386
|
+
declare const knowledgeSourceItemsOutputSchema: z.ZodObject<{
|
|
1387
|
+
items: z.ZodArray<z.ZodObject<{
|
|
1388
|
+
id: z.ZodString;
|
|
1389
|
+
itemId: z.ZodString;
|
|
1390
|
+
name: z.ZodString;
|
|
1391
|
+
path: z.ZodString;
|
|
1392
|
+
state: z.ZodEnum<{
|
|
1393
|
+
failed: "failed";
|
|
1394
|
+
withdrawn: "withdrawn";
|
|
1395
|
+
indexed: "indexed";
|
|
1396
|
+
discovered: "discovered";
|
|
1397
|
+
fetched: "fetched";
|
|
1398
|
+
}>;
|
|
1399
|
+
failureCode: z.ZodOptional<z.ZodUnion<readonly [z.ZodEnum<{
|
|
1400
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1401
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1402
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1403
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1404
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1405
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1406
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1407
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1408
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1409
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1410
|
+
}>, z.ZodEnum<{
|
|
1411
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1412
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1413
|
+
knowledge_file_unreadable: "knowledge_file_unreadable";
|
|
1414
|
+
knowledge_file_missing: "knowledge_file_missing";
|
|
1415
|
+
knowledge_extraction_failed: "knowledge_extraction_failed";
|
|
1416
|
+
knowledge_file_format_unavailable: "knowledge_file_format_unavailable";
|
|
1417
|
+
knowledge_text_unreadable: "knowledge_text_unreadable";
|
|
1418
|
+
knowledge_text_empty: "knowledge_text_empty";
|
|
1419
|
+
knowledge_index_failed: "knowledge_index_failed";
|
|
1420
|
+
knowledge_file_too_many_pages: "knowledge_file_too_many_pages";
|
|
1421
|
+
knowledge_processor_output_invalid: "knowledge_processor_output_invalid";
|
|
1422
|
+
knowledge_conversion_timeout: "knowledge_conversion_timeout";
|
|
1423
|
+
}>]>>;
|
|
1424
|
+
documentId: z.ZodOptional<z.ZodString>;
|
|
1425
|
+
originLink: z.ZodOptional<z.ZodString>;
|
|
1426
|
+
changedAt: z.ZodString;
|
|
1427
|
+
}, z.core.$strict>>;
|
|
1428
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
1429
|
+
}, z.core.$strict>;
|
|
1430
|
+
type KnowledgeSourceItemsOutput = z.infer<typeof knowledgeSourceItemsOutputSchema>;
|
|
1431
|
+
/**
|
|
1432
|
+
* KB-5c's retry, widened: documents by id, or items of a source by id, by failure code or all
|
|
1433
|
+
* failed ones. A failed fetch is fetched again; a failed document of a synced source is
|
|
1434
|
+
* fetched and indexed again, because its original is not kept.
|
|
1435
|
+
*/
|
|
1436
|
+
declare const knowledgeRetryInputSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
1437
|
+
documentIds: z.ZodArray<z.ZodString>;
|
|
1438
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1439
|
+
source: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
1440
|
+
sourceItemIds: z.ZodArray<z.ZodString>;
|
|
1441
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1442
|
+
source: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
1443
|
+
failureCode: z.ZodUnion<readonly [z.ZodEnum<{
|
|
1444
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1445
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1446
|
+
knowledge_source_unreachable: "knowledge_source_unreachable";
|
|
1447
|
+
knowledge_source_refused: "knowledge_source_refused";
|
|
1448
|
+
knowledge_fetch_failed: "knowledge_fetch_failed";
|
|
1449
|
+
knowledge_source_limit_reached: "knowledge_source_limit_reached";
|
|
1450
|
+
knowledge_item_invalid: "knowledge_item_invalid";
|
|
1451
|
+
knowledge_fetch_not_allowed: "knowledge_fetch_not_allowed";
|
|
1452
|
+
knowledge_ingest_cancelled: "knowledge_ingest_cancelled";
|
|
1453
|
+
knowledge_item_removed: "knowledge_item_removed";
|
|
1454
|
+
}>, z.ZodEnum<{
|
|
1455
|
+
knowledge_file_format_unsupported: "knowledge_file_format_unsupported";
|
|
1456
|
+
knowledge_file_over_limit: "knowledge_file_over_limit";
|
|
1457
|
+
knowledge_file_unreadable: "knowledge_file_unreadable";
|
|
1458
|
+
knowledge_file_missing: "knowledge_file_missing";
|
|
1459
|
+
knowledge_extraction_failed: "knowledge_extraction_failed";
|
|
1460
|
+
knowledge_file_format_unavailable: "knowledge_file_format_unavailable";
|
|
1461
|
+
knowledge_text_unreadable: "knowledge_text_unreadable";
|
|
1462
|
+
knowledge_text_empty: "knowledge_text_empty";
|
|
1463
|
+
knowledge_index_failed: "knowledge_index_failed";
|
|
1464
|
+
knowledge_file_too_many_pages: "knowledge_file_too_many_pages";
|
|
1465
|
+
knowledge_processor_output_invalid: "knowledge_processor_output_invalid";
|
|
1466
|
+
knowledge_conversion_timeout: "knowledge_conversion_timeout";
|
|
1467
|
+
}>]>;
|
|
1468
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1469
|
+
source: z.ZodUnion<readonly [z.ZodString, z.ZodString]>;
|
|
1470
|
+
all: z.ZodLiteral<true>;
|
|
1471
|
+
}, z.core.$strict>]>;
|
|
1472
|
+
type KnowledgeRetryInput = z.infer<typeof knowledgeRetryInputSchema>;
|
|
1473
|
+
declare const knowledgeRetryOutputSchema: z.ZodObject<{
|
|
1474
|
+
documents: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1475
|
+
id: z.ZodString;
|
|
1476
|
+
state: z.ZodEnum<{
|
|
1477
|
+
failed: "failed";
|
|
1478
|
+
pending: "pending";
|
|
1479
|
+
indexed: "indexed";
|
|
1480
|
+
}>;
|
|
1481
|
+
}, z.core.$strict>>>;
|
|
1482
|
+
queued: z.ZodNumber;
|
|
1483
|
+
released: z.ZodOptional<z.ZodNumber>;
|
|
1484
|
+
}, z.core.$strict>;
|
|
1485
|
+
type KnowledgeRetryOutput = z.infer<typeof knowledgeRetryOutputSchema>;
|
|
1486
|
+
declare const knowledgeLocateInputSchema: z.ZodObject<{
|
|
1487
|
+
sourceItemId: z.ZodString;
|
|
1488
|
+
}, z.core.$strict>;
|
|
1489
|
+
type KnowledgeLocateInput = z.infer<typeof knowledgeLocateInputSchema>;
|
|
1490
|
+
/** An item's state and times, and no content, name or path. */
|
|
1491
|
+
declare const knowledgeLocateOutputSchema: z.ZodObject<{
|
|
1492
|
+
sourceItemId: z.ZodString;
|
|
1493
|
+
source: z.ZodString;
|
|
1494
|
+
itemId: z.ZodString;
|
|
1495
|
+
state: z.ZodEnum<{
|
|
1496
|
+
failed: "failed";
|
|
1497
|
+
withdrawn: "withdrawn";
|
|
1498
|
+
indexed: "indexed";
|
|
1499
|
+
discovered: "discovered";
|
|
1500
|
+
fetched: "fetched";
|
|
1501
|
+
}>;
|
|
1502
|
+
discoveredAt: z.ZodString;
|
|
1503
|
+
fetchedAt: z.ZodOptional<z.ZodString>;
|
|
1504
|
+
withdrawnAt: z.ZodOptional<z.ZodString>;
|
|
1505
|
+
purgedAt: z.ZodOptional<z.ZodString>;
|
|
1506
|
+
removedAt: z.ZodOptional<z.ZodString>;
|
|
1507
|
+
}, z.core.$strict>;
|
|
1508
|
+
type KnowledgeLocateOutput = z.infer<typeof knowledgeLocateOutputSchema>;
|
|
1509
|
+
/**
|
|
1510
|
+
* The delete question of a Workflow (KBW-2c): the Knowledge Bases its source feeds, each with
|
|
1511
|
+
* how many documents it holds there, which a delete withdraws. Those the reader may not open are
|
|
1512
|
+
* counted only, by number of Knowledge Bases and documents, and never named.
|
|
1513
|
+
*/
|
|
1514
|
+
declare const knowledgeWorkflowSourcesOutputSchema: z.ZodObject<{
|
|
1515
|
+
knowledgeBases: z.ZodArray<z.ZodObject<{
|
|
1516
|
+
name: z.ZodString;
|
|
1517
|
+
title: z.ZodString;
|
|
1518
|
+
documents: z.ZodNumber;
|
|
1519
|
+
}, z.core.$strict>>;
|
|
1520
|
+
hidden: z.ZodObject<{
|
|
1521
|
+
knowledgeBases: z.ZodNumber;
|
|
1522
|
+
documents: z.ZodNumber;
|
|
1523
|
+
}, z.core.$strict>;
|
|
1524
|
+
}, z.core.$strict>;
|
|
1525
|
+
type KnowledgeWorkflowSourcesOutput = z.infer<typeof knowledgeWorkflowSourcesOutputSchema>;
|
|
1526
|
+
|
|
1527
|
+
/** Dataset checkpoints exposed in Workflow metadata; rows remain in object storage. */
|
|
1528
|
+
declare const WORKFLOW_DATASET_STATES: readonly ["writing", "complete", "deleted"];
|
|
1529
|
+
type WorkflowDatasetState = (typeof WORKFLOW_DATASET_STATES)[number];
|
|
1530
|
+
|
|
1531
|
+
/** The reference kept in step data; rows live in the owning run's dataset. */
|
|
1532
|
+
declare const workflowDatasetReferenceSchema: z.ZodObject<{
|
|
1533
|
+
$dataset: z.ZodString;
|
|
1534
|
+
rowCount: z.ZodNumber;
|
|
1535
|
+
bytes: z.ZodNumber;
|
|
1536
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1537
|
+
}, z.core.$strict>;
|
|
1538
|
+
/** One row of a batch's failures dataset, preserving the input item for a retry. */
|
|
1539
|
+
declare const operationBatchFailureSchema: z.ZodObject<{
|
|
1540
|
+
item: z.ZodJSONSchema;
|
|
1541
|
+
code: z.ZodString;
|
|
1542
|
+
message: z.ZodString;
|
|
1543
|
+
}, z.core.$strict>;
|
|
1544
|
+
/** One failed item never fails the call or its neighbours. */
|
|
1545
|
+
declare const operationBatchResultSchema: z.ZodObject<{
|
|
1546
|
+
done: z.ZodNumber;
|
|
1547
|
+
failed: z.ZodNumber;
|
|
1548
|
+
failures: z.ZodObject<{
|
|
1549
|
+
$dataset: z.ZodString;
|
|
1550
|
+
rowCount: z.ZodNumber;
|
|
1551
|
+
bytes: z.ZodNumber;
|
|
1552
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1553
|
+
}, z.core.$strict>;
|
|
1554
|
+
}, z.core.$strict>;
|
|
1555
|
+
type OperationBatchResult = z.infer<typeof operationBatchResultSchema>;
|
|
1556
|
+
type OperationBatchFailure = z.infer<typeof operationBatchFailureSchema>;
|
|
1557
|
+
|
|
1558
|
+
/** Reserved until CONN-DL: the Workflow's account must be allowed to use this Connection. */
|
|
1559
|
+
declare const knowledgeIngestFetchSchema: z.ZodObject<{
|
|
1560
|
+
connection: z.ZodString;
|
|
1561
|
+
operation: z.ZodString;
|
|
1562
|
+
input: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1563
|
+
}, z.core.$strict>;
|
|
1564
|
+
/** Exactly one content, in both the TypeScript type and the runtime schema. */
|
|
1565
|
+
declare const knowledgeIngestItemSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
1566
|
+
itemId: z.ZodString;
|
|
1567
|
+
version: z.ZodString;
|
|
1568
|
+
name: z.ZodString;
|
|
1569
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1570
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1571
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1572
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1573
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1574
|
+
text: z.ZodString;
|
|
1575
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1576
|
+
itemId: z.ZodString;
|
|
1577
|
+
version: z.ZodString;
|
|
1578
|
+
name: z.ZodString;
|
|
1579
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1580
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1581
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1582
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1583
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1584
|
+
fileId: z.ZodString;
|
|
1585
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1586
|
+
itemId: z.ZodString;
|
|
1587
|
+
version: z.ZodString;
|
|
1588
|
+
name: z.ZodString;
|
|
1589
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1590
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1591
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1592
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1593
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1594
|
+
fetch: z.ZodObject<{
|
|
1595
|
+
connection: z.ZodString;
|
|
1596
|
+
operation: z.ZodString;
|
|
1597
|
+
input: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1598
|
+
}, z.core.$strict>;
|
|
1599
|
+
}, z.core.$strict>]>;
|
|
1600
|
+
type KnowledgeIngestItem = z.infer<typeof knowledgeIngestItemSchema>;
|
|
1601
|
+
declare const knowledgeIngestInputSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
1602
|
+
items: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
1603
|
+
itemId: z.ZodString;
|
|
1604
|
+
version: z.ZodString;
|
|
1605
|
+
name: z.ZodString;
|
|
1606
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1607
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1608
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1609
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1610
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1611
|
+
text: z.ZodString;
|
|
1612
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1613
|
+
itemId: z.ZodString;
|
|
1614
|
+
version: z.ZodString;
|
|
1615
|
+
name: z.ZodString;
|
|
1616
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1617
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1618
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1619
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1620
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1621
|
+
fileId: z.ZodString;
|
|
1622
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1623
|
+
itemId: z.ZodString;
|
|
1624
|
+
version: z.ZodString;
|
|
1625
|
+
name: z.ZodString;
|
|
1626
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1627
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1628
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1629
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1630
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1631
|
+
fetch: z.ZodObject<{
|
|
1632
|
+
connection: z.ZodString;
|
|
1633
|
+
operation: z.ZodString;
|
|
1634
|
+
input: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1635
|
+
}, z.core.$strict>;
|
|
1636
|
+
}, z.core.$strict>]>>;
|
|
1637
|
+
complete: z.ZodOptional<z.ZodBoolean>;
|
|
1638
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1639
|
+
dataset: z.ZodObject<{
|
|
1640
|
+
$dataset: z.ZodString;
|
|
1641
|
+
rowCount: z.ZodNumber;
|
|
1642
|
+
bytes: z.ZodNumber;
|
|
1643
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1644
|
+
}, z.core.$strict>;
|
|
1645
|
+
complete: z.ZodOptional<z.ZodBoolean>;
|
|
1646
|
+
}, z.core.$strict>]>;
|
|
1647
|
+
declare const knowledgeIngestOutputSchema: z.ZodObject<{
|
|
1648
|
+
done: z.ZodNumber;
|
|
1649
|
+
failed: z.ZodNumber;
|
|
1650
|
+
failures: z.ZodObject<{
|
|
1651
|
+
$dataset: z.ZodString;
|
|
1652
|
+
rowCount: z.ZodNumber;
|
|
1653
|
+
bytes: z.ZodNumber;
|
|
1654
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1655
|
+
}, z.core.$strict>;
|
|
1656
|
+
accepted: z.ZodNumber;
|
|
1657
|
+
withdrawn: z.ZodNumber;
|
|
1658
|
+
}, z.core.$strict>;
|
|
1659
|
+
declare const knowledgeWithdrawInputSchema: z.ZodObject<{
|
|
1660
|
+
itemIds: z.ZodArray<z.ZodString>;
|
|
1661
|
+
}, z.core.$strict>;
|
|
1662
|
+
declare const knowledgeWithdrawOutputSchema: z.ZodObject<{
|
|
1663
|
+
withdrawn: z.ZodNumber;
|
|
1664
|
+
}, z.core.$strict>;
|
|
1665
|
+
declare const knowledgePendingInputSchema: z.ZodObject<{
|
|
1666
|
+
type: z.ZodOptional<z.ZodString>;
|
|
1667
|
+
since: z.ZodOptional<z.ZodISODateTime>;
|
|
1668
|
+
limit: z.ZodNumber;
|
|
1669
|
+
}, z.core.$strict>;
|
|
1670
|
+
declare const knowledgePendingRowSchema: z.ZodObject<{
|
|
1671
|
+
id: z.ZodString;
|
|
1672
|
+
type: z.ZodString;
|
|
1673
|
+
contentHash: z.ZodString;
|
|
1674
|
+
pages: z.ZodObject<{
|
|
1675
|
+
$dataset: z.ZodString;
|
|
1676
|
+
rowCount: z.ZodNumber;
|
|
1677
|
+
bytes: z.ZodNumber;
|
|
1678
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1679
|
+
}, z.core.$strict>;
|
|
1680
|
+
}, z.core.$strict>;
|
|
1681
|
+
declare const knowledgePendingOutputSchema: z.ZodObject<{
|
|
1682
|
+
documents: z.ZodObject<{
|
|
1683
|
+
$dataset: z.ZodString;
|
|
1684
|
+
rowCount: z.ZodNumber;
|
|
1685
|
+
bytes: z.ZodNumber;
|
|
1686
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1687
|
+
}, z.core.$strict>;
|
|
1688
|
+
}, z.core.$strict>;
|
|
1689
|
+
/**
|
|
1690
|
+
* A processor returns logical documents and page text (tables as Markdown), optional
|
|
1691
|
+
* section boundaries and fields. Chunking and vectors remain the platform's. This is the
|
|
1692
|
+
* single validator for built-ins and Workflow write-back; every refusal has the code
|
|
1693
|
+
* knowledge_processor_output_invalid. Fields' declared JSON Schema is checked by PROC-1.
|
|
1694
|
+
*/
|
|
1695
|
+
declare const knowledgeProcessorOutputSchema: z.ZodObject<{
|
|
1696
|
+
documents: z.ZodArray<z.ZodObject<{
|
|
1697
|
+
pageFrom: z.ZodNumber;
|
|
1698
|
+
pageTo: z.ZodNumber;
|
|
1699
|
+
}, z.core.$strict>>;
|
|
1700
|
+
sections: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1701
|
+
pageFrom: z.ZodNumber;
|
|
1702
|
+
pageTo: z.ZodNumber;
|
|
1703
|
+
title: z.ZodString;
|
|
1704
|
+
}, z.core.$strict>>>;
|
|
1705
|
+
fields: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1706
|
+
pages: z.ZodArray<z.ZodObject<{
|
|
1707
|
+
page: z.ZodNumber;
|
|
1708
|
+
text: z.ZodString;
|
|
1709
|
+
}, z.core.$strict>>;
|
|
1710
|
+
}, z.core.$strict>;
|
|
1711
|
+
type KnowledgeProcessorOutput = z.infer<typeof knowledgeProcessorOutputSchema>;
|
|
1712
|
+
declare const knowledgePutProcessedInputSchema: z.ZodObject<{
|
|
1713
|
+
items: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
|
|
1714
|
+
documentId: z.ZodString;
|
|
1715
|
+
contentHash: z.ZodString;
|
|
1716
|
+
workflowRevision: z.ZodString;
|
|
1717
|
+
output: z.ZodObject<{
|
|
1718
|
+
documents: z.ZodArray<z.ZodObject<{
|
|
1719
|
+
pageFrom: z.ZodNumber;
|
|
1720
|
+
pageTo: z.ZodNumber;
|
|
1721
|
+
}, z.core.$strict>>;
|
|
1722
|
+
sections: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1723
|
+
pageFrom: z.ZodNumber;
|
|
1724
|
+
pageTo: z.ZodNumber;
|
|
1725
|
+
title: z.ZodString;
|
|
1726
|
+
}, z.core.$strict>>>;
|
|
1727
|
+
fields: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1728
|
+
pages: z.ZodObject<{
|
|
1729
|
+
$dataset: z.ZodString;
|
|
1730
|
+
rowCount: z.ZodNumber;
|
|
1731
|
+
bytes: z.ZodNumber;
|
|
1732
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1733
|
+
}, z.core.$strict>;
|
|
1734
|
+
}, z.core.$strict>;
|
|
1735
|
+
}, z.core.$strict>>, z.ZodObject<{
|
|
1736
|
+
$dataset: z.ZodString;
|
|
1737
|
+
rowCount: z.ZodNumber;
|
|
1738
|
+
bytes: z.ZodNumber;
|
|
1739
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1740
|
+
}, z.core.$strict>]>;
|
|
1741
|
+
}, z.core.$strict>;
|
|
1742
|
+
declare const knowledgeFieldValueSchema: z.ZodJSONSchema;
|
|
1743
|
+
declare const knowledgeExtractFieldsInputSchema: z.ZodObject<{
|
|
1744
|
+
documentId: z.ZodString;
|
|
1745
|
+
schema: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1746
|
+
}, z.core.$strict>;
|
|
1747
|
+
declare const knowledgeExtractFieldsOutputSchema: z.ZodObject<{
|
|
1748
|
+
droppedFields: z.ZodOptional<z.ZodNumber>;
|
|
1749
|
+
failedFields: z.ZodOptional<z.ZodNumber>;
|
|
1750
|
+
path: z.ZodString;
|
|
1751
|
+
date: z.ZodNullable<z.ZodISODate>;
|
|
1752
|
+
type: z.ZodString;
|
|
1753
|
+
fields: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1754
|
+
value: z.ZodJSONSchema;
|
|
1755
|
+
page: z.ZodNumber;
|
|
1756
|
+
quote: z.ZodString;
|
|
1757
|
+
}, z.core.$strict>>;
|
|
1758
|
+
}, z.core.$strict>;
|
|
1759
|
+
/** Created by the first ingest, never authored in kb.yaml; the id cannot collide with a connector source. */
|
|
1760
|
+
declare const knowledgeWorkflowSourceSchema: z.ZodObject<{
|
|
1761
|
+
id: z.ZodString;
|
|
1762
|
+
kind: z.ZodLiteral<"workflow">;
|
|
1763
|
+
workflowId: z.ZodString;
|
|
1764
|
+
}, z.core.$strict>;
|
|
1765
|
+
type KnowledgeWorkflowSource = z.infer<typeof knowledgeWorkflowSourceSchema>;
|
|
1766
|
+
/** Contract inventory; completion, batch and dataset are present only where the table declares them. */
|
|
1767
|
+
declare const knowledgeWriteContracts: {
|
|
1768
|
+
readonly ingest: {
|
|
1769
|
+
readonly description: "Ingest items or a dataset into the calling data Workflow's source; complete promises a full pass, withdrawn only after the run succeeds.";
|
|
1770
|
+
readonly inputSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
1771
|
+
items: z.ZodArray<z.ZodUnion<readonly [z.ZodObject<{
|
|
1772
|
+
itemId: z.ZodString;
|
|
1773
|
+
version: z.ZodString;
|
|
1774
|
+
name: z.ZodString;
|
|
1775
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1776
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1777
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1778
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1779
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1780
|
+
text: z.ZodString;
|
|
1781
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1782
|
+
itemId: z.ZodString;
|
|
1783
|
+
version: z.ZodString;
|
|
1784
|
+
name: z.ZodString;
|
|
1785
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1786
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1787
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1788
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1789
|
+
fetch: z.ZodOptional<z.ZodNever>;
|
|
1790
|
+
fileId: z.ZodString;
|
|
1791
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1792
|
+
itemId: z.ZodString;
|
|
1793
|
+
version: z.ZodString;
|
|
1794
|
+
name: z.ZodString;
|
|
1795
|
+
path: z.ZodOptional<z.ZodString>;
|
|
1796
|
+
originLink: z.ZodOptional<z.ZodURL>;
|
|
1797
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodJSONSchema>>;
|
|
1798
|
+
text: z.ZodOptional<z.ZodNever>;
|
|
1799
|
+
fileId: z.ZodOptional<z.ZodNever>;
|
|
1800
|
+
fetch: z.ZodObject<{
|
|
1801
|
+
connection: z.ZodString;
|
|
1802
|
+
operation: z.ZodString;
|
|
1803
|
+
input: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1804
|
+
}, z.core.$strict>;
|
|
1805
|
+
}, z.core.$strict>]>>;
|
|
1806
|
+
complete: z.ZodOptional<z.ZodBoolean>;
|
|
1807
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1808
|
+
dataset: z.ZodObject<{
|
|
1809
|
+
$dataset: z.ZodString;
|
|
1810
|
+
rowCount: z.ZodNumber;
|
|
1811
|
+
bytes: z.ZodNumber;
|
|
1812
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1813
|
+
}, z.core.$strict>;
|
|
1814
|
+
complete: z.ZodOptional<z.ZodBoolean>;
|
|
1815
|
+
}, z.core.$strict>]>;
|
|
1816
|
+
readonly outputSchema: z.ZodObject<{
|
|
1817
|
+
done: z.ZodNumber;
|
|
1818
|
+
failed: z.ZodNumber;
|
|
1819
|
+
failures: z.ZodObject<{
|
|
1820
|
+
$dataset: z.ZodString;
|
|
1821
|
+
rowCount: z.ZodNumber;
|
|
1822
|
+
bytes: z.ZodNumber;
|
|
1823
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1824
|
+
}, z.core.$strict>;
|
|
1825
|
+
accepted: z.ZodNumber;
|
|
1826
|
+
withdrawn: z.ZodNumber;
|
|
1827
|
+
}, z.core.$strict>;
|
|
1828
|
+
readonly effect: "changing";
|
|
1829
|
+
readonly right: "knowledge_base.ingest";
|
|
1830
|
+
readonly keyLevel: "write";
|
|
1831
|
+
readonly completion: "async";
|
|
1832
|
+
readonly batch: true;
|
|
1833
|
+
};
|
|
1834
|
+
readonly withdraw: {
|
|
1835
|
+
readonly description: "Withdraw item ids from the calling Workflow's source; removed from search immediately.";
|
|
1836
|
+
readonly inputSchema: z.ZodObject<{
|
|
1837
|
+
itemIds: z.ZodArray<z.ZodString>;
|
|
1838
|
+
}, z.core.$strict>;
|
|
1839
|
+
readonly outputSchema: z.ZodObject<{
|
|
1840
|
+
withdrawn: z.ZodNumber;
|
|
1841
|
+
}, z.core.$strict>;
|
|
1842
|
+
readonly effect: "changing";
|
|
1843
|
+
readonly right: "knowledge_base.ingest";
|
|
1844
|
+
readonly keyLevel: "write";
|
|
1845
|
+
};
|
|
1846
|
+
readonly pending: {
|
|
1847
|
+
readonly description: "Pull pending documents by type and time as a dataset; page text is another dataset reference.";
|
|
1848
|
+
readonly inputSchema: z.ZodObject<{
|
|
1849
|
+
type: z.ZodOptional<z.ZodString>;
|
|
1850
|
+
since: z.ZodOptional<z.ZodISODateTime>;
|
|
1851
|
+
limit: z.ZodNumber;
|
|
1852
|
+
}, z.core.$strict>;
|
|
1853
|
+
readonly outputSchema: z.ZodObject<{
|
|
1854
|
+
documents: z.ZodObject<{
|
|
1855
|
+
$dataset: z.ZodString;
|
|
1856
|
+
rowCount: z.ZodNumber;
|
|
1857
|
+
bytes: z.ZodNumber;
|
|
1858
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1859
|
+
}, z.core.$strict>;
|
|
1860
|
+
}, z.core.$strict>;
|
|
1861
|
+
readonly rowSchema: z.ZodObject<{
|
|
1862
|
+
id: z.ZodString;
|
|
1863
|
+
type: z.ZodString;
|
|
1864
|
+
contentHash: z.ZodString;
|
|
1865
|
+
pages: z.ZodObject<{
|
|
1866
|
+
$dataset: z.ZodString;
|
|
1867
|
+
rowCount: z.ZodNumber;
|
|
1868
|
+
bytes: z.ZodNumber;
|
|
1869
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1870
|
+
}, z.core.$strict>;
|
|
1871
|
+
}, z.core.$strict>;
|
|
1872
|
+
readonly effect: "reading";
|
|
1873
|
+
readonly right: "knowledge_base.read";
|
|
1874
|
+
readonly keyLevel: "read";
|
|
1875
|
+
readonly dataset: true;
|
|
1876
|
+
};
|
|
1877
|
+
readonly put_processed: {
|
|
1878
|
+
readonly description: "Write processor output by document, content hash and Workflow revision, with pages as a dataset reference like pending; the platform validates, chunks and indexes it, with per-item outcomes.";
|
|
1879
|
+
readonly inputSchema: z.ZodObject<{
|
|
1880
|
+
items: z.ZodUnion<readonly [z.ZodArray<z.ZodObject<{
|
|
1881
|
+
documentId: z.ZodString;
|
|
1882
|
+
contentHash: z.ZodString;
|
|
1883
|
+
workflowRevision: z.ZodString;
|
|
1884
|
+
output: z.ZodObject<{
|
|
1885
|
+
documents: z.ZodArray<z.ZodObject<{
|
|
1886
|
+
pageFrom: z.ZodNumber;
|
|
1887
|
+
pageTo: z.ZodNumber;
|
|
1888
|
+
}, z.core.$strict>>;
|
|
1889
|
+
sections: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
1890
|
+
pageFrom: z.ZodNumber;
|
|
1891
|
+
pageTo: z.ZodNumber;
|
|
1892
|
+
title: z.ZodString;
|
|
1893
|
+
}, z.core.$strict>>>;
|
|
1894
|
+
fields: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1895
|
+
pages: z.ZodObject<{
|
|
1896
|
+
$dataset: z.ZodString;
|
|
1897
|
+
rowCount: z.ZodNumber;
|
|
1898
|
+
bytes: z.ZodNumber;
|
|
1899
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1900
|
+
}, z.core.$strict>;
|
|
1901
|
+
}, z.core.$strict>;
|
|
1902
|
+
}, z.core.$strict>>, z.ZodObject<{
|
|
1903
|
+
$dataset: z.ZodString;
|
|
1904
|
+
rowCount: z.ZodNumber;
|
|
1905
|
+
bytes: z.ZodNumber;
|
|
1906
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1907
|
+
}, z.core.$strict>]>;
|
|
1908
|
+
}, z.core.$strict>;
|
|
1909
|
+
readonly outputSchema: z.ZodObject<{
|
|
1910
|
+
done: z.ZodNumber;
|
|
1911
|
+
failed: z.ZodNumber;
|
|
1912
|
+
failures: z.ZodObject<{
|
|
1913
|
+
$dataset: z.ZodString;
|
|
1914
|
+
rowCount: z.ZodNumber;
|
|
1915
|
+
bytes: z.ZodNumber;
|
|
1916
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
1917
|
+
}, z.core.$strict>;
|
|
1918
|
+
}, z.core.$strict>;
|
|
1919
|
+
readonly effect: "changing";
|
|
1920
|
+
readonly right: "knowledge_base.ingest";
|
|
1921
|
+
readonly keyLevel: "write";
|
|
1922
|
+
readonly batch: true;
|
|
1923
|
+
};
|
|
1924
|
+
readonly extract_fields: {
|
|
1925
|
+
readonly description: "Extract fields by schema through the approved model binding within the Knowledge Base budget; each value carries page and quote evidence.";
|
|
1926
|
+
readonly inputSchema: z.ZodObject<{
|
|
1927
|
+
documentId: z.ZodString;
|
|
1928
|
+
schema: z.ZodRecord<z.ZodString, z.ZodJSONSchema>;
|
|
1929
|
+
}, z.core.$strict>;
|
|
1930
|
+
readonly outputSchema: z.ZodObject<{
|
|
1931
|
+
droppedFields: z.ZodOptional<z.ZodNumber>;
|
|
1932
|
+
failedFields: z.ZodOptional<z.ZodNumber>;
|
|
1933
|
+
path: z.ZodString;
|
|
1934
|
+
date: z.ZodNullable<z.ZodISODate>;
|
|
1935
|
+
type: z.ZodString;
|
|
1936
|
+
fields: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
1937
|
+
value: z.ZodJSONSchema;
|
|
1938
|
+
page: z.ZodNumber;
|
|
1939
|
+
quote: z.ZodString;
|
|
1940
|
+
}, z.core.$strict>>;
|
|
1941
|
+
}, z.core.$strict>;
|
|
1942
|
+
readonly effect: "reading";
|
|
1943
|
+
readonly right: "knowledge_base.read";
|
|
1944
|
+
readonly keyLevel: "read";
|
|
1945
|
+
};
|
|
1946
|
+
};
|
|
1947
|
+
/** Records rules belong to the Data Store; kb.yaml must never hold them. */
|
|
1948
|
+
declare const knowledgeRecordsRefusalSchema: z.ZodOptional<z.ZodNever>;
|
|
1949
|
+
type KnowledgeIngestInput = z.infer<typeof knowledgeIngestInputSchema>;
|
|
1950
|
+
type KnowledgeIngestOutput = z.infer<typeof knowledgeIngestOutputSchema>;
|
|
1951
|
+
type KnowledgeIngestFetch = z.infer<typeof knowledgeIngestFetchSchema>;
|
|
1952
|
+
type KnowledgeWithdrawInput = z.infer<typeof knowledgeWithdrawInputSchema>;
|
|
1953
|
+
type KnowledgeWithdrawOutput = z.infer<typeof knowledgeWithdrawOutputSchema>;
|
|
1954
|
+
type KnowledgePendingInput = z.infer<typeof knowledgePendingInputSchema>;
|
|
1955
|
+
type KnowledgePendingRow = z.infer<typeof knowledgePendingRowSchema>;
|
|
1956
|
+
type KnowledgePendingOutput = z.infer<typeof knowledgePendingOutputSchema>;
|
|
1957
|
+
type KnowledgePutProcessedInput = z.infer<typeof knowledgePutProcessedInputSchema>;
|
|
1958
|
+
type KnowledgeExtractFieldsInput = z.infer<typeof knowledgeExtractFieldsInputSchema>;
|
|
1959
|
+
type KnowledgeExtractFieldsOutput = z.infer<typeof knowledgeExtractFieldsOutputSchema>;
|
|
1960
|
+
|
|
1961
|
+
/** Paging settings shared by accepted Connections and their API view. */
|
|
1962
|
+
declare const operationPagingSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
1963
|
+
by: z.ZodEnum<{
|
|
1964
|
+
page: "page";
|
|
1965
|
+
offset: "offset";
|
|
1966
|
+
}>;
|
|
1967
|
+
param: z.ZodString;
|
|
1968
|
+
sizeParam: z.ZodString;
|
|
1969
|
+
size: z.ZodNumber;
|
|
1970
|
+
start: z.ZodOptional<z.ZodNumber>;
|
|
1971
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
1972
|
+
by: z.ZodEnum<{
|
|
1973
|
+
cursor: "cursor";
|
|
1974
|
+
next_link: "next_link";
|
|
1975
|
+
}>;
|
|
1976
|
+
param: z.ZodString;
|
|
1977
|
+
cursor: z.ZodString;
|
|
1978
|
+
}, z.core.$strict>], "by">;
|
|
1979
|
+
type OperationPaging = z.infer<typeof operationPagingSchema>;
|
|
1980
|
+
|
|
1981
|
+
/** Published data Workflows that fill or process an asset, with unreadable names withheld. */
|
|
1982
|
+
declare const workflowDataFlowsSchema: z.ZodObject<{
|
|
1983
|
+
fills: z.ZodArray<z.ZodObject<{
|
|
1984
|
+
id: z.ZodString;
|
|
1985
|
+
name: z.ZodString;
|
|
1986
|
+
title: z.ZodString;
|
|
1987
|
+
}, z.core.$strip>>;
|
|
1988
|
+
processes: z.ZodArray<z.ZodObject<{
|
|
1989
|
+
id: z.ZodString;
|
|
1990
|
+
name: z.ZodString;
|
|
1991
|
+
title: z.ZodString;
|
|
1992
|
+
}, z.core.$strip>>;
|
|
1993
|
+
hidden: z.ZodObject<{
|
|
1994
|
+
fills: z.ZodNumber;
|
|
1995
|
+
processes: z.ZodNumber;
|
|
1996
|
+
}, z.core.$strip>;
|
|
1997
|
+
truncated: z.ZodBoolean;
|
|
1998
|
+
}, z.core.$strip>;
|
|
1999
|
+
|
|
2000
|
+
declare const RECORDS_PROPOSE_MAX_ITEMS_PER_CALL = 1000;
|
|
2001
|
+
declare const RECORDS_PROPOSE_MAX_FIELDS_PER_ITEM = 1000;
|
|
2002
|
+
declare const RECORDS_FLAGGED_MAX_ITEMS_PER_PAGE = 10000;
|
|
2003
|
+
declare const dataStoreRecordsRuleSchema: z.ZodObject<{
|
|
2004
|
+
table: z.ZodString;
|
|
2005
|
+
key: z.ZodUnion<readonly [z.ZodObject<{
|
|
2006
|
+
column: z.ZodString;
|
|
2007
|
+
fromPath: z.ZodString;
|
|
2008
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2009
|
+
column: z.ZodString;
|
|
2010
|
+
fromField: z.ZodString;
|
|
2011
|
+
}, z.core.$strict>]>;
|
|
2012
|
+
precedence: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
2013
|
+
review: z.ZodPrefault<z.ZodObject<{
|
|
2014
|
+
always: z.ZodDefault<z.ZodArray<z.ZodString>>;
|
|
2015
|
+
}, z.core.$strict>>;
|
|
2016
|
+
retainWithoutSource: z.ZodDefault<z.ZodBoolean>;
|
|
2017
|
+
}, z.core.$strict>;
|
|
2018
|
+
type DataStoreRecordsRule = z.infer<typeof dataStoreRecordsRuleSchema>;
|
|
2019
|
+
/** A necessary condition, never a model confidence score or proof of correctness. */
|
|
2020
|
+
declare const recordEvidenceResultSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2021
|
+
status: z.ZodLiteral<"passed">;
|
|
2022
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2023
|
+
status: z.ZodLiteral<"failed">;
|
|
2024
|
+
reason: z.ZodEnum<{
|
|
2025
|
+
page_not_found: "page_not_found";
|
|
2026
|
+
quote_not_found: "quote_not_found";
|
|
2027
|
+
value_not_parsed: "value_not_parsed";
|
|
2028
|
+
}>;
|
|
2029
|
+
}, z.core.$strict>], "status">;
|
|
2030
|
+
type RecordEvidenceResult = z.infer<typeof recordEvidenceResultSchema>;
|
|
2031
|
+
declare const RECORD_FIELD_STATES: readonly ["extracted", "confirmed", "corrected", "conflict"];
|
|
2032
|
+
/** Why a field waits for a person in "Prüfen". */
|
|
2033
|
+
declare const RECORD_FLAG_REASONS: readonly ["conflict", "not_evidenced", "confirmation_required", "key_unresolved"];
|
|
2034
|
+
declare const RECORD_FIELD_FAILURE_CODES: readonly ["record_field_unknown"];
|
|
2035
|
+
declare const dataStoreRecordProposalItemSchema: z.ZodObject<{
|
|
2036
|
+
knowledgeBaseId: z.ZodString;
|
|
2037
|
+
documentId: z.ZodString;
|
|
2038
|
+
kind: z.ZodString;
|
|
2039
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2040
|
+
path: z.ZodOptional<z.ZodString>;
|
|
2041
|
+
fields: z.ZodArray<z.ZodObject<{
|
|
2042
|
+
value: z.ZodJSONSchema;
|
|
2043
|
+
page: z.ZodNumber;
|
|
2044
|
+
quote: z.ZodString;
|
|
2045
|
+
name: z.ZodString;
|
|
2046
|
+
}, z.core.$strict>>;
|
|
2047
|
+
}, z.core.$strict>;
|
|
2048
|
+
type DataStoreRecordProposalItem = z.infer<typeof dataStoreRecordProposalItemSchema>;
|
|
2049
|
+
declare const dataStoreRecordsProposeInputSchema: z.ZodObject<{
|
|
2050
|
+
table: z.ZodString;
|
|
2051
|
+
items: z.ZodArray<z.ZodObject<{
|
|
2052
|
+
knowledgeBaseId: z.ZodString;
|
|
2053
|
+
documentId: z.ZodString;
|
|
2054
|
+
kind: z.ZodString;
|
|
2055
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2056
|
+
path: z.ZodOptional<z.ZodString>;
|
|
2057
|
+
fields: z.ZodArray<z.ZodObject<{
|
|
2058
|
+
value: z.ZodJSONSchema;
|
|
2059
|
+
page: z.ZodNumber;
|
|
2060
|
+
quote: z.ZodString;
|
|
2061
|
+
name: z.ZodString;
|
|
2062
|
+
}, z.core.$strict>>;
|
|
2063
|
+
}, z.core.$strict>>;
|
|
2064
|
+
}, z.core.$strict>;
|
|
2065
|
+
type DataStoreRecordsProposeInput = z.infer<typeof dataStoreRecordsProposeInputSchema>;
|
|
2066
|
+
declare const dataStoreRecordsDecideInputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2067
|
+
table: z.ZodString;
|
|
2068
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2069
|
+
field: z.ZodString;
|
|
2070
|
+
documentId: z.ZodOptional<z.ZodString>;
|
|
2071
|
+
knowledgeBaseId: z.ZodOptional<z.ZodString>;
|
|
2072
|
+
action: z.ZodLiteral<"confirm">;
|
|
2073
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2074
|
+
table: z.ZodString;
|
|
2075
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2076
|
+
field: z.ZodString;
|
|
2077
|
+
documentId: z.ZodOptional<z.ZodString>;
|
|
2078
|
+
knowledgeBaseId: z.ZodOptional<z.ZodString>;
|
|
2079
|
+
action: z.ZodLiteral<"correct">;
|
|
2080
|
+
value: z.ZodJSONSchema;
|
|
2081
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2082
|
+
table: z.ZodString;
|
|
2083
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2084
|
+
field: z.ZodString;
|
|
2085
|
+
action: z.ZodLiteral<"assign">;
|
|
2086
|
+
documentId: z.ZodString;
|
|
2087
|
+
knowledgeBaseId: z.ZodString;
|
|
2088
|
+
}, z.core.$strict>], "action">;
|
|
2089
|
+
type DataStoreRecordsDecideInput = z.infer<typeof dataStoreRecordsDecideInputSchema>;
|
|
2090
|
+
declare const dataStoreRecordsDecideOutputSchema: z.ZodObject<{
|
|
2091
|
+
decided: z.ZodLiteral<true>;
|
|
2092
|
+
}, z.core.$strict>;
|
|
2093
|
+
declare const dataStoreRecordsFlaggedInputSchema: z.ZodObject<{
|
|
2094
|
+
table: z.ZodOptional<z.ZodString>;
|
|
2095
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
2096
|
+
limit: z.ZodNumber;
|
|
2097
|
+
}, z.core.$strict>;
|
|
2098
|
+
declare const dataStoreRecordFieldSchema: z.ZodObject<{
|
|
2099
|
+
value: z.ZodJSONSchema;
|
|
2100
|
+
page: z.ZodNumber;
|
|
2101
|
+
quote: z.ZodString;
|
|
2102
|
+
name: z.ZodString;
|
|
2103
|
+
correctedValue: z.ZodNullable<z.ZodJSONSchema>;
|
|
2104
|
+
table: z.ZodString;
|
|
2105
|
+
key: z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
|
|
2106
|
+
knowledgeBaseId: z.ZodString;
|
|
2107
|
+
documentId: z.ZodString;
|
|
2108
|
+
kind: z.ZodString;
|
|
2109
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2110
|
+
extractedAt: z.ZodISODateTime;
|
|
2111
|
+
evidence: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2112
|
+
status: z.ZodLiteral<"passed">;
|
|
2113
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2114
|
+
status: z.ZodLiteral<"failed">;
|
|
2115
|
+
reason: z.ZodEnum<{
|
|
2116
|
+
page_not_found: "page_not_found";
|
|
2117
|
+
quote_not_found: "quote_not_found";
|
|
2118
|
+
value_not_parsed: "value_not_parsed";
|
|
2119
|
+
}>;
|
|
2120
|
+
}, z.core.$strict>], "status">;
|
|
2121
|
+
state: z.ZodEnum<{
|
|
2122
|
+
confirmed: "confirmed";
|
|
2123
|
+
extracted: "extracted";
|
|
2124
|
+
corrected: "corrected";
|
|
2125
|
+
conflict: "conflict";
|
|
2126
|
+
}>;
|
|
2127
|
+
decidedBy: z.ZodNullable<z.ZodString>;
|
|
2128
|
+
decidedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2129
|
+
}, z.core.$strict>;
|
|
2130
|
+
type DataStoreRecordField = z.infer<typeof dataStoreRecordFieldSchema>;
|
|
2131
|
+
declare const dataStoreRecordsFlaggedOutputSchema: z.ZodObject<{
|
|
2132
|
+
items: z.ZodArray<z.ZodObject<{
|
|
2133
|
+
value: z.ZodJSONSchema;
|
|
2134
|
+
page: z.ZodNumber;
|
|
2135
|
+
quote: z.ZodString;
|
|
2136
|
+
name: z.ZodString;
|
|
2137
|
+
correctedValue: z.ZodNullable<z.ZodJSONSchema>;
|
|
2138
|
+
table: z.ZodString;
|
|
2139
|
+
key: z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
|
|
2140
|
+
knowledgeBaseId: z.ZodString;
|
|
2141
|
+
documentId: z.ZodString;
|
|
2142
|
+
kind: z.ZodString;
|
|
2143
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2144
|
+
extractedAt: z.ZodISODateTime;
|
|
2145
|
+
evidence: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2146
|
+
status: z.ZodLiteral<"passed">;
|
|
2147
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2148
|
+
status: z.ZodLiteral<"failed">;
|
|
2149
|
+
reason: z.ZodEnum<{
|
|
2150
|
+
page_not_found: "page_not_found";
|
|
2151
|
+
quote_not_found: "quote_not_found";
|
|
2152
|
+
value_not_parsed: "value_not_parsed";
|
|
2153
|
+
}>;
|
|
2154
|
+
}, z.core.$strict>], "status">;
|
|
2155
|
+
state: z.ZodEnum<{
|
|
2156
|
+
confirmed: "confirmed";
|
|
2157
|
+
extracted: "extracted";
|
|
2158
|
+
corrected: "corrected";
|
|
2159
|
+
conflict: "conflict";
|
|
2160
|
+
}>;
|
|
2161
|
+
decidedBy: z.ZodNullable<z.ZodString>;
|
|
2162
|
+
decidedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2163
|
+
reason: z.ZodEnum<{
|
|
2164
|
+
conflict: "conflict";
|
|
2165
|
+
not_evidenced: "not_evidenced";
|
|
2166
|
+
confirmation_required: "confirmation_required";
|
|
2167
|
+
key_unresolved: "key_unresolved";
|
|
2168
|
+
}>;
|
|
2169
|
+
document: z.ZodOptional<z.ZodObject<{
|
|
2170
|
+
knowledgeBase: z.ZodString;
|
|
2171
|
+
fileName: z.ZodString;
|
|
2172
|
+
}, z.core.$strict>>;
|
|
2173
|
+
decidedByName: z.ZodOptional<z.ZodString>;
|
|
2174
|
+
}, z.core.$strict>>;
|
|
2175
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
2176
|
+
}, z.core.$strict>;
|
|
2177
|
+
type ColumnType = (typeof DATA_STORE_SCALAR_TYPES)[number];
|
|
2178
|
+
interface RecordColumn {
|
|
2179
|
+
name: string;
|
|
2180
|
+
type: ColumnType | `${ColumnType}[]` | "other";
|
|
2181
|
+
nullable: boolean;
|
|
2182
|
+
generated?: boolean;
|
|
2183
|
+
}
|
|
2184
|
+
/** Whether a column takes the value, as a proposal and a person's correction are checked. */
|
|
2185
|
+
declare function recordColumnTakes(column: RecordColumn, value: unknown): boolean;
|
|
2186
|
+
/**
|
|
2187
|
+
* Validate a whole item before any candidate or customer row is written. The batch writer
|
|
2188
|
+
* maps this refusal to record_field_unknown for that item and continues with other items.
|
|
2189
|
+
* Types come from the store catalog, never from the caller's extraction schema.
|
|
2190
|
+
*/
|
|
2191
|
+
declare function proposalItemSchemaFor(columns: readonly RecordColumn[]): z.ZodObject<{
|
|
2192
|
+
knowledgeBaseId: z.ZodString;
|
|
2193
|
+
documentId: z.ZodString;
|
|
2194
|
+
kind: z.ZodString;
|
|
2195
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2196
|
+
path: z.ZodOptional<z.ZodString>;
|
|
2197
|
+
fields: z.ZodArray<z.ZodObject<{
|
|
2198
|
+
value: z.ZodJSONSchema;
|
|
2199
|
+
page: z.ZodNumber;
|
|
2200
|
+
quote: z.ZodString;
|
|
2201
|
+
name: z.ZodString;
|
|
2202
|
+
}, z.core.$strict>>;
|
|
2203
|
+
}, z.core.$strict>;
|
|
2204
|
+
/** Contracts only: REC-1a/1b/2 register the implementations, not REC-0. */
|
|
2205
|
+
declare const dataStoreRecordsContracts: {
|
|
2206
|
+
readonly propose: {
|
|
2207
|
+
readonly description: "Propose extracted fields with Knowledge Base/document/page/quote evidence. Validate each whole item against the published table before writing; failures are per item. Send at most 1000 items per call and 1000 fields per item; split larger work into batches. Merge by evidence precedence, then document date; unresolved keys and evidence go to review.";
|
|
2208
|
+
readonly inputSchema: z.ZodObject<{
|
|
2209
|
+
table: z.ZodString;
|
|
2210
|
+
items: z.ZodArray<z.ZodObject<{
|
|
2211
|
+
knowledgeBaseId: z.ZodString;
|
|
2212
|
+
documentId: z.ZodString;
|
|
2213
|
+
kind: z.ZodString;
|
|
2214
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2215
|
+
path: z.ZodOptional<z.ZodString>;
|
|
2216
|
+
fields: z.ZodArray<z.ZodObject<{
|
|
2217
|
+
value: z.ZodJSONSchema;
|
|
2218
|
+
page: z.ZodNumber;
|
|
2219
|
+
quote: z.ZodString;
|
|
2220
|
+
name: z.ZodString;
|
|
2221
|
+
}, z.core.$strict>>;
|
|
2222
|
+
}, z.core.$strict>>;
|
|
2223
|
+
}, z.core.$strict>;
|
|
2224
|
+
readonly outputSchema: z.ZodObject<{
|
|
2225
|
+
done: z.ZodNumber;
|
|
2226
|
+
failed: z.ZodNumber;
|
|
2227
|
+
failures: z.ZodObject<{
|
|
2228
|
+
$dataset: z.ZodString;
|
|
2229
|
+
rowCount: z.ZodNumber;
|
|
2230
|
+
bytes: z.ZodNumber;
|
|
2231
|
+
offset: z.ZodOptional<z.ZodNumber>;
|
|
2232
|
+
}, z.core.$strict>;
|
|
2233
|
+
}, z.core.$strict>;
|
|
2234
|
+
readonly itemSchemaFor: typeof proposalItemSchemaFor;
|
|
2235
|
+
readonly effect: "changing";
|
|
2236
|
+
readonly right: "data_store.records";
|
|
2237
|
+
readonly keyLevel: "write";
|
|
2238
|
+
readonly batch: true;
|
|
2239
|
+
};
|
|
2240
|
+
readonly decide: {
|
|
2241
|
+
readonly description: "Confirm or correct a field against its evidence, or assign a document to an object key. Decisions are pinned; audit table/field/action/actor only, never the value.";
|
|
2242
|
+
readonly inputSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2243
|
+
table: z.ZodString;
|
|
2244
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2245
|
+
field: z.ZodString;
|
|
2246
|
+
documentId: z.ZodOptional<z.ZodString>;
|
|
2247
|
+
knowledgeBaseId: z.ZodOptional<z.ZodString>;
|
|
2248
|
+
action: z.ZodLiteral<"confirm">;
|
|
2249
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2250
|
+
table: z.ZodString;
|
|
2251
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2252
|
+
field: z.ZodString;
|
|
2253
|
+
documentId: z.ZodOptional<z.ZodString>;
|
|
2254
|
+
knowledgeBaseId: z.ZodOptional<z.ZodString>;
|
|
2255
|
+
action: z.ZodLiteral<"correct">;
|
|
2256
|
+
value: z.ZodJSONSchema;
|
|
2257
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2258
|
+
table: z.ZodString;
|
|
2259
|
+
key: z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>;
|
|
2260
|
+
field: z.ZodString;
|
|
2261
|
+
action: z.ZodLiteral<"assign">;
|
|
2262
|
+
documentId: z.ZodString;
|
|
2263
|
+
knowledgeBaseId: z.ZodString;
|
|
2264
|
+
}, z.core.$strict>], "action">;
|
|
2265
|
+
readonly outputSchema: z.ZodObject<{
|
|
2266
|
+
decided: z.ZodLiteral<true>;
|
|
2267
|
+
}, z.core.$strict>;
|
|
2268
|
+
readonly effect: "changing";
|
|
2269
|
+
readonly right: "data_store.records";
|
|
2270
|
+
readonly keyLevel: "write";
|
|
2271
|
+
};
|
|
2272
|
+
readonly flagged: {
|
|
2273
|
+
readonly description: "Page through fields needing review, up to 10000 per call; pass nextCursor as cursor for the next page. Check Knowledge Base access before showing any document citation; the store right alone does not grant access to source documents.";
|
|
2274
|
+
readonly inputSchema: z.ZodObject<{
|
|
2275
|
+
table: z.ZodOptional<z.ZodString>;
|
|
2276
|
+
cursor: z.ZodOptional<z.ZodString>;
|
|
2277
|
+
limit: z.ZodNumber;
|
|
2278
|
+
}, z.core.$strict>;
|
|
2279
|
+
readonly outputSchema: z.ZodObject<{
|
|
2280
|
+
items: z.ZodArray<z.ZodObject<{
|
|
2281
|
+
value: z.ZodJSONSchema;
|
|
2282
|
+
page: z.ZodNumber;
|
|
2283
|
+
quote: z.ZodString;
|
|
2284
|
+
name: z.ZodString;
|
|
2285
|
+
correctedValue: z.ZodNullable<z.ZodJSONSchema>;
|
|
2286
|
+
table: z.ZodString;
|
|
2287
|
+
key: z.ZodNullable<z.ZodUnion<readonly [z.ZodString, z.ZodNumber, z.ZodBoolean]>>;
|
|
2288
|
+
knowledgeBaseId: z.ZodString;
|
|
2289
|
+
documentId: z.ZodString;
|
|
2290
|
+
kind: z.ZodString;
|
|
2291
|
+
documentDate: z.ZodNullable<z.ZodISODate>;
|
|
2292
|
+
extractedAt: z.ZodISODateTime;
|
|
2293
|
+
evidence: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2294
|
+
status: z.ZodLiteral<"passed">;
|
|
2295
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2296
|
+
status: z.ZodLiteral<"failed">;
|
|
2297
|
+
reason: z.ZodEnum<{
|
|
2298
|
+
page_not_found: "page_not_found";
|
|
2299
|
+
quote_not_found: "quote_not_found";
|
|
2300
|
+
value_not_parsed: "value_not_parsed";
|
|
2301
|
+
}>;
|
|
2302
|
+
}, z.core.$strict>], "status">;
|
|
2303
|
+
state: z.ZodEnum<{
|
|
2304
|
+
confirmed: "confirmed";
|
|
2305
|
+
extracted: "extracted";
|
|
2306
|
+
corrected: "corrected";
|
|
2307
|
+
conflict: "conflict";
|
|
2308
|
+
}>;
|
|
2309
|
+
decidedBy: z.ZodNullable<z.ZodString>;
|
|
2310
|
+
decidedAt: z.ZodNullable<z.ZodISODateTime>;
|
|
2311
|
+
reason: z.ZodEnum<{
|
|
2312
|
+
conflict: "conflict";
|
|
2313
|
+
not_evidenced: "not_evidenced";
|
|
2314
|
+
confirmation_required: "confirmation_required";
|
|
2315
|
+
key_unresolved: "key_unresolved";
|
|
2316
|
+
}>;
|
|
2317
|
+
document: z.ZodOptional<z.ZodObject<{
|
|
2318
|
+
knowledgeBase: z.ZodString;
|
|
2319
|
+
fileName: z.ZodString;
|
|
2320
|
+
}, z.core.$strict>>;
|
|
2321
|
+
decidedByName: z.ZodOptional<z.ZodString>;
|
|
2322
|
+
}, z.core.$strict>>;
|
|
2323
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
2324
|
+
}, z.core.$strict>;
|
|
2325
|
+
readonly effect: "reading";
|
|
2326
|
+
readonly right: "data_store.records";
|
|
2327
|
+
readonly keyLevel: "read";
|
|
2328
|
+
};
|
|
2329
|
+
};
|
|
2330
|
+
type DataStoreRecordsDecideOutput = z.infer<typeof dataStoreRecordsDecideOutputSchema>;
|
|
2331
|
+
type DataStoreRecordsFlaggedInput = z.infer<typeof dataStoreRecordsFlaggedInputSchema>;
|
|
2332
|
+
type DataStoreRecordsFlaggedOutput = z.infer<typeof dataStoreRecordsFlaggedOutputSchema>;
|
|
2333
|
+
|
|
2334
|
+
/** The UTC counter windows, metrics and scopes a model usage refusal may name. */
|
|
2335
|
+
declare const MODEL_USAGE_LIMIT_PERIODS: readonly ["day", "month"];
|
|
2336
|
+
declare const MODEL_USAGE_LIMIT_METRICS: readonly ["modelCallCount", "tokens", "costMicros"];
|
|
2337
|
+
declare const MODEL_USAGE_LIMIT_SCOPES: readonly ["instance", "user", "system", "workspace"];
|
|
2338
|
+
/**
|
|
2339
|
+
* Where an admin sets a spend limit (LU-2): the instance, one default for every shared
|
|
2340
|
+
* workspace and one for every user, and a value for one workspace or one user that replaces
|
|
2341
|
+
* that default.
|
|
2342
|
+
*/
|
|
2343
|
+
declare const USAGE_SPEND_LIMIT_LEVELS: readonly ["instance", "workspace_default", "workspace", "user_default", "user"];
|
|
2344
|
+
/** The limit that refused a call: its period, what it counts, and whose counter it is. */
|
|
2345
|
+
interface ModelUsageRefusal {
|
|
2346
|
+
period: (typeof MODEL_USAGE_LIMIT_PERIODS)[number];
|
|
2347
|
+
metric: (typeof MODEL_USAGE_LIMIT_METRICS)[number];
|
|
2348
|
+
/**
|
|
2349
|
+
* `user`: the person's own calls. `system`: the calls the product makes for a person, or
|
|
2350
|
+
* those no person made. `workspace`: the calls inside one shared workspace. `instance`: the
|
|
2351
|
+
* spend budget everyone shares.
|
|
2352
|
+
*/
|
|
2353
|
+
scope: (typeof MODEL_USAGE_LIMIT_SCOPES)[number];
|
|
2354
|
+
}
|
|
2355
|
+
/** The workspace key every Personal Workspace shares in the usage sums (LU-3): one row. */
|
|
2356
|
+
declare const PERSONAL_WORKSPACES_KEY = "personal";
|
|
2357
|
+
/** What the Breakdown of the Usage page groups by (LU-3, limits spec 3.3, view 2). */
|
|
2358
|
+
declare const USAGE_BREAKDOWN_DIMENSIONS: readonly ["workspace", "agent", "app", "workflow", "model", "origin"];
|
|
2359
|
+
/**
|
|
2360
|
+
* Where usage came from (limits spec 3.2): a conversation, an App, a Workflow, Knowledge Base
|
|
2361
|
+
* ingestion, or a call the product made for itself, such as a title or a guardrail check.
|
|
2362
|
+
*/
|
|
2363
|
+
declare const USAGE_ORIGINS: readonly ["conversation", "app", "workflow", "knowledge_base", "system"];
|
|
2364
|
+
|
|
2365
|
+
/**
|
|
2366
|
+
* The JSON Schema `format` of a string field that takes Markdown, such as the body of
|
|
2367
|
+
* `mail.send`. In such a field a referenced list of strings joins as a bulleted list and a
|
|
2368
|
+
* list of flat records as a table, and every referenced value is escaped as Markdown text.
|
|
2369
|
+
*/
|
|
2370
|
+
declare const WORKFLOW_TEXT_FORMAT_MARKDOWN = "markdown";
|
|
2371
|
+
/** The most parts one joined text has. */
|
|
2372
|
+
declare const WORKFLOW_TEXT_MAX_PARTS = 100;
|
|
2373
|
+
/** A referenced list in a Markdown field joins as at most this many rows; more is refused. */
|
|
2374
|
+
declare const WORKFLOW_MARKDOWN_MAX_ROWS = 100;
|
|
2375
|
+
/** A referenced list of records joins as a table of at most this many columns. */
|
|
2376
|
+
declare const WORKFLOW_MARKDOWN_MAX_COLUMNS = 8;
|
|
2377
|
+
|
|
2378
|
+
/** The platform operation. It exists on an instance only while `outbound.enabled` is true. */
|
|
2379
|
+
declare const MAIL_SEND_OPERATION = "mail.send";
|
|
2380
|
+
/** The resource kind of a sender. Its right is `mail_sender.use`, on one sender. */
|
|
2381
|
+
declare const MAIL_SENDER_RESOURCE_KIND = "mail_sender";
|
|
2382
|
+
declare const MAIL_SENDER_USE_ACTION = "mail_sender.use";
|
|
2383
|
+
/** The instance's own mailer (`infrastructure.mail`), the only sender until MAIL-M365S. */
|
|
2384
|
+
declare const MAIL_SENDER_SYSTEM = "system";
|
|
2385
|
+
/** The prefix of a Connection sender (MAIL-M365S, MAIL-M365P): `connection.<name>`. */
|
|
2386
|
+
declare const MAIL_SENDER_CONNECTION_PREFIX = "connection.";
|
|
2387
|
+
/**
|
|
2388
|
+
* The icon key the step shows for the system sender. An assembly may register the instance's
|
|
2389
|
+
* mark under it; without one the generic mail icon stands. A Connection sender shows its
|
|
2390
|
+
* Connection's `service` icon. The transport (Mailjet, capture, SMTP) never has an icon.
|
|
2391
|
+
*/
|
|
2392
|
+
declare const MAIL_SENDER_SYSTEM_ICON = "system-mail";
|
|
2393
|
+
/** The template `packages/mail` renders a mail of `mail.send` in. */
|
|
2394
|
+
declare const MAIL_WORKFLOW_MESSAGE_TEMPLATE = "workflow-message";
|
|
2395
|
+
/** Addresses of one mail once `{ workspace }` recipients are expanded, over to, cc and bcc. */
|
|
2396
|
+
declare const MAIL_SEND_MAX_ADDRESSES = 50;
|
|
2397
|
+
declare const MAIL_SUBJECT_MAX_LENGTH = 200;
|
|
2398
|
+
declare const MAIL_BODY_MAX_BYTES: number;
|
|
2399
|
+
declare const MAIL_SENDER_NAME_MAX_LENGTH = 80;
|
|
2400
|
+
/** The longest address RFC 5321 lets through a path. */
|
|
2401
|
+
declare const MAIL_ADDRESS_MAX_LENGTH = 254;
|
|
2402
|
+
/** `infrastructure.mail.outbound.limits` unless release config sets them; only it raises them. */
|
|
2403
|
+
declare const MAIL_OUTBOUND_DEFAULT_LIMITS: {
|
|
2404
|
+
readonly perWorkflowPerHour: 200;
|
|
2405
|
+
readonly perInstancePerDay: 1000;
|
|
2406
|
+
};
|
|
2407
|
+
/** One language's legal footer (§ 37a HGB company details), as plain text. */
|
|
2408
|
+
declare const MAIL_OUTBOUND_FOOTER_MAX_LENGTH = 2000;
|
|
2409
|
+
/** `mail.sent` names at most this many distinct recipient domains, then counts the rest. */
|
|
2410
|
+
declare const MAIL_AUDIT_MAX_DOMAINS = 10;
|
|
2411
|
+
/** Reserved for MAIL-4: Managed Files and datasets of the run, together. */
|
|
2412
|
+
declare const MAIL_ATTACHMENTS_MAX_FILES = 10;
|
|
2413
|
+
declare const MAIL_ATTACHMENTS_MAX_BYTES: number;
|
|
2414
|
+
/**
|
|
2415
|
+
* Why `mail.send` refused or failed a mail, as `details.reason` of a VALIDATION_FAILED and as
|
|
2416
|
+
* the code of a failed step. None is retried.
|
|
2417
|
+
* - `recipient_not_allowed`: an address outside `recipientDomains` that is not a person of the
|
|
2418
|
+
* instance, or such a `replyTo`. `details.domain` names its domain. Nothing is sent to any
|
|
2419
|
+
* recipient of the mail.
|
|
2420
|
+
* - `no_recipient`: `to` named people or workspaces, and none of them has an address.
|
|
2421
|
+
* - `workspace_not_allowed`: a `{ workspace }` recipient is not a Shared Workspace the author
|
|
2422
|
+
* of the mail can see: they are no member of it and no instance admin (MAIL-2). The author
|
|
2423
|
+
* is the person who saves, publishes or tests the Workflow, or for whom an agent calls; in a
|
|
2424
|
+
* published run, its publisher. Nothing is sent and no member of it is named.
|
|
2425
|
+
* - `mail_rejected`: the provider refused the mail before accepting it. `details.providerCode`
|
|
2426
|
+
* holds the provider's own code; its text is never kept.
|
|
2427
|
+
* A transient failure is not one of these: a refused connection is retried by the step's
|
|
2428
|
+
* attempts, and an answer lost after the request left is `operation_interrupted`.
|
|
2429
|
+
*/
|
|
2430
|
+
declare const MAIL_SEND_ERROR_CODES: {
|
|
2431
|
+
readonly recipientNotAllowed: "recipient_not_allowed";
|
|
2432
|
+
readonly noRecipient: "no_recipient";
|
|
2433
|
+
readonly mailRejected: "mail_rejected";
|
|
2434
|
+
readonly workspaceNotAllowed: "workspace_not_allowed";
|
|
2435
|
+
};
|
|
2436
|
+
type MailSendErrorCode = (typeof MAIL_SEND_ERROR_CODES)[keyof typeof MAIL_SEND_ERROR_CODES];
|
|
2437
|
+
declare const MAIL_SEND_REFUSAL_REASONS: readonly ["recipient_not_allowed", "no_recipient", "mail_rejected", "workspace_not_allowed"];
|
|
2438
|
+
/** `details` of a refused `mail.send`: the one refused domain, or the provider's code. */
|
|
2439
|
+
declare const mailSendRefusalDetailsSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2440
|
+
reason: z.ZodLiteral<"recipient_not_allowed">;
|
|
2441
|
+
domain: z.ZodString;
|
|
2442
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2443
|
+
reason: z.ZodLiteral<"no_recipient">;
|
|
2444
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2445
|
+
reason: z.ZodLiteral<"workspace_not_allowed">;
|
|
2446
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2447
|
+
reason: z.ZodLiteral<"mail_rejected">;
|
|
2448
|
+
providerCode: z.ZodOptional<z.ZodString>;
|
|
2449
|
+
}, z.core.$strict>], "reason">;
|
|
2450
|
+
type MailSendRefusalDetails = z.infer<typeof mailSendRefusalDetailsSchema>;
|
|
2451
|
+
/** A user or workspace id, as `NOTICE_ID_PATTERN` of core reads it. */
|
|
2452
|
+
declare const MAIL_RECIPIENT_ID_PATTERN: RegExp;
|
|
2453
|
+
/** One address as written. Its domain is compared without regard to case. */
|
|
2454
|
+
declare const mailAddressSchema: z.ZodEmail;
|
|
2455
|
+
/**
|
|
2456
|
+
* A domain of `recipientDomains`, lowercase: `kanzlei.de` matches that domain only,
|
|
2457
|
+
* `*.kanzlei.de` its subdomains and not the domain itself. `*` alone admits every address.
|
|
2458
|
+
*/
|
|
2459
|
+
declare const MAIL_RECIPIENT_DOMAIN_PATTERN: RegExp;
|
|
2460
|
+
declare const MAIL_RECIPIENT_DOMAINS_ANY = "*";
|
|
2461
|
+
declare const mailRecipientDomainSchema: z.ZodString;
|
|
2462
|
+
/**
|
|
2463
|
+
* Which sender the mail goes out as. `system` until MAIL-M365S; `connection.<name>` is
|
|
2464
|
+
* reserved and refused with `not_supported_yet`.
|
|
2465
|
+
*/
|
|
2466
|
+
declare const mailSenderIdSchema: z.ZodUnion<readonly [z.ZodLiteral<"system">, z.ZodTemplateLiteral<`connection.${string}`>]>;
|
|
2467
|
+
type MailSenderId = typeof MAIL_SENDER_SYSTEM | `connection.${string}`;
|
|
2468
|
+
/**
|
|
2469
|
+
* One recipient of a literal list: an address, a person of the instance by id, or a workspace,
|
|
2470
|
+
* which stands for its members. A person or member without an address is skipped and counted.
|
|
2471
|
+
*/
|
|
2472
|
+
declare const mailRecipientSchema: z.ZodUnion<readonly [z.ZodObject<{
|
|
2473
|
+
address: z.ZodEmail;
|
|
2474
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2475
|
+
user: z.ZodString;
|
|
2476
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2477
|
+
workspace: z.ZodString;
|
|
2478
|
+
}, z.core.$strict>]>;
|
|
2479
|
+
type MailSendRecipient = z.infer<typeof mailRecipientSchema>;
|
|
2480
|
+
declare const mailRecipientListSchema: z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2481
|
+
address: z.ZodEmail;
|
|
2482
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2483
|
+
user: z.ZodString;
|
|
2484
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2485
|
+
workspace: z.ZodString;
|
|
2486
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2487
|
+
email: z.ZodEmail;
|
|
2488
|
+
}, z.core.$loose>]>>]>;
|
|
2489
|
+
type MailSendRecipientList = z.infer<typeof mailRecipientListSchema>;
|
|
2490
|
+
/**
|
|
2491
|
+
* What `cc` and `bcc` take: as `to`, and an empty list too, since a referenced list of copy
|
|
2492
|
+
* recipients may hold nobody and the mail still goes to `to`.
|
|
2493
|
+
*/
|
|
2494
|
+
declare const mailCopyRecipientListSchema: z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2495
|
+
address: z.ZodEmail;
|
|
2496
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2497
|
+
user: z.ZodString;
|
|
2498
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2499
|
+
workspace: z.ZodString;
|
|
2500
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2501
|
+
email: z.ZodEmail;
|
|
2502
|
+
}, z.core.$loose>]>>]>;
|
|
2503
|
+
/** One address, or a person of the instance. The recipient rule applies to it as to `to`. */
|
|
2504
|
+
declare const mailReplyToSchema: z.ZodUnion<readonly [z.ZodEmail, z.ZodObject<{
|
|
2505
|
+
address: z.ZodEmail;
|
|
2506
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2507
|
+
user: z.ZodString;
|
|
2508
|
+
}, z.core.$strict>]>;
|
|
2509
|
+
/** One line of 1 to 200 characters with something besides spaces. */
|
|
2510
|
+
declare const mailSubjectSchema: z.ZodString;
|
|
2511
|
+
/**
|
|
2512
|
+
* The author's Markdown, rendered on the server: no raw HTML, no image, links over `https`,
|
|
2513
|
+
* `http` and `mailto` only. `format: markdown` is what makes a mapped field join lists and
|
|
2514
|
+
* tables (EW-TEXT) and escape every referenced value, and a field mapped as one reference show
|
|
2515
|
+
* each link's address after its label (MAIL-2).
|
|
2516
|
+
*/
|
|
2517
|
+
declare const mailBodySchema: z.ZodString;
|
|
2518
|
+
/** The display name on the From line. The address stays the sender's. */
|
|
2519
|
+
declare const mailSenderNameSchema: z.ZodString;
|
|
2520
|
+
/**
|
|
2521
|
+
* The input of `mail.send`, as the operation reads it after a step's mapping is resolved. Each
|
|
2522
|
+
* field of a step's mapping takes a literal, a reference or, for the strings, text joined
|
|
2523
|
+
* from parts (EW-TEXT). `attachments` arrives with MAIL-4 and is refused until then.
|
|
2524
|
+
*/
|
|
2525
|
+
declare const mailSendInputSchema: z.ZodObject<{
|
|
2526
|
+
sender: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"system">, z.ZodTemplateLiteral<`connection.${string}`>]>>;
|
|
2527
|
+
to: z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2528
|
+
address: z.ZodEmail;
|
|
2529
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2530
|
+
user: z.ZodString;
|
|
2531
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2532
|
+
workspace: z.ZodString;
|
|
2533
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2534
|
+
email: z.ZodEmail;
|
|
2535
|
+
}, z.core.$loose>]>>]>;
|
|
2536
|
+
cc: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2537
|
+
address: z.ZodEmail;
|
|
2538
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2539
|
+
user: z.ZodString;
|
|
2540
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2541
|
+
workspace: z.ZodString;
|
|
2542
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2543
|
+
email: z.ZodEmail;
|
|
2544
|
+
}, z.core.$loose>]>>]>>;
|
|
2545
|
+
bcc: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2546
|
+
address: z.ZodEmail;
|
|
2547
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2548
|
+
user: z.ZodString;
|
|
2549
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2550
|
+
workspace: z.ZodString;
|
|
2551
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2552
|
+
email: z.ZodEmail;
|
|
2553
|
+
}, z.core.$loose>]>>]>>;
|
|
2554
|
+
subject: z.ZodString;
|
|
2555
|
+
body: z.ZodString;
|
|
2556
|
+
senderName: z.ZodOptional<z.ZodString>;
|
|
2557
|
+
replyTo: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodObject<{
|
|
2558
|
+
address: z.ZodEmail;
|
|
2559
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2560
|
+
user: z.ZodString;
|
|
2561
|
+
}, z.core.$strict>]>>;
|
|
2562
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
2563
|
+
en: "en";
|
|
2564
|
+
de: "de";
|
|
2565
|
+
}>>;
|
|
2566
|
+
}, z.core.$strict>;
|
|
2567
|
+
type MailSendInput = z.infer<typeof mailSendInputSchema>;
|
|
2568
|
+
type MailSendInputFields = z.input<typeof mailSendInputSchema>;
|
|
2569
|
+
/**
|
|
2570
|
+
* What a live or test send answers: counts and the provider's message id, never an address.
|
|
2571
|
+
* `skipped` counts people and members without an address. `test` marks "Run live once",
|
|
2572
|
+
* which sent to the tester alone.
|
|
2573
|
+
*/
|
|
2574
|
+
declare const mailSendOutputSchema: z.ZodObject<{
|
|
2575
|
+
sentAt: z.ZodISODateTime;
|
|
2576
|
+
messageId: z.ZodOptional<z.ZodString>;
|
|
2577
|
+
recipients: z.ZodObject<{
|
|
2578
|
+
to: z.ZodNumber;
|
|
2579
|
+
cc: z.ZodNumber;
|
|
2580
|
+
bcc: z.ZodNumber;
|
|
2581
|
+
}, z.core.$strict>;
|
|
2582
|
+
skipped: z.ZodNumber;
|
|
2583
|
+
test: z.ZodOptional<z.ZodLiteral<true>>;
|
|
2584
|
+
}, z.core.$strict>;
|
|
2585
|
+
type MailSendOutput = z.infer<typeof mailSendOutputSchema>;
|
|
2586
|
+
/** A recipient as a preview names it: a person by name, an address as written. */
|
|
2587
|
+
declare const mailPreviewRecipientSchema: z.ZodObject<{
|
|
2588
|
+
kind: z.ZodEnum<{
|
|
2589
|
+
address: "address";
|
|
2590
|
+
person: "person";
|
|
2591
|
+
}>;
|
|
2592
|
+
label: z.ZodString;
|
|
2593
|
+
}, z.core.$strict>;
|
|
2594
|
+
type MailPreviewRecipient = z.infer<typeof mailPreviewRecipientSchema>;
|
|
2595
|
+
/**
|
|
2596
|
+
* The mail as it would go out, checked against the recipient rule. It is step data of a test
|
|
2597
|
+
* run and the confirmation card's content; it is never audit data.
|
|
2598
|
+
*/
|
|
2599
|
+
declare const mailSendPreviewSchema: z.ZodObject<{
|
|
2600
|
+
from: z.ZodObject<{
|
|
2601
|
+
name: z.ZodString;
|
|
2602
|
+
address: z.ZodEmail;
|
|
2603
|
+
}, z.core.$strict>;
|
|
2604
|
+
replyTo: z.ZodOptional<z.ZodEmail>;
|
|
2605
|
+
to: z.ZodArray<z.ZodObject<{
|
|
2606
|
+
kind: z.ZodEnum<{
|
|
2607
|
+
address: "address";
|
|
2608
|
+
person: "person";
|
|
2609
|
+
}>;
|
|
2610
|
+
label: z.ZodString;
|
|
2611
|
+
}, z.core.$strict>>;
|
|
2612
|
+
cc: z.ZodArray<z.ZodObject<{
|
|
2613
|
+
kind: z.ZodEnum<{
|
|
2614
|
+
address: "address";
|
|
2615
|
+
person: "person";
|
|
2616
|
+
}>;
|
|
2617
|
+
label: z.ZodString;
|
|
2618
|
+
}, z.core.$strict>>;
|
|
2619
|
+
bcc: z.ZodArray<z.ZodObject<{
|
|
2620
|
+
kind: z.ZodEnum<{
|
|
2621
|
+
address: "address";
|
|
2622
|
+
person: "person";
|
|
2623
|
+
}>;
|
|
2624
|
+
label: z.ZodString;
|
|
2625
|
+
}, z.core.$strict>>;
|
|
2626
|
+
skipped: z.ZodNumber;
|
|
2627
|
+
subject: z.ZodString;
|
|
2628
|
+
html: z.ZodString;
|
|
2629
|
+
text: z.ZodString;
|
|
2630
|
+
}, z.core.$strict>;
|
|
2631
|
+
type MailSendPreview = z.infer<typeof mailSendPreviewSchema>;
|
|
2632
|
+
/** What a simulated call (a test run's `dry_run`, an agent preview turn) answers. */
|
|
2633
|
+
declare const mailSendSimulatedOutputSchema: z.ZodObject<{
|
|
2634
|
+
simulated: z.ZodLiteral<true>;
|
|
2635
|
+
preview: z.ZodObject<{
|
|
2636
|
+
from: z.ZodObject<{
|
|
2637
|
+
name: z.ZodString;
|
|
2638
|
+
address: z.ZodEmail;
|
|
2639
|
+
}, z.core.$strict>;
|
|
2640
|
+
replyTo: z.ZodOptional<z.ZodEmail>;
|
|
2641
|
+
to: z.ZodArray<z.ZodObject<{
|
|
2642
|
+
kind: z.ZodEnum<{
|
|
2643
|
+
address: "address";
|
|
2644
|
+
person: "person";
|
|
2645
|
+
}>;
|
|
2646
|
+
label: z.ZodString;
|
|
2647
|
+
}, z.core.$strict>>;
|
|
2648
|
+
cc: z.ZodArray<z.ZodObject<{
|
|
2649
|
+
kind: z.ZodEnum<{
|
|
2650
|
+
address: "address";
|
|
2651
|
+
person: "person";
|
|
2652
|
+
}>;
|
|
2653
|
+
label: z.ZodString;
|
|
2654
|
+
}, z.core.$strict>>;
|
|
2655
|
+
bcc: z.ZodArray<z.ZodObject<{
|
|
2656
|
+
kind: z.ZodEnum<{
|
|
2657
|
+
address: "address";
|
|
2658
|
+
person: "person";
|
|
2659
|
+
}>;
|
|
2660
|
+
label: z.ZodString;
|
|
2661
|
+
}, z.core.$strict>>;
|
|
2662
|
+
skipped: z.ZodNumber;
|
|
2663
|
+
subject: z.ZodString;
|
|
2664
|
+
html: z.ZodString;
|
|
2665
|
+
text: z.ZodString;
|
|
2666
|
+
}, z.core.$strict>;
|
|
2667
|
+
}, z.core.$strict>;
|
|
2668
|
+
type MailSendSimulatedOutput = z.infer<typeof mailSendSimulatedOutputSchema>;
|
|
2669
|
+
/**
|
|
2670
|
+
* The params of the template `workflow-message`, per mail. The frame (the instance's name,
|
|
2671
|
+
* embedded logo, accent colour and `outbound.footer`) is the instance's and not a param; the
|
|
2672
|
+
* envelope (From name, to, cc, bcc, Reply-To) is the message's and not a param either.
|
|
2673
|
+
* `markdown` arrives with every joined referenced value already escaped, and a body mapped as
|
|
2674
|
+
* one reference with each link's address shown. `test` puts "[Test]" before
|
|
2675
|
+
* the subject and lists whom the mail would have reached.
|
|
2676
|
+
*/
|
|
2677
|
+
declare const workflowMessageMailParamsSchema: z.ZodObject<{
|
|
2678
|
+
subject: z.ZodString;
|
|
2679
|
+
markdown: z.ZodString;
|
|
2680
|
+
sentBy: z.ZodDiscriminatedUnion<[z.ZodObject<{
|
|
2681
|
+
kind: z.ZodLiteral<"workflow">;
|
|
2682
|
+
workflowName: z.ZodString;
|
|
2683
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2684
|
+
kind: z.ZodLiteral<"agent">;
|
|
2685
|
+
onBehalfOf: z.ZodString;
|
|
2686
|
+
}, z.core.$strict>], "kind">;
|
|
2687
|
+
test: z.ZodOptional<z.ZodObject<{
|
|
2688
|
+
intendedRecipients: z.ZodObject<{
|
|
2689
|
+
to: z.ZodArray<z.ZodObject<{
|
|
2690
|
+
kind: z.ZodEnum<{
|
|
2691
|
+
address: "address";
|
|
2692
|
+
person: "person";
|
|
2693
|
+
}>;
|
|
2694
|
+
label: z.ZodString;
|
|
2695
|
+
}, z.core.$strict>>;
|
|
2696
|
+
cc: z.ZodArray<z.ZodObject<{
|
|
2697
|
+
kind: z.ZodEnum<{
|
|
2698
|
+
address: "address";
|
|
2699
|
+
person: "person";
|
|
2700
|
+
}>;
|
|
2701
|
+
label: z.ZodString;
|
|
2702
|
+
}, z.core.$strict>>;
|
|
2703
|
+
bcc: z.ZodArray<z.ZodObject<{
|
|
2704
|
+
kind: z.ZodEnum<{
|
|
2705
|
+
address: "address";
|
|
2706
|
+
person: "person";
|
|
2707
|
+
}>;
|
|
2708
|
+
label: z.ZodString;
|
|
2709
|
+
}, z.core.$strict>>;
|
|
2710
|
+
}, z.core.$strict>;
|
|
2711
|
+
}, z.core.$strict>>;
|
|
2712
|
+
}, z.core.$strict>;
|
|
2713
|
+
type WorkflowMessageMailParams = z.infer<typeof workflowMessageMailParamsSchema>;
|
|
2714
|
+
/**
|
|
2715
|
+
* What the step facts of a `mail.send` step carry beside `source { kind: "mail_sender", title,
|
|
2716
|
+
* service }`, where `service` is the icon key: the sender's address and the instance's
|
|
2717
|
+
* `recipientDomains`, so the panel marks an address a run would refuse.
|
|
2718
|
+
*/
|
|
2719
|
+
declare const workflowMailSenderFactSchema: z.ZodObject<{
|
|
2720
|
+
sender: z.ZodString;
|
|
2721
|
+
title: z.ZodString;
|
|
2722
|
+
icon: z.ZodString;
|
|
2723
|
+
address: z.ZodEmail;
|
|
2724
|
+
recipientDomains: z.ZodArray<z.ZodString>;
|
|
2725
|
+
}, z.core.$strict>;
|
|
2726
|
+
type WorkflowMailSenderFact = z.infer<typeof workflowMailSenderFactSchema>;
|
|
2727
|
+
/** Contract only: MAIL-1 registers the operation while `outbound.enabled` is true. */
|
|
2728
|
+
declare const mailSendContract: {
|
|
2729
|
+
readonly name: "mail.send";
|
|
2730
|
+
readonly description: "Send one e-mail as a sender of the instance (system unless set). Recipients are addresses, people of the instance and workspaces; an address outside the instance's recipient domains is refused. The body is Markdown in the instance's frame. A test run previews the mail and sends nothing.";
|
|
2731
|
+
readonly inputSchema: z.ZodObject<{
|
|
2732
|
+
sender: z.ZodDefault<z.ZodUnion<readonly [z.ZodLiteral<"system">, z.ZodTemplateLiteral<`connection.${string}`>]>>;
|
|
2733
|
+
to: z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2734
|
+
address: z.ZodEmail;
|
|
2735
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2736
|
+
user: z.ZodString;
|
|
2737
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2738
|
+
workspace: z.ZodString;
|
|
2739
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2740
|
+
email: z.ZodEmail;
|
|
2741
|
+
}, z.core.$loose>]>>]>;
|
|
2742
|
+
cc: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2743
|
+
address: z.ZodEmail;
|
|
2744
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2745
|
+
user: z.ZodString;
|
|
2746
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2747
|
+
workspace: z.ZodString;
|
|
2748
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2749
|
+
email: z.ZodEmail;
|
|
2750
|
+
}, z.core.$loose>]>>]>>;
|
|
2751
|
+
bcc: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodArray<z.ZodUnion<readonly [z.ZodEmail, z.ZodUnion<readonly [z.ZodObject<{
|
|
2752
|
+
address: z.ZodEmail;
|
|
2753
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2754
|
+
user: z.ZodString;
|
|
2755
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2756
|
+
workspace: z.ZodString;
|
|
2757
|
+
}, z.core.$strict>]>, z.ZodObject<{
|
|
2758
|
+
email: z.ZodEmail;
|
|
2759
|
+
}, z.core.$loose>]>>]>>;
|
|
2760
|
+
subject: z.ZodString;
|
|
2761
|
+
body: z.ZodString;
|
|
2762
|
+
senderName: z.ZodOptional<z.ZodString>;
|
|
2763
|
+
replyTo: z.ZodOptional<z.ZodUnion<readonly [z.ZodEmail, z.ZodObject<{
|
|
2764
|
+
address: z.ZodEmail;
|
|
2765
|
+
}, z.core.$strict>, z.ZodObject<{
|
|
2766
|
+
user: z.ZodString;
|
|
2767
|
+
}, z.core.$strict>]>>;
|
|
2768
|
+
locale: z.ZodOptional<z.ZodEnum<{
|
|
2769
|
+
en: "en";
|
|
2770
|
+
de: "de";
|
|
2771
|
+
}>>;
|
|
2772
|
+
}, z.core.$strict>;
|
|
2773
|
+
readonly outputSchema: z.ZodObject<{
|
|
2774
|
+
sentAt: z.ZodISODateTime;
|
|
2775
|
+
messageId: z.ZodOptional<z.ZodString>;
|
|
2776
|
+
recipients: z.ZodObject<{
|
|
2777
|
+
to: z.ZodNumber;
|
|
2778
|
+
cc: z.ZodNumber;
|
|
2779
|
+
bcc: z.ZodNumber;
|
|
2780
|
+
}, z.core.$strict>;
|
|
2781
|
+
skipped: z.ZodNumber;
|
|
2782
|
+
test: z.ZodOptional<z.ZodLiteral<true>>;
|
|
2783
|
+
}, z.core.$strict>;
|
|
2784
|
+
readonly simulatedOutputSchema: z.ZodObject<{
|
|
2785
|
+
simulated: z.ZodLiteral<true>;
|
|
2786
|
+
preview: z.ZodObject<{
|
|
2787
|
+
from: z.ZodObject<{
|
|
2788
|
+
name: z.ZodString;
|
|
2789
|
+
address: z.ZodEmail;
|
|
2790
|
+
}, z.core.$strict>;
|
|
2791
|
+
replyTo: z.ZodOptional<z.ZodEmail>;
|
|
2792
|
+
to: z.ZodArray<z.ZodObject<{
|
|
2793
|
+
kind: z.ZodEnum<{
|
|
2794
|
+
address: "address";
|
|
2795
|
+
person: "person";
|
|
2796
|
+
}>;
|
|
2797
|
+
label: z.ZodString;
|
|
2798
|
+
}, z.core.$strict>>;
|
|
2799
|
+
cc: z.ZodArray<z.ZodObject<{
|
|
2800
|
+
kind: z.ZodEnum<{
|
|
2801
|
+
address: "address";
|
|
2802
|
+
person: "person";
|
|
2803
|
+
}>;
|
|
2804
|
+
label: z.ZodString;
|
|
2805
|
+
}, z.core.$strict>>;
|
|
2806
|
+
bcc: z.ZodArray<z.ZodObject<{
|
|
2807
|
+
kind: z.ZodEnum<{
|
|
2808
|
+
address: "address";
|
|
2809
|
+
person: "person";
|
|
2810
|
+
}>;
|
|
2811
|
+
label: z.ZodString;
|
|
2812
|
+
}, z.core.$strict>>;
|
|
2813
|
+
skipped: z.ZodNumber;
|
|
2814
|
+
subject: z.ZodString;
|
|
2815
|
+
html: z.ZodString;
|
|
2816
|
+
text: z.ZodString;
|
|
2817
|
+
}, z.core.$strict>;
|
|
2818
|
+
}, z.core.$strict>;
|
|
2819
|
+
readonly effect: "changing";
|
|
2820
|
+
readonly changeClass: "outward";
|
|
2821
|
+
readonly right: "mail_sender.use";
|
|
2822
|
+
readonly resourceKind: "mail_sender";
|
|
2823
|
+
readonly events: {
|
|
2824
|
+
readonly after: "mail.sent";
|
|
2825
|
+
readonly refused: "mail.refused";
|
|
2826
|
+
};
|
|
2827
|
+
readonly errorCodes: {
|
|
2828
|
+
readonly recipientNotAllowed: "recipient_not_allowed";
|
|
2829
|
+
readonly noRecipient: "no_recipient";
|
|
2830
|
+
readonly mailRejected: "mail_rejected";
|
|
2831
|
+
readonly workspaceNotAllowed: "workspace_not_allowed";
|
|
2832
|
+
};
|
|
2833
|
+
};
|
|
2834
|
+
|
|
2835
|
+
/** One instance's data separation dimension. SCOPE-1 serves one dimension. */
|
|
2836
|
+
declare const dataScopeNameSchema: z.ZodString;
|
|
2837
|
+
declare const dataScopesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
2838
|
+
label: z.ZodString;
|
|
2839
|
+
valueType: z.ZodLiteral<"text">;
|
|
2840
|
+
}, z.core.$strict>>;
|
|
2841
|
+
type DataScopes = z.infer<typeof dataScopesSchema>;
|
|
2842
|
+
declare const scopeAssignmentInputSchema: z.ZodObject<{
|
|
2843
|
+
dimension: z.ZodString;
|
|
2844
|
+
holderKind: z.ZodEnum<{
|
|
2845
|
+
user: "user";
|
|
2846
|
+
service_principal: "service_principal";
|
|
2847
|
+
group: "group";
|
|
2848
|
+
}>;
|
|
2849
|
+
holderId: z.ZodString;
|
|
2850
|
+
effect: z.ZodEnum<{
|
|
2851
|
+
allow: "allow";
|
|
2852
|
+
deny: "deny";
|
|
2853
|
+
}>;
|
|
2854
|
+
values: z.ZodUnion<readonly [z.ZodLiteral<"all">, z.ZodArray<z.ZodString>]>;
|
|
2855
|
+
}, z.core.$strict>;
|
|
2856
|
+
type ScopeAssignmentInput = z.infer<typeof scopeAssignmentInputSchema>;
|
|
2857
|
+
declare const scopedTablesSchema: z.ZodRecord<z.ZodString, z.ZodObject<{
|
|
2858
|
+
scope: z.ZodRecord<z.ZodString, z.ZodString>;
|
|
2859
|
+
}, z.core.$strict>>;
|
|
2860
|
+
type ScopedTables = z.infer<typeof scopedTablesSchema>;
|
|
2861
|
+
|
|
2862
|
+
/** The longest comment. */
|
|
2863
|
+
declare const FEEDBACK_TEXT_MAX_LENGTH = 4000;
|
|
2864
|
+
/** The longest machine-written summary and category a workflow stores on a comment. */
|
|
2865
|
+
declare const FEEDBACK_SUMMARY_MAX_LENGTH = 1000;
|
|
2866
|
+
declare const FEEDBACK_CATEGORY_MAX_LENGTH = 60;
|
|
2867
|
+
/** The longest note a reviewer leaves when marking a comment handled. */
|
|
2868
|
+
declare const FEEDBACK_NOTE_MAX_LENGTH = 2000;
|
|
2869
|
+
/**
|
|
2870
|
+
* What a comment is about. `message` in the first version; an App and a Workflow run follow
|
|
2871
|
+
* (LU-6), each with a reference of its own.
|
|
2872
|
+
*/
|
|
2873
|
+
declare const FEEDBACK_SUBJECT_KINDS: readonly ["message"];
|
|
2874
|
+
type FeedbackSubjectKind = (typeof FEEDBACK_SUBJECT_KINDS)[number];
|
|
2875
|
+
declare const FEEDBACK_STATES: readonly ["new", "handled"];
|
|
2876
|
+
type FeedbackState = (typeof FEEDBACK_STATES)[number];
|
|
2877
|
+
|
|
2878
|
+
/** The source of an operation. A source the caller may not read is told by its kind alone. */
|
|
2879
|
+
declare const operationSourceSchema: z.ZodObject<{
|
|
2880
|
+
kind: z.ZodEnum<{
|
|
2881
|
+
workflow: "workflow";
|
|
2882
|
+
other: "other";
|
|
2883
|
+
connection: "connection";
|
|
2884
|
+
data_store: "data_store";
|
|
2885
|
+
knowledge_base: "knowledge_base";
|
|
2886
|
+
}>;
|
|
2887
|
+
title: z.ZodOptional<z.ZodString>;
|
|
2888
|
+
service: z.ZodOptional<z.ZodString>;
|
|
2889
|
+
}, z.core.$strip>;
|
|
2890
|
+
type OperationSourceView = z.infer<typeof operationSourceSchema>;
|
|
2891
|
+
declare const callableOperationSchema: z.ZodObject<{
|
|
2892
|
+
name: z.ZodString;
|
|
2893
|
+
effect: z.ZodEnum<{
|
|
2894
|
+
reading: "reading";
|
|
2895
|
+
changing: "changing";
|
|
2896
|
+
}>;
|
|
2897
|
+
title: z.ZodString;
|
|
2898
|
+
description: z.ZodOptional<z.ZodString>;
|
|
2899
|
+
source: z.ZodObject<{
|
|
2900
|
+
kind: z.ZodEnum<{
|
|
2901
|
+
workflow: "workflow";
|
|
2902
|
+
other: "other";
|
|
2903
|
+
connection: "connection";
|
|
2904
|
+
data_store: "data_store";
|
|
2905
|
+
knowledge_base: "knowledge_base";
|
|
2906
|
+
}>;
|
|
2907
|
+
title: z.ZodOptional<z.ZodString>;
|
|
2908
|
+
service: z.ZodOptional<z.ZodString>;
|
|
2909
|
+
}, z.core.$strip>;
|
|
2910
|
+
available: z.ZodBoolean;
|
|
2911
|
+
inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
2912
|
+
outputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
2913
|
+
}, z.core.$strip>;
|
|
2914
|
+
type CallableOperationView = z.infer<typeof callableOperationSchema>;
|
|
2915
|
+
/** One page of callable operations. */
|
|
2916
|
+
declare const callableOperationsPageSchema: z.ZodObject<{
|
|
2917
|
+
operations: z.ZodArray<z.ZodObject<{
|
|
2918
|
+
name: z.ZodString;
|
|
2919
|
+
effect: z.ZodEnum<{
|
|
2920
|
+
reading: "reading";
|
|
2921
|
+
changing: "changing";
|
|
2922
|
+
}>;
|
|
2923
|
+
title: z.ZodString;
|
|
2924
|
+
description: z.ZodOptional<z.ZodString>;
|
|
2925
|
+
source: z.ZodObject<{
|
|
2926
|
+
kind: z.ZodEnum<{
|
|
2927
|
+
workflow: "workflow";
|
|
2928
|
+
other: "other";
|
|
2929
|
+
connection: "connection";
|
|
2930
|
+
data_store: "data_store";
|
|
2931
|
+
knowledge_base: "knowledge_base";
|
|
2932
|
+
}>;
|
|
2933
|
+
title: z.ZodOptional<z.ZodString>;
|
|
2934
|
+
service: z.ZodOptional<z.ZodString>;
|
|
2935
|
+
}, z.core.$strip>;
|
|
2936
|
+
available: z.ZodBoolean;
|
|
2937
|
+
inputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
2938
|
+
outputSchema: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
2939
|
+
}, z.core.$strip>>;
|
|
2940
|
+
nextCursor: z.ZodOptional<z.ZodString>;
|
|
2941
|
+
truncated: z.ZodBoolean;
|
|
2942
|
+
}, z.core.$strip>;
|
|
2943
|
+
type CallableOperationsPage = z.infer<typeof callableOperationsPageSchema>;
|
|
2944
|
+
|
|
2945
|
+
export { ACCESS_SOURCES, ACTIONS, ACTIVE_AGENT_RUN_STATUSES, ADMINISTERED_USER_STATUSES, AGENT_AVAILABILITY_MODES, AGENT_EDITABLE_FIELDS, AGENT_PREVIEW_SOURCES, AGENT_RUN_FAILURE_CATEGORIES, AGENT_RUN_STATUSES, AGENT_STARTERS_MAX, AGENT_USE_SETTINGS, API_CREDENTIAL_SCOPES, APPROVAL_CHECK_FAILURE_OUTCOMES, APPROVAL_CHECK_STATUSES, APPROVAL_EXECUTIONS, APPROVAL_REQUEST_STATUSES, APP_ACTION_CALL_STATUSES, APP_AUDIENCES, APP_ERROR_CODES, APP_ERROR_STATUS_CODES, APP_MODES, ARTIFACT_PREVIEW_IMAGE_FORMATS, ARTIFACT_PREVIEW_IMAGE_MIME_TYPES, ARTIFACT_PREVIEW_STATUSES, ASSET_ACCESS_VERBS, ASSET_LIFECYCLES, ASSET_NAME_REFUSAL_REASONS, ASSET_OWNER_KINDS, ASSET_REPO_BUNDLE_KINDS, ASSET_REPRESENTATIONS, ASSET_SYNC_CHANGE_TYPES, ATTACHMENT_CREATE_OUTCOMES, AUDIT_ACTOR_KINDS, AUDIT_EVENT_STATUSES, AUDIT_OUTCOMES, AUDIT_TIERS, AUTH_PRINCIPAL_KINDS, AUTH_SCOPE_WILDCARD, AWS_ACCOUNT_ID, type AccessSource, type ActiveAgentRunStatus, type AdministeredUserStatus, type AgentAvailabilityMode, type AgentConfig, type AgentEditableField, type AgentInitialPromptConfig, type AgentRunFailureCategory, type AgentRunStatus, type AgentUse, type ApiCredentialScope, type AppActionCallStatus, type AppErrorCode, type AppMode, type ApprovalCheckFailureOutcome, type ApprovalCheckStatus, type ApprovalExecution, type ApprovalRequestStatus, type ArtifactPreviewImageFormat, type ArtifactPreviewImageMimeType, type ArtifactPreviewStatus, type AssetLifecycle, type AssetNameRefusalReason, type AssetOwnerKind, type AssetRepoBundleKind, type AssetRepresentation, type AssetSyncChangeType, type AttachmentCreateOutcome, type AuditActorKind, type AuditEventStatus, type AuditOutcome, type AuditTier, type AuthPrincipalKind, BEDROCK_REGION, CATALOGUE_CATEGORIES, CATALOGUE_PARTS, CHAT_MESSAGE_ROLES, CHAT_SESSION_AUTH_SCOPES, COLLABORATION_WORKSPACE_KINDS, CONFIG_ASSET_CHANGE_OPERATIONS, CONFIG_ASSET_KINDS, CONNECTION_BINDING_STATES, CONNECTION_CREDENTIAL_MODES, CONNECTION_EXPOSURES, CONNECTION_HEALTH_STATES, CONNECTION_NAME_MAX_LENGTH, CONNECTION_NAME_PATTERN, CONNECTION_NETWORKS, CONNECTION_OAUTH_REGISTRATIONS, CONNECTION_OPERATION_POLICIES, CONNECTION_OPERATION_STATUSES, CONNECTION_ORIGINS, CONNECTION_PROPOSAL_BINDING_STATES, CONNECTION_PROPOSAL_STATES, CONNECTION_PROVIDER_REVOCATIONS, CONNECTION_SECRET_STATES, CONNECTION_SIGN_IN_NEEDS, CONNECTOR_TEST_STATUSES, CONVERSATION_ATTACHMENT_STATUSES, CONVERSATION_KINDS, CONVERSATION_VISIBILITIES, type CallableOperationView, type CallableOperationsPage, type CatalogueCategory, type CataloguePart, type ChatMessageRole, type ChatSessionAuthScope, type CollaborationWorkspaceKind, type ConfigAssetChangeOperation, type ConfigAssetKind, type ConnectionBindingState, type ConnectionCredentialMode, type ConnectionExposure, type ConnectionHealth, type ConnectionNetwork, type ConnectionOAuthRegistration, type ConnectionOperationPolicy, type ConnectionOperationStatus, type ConnectionOrigin, type ConnectionProposalBindingState, type ConnectionProposalState, type ConnectionProviderRevocation, type ConnectionSecretState, type ConnectionSignInNeed, type ConnectorTestStatus, type ConversationAttachmentStatus, type ConversationKind, type ConversationVisibility, DATABASE_RELATION_TYPES, DATA_STORE_CONDITIONS, DATA_STORE_INSERT_CONFLICT_MODES, DATA_STORE_LOAD_CONFLICT_MODES, DATA_STORE_MIGRATION_OUTCOMES, DATA_STORE_SCALAR_TYPES, DATA_STORE_STATUSES, DECIDED_APPROVAL_REQUEST_STATUSES, DELETION_STATES, type DataScopes, type DataStoreCondition, type DataStoreInsertConflictMode, type DataStoreLoadConflictMode, type DataStoreMigrationOutcome, type DataStoreRecordField, type DataStoreRecordProposalItem, type DataStoreRecordsDecideInput, type DataStoreRecordsDecideOutput, type DataStoreRecordsFlaggedInput, type DataStoreRecordsFlaggedOutput, type DataStoreRecordsProposeInput, type DataStoreRecordsRule, type DataStoreScalarType, type DataStoreStatus, type DatabaseRelationType, type DecidedApprovalRequestStatus, type DeletionState, ENDED_AGENT_RUN_STATUSES, ENDED_APPROVAL_EXECUTIONS, type EndedAgentRunStatus, type EndedApprovalExecution, FAILED_JOB_STATUSES, FEEDBACK_CATEGORY_MAX_LENGTH, FEEDBACK_NOTE_MAX_LENGTH, FEEDBACK_STATES, FEEDBACK_SUBJECT_KINDS, FEEDBACK_SUMMARY_MAX_LENGTH, FEEDBACK_TEXT_MAX_LENGTH, FIRST_PARTY_AUTH_SCOPES, FOLLOW_UP_MODES, FOLLOW_UP_STATUSES, type FailedJobStatus, type FeedbackState, type FeedbackSubjectKind, type FirstPartyAuthScope, GRANT_EFFECTS, GRANT_HOLDER_KINDS, GRANT_SCOPE_KINDS, GUARDRAIL_HIT_OUTCOMES, GUARDRAIL_NAME_MAX_LENGTH, GUARDRAIL_NAME_PATTERN, GUARDRAIL_OUTCOMES, type GrantEffect, type GrantHolderKind, type GrantScopeKind, type GuardrailHitOutcome, type GuardrailOutcome, IDEMPOTENCY_KEY_MAX_LENGTH, INFRASTRUCTURE_SECRET_STATES, INFRASTRUCTURE_WITHHELD_FIELDS, type InfrastructureSecretState, type InfrastructureWithheldField, JOB_STATUSES, type JobStatus, KNOWLEDGE_BASE_STATUSES, KNOWLEDGE_CHECK_STATUSES, KNOWLEDGE_DOCUMENT_FAILURE_CODES, KNOWLEDGE_DOCUMENT_STATES, KNOWLEDGE_DOCUMENT_WAIT_CODES, KNOWLEDGE_EMBEDDING_STATES, KNOWLEDGE_FILE_MAX_BYTES, KNOWLEDGE_SEARCH_SIGNALS, KNOWLEDGE_SOURCE_FAILURE_CODES, KNOWLEDGE_SOURCE_ITEM_FAILURE_CODES, KNOWLEDGE_SOURCE_ITEM_SHOWN_STATES, KNOWLEDGE_SOURCE_ITEM_STATES, KNOWLEDGE_SYNC_COUNTS, KNOWLEDGE_SYNC_MODES, KNOWLEDGE_SYNC_RUN_STATES, type KnowledgeBaseStatus, type KnowledgeCheckStatus, type KnowledgeDocumentFailureCode, type KnowledgeDocumentState, type KnowledgeDocumentWaitCode, type KnowledgeExtractFieldsInput, type KnowledgeExtractFieldsOutput, type KnowledgeFirstPassConfirmation, type KnowledgeIngestFetch, type KnowledgeIngestInput, type KnowledgeIngestItem, type KnowledgeIngestOutput, type KnowledgeLocateInput, type KnowledgeLocateOutput, type KnowledgePendingInput, type KnowledgePendingOutput, type KnowledgePendingRow, type KnowledgeProcessorOutput, type KnowledgePutProcessedInput, type KnowledgeRetryInput, type KnowledgeRetryOutput, type KnowledgeSearchSignal, type KnowledgeSourceFailureCode, type KnowledgeSourceItemFailureCode, type KnowledgeSourceItemShownState, type KnowledgeSourceItemState, type KnowledgeSourceItemsInput, type KnowledgeSourceItemsOutput, type KnowledgeSourcesOutput, type KnowledgeSyncCount, type KnowledgeSyncInput, type KnowledgeSyncMode, type KnowledgeSyncResult, type KnowledgeSyncRunState, type KnowledgeWithdrawInput, type KnowledgeWithdrawOutput, type KnowledgeWorkflowSource, type KnowledgeWorkflowSourcesOutput, LISTED_DATA_STORE_STATUSES, LIVE_JOB_STATUSES, type ListedDataStoreStatus, type LiveJobStatus, type LocaleCode, type LocalizedStringConfig, MAIL_ADDRESS_MAX_LENGTH, MAIL_ATTACHMENTS_MAX_BYTES, MAIL_ATTACHMENTS_MAX_FILES, MAIL_AUDIT_MAX_DOMAINS, MAIL_BODY_MAX_BYTES, MAIL_OUTBOUND_DEFAULT_LIMITS, MAIL_OUTBOUND_FOOTER_MAX_LENGTH, MAIL_RECIPIENT_DOMAINS_ANY, MAIL_RECIPIENT_DOMAIN_PATTERN, MAIL_RECIPIENT_ID_PATTERN, MAIL_SENDER_CONNECTION_PREFIX, MAIL_SENDER_NAME_MAX_LENGTH, MAIL_SENDER_RESOURCE_KIND, MAIL_SENDER_SYSTEM, MAIL_SENDER_SYSTEM_ICON, MAIL_SENDER_USE_ACTION, MAIL_SEND_ERROR_CODES, MAIL_SEND_MAX_ADDRESSES, MAIL_SEND_OPERATION, MAIL_SEND_REFUSAL_REASONS, MAIL_SUBJECT_MAX_LENGTH, MAIL_WORKFLOW_MESSAGE_TEMPLATE, MANAGED_FILE_STATUSES, MESSAGE_FINISH_STATUSES, MODEL_FALLBACK_REASONS, MODEL_PROVIDER_AUTH_MODES, MODEL_USAGE_EVENT_STATUSES, MODEL_USAGE_LIMIT_METRICS, MODEL_USAGE_LIMIT_PERIODS, MODEL_USAGE_LIMIT_SCOPES, MODEL_USAGE_SOURCES, MODEL_USAGE_TIERS, type MailPreviewRecipient, type MailSendErrorCode, type MailSendInput, type MailSendInputFields, type MailSendOutput, type MailSendPreview, type MailSendRecipient, type MailSendRecipientList, type MailSendRefusalDetails, type MailSendSimulatedOutput, type MailSenderId, type MessageFinishStatus, type ModelFallbackReason, type ModelProviderAuthMode, type ModelUsageEventStatus, type ModelUsageRefusal, type ModelUsageSource, type ModelUsageTier, NOTIFY_CHANNELS, type NotifyChannel, OPENAI_COMPATIBLE_APIS, OPERATIONS_AUDIENCES, OPERATION_CHANGE_CLASSES, OPERATION_CONFIRMATION_DECISIONS, OPERATION_DENIAL_REASONS, OPERATION_EFFECTS, OPERATION_ORIGIN_KINDS, OPERATION_RUN_DECISION_MODES, OPERATION_RUN_DECISION_REASONS, OPERATION_RUN_STATUSES, OPERATION_SOURCE_KINDS, OPERATION_TARGETS, type OpenaiCompatibleApi, type OperationBatchFailure, type OperationBatchResult, type OperationDenialReason, type OperationEffect, type OperationOriginKind, type OperationPaging, type OperationRunDecisionMode, type OperationRunDecisionReason, type OperationRunStatus, type OperationScope, type OperationSourceKind, type OperationSourceView, type OperationTarget, type OperationsAudience, PERSONAL_WORKSPACES_KEY, PERSON_POLICY_SETTINGS, POLICY_VALUES, PRINCIPAL_HOLDER_KINDS, PROVIDER_CHECK_ERROR_CLASSES, PROVIDER_PORTS, PROVIDER_REGIONS, PUBLISHED_DATA_CONSUMER_KINDS, type PlatformAction, type PolicyValue, type PrincipalHolderKind, type ProviderCheckErrorClass, type ProviderPort, type ProviderRegion, type PublishedDataConsumerKind, READING_POLICY_VALUES, REASONING_EFFORTS, RECORDS_FLAGGED_MAX_ITEMS_PER_PAGE, RECORDS_PROPOSE_MAX_FIELDS_PER_ITEM, RECORDS_PROPOSE_MAX_ITEMS_PER_CALL, RECORD_FIELD_FAILURE_CODES, RECORD_FIELD_STATES, RECORD_FLAG_REASONS, ROLE_GRANT_SCOPE_KINDS, ROLE_PENDING_CHANGES, ROLE_PENDING_DECISIONS, type ReadingPolicyValue, type ReasoningEffortConfig, type RecordColumn, type RecordEvidenceResult, type RoleGrantScopeKind, type RolePendingDecision, SCHEDULED_START_STATES, SECRET_NAME_EXPECTATION, SERVICE_PRINCIPAL_PERMISSIONS, SERVICE_PRINCIPAL_STATUSES, SKILL_CHANGE_TYPES, SKILL_FRONTMATTER_FIELDS, SKILL_FRONTMATTER_MAX_BYTES, SKILL_FRONTMATTER_MAX_DEPTH, SKILL_NAME_PATTERN, SKILL_NAME_RULE, SKILL_ORIGINS, SKILL_PORTABLE_DESCRIPTION_MAX_CHARS, SKILL_PORTABLE_NAME_MAX_CHARS, SKILL_RESOURCE_MEDIA_TYPES, SKILL_STARTERS_MAX, SKILL_STARTER_LINE_MAX_LENGTH, SKILL_SUMMARY_MAX_LENGTH, STRUCTURED_DATA_REVIEW_REASONS, SUPPORTED_IMAGE_MIME_TYPES, type ScopeAssignmentInput, type ScopedTables, type ServicePrincipalPermission, type ServicePrincipalStatus, type SkillChangeType, type SkillConfig, type SkillFileEntry, type SkillFrontmatterRefusal, SkillMarkdownError, type SkillOrigin, type SkillResourceConfig, type SkillResourceMediaType, type SkillStarterConfig, type StructuredDataReviewReason, type SupportedImageMimeType, THEME_MODES, THEME_MODE_PREFERENCES, TOOL_CALL_STATES, TOOL_DECISION_MODES, TOOL_DECISION_OUTCOMES, TOOL_DISPLAY_MODES, TOOL_GROUPS, TOOL_INPUT_PARSE_ERROR_CODES, type ThemeMode, type ThemeModePreference, type ToolCallState, type ToolDisplayMode, type ToolGroup, type ToolInputParseErrorCode, USAGE_BREAKDOWN_DIMENSIONS, USAGE_COST_STATUSES, USAGE_ORIGINS, USAGE_SPEND_LIMIT_LEVELS, USER_STATUSES, type UsageCostStatus, type UserStatus, WAITING_OPERATION_RUN_STATUSES, WEB_SOURCE_PROVIDERS, WORKFLOW_DATASET_DOWNLOAD_FORMATS, WORKFLOW_DATASET_STATES, WORKFLOW_ENDED_STATUSES, WORKFLOW_EXECUTED_STEP_TYPES, WORKFLOW_KINDS, WORKFLOW_MARKDOWN_MAX_COLUMNS, WORKFLOW_MARKDOWN_MAX_ROWS, WORKFLOW_NAME_PATTERN, WORKFLOW_NAME_RULE, WORKFLOW_RESERVED_STEP_TYPES, WORKFLOW_RIGHTS_REVISIONS, WORKFLOW_RIGHT_NEEDED_FOR, WORKFLOW_RIGHT_REFUSALS, WORKFLOW_RUN_ACCOUNT_STATUSES, WORKFLOW_RUN_MODES, WORKFLOW_RUN_STATUSES, WORKFLOW_STEP_RUN_STATUSES, WORKFLOW_STEP_SOURCE_KINDS, WORKFLOW_STEP_TYPES, WORKFLOW_TEST_REVISIONS, WORKFLOW_TEXT_FORMAT_MARKDOWN, WORKFLOW_TEXT_MAX_PARTS, WORKFLOW_TRIGGER_KINDS, WORKSPACE_ACCENT_COLORS, WORKSPACE_ACCESS_STATES, WORKSPACE_COMMAND_STATUSES, WORKSPACE_FILE_KINDS, WORKSPACE_MEMBERSHIP_ROLES, WORKSPACE_SECTIONS, WORKSPACE_USE_ASSET_KINDS, WORKSPACE_VISIBILITIES, type WebSourceProvider, type WorkflowAssetConfig, type WorkflowDatasetDownloadFormat, type WorkflowDatasetState, type WorkflowEndedStatus, type WorkflowKind, type WorkflowMailSenderFact, type WorkflowMessageMailParams, type WorkflowReservedStepType, type WorkflowRunMode, type WorkflowRunStatus, type WorkflowStepRunStatus, type WorkflowStepSourceKind, type WorkflowStepType, type WorkflowTestRevision, type WorkflowTriggerKind, type WorkspaceAccentColor, type WorkspaceAccessState, type WorkspaceCommandStatus, type WorkspaceFileKind, type WorkspaceMembershipRole, type WorkspaceSection, type WorkspaceVisibility, YAML_DATA_MAX_VALUES, YamlDataError, type YamlDataIssue, type YamlDataIssueCode, type YamlDataOptions, type YamlDataResult, agentConfigSchema, bedrockProfileRefusal, callableOperationSchema, callableOperationsPageSchema, checkStorableTexts, dataScopeNameSchema, dataScopesSchema, dataStoreRecordFieldSchema, dataStoreRecordProposalItemSchema, dataStoreRecordsContracts, dataStoreRecordsDecideInputSchema, dataStoreRecordsDecideOutputSchema, dataStoreRecordsFlaggedInputSchema, dataStoreRecordsFlaggedOutputSchema, dataStoreRecordsProposeInputSchema, dataStoreRecordsRuleSchema, deriveSkillTitle, formatSkillMarkdown, isPlainConfigObject, isSecretName, isStorableText, knowledgeExtractFieldsInputSchema, knowledgeExtractFieldsOutputSchema, knowledgeFieldValueSchema, knowledgeFirstPassConfirmationSchema, knowledgeIngestFetchSchema, knowledgeIngestInputSchema, knowledgeIngestItemSchema, knowledgeIngestOutputSchema, knowledgeLocateInputSchema, knowledgeLocateOutputSchema, knowledgePendingInputSchema, knowledgePendingOutputSchema, knowledgePendingRowSchema, knowledgeProcessorOutputSchema, knowledgePutProcessedInputSchema, knowledgeRecordsRefusalSchema, knowledgeRetryInputSchema, knowledgeRetryOutputSchema, knowledgeSourceItemsInputSchema, knowledgeSourceItemsOutputSchema, knowledgeSourcesOutputSchema, knowledgeSyncInputSchema, knowledgeSyncResultSchema, knowledgeWithdrawInputSchema, knowledgeWithdrawOutputSchema, knowledgeWorkflowSourceSchema, knowledgeWorkflowSourcesOutputSchema, knowledgeWriteContracts, loadYamlData, localeCodes, localizedStringSchema, mailAddressSchema, mailBodySchema, mailCopyRecipientListSchema, mailPreviewRecipientSchema, mailRecipientDomainSchema, mailRecipientListSchema, mailRecipientSchema, mailReplyToSchema, mailSendContract, mailSendInputSchema, mailSendOutputSchema, mailSendPreviewSchema, mailSendRefusalDetailsSchema, mailSendSimulatedOutputSchema, mailSenderIdSchema, mailSenderNameSchema, mailSubjectSchema, mergeConfigObjects, operationBatchFailureSchema, operationBatchResultSchema, operationPagingSchema, operationSourceSchema, parseSkillMarkdown, providerRegionSchema, readYamlData, recordColumnTakes, recordEvidenceResultSchema, scopeAssignmentInputSchema, scopedTablesSchema, skillConfigSchema, skillFileEntrySchema, skillFileFrontmatterSchema, skillNameSchema, skillPortabilityIssues, skillResourceConfigSchema, skillResourceMediaTypeForPath, skillResourcePathSchema, skillStarterSchema, workflowConfigSchema, workflowDataFlowsSchema, workflowDatasetReferenceSchema, workflowMailSenderFactSchema, workflowMessageMailParamsSchema, yamlValueIssue, yamlValueIssueSentence };
|