@revoengine/sdk 1.6.7 → 1.6.8
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/README.md +11 -3
- package/dist/{errors-Cdksdvcb.d.cts → errors-DAkcmPyN.d.cts} +183 -32
- package/dist/{errors-Cdksdvcb.d.ts → errors-DAkcmPyN.d.ts} +183 -32
- package/dist/hosted.cjs +1136 -161
- package/dist/hosted.cjs.map +1 -1
- package/dist/hosted.d.cts +2 -2
- package/dist/hosted.d.ts +2 -2
- package/dist/hosted.js +1136 -161
- package/dist/hosted.js.map +1 -1
- package/dist/index.cjs +1136 -161
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +1003 -158
- package/dist/index.d.ts +1003 -158
- package/dist/index.js +1136 -161
- package/dist/index.js.map +1 -1
- package/package.json +1 -1
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
import * as node_worker_threads from 'node:worker_threads';
|
|
2
2
|
import { Buffer as Buffer$1 } from 'node:buffer';
|
|
3
3
|
|
|
4
|
-
declare const SDK_VERSION: "1.6.
|
|
4
|
+
declare const SDK_VERSION: "1.6.8";
|
|
5
5
|
declare const PROTOCOL_VERSION: 1;
|
|
6
|
-
declare const CONTRACT_REVISION: "
|
|
6
|
+
declare const CONTRACT_REVISION: "cda216e308d857954aa46b31185a8b653015dd1e3d84996bdf3a93745e72bd43";
|
|
7
7
|
type RuntimeSurfaceName = 'api' | 'storage' | 'transport' | 'vault' | 'serviceAccount' | 'agents' | 'lowCode';
|
|
8
8
|
|
|
9
9
|
// AUTO-GENERATED FILE. DO NOT EDIT DIRECTLY.
|
|
@@ -44,7 +44,7 @@ interface SwaggerAgentCheapTurnPolicyDto {
|
|
|
44
44
|
}
|
|
45
45
|
interface SwaggerAgentConfigDto {
|
|
46
46
|
/** Supported assistant model used when the agent starts a thread. */
|
|
47
|
-
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
47
|
+
"model"?: "gpt-6.1-sol" | "gpt-6.1-terra" | "gpt-6-luna";
|
|
48
48
|
/** Reasoning effort passed to assistant threads. */
|
|
49
49
|
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
50
50
|
/** Durable execution-mode default used for agent-loop turns. Per-turn fast-path routing and prompt-tier selection are derived by runtime, not configured here. */
|
|
@@ -57,6 +57,10 @@ interface SwaggerAgentConfigDto {
|
|
|
57
57
|
"persona"?: "friendly" | "pragmatic" | "professional" | "concise" | "calm" | "mentor" | "assertive";
|
|
58
58
|
/** Additional per-agent system instructions persisted with the definition. Runtime policy still has higher priority. */
|
|
59
59
|
"systemInstructions"?: string;
|
|
60
|
+
/** Context profile for new Agent threads. platform preserves the normal Agent context; minimal reduces automatic context while retaining mandatory policy and configured Agent instructions. Existing Agent tool and plugin admission is unchanged. Existing threads retain their saved profile on continuation and Resume. */
|
|
61
|
+
"contextMode"?: "platform" | "minimal";
|
|
62
|
+
/** Validated final-answer format for new Agent threads. Defaults to text. JSON may use the shared strict response schema contract. Existing threads retain their saved format on continuation and Resume; this field never replaces systemInstructions. */
|
|
63
|
+
"responseFormat"?: SwaggerAssistantResponseFormatDto;
|
|
60
64
|
/** One persistent Agent memory shared by Memory settings and runtime memory tools, included in instructions on every turn. Limited to 20,000 assistant tokens. */
|
|
61
65
|
"memory"?: string;
|
|
62
66
|
/** Structured operator-owned Agent identity loaded on every autonomous turn. Learned memory cannot mutate this definition. */
|
|
@@ -400,6 +404,42 @@ interface SwaggerAgentReleaseRolloutPolicyDto {
|
|
|
400
404
|
/** Optional admitted snapshot to roll back to when the current rollout is revoked. */
|
|
401
405
|
"rollbackToSnapshotId"?: string;
|
|
402
406
|
}
|
|
407
|
+
interface SwaggerAssistantOutputDto {
|
|
408
|
+
/** Validated final-answer format. */
|
|
409
|
+
"type": "text" | "json";
|
|
410
|
+
/** Complete validated answer text. This value is independent of bounded operator summaries. */
|
|
411
|
+
"text": string;
|
|
412
|
+
/** Complete parsed object for a validated JSON answer; absent for text answers. */
|
|
413
|
+
"json"?: Record<string, unknown>;
|
|
414
|
+
}
|
|
415
|
+
interface SwaggerAssistantResponseFormatDto {
|
|
416
|
+
/** Final answer format. JSON without a schema requires a JSON object; with a schema it uses strict Structured Outputs. Defaults to text. */
|
|
417
|
+
"type": "text" | "json";
|
|
418
|
+
/** Optional strict JSON Schema for a JSON object response. All object properties must be required and additionalProperties must be false. Only local schema references are allowed. Maximum 32 KiB. */
|
|
419
|
+
"schema"?: Record<string, unknown>;
|
|
420
|
+
/** Schema responses are always strict. Defaults to true when schema is supplied; false and strict without a schema are rejected. */
|
|
421
|
+
"strict"?: true;
|
|
422
|
+
}
|
|
423
|
+
interface SwaggerAssistantThreadlessResponseContextDto {
|
|
424
|
+
/** Current Revo UI component hint included in the response context. It does not automatically select tools or skills. */
|
|
425
|
+
"componentContext"?: "PREFERENCES" | "USERS" | "SERVICE_ACCOUNTS" | "GROUPS" | "ROLE_GROUPS" | "SECRETS" | "REVISIONS" | "DATABASES" | "DATABASE_OPERATIONS" | "DATABASE_VIEWS" | "DATA" | "DATA_ITEMS" | "ENDPOINTS" | "TEMPLATES" | "SCHEDULE" | "SCHEDULE_HISTORY" | "EVENTS" | "JOBS" | "AGENTS" | "AGENT_RUNS" | "AGENT_INBOX" | "AGENT_PLUGINS" | "AGENT_TERMINALS" | "WEBHOOKS" | "COMPONENTS" | "COMPONENT_ELEMENTS" | "EVENTS_HISTORY" | "USER_KEYS" | "FILES" | "STORAGE" | "REALTIME" | "LOGS" | "MONITORING" | "THREAD" | "SECURITY_SETTINGS" | "ME_SETTINGS" | "ME_KEYS" | "USER_DETAILS" | "PLAYGROUND" | "WEB_IDE";
|
|
426
|
+
/** UI-level intent hint for the lightweight response. */
|
|
427
|
+
"kind"?: "suggestion" | "code_refactor" | "code_explain" | "completion" | "generic";
|
|
428
|
+
/** Additional UI instruction for this lightweight response. */
|
|
429
|
+
"instruction"?: string;
|
|
430
|
+
/** Programming or content language hint, for example typescript. */
|
|
431
|
+
"language"?: string;
|
|
432
|
+
/** Optional file/component path currently shown in the UI. */
|
|
433
|
+
"filePath"?: string;
|
|
434
|
+
/** Current selected text/code from the UI. */
|
|
435
|
+
"selectedText"?: string;
|
|
436
|
+
/** Nearby text/code around the current selection. */
|
|
437
|
+
"surroundingText"?: string;
|
|
438
|
+
/** Optional exact platform refs already known by the UI. */
|
|
439
|
+
"resourceRefs"?: Array<string>;
|
|
440
|
+
/** Compatibility context tags. Currently do not affect response context or tool selection. */
|
|
441
|
+
"requestContext"?: Array<string>;
|
|
442
|
+
}
|
|
403
443
|
interface SwaggerDatabaseDefinition {
|
|
404
444
|
/** Column id, required only for update. */
|
|
405
445
|
"databaseDefinitionId"?: string;
|
|
@@ -466,19 +506,19 @@ interface SwaggerDatabaseIndexExpressionDto {
|
|
|
466
506
|
"fn"?: string;
|
|
467
507
|
"args"?: Array<SwaggerDatabaseIndexExpressionDto>;
|
|
468
508
|
"cast"?: string;
|
|
469
|
-
"literal"?:
|
|
509
|
+
"literal"?: string | number | boolean | null;
|
|
470
510
|
}
|
|
471
511
|
interface SwaggerDatabaseIndexPredicateDto {
|
|
472
512
|
/** Logical AND. */
|
|
473
|
-
"and"?: Array<
|
|
513
|
+
"and"?: Array<SwaggerDatabaseIndexPredicateDto>;
|
|
474
514
|
/** Logical OR. */
|
|
475
|
-
"or"?: Array<
|
|
515
|
+
"or"?: Array<SwaggerDatabaseIndexPredicateDto>;
|
|
476
516
|
/** Logical NOT. */
|
|
477
517
|
"not"?: SwaggerDatabaseIndexPredicateDto;
|
|
478
518
|
"column"?: string;
|
|
479
519
|
"op"?: "eq" | "ne" | "gt" | "gte" | "lt" | "lte" | "like" | "ilike" | "in" | "between" | "isnull" | "notnull";
|
|
480
|
-
"value"?:
|
|
481
|
-
"values"?: Array<string>;
|
|
520
|
+
"value"?: string | number | boolean | null;
|
|
521
|
+
"values"?: Array<string | number | boolean | null>;
|
|
482
522
|
}
|
|
483
523
|
interface SwaggerDatabaseOptionsDto {
|
|
484
524
|
"indexes"?: Array<SwaggerDatabaseIndexDefinitionDto>;
|
|
@@ -707,6 +747,42 @@ interface SwaggerWebhookRequestPatchDto {
|
|
|
707
747
|
/** Explicit replacement of the whole body. Omitted body reuses the saved body. */
|
|
708
748
|
"body"?: Record<string, unknown> | Array<unknown>;
|
|
709
749
|
}
|
|
750
|
+
interface SwaggerAgentRunResultDto {
|
|
751
|
+
/** Complete validated terminal answer, independent of the bounded human-readable summary. */
|
|
752
|
+
"output"?: SwaggerAssistantOutputDto;
|
|
753
|
+
/** Bounded human-readable terminal summary. Use output.text or output.json for the complete answer. */
|
|
754
|
+
"summary"?: string;
|
|
755
|
+
}
|
|
756
|
+
interface AssistantThreadQuery {
|
|
757
|
+
/** Number of rows to skip before pagination starts. Parsed from a query-string integer. */
|
|
758
|
+
"skip"?: number;
|
|
759
|
+
/** Maximum number of rows to return. Parsed from a query-string integer. Most list endpoints default to 100 when omitted. */
|
|
760
|
+
"take"?: number;
|
|
761
|
+
/** Include the total count in the response envelope only when explicitly true. Omitted or false skips the count query. */
|
|
762
|
+
"count"?: boolean;
|
|
763
|
+
/** Filter tree as a JSON string or bracket-style query object. Supports and/or/not groups and field predicates with ops such as eq, ne, gt, gte, lt, lte, like, notLike, ilike, notILike, in, notIn, any, isNull, isNotNull, between, contains, containedBy, arrayHas, arrayHasAny, arrayHasAll, arrayContainedBy, jsonArrayHas, jsonArrayHasAny, jsonArrayHasAll, startsWith, endsWith, true, and false. Field names are allowed logical fields; relation fields use dot paths such as groups.groupId when exposed by the endpoint. */
|
|
764
|
+
"filter"?: string;
|
|
765
|
+
/** Sort definition as a JSON string, indexed array query object, array, or legacy CSV. JSON object values should be ASC or DESC. CSV supports descending fields with a leading dash, for example name,-lastUpdateAt. */
|
|
766
|
+
"sort"?: string;
|
|
767
|
+
/** Optional DISTINCT ON logical fields as a JSON array string, indexed array query object, array, or legacy CSV. Selected distinct fields are included in the projection. */
|
|
768
|
+
"distinct"?: string;
|
|
769
|
+
/** Optional field projection as a JSON array string, indexed array query object, array, or legacy CSV. String fields must be allowlisted logical fields. Advanced select items may use field, fn, raw, cast, coalesce, or case expressions when the endpoint enables dynamic projection. */
|
|
770
|
+
"fields"?: string;
|
|
771
|
+
/** Optional join definitions as a JSON string or bracket-style query object. This is only honored by endpoints that explicitly enable dynamic joins, such as dynamic database data reads. Each join has table, alias, type (left or inner), and an on condition. */
|
|
772
|
+
"joins"?: string;
|
|
773
|
+
/** Optional groupBy logical fields as a JSON array string, indexed array query object, array, or legacy CSV. Only honored when the endpoint enables dynamic grouping or already has grouped defaults. */
|
|
774
|
+
"groupBy"?: string;
|
|
775
|
+
/** Optional cast mapping as a JSON string or bracket-style query object. Keys are selected aliases or logical fields; values are database definition types such as TEXT, INTEGER, BIGINT, NUMERIC, BOOLEAN, DATE, TIMESTAMP, TIMESTAMPTZ, JSON, JSONB, or UUID where supported. */
|
|
776
|
+
"cast"?: string;
|
|
777
|
+
/** Optional CTE definitions as a JSON string or bracket-style query object. Only honored by endpoints that explicitly enable dynamic CTEs. */
|
|
778
|
+
"with"?: string;
|
|
779
|
+
/** Enable debug output for the request, including compiled SQL, bound params, and bounded EXPLAIN plans when the endpoint supports it. */
|
|
780
|
+
"debug"?: boolean;
|
|
781
|
+
/** Include technical response threads alongside conversations. Independent of deleted visibility. */
|
|
782
|
+
"includeResponses"?: boolean;
|
|
783
|
+
/** Include deleted owned threads. Independent of technical response visibility. */
|
|
784
|
+
"includeDeleted"?: boolean;
|
|
785
|
+
}
|
|
710
786
|
interface AgentRunCancelInput {
|
|
711
787
|
/** Optional cancellation reason for audit traces. */
|
|
712
788
|
"reason"?: string;
|
|
@@ -812,14 +888,30 @@ interface ServiceAccountKeyCreateInput {
|
|
|
812
888
|
"expireAt"?: string;
|
|
813
889
|
}
|
|
814
890
|
interface AssistantMessageInput {
|
|
891
|
+
/** Instructions persisted on this thread across follow-up messages, Resume, same-owner forks and compaction. Maximum 16 KiB UTF-8 and 16 KiB after safe instruction rendering. Supplements mandatory runtime and instance-global instructions; never grants tool permissions. Immutable after creation. */
|
|
892
|
+
"instructions"?: string;
|
|
893
|
+
/** Persisted context profile. platform preserves the normal Revo Assistant. minimal keeps instance-global and account standing instructions and safety, omits automatic memory and plugin discovery/preload, and admits only explicitly selected tools/plugins. Defaults to platform. Immutable after creation. */
|
|
894
|
+
"contextMode"?: "platform" | "minimal";
|
|
895
|
+
/** Persisted final-answer format, also enforced on browser follow-ups and Resume. Defaults to text. Immutable after creation. */
|
|
896
|
+
"responseFormat"?: SwaggerAssistantResponseFormatDto;
|
|
897
|
+
/** Per-turn approval policy. default requires approval for side-effecting tool calls, auto_review uses conditional safe auto-review, and full skips normal approval gates. */
|
|
898
|
+
"permissions"?: "default" | "auto_review" | "full";
|
|
899
|
+
/** Optional per-tool approval policy overrides. Runtime sanitizes keys and enum values before persisting them. */
|
|
900
|
+
"toolPermissions"?: Record<string, "default" | "auto_review" | "full">;
|
|
901
|
+
/** Optional allowlist of operational tool names for this turn. Omit to allow the gateway default surface; pass an empty array to admit no tools for direct-answer turns. */
|
|
902
|
+
"toolNames"?: Array<"ref_search" | "ref_describe" | "ref_apply" | "snapshot_get" | "snapshot_history" | "snapshot_diff" | "storage" | "skill_search" | "skill_load" | "memory_search" | "memory_load" | "memory_save" | "plan_update" | "code_search" | "code_read" | "code_exec" | "ops_investigate" | "platform_api_find_operation" | "dependency_graph" | "web_search" | "web_load" | "web_rich_lookup" | "wait" | "conversation_search" | "conversation_load" | "attachment_load" | "send_message" | "agent_handoff" | "agent_delegate" | "plugin_search" | "plugin_load" | "plugin_call" | "request_clarification" | "code_describe" | "generate_widget" | "terminal_exec" | "terminal" | "studio" | "tool_exec" | "tool_wait" | "tool_status" | "tool_cancel">;
|
|
903
|
+
/** Optional registry plugin ids attached to this assistant turn. */
|
|
904
|
+
"pluginIds"?: Array<string>;
|
|
905
|
+
/** Optional Studio session to work on in this conversation. Requires an enabled Studio feature and live editing membership. The binding persists across follow-up turns and does not share private conversation history. */
|
|
906
|
+
"studioSessionId"?: string;
|
|
815
907
|
/** Finalized Storage files to link to this message. File access is checked on send and every read. */
|
|
816
908
|
"storageEntryIds"?: Array<string>;
|
|
817
909
|
/** Content of the message, validated up to 100000 tokens. */
|
|
818
910
|
"content": string;
|
|
819
911
|
/** Optional hidden draft user message id created before attachment uploads. When provided, the send operation finalizes that draft instead of creating a new user message. */
|
|
820
912
|
"preflightMessageId"?: string;
|
|
821
|
-
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6.1 Sol and GPT-6 Luna are supported. */
|
|
822
|
-
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
913
|
+
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6.1 Sol, GPT-6.1 Terra and GPT-6 Luna are supported. */
|
|
914
|
+
"model"?: "gpt-6.1-sol" | "gpt-6.1-terra" | "gpt-6-luna";
|
|
823
915
|
/** Optional GPT-6 Luna Fast mode. Defaults to false and remains opt-in per thread. */
|
|
824
916
|
"fastMode"?: boolean;
|
|
825
917
|
/** Optional assistant reasoning effort override: none, low, medium, high, or xhigh. Defaults to medium. */
|
|
@@ -838,14 +930,6 @@ interface AssistantMessageInput {
|
|
|
838
930
|
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
839
931
|
/** Planning policy for the turn. standard lets the assistant use internal planning and optionally expose progress; review_required always creates a user-reviewed plan before execution. */
|
|
840
932
|
"planningPolicy"?: "standard" | "review_required";
|
|
841
|
-
/** Per-turn approval policy. default requires approval for side-effecting tool calls, auto_review uses conditional safe auto-review, and full skips normal approval gates. */
|
|
842
|
-
"permissions"?: "default" | "auto_review" | "full";
|
|
843
|
-
/** Optional per-tool approval policy overrides. Runtime sanitizes keys and enum values before persisting them. */
|
|
844
|
-
"toolPermissions"?: Record<string, "default" | "auto_review" | "full">;
|
|
845
|
-
/** Optional allowlist of operational tool names for this turn. Omit to allow the gateway default surface; pass an empty array to admit no tools for direct-answer turns. */
|
|
846
|
-
"toolNames"?: Array<string>;
|
|
847
|
-
/** Optional registry plugin ids attached to this assistant turn. */
|
|
848
|
-
"pluginIds"?: Array<string>;
|
|
849
933
|
/** Optional per-turn backend performance debugger. When true, payload build timing traces are persisted into assistant report artifacts, and local/test runtimes may persist hidden model-call snapshots for this turn. */
|
|
850
934
|
"performanceDebugger"?: boolean;
|
|
851
935
|
}
|
|
@@ -937,6 +1021,58 @@ interface StorageUploadSessionInput {
|
|
|
937
1021
|
/** Explicit allowed user ids for the finalized entry. */
|
|
938
1022
|
"users"?: Array<string>;
|
|
939
1023
|
}
|
|
1024
|
+
interface AssistantResponseInput {
|
|
1025
|
+
/** Instructions persisted on this thread across follow-up messages, Resume, same-owner forks and compaction. Maximum 16 KiB UTF-8 and 16 KiB after safe instruction rendering. Supplements mandatory runtime and instance-global instructions; never grants tool permissions. Immutable after creation. */
|
|
1026
|
+
"instructions"?: string;
|
|
1027
|
+
/** Persisted context profile. platform preserves the normal Revo Assistant. minimal keeps instance-global and account standing instructions and safety, omits automatic memory and plugin discovery/preload, and admits only explicitly selected tools/plugins. Defaults to platform. Immutable after creation. */
|
|
1028
|
+
"contextMode"?: "platform" | "minimal";
|
|
1029
|
+
/** Persisted final-answer format, also enforced on browser follow-ups and Resume. Defaults to text. Immutable after creation. */
|
|
1030
|
+
"responseFormat"?: SwaggerAssistantResponseFormatDto;
|
|
1031
|
+
/** Per-turn approval policy. default requires approval for side-effecting tool calls, auto_review uses conditional safe auto-review, and full skips normal approval gates. */
|
|
1032
|
+
"permissions"?: "default" | "auto_review" | "full";
|
|
1033
|
+
/** Optional per-tool approval policy overrides. Runtime sanitizes keys and enum values before persisting them. */
|
|
1034
|
+
"toolPermissions"?: Record<string, "default" | "auto_review" | "full">;
|
|
1035
|
+
/** Optional allowlist of operational tool names for this turn. Omit to allow the gateway default surface; pass an empty array to admit no tools for direct-answer turns. */
|
|
1036
|
+
"toolNames"?: Array<"ref_search" | "ref_describe" | "ref_apply" | "snapshot_get" | "snapshot_history" | "snapshot_diff" | "storage" | "skill_search" | "skill_load" | "memory_search" | "memory_load" | "memory_save" | "plan_update" | "code_search" | "code_read" | "code_exec" | "ops_investigate" | "platform_api_find_operation" | "dependency_graph" | "web_search" | "web_load" | "web_rich_lookup" | "wait" | "conversation_search" | "conversation_load" | "attachment_load" | "send_message" | "agent_handoff" | "agent_delegate" | "plugin_search" | "plugin_load" | "plugin_call" | "request_clarification" | "code_describe" | "generate_widget" | "terminal_exec" | "terminal" | "studio" | "tool_exec" | "tool_wait" | "tool_status" | "tool_cancel">;
|
|
1037
|
+
/** Optional registry plugin ids attached to this assistant turn. */
|
|
1038
|
+
"pluginIds"?: Array<string>;
|
|
1039
|
+
/** Optional Studio session to work on in this conversation. Requires an enabled Studio feature and live editing membership. The binding persists across follow-up turns and does not share private conversation history. */
|
|
1040
|
+
"studioSessionId"?: string;
|
|
1041
|
+
/** Finalized Storage files to link to this message. File access is checked on send and every read. */
|
|
1042
|
+
"storageEntryIds"?: Array<string>;
|
|
1043
|
+
/** Content of the message, validated up to 100000 tokens. */
|
|
1044
|
+
"content": string;
|
|
1045
|
+
/** Optional hidden draft user message id created before attachment uploads. When provided, the send operation finalizes that draft instead of creating a new user message. */
|
|
1046
|
+
"preflightMessageId"?: string;
|
|
1047
|
+
/** Optional assistant execution-model override. GPT-6 Luna is the default; GPT-6.1 Sol, GPT-6.1 Terra and GPT-6 Luna are supported. */
|
|
1048
|
+
"model"?: "gpt-6.1-sol" | "gpt-6.1-terra" | "gpt-6-luna";
|
|
1049
|
+
/** Optional GPT-6 Luna Fast mode. Defaults to false and remains opt-in per thread. */
|
|
1050
|
+
"fastMode"?: boolean;
|
|
1051
|
+
/** Optional assistant reasoning effort override: none, low, medium, high, or xhigh. Defaults to medium. */
|
|
1052
|
+
"reasoningEffort"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
1053
|
+
/** Alias for reasoningEffort used by assistant preferences. Prefer reasoningEffort for new clients. */
|
|
1054
|
+
"reasoning"?: "none" | "low" | "medium" | "high" | "xhigh";
|
|
1055
|
+
/** Optional flag selecting deadline-bounded background provider recovery. On SSE routes it also allows the turn to continue after client disconnect. Defaults to false. */
|
|
1056
|
+
"backgroundProcessing"?: boolean;
|
|
1057
|
+
/** Optional flag for send-message endpoints. When true, an active streamed assistant turn for the thread is interrupted before appending this message. */
|
|
1058
|
+
"interruptActive"?: boolean;
|
|
1059
|
+
/** Internal steer flag set by steer endpoints. When true, the visible user message is preserved while the executor receives a wrapper telling it to apply the message as a correction or refinement to the interrupted task. */
|
|
1060
|
+
"steeringMode"?: boolean;
|
|
1061
|
+
/** Optional durable turn goal for non-plan execution. Agent runtime carries this goal across tool loops, compaction, and follow-up turns without forcing visible plan review. */
|
|
1062
|
+
"goal"?: string;
|
|
1063
|
+
/** Execution mode for the turn. Interactive may pause for approval or clarification. Background and automation should avoid user-blocking pauses. */
|
|
1064
|
+
"executionMode"?: "interactive" | "execute" | "background" | "automation";
|
|
1065
|
+
/** Planning policy for the turn. standard lets the assistant use internal planning and optionally expose progress; review_required always creates a user-reviewed plan before execution. */
|
|
1066
|
+
"planningPolicy"?: "standard" | "review_required";
|
|
1067
|
+
/** Optional per-turn backend performance debugger. When true, payload build timing traces are persisted into assistant report artifacts, and local/test runtimes may persist hidden model-call snapshots for this turn. */
|
|
1068
|
+
"performanceDebugger"?: boolean;
|
|
1069
|
+
/** Optional assistant runtime selector. v2 routes the request through agent-gateway. v1 is expired and rejected. */
|
|
1070
|
+
"version"?: "v1" | "v2";
|
|
1071
|
+
/** Structured UI context for lightweight, threadless assistant responses. */
|
|
1072
|
+
"context"?: SwaggerAssistantThreadlessResponseContextDto;
|
|
1073
|
+
/** Create an ordinary visible conversation when true. Otherwise retain a technical response thread excluded from default list/search results; includeResponses opts into reading it. Neither mode automatically deletes the thread or its evidence. Defaults to false. */
|
|
1074
|
+
"persistThread"?: boolean;
|
|
1075
|
+
}
|
|
940
1076
|
interface DatabaseOperationInput {
|
|
941
1077
|
/** Database ID/name, or view ID when viewAction is provided. */
|
|
942
1078
|
"databaseName": string;
|
|
@@ -977,6 +1113,8 @@ interface AssistantForkMessageInput {
|
|
|
977
1113
|
"version"?: "v1" | "v2";
|
|
978
1114
|
/** Optional explicit title for the forked thread. When omitted, orchestration will generate the new thread title. */
|
|
979
1115
|
"title"?: string;
|
|
1116
|
+
/** Bind an owned conversation fork to an OPEN Studio workspace under fresh editing access. A Studio-bound source requires a child whose parentSessionId is the original workspace. The source conversation and its private history remain unchanged. */
|
|
1117
|
+
"studioSessionId"?: string;
|
|
980
1118
|
}
|
|
981
1119
|
interface JobsBulkInput {
|
|
982
1120
|
/** Existing platform filter tree. Exactly one of filter and resource IDs is required. */
|
|
@@ -1077,7 +1215,7 @@ interface AssistantActionResolutionInput {
|
|
|
1077
1215
|
/** Optional flag selecting deadline-bounded background provider recovery. On the SSE route it also allows the resumed turn to continue after client disconnect. Streamed action resolution defaults this to true. */
|
|
1078
1216
|
"backgroundProcessing"?: boolean;
|
|
1079
1217
|
/** Optional assistant model override for the resumed turn after this action is resolved. */
|
|
1080
|
-
"model"?: "gpt-6.1-sol" | "gpt-6-luna";
|
|
1218
|
+
"model"?: "gpt-6.1-sol" | "gpt-6.1-terra" | "gpt-6-luna";
|
|
1081
1219
|
/** Optional Fast-mode override for the resumed turn. Available only on GPT-6 Luna. */
|
|
1082
1220
|
"fastMode"?: boolean;
|
|
1083
1221
|
/** Optional assistant reasoning effort override for the resumed turn: none, low, medium, high, or xhigh. */
|
|
@@ -1089,7 +1227,7 @@ interface AssistantActionResolutionInput {
|
|
|
1089
1227
|
/** Planning policy override for the resumed turn after this action is resolved. */
|
|
1090
1228
|
"planningPolicy"?: "standard" | "review_required";
|
|
1091
1229
|
/** Optional operational tool names admitted for the resumed turn. Omit to keep the current thread admission; pass an empty array to admit no tools for direct-answer continuation. */
|
|
1092
|
-
"toolNames"?: Array<
|
|
1230
|
+
"toolNames"?: Array<"ref_search" | "ref_describe" | "ref_apply" | "snapshot_get" | "snapshot_history" | "snapshot_diff" | "storage" | "skill_search" | "skill_load" | "memory_search" | "memory_load" | "memory_save" | "plan_update" | "code_search" | "code_read" | "code_exec" | "ops_investigate" | "platform_api_find_operation" | "dependency_graph" | "web_search" | "web_load" | "web_rich_lookup" | "wait" | "conversation_search" | "conversation_load" | "attachment_load" | "send_message" | "agent_handoff" | "agent_delegate" | "plugin_search" | "plugin_load" | "plugin_call" | "request_clarification" | "code_describe" | "generate_widget" | "terminal_exec" | "terminal" | "studio" | "tool_exec" | "tool_wait" | "tool_status" | "tool_cancel">;
|
|
1093
1231
|
/** Optional additional registry plugin ids attached to the resumed turn. */
|
|
1094
1232
|
"pluginIds"?: Array<string>;
|
|
1095
1233
|
}
|
|
@@ -1292,11 +1430,6 @@ interface AutomationOperation {
|
|
|
1292
1430
|
skipped: number;
|
|
1293
1431
|
failed: number;
|
|
1294
1432
|
}
|
|
1295
|
-
/**
|
|
1296
|
-
* Canonical public low-code API declarations shared by Monaco and local editors.
|
|
1297
|
-
* Lifecycle input DTOs are generated from Swagger in api.swagger-contracts.generated.d.ts.
|
|
1298
|
-
* Edit this file for model guidance, then regenerate api.monaco.ts.
|
|
1299
|
-
*/
|
|
1300
1433
|
/** Ordered, literal-safe updates. Repeated columns run top to bottom (maximum 100 operations).
|
|
1301
1434
|
* NULL is preserved unless nulls: 'empty' is selected for text/array/JSON transforms.
|
|
1302
1435
|
* insert.position is 1-based Unicode character position. replace replaces all exact matches.
|
|
@@ -2469,7 +2602,9 @@ interface ComponentExecuteRequest {
|
|
|
2469
2602
|
*/
|
|
2470
2603
|
componentId: string;
|
|
2471
2604
|
/**
|
|
2472
|
-
* Optional exact component version. Omit to
|
|
2605
|
+
* Optional exact component version. Omit to use the execution's active release.
|
|
2606
|
+
* A pinned Studio release rejects versions newer than its component binding.
|
|
2607
|
+
* Studio tests accept an explicit version only when it matches their captured source.
|
|
2473
2608
|
*/
|
|
2474
2609
|
componentVersion?: number;
|
|
2475
2610
|
/**
|
|
@@ -2744,6 +2879,10 @@ interface AgentConfig {
|
|
|
2744
2879
|
workMode?: AgentWorkMode;
|
|
2745
2880
|
persona?: AgentPersona;
|
|
2746
2881
|
systemInstructions?: string;
|
|
2882
|
+
/** Profile for new Agent threads; defaults to platform. Mandatory Agent instructions and existing tool/plugin admission remain authoritative. */
|
|
2883
|
+
contextMode?: 'platform' | 'minimal';
|
|
2884
|
+
/** Final-answer contract for new Agent threads; defaults to text. Existing threads keep their saved contract on continuation and Resume. */
|
|
2885
|
+
responseFormat?: SwaggerAssistantResponseFormatDto;
|
|
2747
2886
|
/** Persistent Agent Memory shared with memory tools and included in every instruction packet; at most 20,000 o200k_base tokens. */
|
|
2748
2887
|
memory?: string;
|
|
2749
2888
|
memoryPolicy?: AgentMemoryPolicy;
|
|
@@ -2853,7 +2992,8 @@ interface AgentRun {
|
|
|
2853
2992
|
lastHeartbeatAt?: Date | string | null;
|
|
2854
2993
|
checkpointSummary?: string | null;
|
|
2855
2994
|
state?: Record<string, any>;
|
|
2856
|
-
result
|
|
2995
|
+
/** Complete validated answer is in output; summary is bounded. Additional runtime result fields remain available. */
|
|
2996
|
+
result?: (Record<string, any> & SwaggerAgentRunResultDto) | null;
|
|
2857
2997
|
error?: Record<string, any> | null;
|
|
2858
2998
|
createdBy?: string;
|
|
2859
2999
|
createdAt?: Date | string;
|
|
@@ -2989,6 +3129,12 @@ interface AssistantActionRequired {
|
|
|
2989
3129
|
planningTransition?: AssistantPlanningTransition | null;
|
|
2990
3130
|
}
|
|
2991
3131
|
interface AssistantThread {
|
|
3132
|
+
/** conversation for ordinary chats; response for retained technical results hidden from the default conversation list. */
|
|
3133
|
+
kind?: 'conversation' | 'response';
|
|
3134
|
+
/** Immutable creation-time task contract, preserved by continuation, Resume and same-owner fork. */
|
|
3135
|
+
instructions?: string;
|
|
3136
|
+
contextMode?: 'platform' | 'minimal';
|
|
3137
|
+
responseFormat?: SwaggerAssistantResponseFormatDto;
|
|
2992
3138
|
assistantThreadId: string;
|
|
2993
3139
|
title: string;
|
|
2994
3140
|
status: string;
|
|
@@ -3059,6 +3205,8 @@ interface AssistantSharedThreadResponse {
|
|
|
3059
3205
|
}
|
|
3060
3206
|
interface AssistantThreadResponse {
|
|
3061
3207
|
thread: AssistantThread;
|
|
3208
|
+
/** Validated terminal answer for explicitly configured thread contracts. Absent while approval/clarification is required. */
|
|
3209
|
+
output?: SwaggerAssistantOutputDto;
|
|
3062
3210
|
message?: AssistantMessage | null;
|
|
3063
3211
|
assistantMessage?: AssistantMessage | null;
|
|
3064
3212
|
noticeMessages?: AssistantMessage[];
|
|
@@ -3349,7 +3497,9 @@ interface RevoApi {
|
|
|
3349
3497
|
currentUser(): LoggedUser;
|
|
3350
3498
|
isDebug(): boolean;
|
|
3351
3499
|
getCache(key: string): any;
|
|
3352
|
-
setCache(key: string, value: any
|
|
3500
|
+
setCache(key: string, value: any, options?: {
|
|
3501
|
+
reference?: boolean;
|
|
3502
|
+
}): void;
|
|
3353
3503
|
getContext(): Context;
|
|
3354
3504
|
getErrors(): ProcessLog[];
|
|
3355
3505
|
getExecutionId(): string;
|
|
@@ -3415,12 +3565,12 @@ interface RevoApi {
|
|
|
3415
3565
|
responseType: 'storage';
|
|
3416
3566
|
target: HttpStorageTargetRef;
|
|
3417
3567
|
timeout?: number;
|
|
3418
|
-
proxy?:
|
|
3568
|
+
proxy?: boolean;
|
|
3419
3569
|
}): Promise<{
|
|
3420
3570
|
status: number;
|
|
3421
3571
|
statusText: string;
|
|
3422
3572
|
time: number;
|
|
3423
|
-
headers: LooseObject<string>;
|
|
3573
|
+
headers: LooseObject<string | string[]>;
|
|
3424
3574
|
revo?: HttpRevoResponseScope;
|
|
3425
3575
|
request: {
|
|
3426
3576
|
config: HttpRequestInterface;
|
|
@@ -3443,7 +3593,7 @@ interface RevoApi {
|
|
|
3443
3593
|
status: number;
|
|
3444
3594
|
statusText: string;
|
|
3445
3595
|
time: number;
|
|
3446
|
-
headers: LooseObject<string>;
|
|
3596
|
+
headers: LooseObject<string | string[]>;
|
|
3447
3597
|
revo?: HttpRevoResponseScope;
|
|
3448
3598
|
data: any;
|
|
3449
3599
|
storage?: {
|
|
@@ -3551,7 +3701,7 @@ interface RevoAgents {
|
|
|
3551
3701
|
tickRun(agentRunId: string): Promise<AgentRun>;
|
|
3552
3702
|
cancelRun(agentRunId: string, data?: AgentRunCancelInput): Promise<AgentRun>;
|
|
3553
3703
|
reconcileRuns(): Promise<any>;
|
|
3554
|
-
listThreads(query?:
|
|
3704
|
+
listThreads(query?: AssistantThreadQuery): Promise<CollectionResult<AssistantThread>>;
|
|
3555
3705
|
getThread(assistantThreadId: string, options?: {
|
|
3556
3706
|
hideDeleted?: boolean;
|
|
3557
3707
|
}): Promise<AssistantThread>;
|
|
@@ -3565,6 +3715,7 @@ interface RevoAgents {
|
|
|
3565
3715
|
getSharedThreadMessageArtifact(shareId: string, assistantMessageId: string, artifactId: string): Promise<Record<string, any>>;
|
|
3566
3716
|
forkSharedThreadMessage(shareId: string, assistantMessageId: string, data?: AssistantForkMessageInput): Promise<AssistantThreadResponse>;
|
|
3567
3717
|
createThread(data: AssistantMessageInput): Promise<AssistantThreadResponse>;
|
|
3718
|
+
createResponse(data: AssistantResponseInput): Promise<AssistantThreadResponse>;
|
|
3568
3719
|
deleteThread(assistantThreadId: string): Promise<void>;
|
|
3569
3720
|
restoreThread(assistantThreadId: string): Promise<void>;
|
|
3570
3721
|
listThreadMessages(assistantThreadId: string, query?: Record<string, any>): Promise<CollectionResult<AssistantMessage>>;
|