@vertesia/appgen-docs 1.6.0-dev.20261019.172735Z → 1.7.0-dev.20261120.100641Z
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 +7 -5
- package/lib/docs/symbol-index.json +6793 -3949
- package/lib/docs/ui-interfaces.d.ts +81 -9
- package/lib/docs/vertesia-client.d.ts +289 -72
- package/lib/docs/vertesia-common.d.ts +210 -36
- package/package.json +13 -7
|
@@ -17,6 +17,7 @@ export type { EnableEnvironmentModelPayload, OrphanedAppInstallation } from '@ve
|
|
|
17
17
|
export { getOAuthPermissionScopes, Permission } from '@vertesia/common';
|
|
18
18
|
export * from './client.js';
|
|
19
19
|
export { default as DelegationGrantsApi } from './DelegationGrantsApi.js';
|
|
20
|
+
export type { ExecuteInteractionRequestOptions } from './execute.js';
|
|
20
21
|
export type { GroupsQueryOptions } from './GroupsApi.js';
|
|
21
22
|
export * from './InteractionBase.js';
|
|
22
23
|
export * from './InteractionOutput.js';
|
|
@@ -38,9 +39,9 @@ export type { AsyncExecutionResult };
|
|
|
38
39
|
// -----------------------------------------------------------------------------
|
|
39
40
|
// @vertesia/client: client.d.ts
|
|
40
41
|
// -----------------------------------------------------------------------------
|
|
41
|
-
import { AbstractFetchClient, type FETCH_FN, type IRequestRetryPolicy } from '@vertesia/api-fetch-client';
|
|
42
|
+
import { AbstractFetchClient, type FETCH_FN, type IPacingRetryPolicy, type IRequestRetryPolicy, type RequestIdentityProvider } from '@vertesia/api-fetch-client';
|
|
42
43
|
import type { AppSessionTokenRequest, AppSessionTokenResponse } from '@vertesia/common';
|
|
43
|
-
import { type AuthTokenPayload, type AuthTokenResponse } from '@vertesia/common';
|
|
44
|
+
import { type AuthTokenPayload, type AuthTokenResponse, type ContentSecurity } from '@vertesia/common';
|
|
44
45
|
import AccountApi from './AccountApi.js';
|
|
45
46
|
import AccountsApi from './AccountsApi.js';
|
|
46
47
|
import AnalyticsApi from './AnalyticsApi.js';
|
|
@@ -90,10 +91,14 @@ export type VertesiaClientProps = {
|
|
|
90
91
|
storeUrl?: string;
|
|
91
92
|
tokenServerUrl?: string;
|
|
92
93
|
apikey?: string;
|
|
94
|
+
/** Supplies the complete Authorization header; takes precedence over apikey. */
|
|
95
|
+
authCallback?: () => Promise<string>;
|
|
93
96
|
sessionTags?: string | string[];
|
|
97
|
+
requestIdentity?: RequestIdentityProvider;
|
|
94
98
|
onRequest?: (request: Request) => void;
|
|
95
99
|
onResponse?: (response: Response) => void;
|
|
96
100
|
retryPolicy?: IRequestRetryPolicy;
|
|
101
|
+
pacingRetry?: IPacingRetryPolicy | false;
|
|
97
102
|
/**
|
|
98
103
|
* Default request timeout in ms applied to every request (studio + store) unless overridden
|
|
99
104
|
* per-request via `timeoutMs`. `false`/`null`/`0` disables it. Aborts the whole request
|
|
@@ -107,6 +112,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
107
112
|
* The JWT token linked to the API KEY (sk or pk)
|
|
108
113
|
*/
|
|
109
114
|
_jwt: string | null;
|
|
115
|
+
private abacResolution?;
|
|
110
116
|
/**
|
|
111
117
|
* The store client
|
|
112
118
|
*/
|
|
@@ -160,6 +166,12 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
160
166
|
withApiKey(apiKey: string | null): Promise<this>;
|
|
161
167
|
getRawJWT(): Promise<string | null>;
|
|
162
168
|
getDecodedJWT(): Promise<AuthTokenPayload | null>;
|
|
169
|
+
/**
|
|
170
|
+
* Resolve ABAC only when it is needed. JWT decoding alone deliberately keeps opaque claim
|
|
171
|
+
* references intact. The existing STS validation endpoint verifies the complete bearer before
|
|
172
|
+
* loading Redis; knowing a reference alone never authorizes reading its policy.
|
|
173
|
+
*/
|
|
174
|
+
getAbac(): Promise<ContentSecurity | undefined>;
|
|
163
175
|
getProject(): Promise<import("@vertesia/common/wire-types").ProjectRef | null>;
|
|
164
176
|
getAccount(): Promise<import("@vertesia/common/wire-types").AccountRef | null>;
|
|
165
177
|
/**
|
|
@@ -175,6 +187,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
175
187
|
*/
|
|
176
188
|
get objects(): import("./index.js").ObjectsApi;
|
|
177
189
|
get files(): import("./index.js").FilesApi;
|
|
190
|
+
get contentSources(): import("./index.js").ContentSourcesApi;
|
|
178
191
|
get processes(): import("./index.js").ProcessApi;
|
|
179
192
|
get processTestRuns(): import("./index.js").ProcessTestRunApi;
|
|
180
193
|
get tasks(): import("./index.js").TaskApi;
|
|
@@ -235,10 +248,12 @@ export declare function decodeEndpoints(endpoints: string | Record<string, strin
|
|
|
235
248
|
// @vertesia/client: AppsApi.d.ts
|
|
236
249
|
// -----------------------------------------------------------------------------
|
|
237
250
|
import { ApiTopic, type ClientBase } from '@vertesia/api-fetch-client';
|
|
238
|
-
import type { AgentRunResponse, AppApiKeyCollectionParams, AppBuildProgress, AppDeleteSummary, AppDevelopmentTaskDetails, AppDevelopmentTaskList, AppGithubConfiguration, AppGithubRepositoryList, AppGithubRepositorySetup, AppInspectionResult, AppInstallation, AppInstallationKind, AppInstallationListEntry, AppInstallationPayload, AppInstallationWithManifest, AppInstanceAvailability, AppManifest, AppManifestData, AppPackage, AppPackageScope, AppRepoBranch, AppRepoCommits, AppRepoDocumentCommit, AppRepoRefs, AppRepoTree, AppScaffoldProgress, AppsQuery, AppToolCollection, AppVersionListQuery, AppVersionRecord, CountResult, CreateAppRepoBranchRequest, DeleteAppVersionResponse, ExchangeAppGithubAuthorizationResponse, McpApiKeyStatus, ProjectRef, PromoteAppVersionResponse, RequireAtLeastOne, StartAppBuildRequest, StartAppBuildResponse, StartAppDevelopmentTaskRequest, StartAppGithubAuthorizationResponse, StartAppScaffoldRequest, StartAppScaffoldResponse, UpdateAppPayload, UpsertAppVersionRequest, ValidateUrlResponse } from '@vertesia/common';
|
|
251
|
+
import type { AgentRunResponse, AppApiKeyCollectionParams, AppBuildProgress, AppDeleteSummary, AppDevelopmentTaskDetails, AppDevelopmentTaskList, AppGithubConfiguration, AppGithubRepositoryList, AppGithubRepositorySetup, AppInspectionResult, AppInstallation, AppInstallationKind, AppInstallationListEntry, AppInstallationPayload, AppInstallationWithManifest, AppInstanceAvailability, AppManifest, AppManifestData, AppPackage, AppPackageScope, AppRepoBranch, AppRepoCommits, AppRepoDocumentCommit, AppRepoRefs, AppRepoTree, AppScaffoldProgress, AppsQuery, AppToolCollection, AppVersionLaunchTarget, AppVersionListQuery, AppVersionRecord, CountResult, CreateAppRepoBranchRequest, CreateAppVersionLaunchRequest, CreateAppVersionLaunchResponse, DeleteAppVersionResponse, ExchangeAppGithubAuthorizationResponse, McpApiKeyStatus, OAuthClient, ProjectRef, PromoteAppVersionResponse, RequireAtLeastOne, StartAppBuildRequest, StartAppBuildResponse, StartAppDevelopmentTaskRequest, StartAppGithubAuthorizationResponse, StartAppScaffoldRequest, StartAppScaffoldResponse, UpdateAppInstallationToolPermissionsPayload, UpdateAppPayload, UpsertAppVersionRequest, ValidateUrlResponse } from '@vertesia/common';
|
|
239
252
|
export type { OrphanedAppInstallation } from '@vertesia/common';
|
|
240
253
|
export default class AppsApi extends ApiTopic {
|
|
241
254
|
constructor(parent: ClientBase);
|
|
255
|
+
/** The publisher-managed OAuth registration shared by all installations of an app. */
|
|
256
|
+
getOAuthClient(appId: string): Promise<OAuthClient>;
|
|
242
257
|
create(manifest: AppManifestData): Promise<AppManifest>;
|
|
243
258
|
update(id: string, manifest: UpdateAppPayload): Promise<AppManifest>;
|
|
244
259
|
/**
|
|
@@ -269,6 +284,14 @@ export default class AppsApi extends ApiTopic {
|
|
|
269
284
|
upsertVersion(payload: UpsertAppVersionRequest): Promise<AppVersionRecord>;
|
|
270
285
|
getVersion(recordId: string): Promise<AppVersionRecord>;
|
|
271
286
|
promoteVersion(recordId: string): Promise<PromoteAppVersionResponse>;
|
|
287
|
+
/** Create an ephemeral launch of an immutable version with temporary installation settings. */
|
|
288
|
+
createVersionLaunch(recordId: string, payload: CreateAppVersionLaunchRequest): Promise<CreateAppVersionLaunchResponse>;
|
|
289
|
+
/** List accessible projects where this app is installed and can host a temporary launch. */
|
|
290
|
+
listVersionLaunchTargets(recordId: string): Promise<AppVersionLaunchTarget[]>;
|
|
291
|
+
/** Assign or move a stable deployment alias to an immutable app version. */
|
|
292
|
+
assignVersionAlias(recordId: string, alias: string): Promise<AppVersionRecord>;
|
|
293
|
+
/** Remove an alias only when it still points to the specified app version. */
|
|
294
|
+
removeVersionAlias(recordId: string, alias: string): Promise<AppVersionRecord>;
|
|
272
295
|
rebuildVersion(recordId: string): Promise<StartAppBuildResponse>;
|
|
273
296
|
deleteVersion(recordId: string): Promise<DeleteAppVersionResponse>;
|
|
274
297
|
startBuild(appIdOrRecordId: string, payload: StartAppBuildRequest): Promise<StartAppBuildResponse>;
|
|
@@ -375,7 +398,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
375
398
|
* package-resolved (no per-id route), so this is how a client reads the full definition — type
|
|
376
399
|
* schema, interaction prompt, process definition, dashboard spec — to visualize an exposed id.
|
|
377
400
|
*/
|
|
378
|
-
getAppPackage(appIdOrName: string, scope?: AppPackageScope | AppPackageScope[]): Promise<AppPackage>;
|
|
401
|
+
getAppPackage(appIdOrName: string, scope?: AppPackageScope | AppPackageScope[], deploymentAlias?: string): Promise<AppPackage>;
|
|
379
402
|
/**
|
|
380
403
|
* Get package capabilities exposed by an app installation.
|
|
381
404
|
*/
|
|
@@ -404,7 +427,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
404
427
|
client_id?: string;
|
|
405
428
|
client_secret?: string;
|
|
406
429
|
scopes?: string[];
|
|
407
|
-
}>, apiKeyParams?: AppApiKeyCollectionParams, mcpParameters?: AppInstallationPayload['mcp_parameters'], mcpSharedParameters?: AppInstallationPayload['mcp_shared_parameters'],
|
|
430
|
+
}>, apiKeyParams?: AppApiKeyCollectionParams, mcpParameters?: AppInstallationPayload['mcp_parameters'], mcpSharedParameters?: AppInstallationPayload['mcp_shared_parameters'], installation?: Pick<AppInstallationPayload, 'approved_scopes' | 'deployment_alias' | 'instance_key' | 'display_name' | 'namespace_overrides'>): Promise<AppInstallation>;
|
|
408
431
|
/**
|
|
409
432
|
* Remove the given app from the current project.
|
|
410
433
|
* @param installationId - the id of the app installation
|
|
@@ -456,6 +479,11 @@ export default class AppsApi extends ApiTopic {
|
|
|
456
479
|
* Pass null to remove all restrictions (all tools permitted).
|
|
457
480
|
*/
|
|
458
481
|
updateToolAllowlist(installId: string, tool_allowlist: string[] | null): Promise<AppInstallationWithManifest>;
|
|
482
|
+
/**
|
|
483
|
+
* Update the tool allowlist and the tools requiring human approval of an app installation in one atomic write.
|
|
484
|
+
* Omit a field to leave it unchanged; pass null to clear it.
|
|
485
|
+
*/
|
|
486
|
+
updateToolPermissions(installId: string, payload: UpdateAppInstallationToolPermissionsPayload): Promise<AppInstallationWithManifest>;
|
|
459
487
|
/**
|
|
460
488
|
* Validate that a URL is safe to use as a remote tool/activity endpoint.
|
|
461
489
|
* Throws a ServerError(400) if the URL is blocked (SSRF protection).
|
|
@@ -467,7 +495,8 @@ export default class AppsApi extends ApiTopic {
|
|
|
467
495
|
// @vertesia/client: InteractionsApi.d.ts
|
|
468
496
|
// -----------------------------------------------------------------------------
|
|
469
497
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
470
|
-
import type { AsyncExecutionPayload, AsyncExecutionResult, ComputedFacetResponse, ComputeInteractionFacetPayload, DeleteByIdResult,
|
|
498
|
+
import type { AsyncExecutionPayload, AsyncExecutionResult, ComputedFacetResponse, ComputeInteractionFacetPayload, DeleteByIdResult, GeneratedTestDataRecord, GenerateTestDataPayload, Interaction, InteractionCreatePayload, InteractionDeletePayload, InteractionEndpoint, InteractionEndpointQuery, InteractionExecutionPayload, InteractionForkPayload, InteractionPublishPayload, InteractionRef, InteractionRefWithSchema, InteractionSearchPayload, InteractionSearchQuery, InteractionsExportPayload, InteractionTags, InteractionUpdatePayload, RateLimitRequestPayload, RateLimitRequestResponse, ResolvedInteractionExecutionInfo, ResolveInteractionQuery } from '@vertesia/common';
|
|
499
|
+
import { type ExecuteInteractionRequestOptions } from './execute.js';
|
|
471
500
|
import { InteractionCatalogApi } from './InteractionCatalogApi.js';
|
|
472
501
|
import { type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
473
502
|
export default class InteractionsApi extends ApiTopic {
|
|
@@ -580,9 +609,10 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
580
609
|
* @param nameWithTag
|
|
581
610
|
* @param payload
|
|
582
611
|
* @param onChunk
|
|
612
|
+
* @param requestOptions request options, e.g. `{ query: { include_prompt: false } }` to omit the rendered prompt
|
|
583
613
|
* @returns
|
|
584
614
|
*/
|
|
585
|
-
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?:
|
|
615
|
+
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?: ExecuteInteractionRequestOptions): Promise<EnhancedInteractionExecutionResult<ResultT, ParamsT>>;
|
|
586
616
|
/**
|
|
587
617
|
* Execute an interaction in an workflow
|
|
588
618
|
* @param payload
|
|
@@ -591,20 +621,10 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
591
621
|
executeAsync(payload: AsyncExecutionPayload): Promise<AsyncExecutionResult>;
|
|
592
622
|
publish(id: string, payload: InteractionPublishPayload): Promise<Interaction>;
|
|
593
623
|
fork(id: string, payload: InteractionForkPayload): Promise<Interaction>;
|
|
594
|
-
/**
|
|
595
|
-
* Generate Composable definition of an interaction
|
|
596
|
-
**/
|
|
597
|
-
generateInteraction(id: string, payload: GenerateInteractionPayload): Promise<GeneratedInteractionDefinition[]>;
|
|
598
624
|
/**
|
|
599
625
|
* Generate Test Data for an interaction
|
|
600
626
|
**/
|
|
601
627
|
generateTestData(id: string, payload: GenerateTestDataPayload): Promise<GeneratedTestDataRecord[]>;
|
|
602
|
-
/**
|
|
603
|
-
* Suggest Improvement for a prompt
|
|
604
|
-
* @deprecated use suggestPromptImprovements instead
|
|
605
|
-
*/
|
|
606
|
-
suggestImprovements(id: string, payload: ImprovePromptPayloadConfig): Promise<PromptImprovementResponse>;
|
|
607
|
-
suggestPromptImprovements(payload: ImprovePromptPayload): Promise<PromptImprovementResponse>;
|
|
608
628
|
/**
|
|
609
629
|
* List the versions of the interaction. Returns an empty array if no versions are found
|
|
610
630
|
* @param id
|
|
@@ -620,7 +640,8 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
620
640
|
/**
|
|
621
641
|
* Request a time slot to execute an interaction with a given environment / model
|
|
622
642
|
* @param payload RateLimitRequestPayload
|
|
623
|
-
* @returns RateLimitRequestResponse with delay_ms
|
|
643
|
+
* @returns RateLimitRequestResponse with delay_ms and, when the request holds a slot, its rate_limit_grant.
|
|
644
|
+
* Once admitted (delay_ms is 0), send the grant back as `workflow.rate_limit_id` when executing
|
|
624
645
|
*/
|
|
625
646
|
requestSlot(payload: RateLimitRequestPayload): Promise<RateLimitRequestResponse>;
|
|
626
647
|
/**
|
|
@@ -781,7 +802,7 @@ export default class SkillsApi extends ApiTopic {
|
|
|
781
802
|
// -----------------------------------------------------------------------------
|
|
782
803
|
import type { ExecutionResponse } from '@llumiverse/common';
|
|
783
804
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
784
|
-
import type { ComputeRunFacetPayload, ComputeRunFacetsResponse, ExecutionRunDocRef, ExecutionRunRef, FindPayload, FindRunResult, PopulatedExecutionRun, RunClonePayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload, ToolResultsPayload, UserMessagePayload } from '@vertesia/common';
|
|
805
|
+
import type { ComputeRunFacetPayload, ComputeRunFacetsResponse, ExecutionRunDocRef, ExecutionRunRef, FindPayload, FindRunResult, GetRunQuery, PopulatedExecutionRun, RunClonePayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload, ToolResultsPayload, UserMessagePayload } from '@vertesia/common';
|
|
785
806
|
import { type EnhancedExecutionRun, type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
786
807
|
export interface FilterOption {
|
|
787
808
|
id: string;
|
|
@@ -804,9 +825,10 @@ export declare class RunsApi extends ApiTopic {
|
|
|
804
825
|
* Get a run by id
|
|
805
826
|
*
|
|
806
827
|
* @param id
|
|
828
|
+
* @param query response options, e.g. `{ include_prompt: false }` to omit the rendered prompt
|
|
807
829
|
* @returns InteractionResult
|
|
808
830
|
**/
|
|
809
|
-
retrieve<ResultT = unknown, ParamsT = unknown>(id: string): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
831
|
+
retrieve<ResultT = unknown, ParamsT = unknown>(id: string, query?: GetRunQuery): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
810
832
|
retrievePopulated<P = unknown>(id: string): Promise<PopulatedExecutionRun<P>>;
|
|
811
833
|
/**
|
|
812
834
|
* Get filter options for a field
|
|
@@ -846,11 +868,12 @@ export declare class RunsApi extends ApiTopic {
|
|
|
846
868
|
// -----------------------------------------------------------------------------
|
|
847
869
|
// @vertesia/client: store/client.d.ts
|
|
848
870
|
// -----------------------------------------------------------------------------
|
|
849
|
-
import { AbstractFetchClient, type FETCH_FN, type IRequestRetryPolicy } from '@vertesia/api-fetch-client';
|
|
871
|
+
import { AbstractFetchClient, type FETCH_FN, type IPacingRetryPolicy, type IRequestRetryPolicy, type RequestIdentityProvider } from '@vertesia/api-fetch-client';
|
|
850
872
|
import { type BulkOperationPayload, type BulkOperationResponse } from '@vertesia/common';
|
|
851
873
|
import { AgentsApi } from './AgentsApi.js';
|
|
852
874
|
import { CollectionsApi } from './CollectionsApi.js';
|
|
853
875
|
import { ContentApi } from './ContentApi.js';
|
|
876
|
+
import { ContentSourcesApi } from './ContentSourcesApi.js';
|
|
854
877
|
import { CostApi } from './CostApi.js';
|
|
855
878
|
import { DataApi } from './DataApi.js';
|
|
856
879
|
import { EmailApi } from './EmailApi.js';
|
|
@@ -858,6 +881,7 @@ import { EmbeddingsApi } from './EmbeddingsApi.js';
|
|
|
858
881
|
import { EventsApi } from './EventsApi.js';
|
|
859
882
|
import { FilesApi } from './FilesApi.js';
|
|
860
883
|
import { IndexingApi } from './IndexingApi.js';
|
|
884
|
+
import { NotificationsApi } from './NotificationsApi.js';
|
|
861
885
|
import { ObjectsApi } from './ObjectsApi.js';
|
|
862
886
|
import { PendingAsksApi } from './PendingAsksApi.js';
|
|
863
887
|
import { ProcessApi } from './ProcessApi.js';
|
|
@@ -873,9 +897,13 @@ export interface ZenoClientProps {
|
|
|
873
897
|
serverUrl?: string;
|
|
874
898
|
tokenServerUrl?: string;
|
|
875
899
|
apikey?: string;
|
|
900
|
+
/** Supplies the complete Authorization header; takes precedence over apikey. */
|
|
901
|
+
authCallback?: () => Promise<string>;
|
|
902
|
+
requestIdentity?: RequestIdentityProvider;
|
|
876
903
|
onRequest?: (request: Request) => void;
|
|
877
904
|
onResponse?: (response: Response) => void;
|
|
878
905
|
retryPolicy?: IRequestRetryPolicy;
|
|
906
|
+
pacingRetry?: IPacingRetryPolicy | false;
|
|
879
907
|
timeout?: number | false | null;
|
|
880
908
|
fetch?: FETCH_FN | Promise<FETCH_FN>;
|
|
881
909
|
}
|
|
@@ -896,6 +924,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
896
924
|
types: TypesApi;
|
|
897
925
|
workflows: WorkflowsApi;
|
|
898
926
|
schedules: SchedulesApi;
|
|
927
|
+
contentSources: ContentSourcesApi;
|
|
899
928
|
processes: ProcessApi;
|
|
900
929
|
processTestRuns: ProcessTestRunApi;
|
|
901
930
|
tasks: TaskApi;
|
|
@@ -907,6 +936,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
907
936
|
/** @deprecated Use events.subscriptions. */
|
|
908
937
|
eventSubscriptions: import("./EventSubscriptionsApi.js").EventSubscriptionsApi;
|
|
909
938
|
pendingAsks: PendingAsksApi;
|
|
939
|
+
notifications: NotificationsApi;
|
|
910
940
|
data: DataApi;
|
|
911
941
|
indexing: IndexingApi;
|
|
912
942
|
query: QueryApi;
|
|
@@ -918,7 +948,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
918
948
|
// @vertesia/client: store/ObjectsApi.d.ts
|
|
919
949
|
// -----------------------------------------------------------------------------
|
|
920
950
|
import { ApiTopic } from '@vertesia/api-fetch-client';
|
|
921
|
-
import { type BulkObjectCreateOptions, type BulkObjectCreateResult, type BulkObjectDeleteResult, type BulkObjectUpdateOptions, type BulkObjectUpdateResult, type Collection, type ComplexSearchPayload, type ComputedFacetResponse, type ComputeObjectFacetPayload, type ContentObject, type ContentObjectExportArtifactFile, type ContentObjectExportResult, type ContentObjectExportStatusResponse, type ContentObjectItem, type ContentObjectProcessingPriority, type ContentObjectTextResponse, type ContentSource, type CreateContentObjectPayload, canGenerateRendition, type DeleteContentObjectExportResponse, type DeleteContentObjectResult, type Embedding, type ExportPropertiesPayload, type ExportPropertiesResponse, type FindPayload, type FullObjectSearchResponse, type GetFileUrlPayload, type GetFileUrlResponse, type GetRenditionParams, type GetRenditionResponse, type GetUploadUrlPayload, type ListContentObjectExportsResponse, type ListWorkflowRunsResponse, type ObjectSearchPayload, type ObjectSearchResponse, type ProjectedContentObjectApiResponse, type SetObjectEmbeddingsResponse, type SetObjectTextPayload, type StartContentObjectExportRequest, type StartContentObjectExportResponse, type SupportedEmbeddingTypes, type UpdateContentObjectPayload, type ZenoBulkContentObjectExportComposeRequest, type ZenoBulkContentObjectExportPlanRequest, type ZenoBulkContentObjectExportPlanResponse, type ZenoBulkContentObjectExportRequest, type ZenoBulkContentObjectExportShardRequest, type ZenoBulkContentObjectExportShardResult, type ZenoBulkContentObjectExportSplitShardRequest, type ZenoBulkContentObjectExportSplitShardResponse } from '@vertesia/common';
|
|
951
|
+
import { type BulkObjectCreateOptions, type BulkObjectCreateResult, type BulkObjectDeleteResult, type BulkObjectUpdateOptions, type BulkObjectUpdateResult, type Collection, type ComplexSearchPayload, type ComputedFacetResponse, type ComputeObjectFacetPayload, type ContentObject, type ContentObjectExportArtifactFile, type ContentObjectExportResult, type ContentObjectExportStatusResponse, type ContentObjectItem, type ContentObjectProcessingPriority, type ContentObjectTextResponse, type ContentSource, type CreateContentObjectPayload, canGenerateRendition, type DeleteContentObjectExportResponse, type DeleteContentObjectResult, type Embedding, type ExportPropertiesPayload, type ExportPropertiesResponse, type FindPayload, type FullObjectSearchResponse, type GetFileUrlPayload, type GetFileUrlResponse, type GetRenditionParams, type GetRenditionResponse, type GetUploadUrlPayload, type ListContentObjectExportsResponse, type ListWorkflowRunsResponse, type ObjectIntakeCostQuery, type ObjectIntakeCostResponse, type ObjectSearchPayload, type ObjectSearchResponse, type ProjectedContentObjectApiResponse, type SetObjectEmbeddingsResponse, type SetObjectTextPayload, type StartContentObjectExportRequest, type StartContentObjectExportResponse, type SupportedEmbeddingTypes, type UpdateContentObjectPayload, type ZenoBulkContentObjectExportComposeRequest, type ZenoBulkContentObjectExportPlanRequest, type ZenoBulkContentObjectExportPlanResponse, type ZenoBulkContentObjectExportRequest, type ZenoBulkContentObjectExportShardRequest, type ZenoBulkContentObjectExportShardResult, type ZenoBulkContentObjectExportSplitShardRequest, type ZenoBulkContentObjectExportSplitShardResponse } from '@vertesia/common';
|
|
922
952
|
export { getSupportedRenditionFormats, supportsVisualRendition } from '@vertesia/common';
|
|
923
953
|
export { canGenerateRendition };
|
|
924
954
|
import { StreamSource } from '../StreamSource.js';
|
|
@@ -969,12 +999,6 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
969
999
|
exportContentObjectShardViaBulk(payload: ZenoBulkContentObjectExportShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportShardResult>;
|
|
970
1000
|
splitContentObjectExportShardViaBulk(payload: ZenoBulkContentObjectExportSplitShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportSplitShardResponse>;
|
|
971
1001
|
composeContentObjectExportViaBulk(payload: ZenoBulkContentObjectExportComposeRequest, timeoutMs?: number | false | null): Promise<ContentObjectExportResult>;
|
|
972
|
-
/**
|
|
973
|
-
* Get the zeno-bulk base URL.
|
|
974
|
-
* Dev branches: store URL contains "zeno-server" -> replace with "zeno-bulk".
|
|
975
|
-
* Production/preview: same domain, LB routes /export to zeno-bulk.
|
|
976
|
-
*/
|
|
977
|
-
private get zenoBulkBaseUrl();
|
|
978
1002
|
private zenoBulkPost;
|
|
979
1003
|
listFolders(_path?: string): void;
|
|
980
1004
|
/** Find object based on query */
|
|
@@ -1071,6 +1095,11 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
1071
1095
|
bulkUpdate(updates: Record<string, Record<string, unknown>>, options?: BulkObjectUpdateOptions): Promise<BulkObjectUpdateResult>;
|
|
1072
1096
|
bulkCreate(objects: CreateContentObjectPayload[], options?: BulkObjectCreateOptions): Promise<BulkObjectCreateResult>;
|
|
1073
1097
|
listWorkflowRuns(documentId: string): Promise<ListWorkflowRunsResponse>;
|
|
1098
|
+
/**
|
|
1099
|
+
* The LLM and embedding cost of the intake workflows that processed a content object, per run and in total.
|
|
1100
|
+
* Requires read access to the object and a billing read permission.
|
|
1101
|
+
*/
|
|
1102
|
+
getIntakeCost(documentId: string, query?: ObjectIntakeCostQuery): Promise<ObjectIntakeCostResponse>;
|
|
1074
1103
|
listRenditions(documentId: string): Promise<ContentObjectItem[]>;
|
|
1075
1104
|
getRendition(documentId: string, options: GetRenditionParams): Promise<GetRenditionResponse>;
|
|
1076
1105
|
/**
|
|
@@ -1205,6 +1234,9 @@ export declare class AgentsApi extends ApiTopic {
|
|
|
1205
1234
|
/**
|
|
1206
1235
|
* Create and start a new agent run.
|
|
1207
1236
|
* Returns the created AgentRun with its stable id.
|
|
1237
|
+
*
|
|
1238
|
+
* Set `idempotency_key` on an agent run to make the call safe to retry: the client's retry policy
|
|
1239
|
+
* then applies, and a replayed request returns the run the first one started.
|
|
1208
1240
|
*/
|
|
1209
1241
|
start<TData = Record<string, unknown>>(payload: CreateAgentRunPayload<TData>): Promise<AgentRun<TData>>;
|
|
1210
1242
|
start<TData = Record<string, unknown>>(payload: CreateProcessRunPayload<TData>): Promise<ProcessRun>;
|
|
@@ -1510,7 +1542,7 @@ export declare class TypesApi extends ApiTopic {
|
|
|
1510
1542
|
// @vertesia/client: store/FilesApi.d.ts
|
|
1511
1543
|
// -----------------------------------------------------------------------------
|
|
1512
1544
|
import { ApiTopic, type ClientBase } from '@vertesia/api-fetch-client';
|
|
1513
|
-
import type { BucketCreateAccessStatusResponse, BucketReadAccessStatusResponse, BulkUploadUrlsPayload, BulkUploadUrlsResponse, DeleteFileResult, EnsureBucketCreateAccessResponse, EnsureBucketReadAccessResponse, FileBucketResponse, FileListResponse, FileMetadataResponse, FileMetadataUpdateResult, GetFileUrlPayload, GetFileUrlResponse, GetUploadUrlPayload } from '@vertesia/common';
|
|
1545
|
+
import type { AbortUploadSessionPayload, AbortUploadSessionResponse, BucketCreateAccessStatusResponse, BucketReadAccessStatusResponse, BulkUploadUrlsPayload, BulkUploadUrlsResponse, CompleteUploadSessionPayload, CompleteUploadSessionResponse, CreateUploadSessionPayload, DeleteFileResult, EnsureBucketCreateAccessResponse, EnsureBucketReadAccessResponse, FileBucketResponse, FileListResponse, FileMetadataResponse, FileMetadataUpdateResult, GetFileUrlPayload, GetFileUrlResponse, GetUploadPartUrlsPayload, GetUploadUrlPayload, UploadPartUrlsResponse, UploadSession } from '@vertesia/common';
|
|
1514
1546
|
import { StreamSource } from '../StreamSource.js';
|
|
1515
1547
|
export declare const MEMORIES_PREFIX = "memories";
|
|
1516
1548
|
export declare const ARTIFACTS_PREFIX = "agents";
|
|
@@ -1555,6 +1587,17 @@ export declare class FilesApi extends ApiTopic {
|
|
|
1555
1587
|
getBucketCreateAccessStatus(principal: string): Promise<BucketCreateAccessStatusResponse>;
|
|
1556
1588
|
list(prefix: string): Promise<FileListResponse>;
|
|
1557
1589
|
getUploadUrl(payload: GetUploadUrlPayload): Promise<GetFileUrlResponse>;
|
|
1590
|
+
/**
|
|
1591
|
+
* Start an upload in parts, for content too large for one signed PUT. The upload methods of this API use it
|
|
1592
|
+
* for stream sources longer than one part; call it directly only to drive the store's protocol yourself.
|
|
1593
|
+
*/
|
|
1594
|
+
createUploadSession(payload: CreateUploadSessionPayload): Promise<UploadSession>;
|
|
1595
|
+
/** Signed URLs for parts of an `s3_multipart` upload session. */
|
|
1596
|
+
getUploadPartUrls(payload: GetUploadPartUrlsPayload): Promise<UploadPartUrlsResponse>;
|
|
1597
|
+
/** Assemble the uploaded parts of an `s3_multipart` upload session into the file. */
|
|
1598
|
+
completeUploadSession(payload: CompleteUploadSessionPayload): Promise<CompleteUploadSessionResponse>;
|
|
1599
|
+
/** Discard an unfinished `s3_multipart` upload session and its parts. */
|
|
1600
|
+
abortUploadSession(payload: AbortUploadSessionPayload): Promise<AbortUploadSessionResponse>;
|
|
1558
1601
|
getDownloadUrl(file: string, name?: string, disposition?: 'inline' | 'attachment'): Promise<GetFileUrlResponse>;
|
|
1559
1602
|
getDownloadUrlWithOptions(payload: GetFileUrlPayload): Promise<GetFileUrlResponse>;
|
|
1560
1603
|
/**
|
|
@@ -1594,11 +1637,14 @@ export declare class FilesApi extends ApiTopic {
|
|
|
1594
1637
|
id: string;
|
|
1595
1638
|
path: string;
|
|
1596
1639
|
}>;
|
|
1640
|
+
/** Upload a source under a file id and name that may differ from its own. */
|
|
1641
|
+
private uploadSource;
|
|
1597
1642
|
/**
|
|
1598
1643
|
*
|
|
1599
1644
|
* @param location can be a relative path in the project, a reference to a cloud storage, or a accessible HTTPS URL (typically signed URL)
|
|
1600
1645
|
* @returns ReadableStream
|
|
1601
1646
|
*/
|
|
1647
|
+
fetchDownloadUrl(url: string): Promise<Response>;
|
|
1602
1648
|
downloadFile(location: string): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>;
|
|
1603
1649
|
/**
|
|
1604
1650
|
* Copy a file to a new destination within the same bucket.
|
|
@@ -1867,7 +1913,7 @@ export declare class DataApi extends ApiTopic {
|
|
|
1867
1913
|
* Named snapshots are kept indefinitely (not subject to 30-day cleanup).
|
|
1868
1914
|
*
|
|
1869
1915
|
* @param id - Data store ID
|
|
1870
|
-
* @param payload - Snapshot name and
|
|
1916
|
+
* @param payload - Snapshot name and message, both non-empty
|
|
1871
1917
|
* @returns The created version/snapshot
|
|
1872
1918
|
*
|
|
1873
1919
|
* @example
|
|
@@ -2005,21 +2051,21 @@ export declare class DataApi extends ApiTopic {
|
|
|
2005
2051
|
* // List dashboards
|
|
2006
2052
|
* const dashboards = await client.data.dashboards(storeId).list();
|
|
2007
2053
|
*
|
|
2008
|
-
* // Preview a dashboard before creating
|
|
2009
|
-
* const preview = await client.data.dashboards(storeId).
|
|
2010
|
-
*
|
|
2011
|
-
*
|
|
2054
|
+
* // Preview a dashboard before creating it
|
|
2055
|
+
* const preview = await client.data.dashboards(storeId).exportPreview({
|
|
2056
|
+
* query: 'SELECT region, SUM(amount) AS total FROM sales GROUP BY region',
|
|
2057
|
+
* spec: { mark: 'bar', encoding: { ... } },
|
|
2012
2058
|
* });
|
|
2013
2059
|
*
|
|
2014
2060
|
* // Create a dashboard
|
|
2015
2061
|
* const dashboard = await client.data.dashboards(storeId).create({
|
|
2016
2062
|
* name: 'Sales Overview',
|
|
2017
|
-
*
|
|
2018
|
-
*
|
|
2063
|
+
* query: 'SELECT region, SUM(amount) AS total FROM sales GROUP BY region',
|
|
2064
|
+
* spec: { mark: 'bar', encoding: { ... } },
|
|
2019
2065
|
* });
|
|
2020
2066
|
*
|
|
2021
|
-
* //
|
|
2022
|
-
* const
|
|
2067
|
+
* // Export the dashboard as a PNG (signed download URL)
|
|
2068
|
+
* const { url } = await client.data.dashboards(storeId).export(dashboard.id);
|
|
2023
2069
|
* ```
|
|
2024
2070
|
*/
|
|
2025
2071
|
dashboards(storeId: string): DashboardApi;
|
|
@@ -2282,6 +2328,12 @@ export declare enum ContentNature {
|
|
|
2282
2328
|
Code = "code",
|
|
2283
2329
|
Other = "other"
|
|
2284
2330
|
}
|
|
2331
|
+
/**
|
|
2332
|
+
* Whether a MIME type is a video: any `video/*` type, or a video container registered under `application/*`.
|
|
2333
|
+
* Types that may hold audio only, such as `application/mp4` and `application/ogg`, are not counted. MIME types are
|
|
2334
|
+
* case-insensitive and may carry parameters (`application/MXF; foo=bar`), so both are ignored.
|
|
2335
|
+
*/
|
|
2336
|
+
export declare function isVideoContentType(contentType: string | undefined): boolean;
|
|
2285
2337
|
export interface Dimensions {
|
|
2286
2338
|
width: number;
|
|
2287
2339
|
height: number;
|
|
@@ -2302,6 +2354,61 @@ export declare const POSTER_RENDITION_NAME = "Poster";
|
|
|
2302
2354
|
export declare const AUDIO_RENDITION_NAME = "Audio";
|
|
2303
2355
|
export declare const WEB_VIDEO_RENDITION_NAME = "Web";
|
|
2304
2356
|
export declare const PDF_RENDITION_NAME = "PDF";
|
|
2357
|
+
/**
|
|
2358
|
+
* Request header sent by a workflow that can wait for media renditions still being generated. With it,
|
|
2359
|
+
* the execute endpoint answers 412 and lists the pending objects instead of rendering a media input from
|
|
2360
|
+
* its original source.
|
|
2361
|
+
*/
|
|
2362
|
+
export declare const RENDITION_WAIT_HEADER = "x-vertesia-rendition-wait";
|
|
2363
|
+
/**
|
|
2364
|
+
* Renditions that intake has started but not stored yet. `etag` is the key the renditions are stored under (the
|
|
2365
|
+
* content etag, or the object id when the content has none), so a marker left from earlier content does not apply to
|
|
2366
|
+
* the current content.
|
|
2367
|
+
*/
|
|
2368
|
+
export interface PendingRenditionNames {
|
|
2369
|
+
etag: string;
|
|
2370
|
+
names: string[];
|
|
2371
|
+
}
|
|
2372
|
+
/** A media input whose rendition is still being generated. */
|
|
2373
|
+
export interface PendingRendition {
|
|
2374
|
+
object_id: string;
|
|
2375
|
+
kind: 'video' | 'image';
|
|
2376
|
+
}
|
|
2377
|
+
/** A user of the external system a content source reads, as that system reports them. */
|
|
2378
|
+
export interface ContentSourcePerson {
|
|
2379
|
+
/** The system's own ID for the user. */
|
|
2380
|
+
id?: string;
|
|
2381
|
+
name?: string;
|
|
2382
|
+
email?: string;
|
|
2383
|
+
}
|
|
2384
|
+
/**
|
|
2385
|
+
* The widest audience a file's sharing links reach: anyone with the link, everyone in the organization, or specific
|
|
2386
|
+
* people. `none` when the file has no sharing link. Permissions granted without a link are not reflected.
|
|
2387
|
+
*/
|
|
2388
|
+
export type ContentSourceSharing = 'none' | 'anonymous' | 'organization' | 'users';
|
|
2389
|
+
/** What the external system reports about a synced file, kept at `metadata.source`. */
|
|
2390
|
+
export interface ContentSourceItemMetadata {
|
|
2391
|
+
/** The system the file is in, such as `sharepoint` or `box`. */
|
|
2392
|
+
provider: string;
|
|
2393
|
+
/** The file's ID in that system, stable across renames and moves. */
|
|
2394
|
+
item_id: string;
|
|
2395
|
+
/** The ID of the folder that holds the file. */
|
|
2396
|
+
folder_id?: string;
|
|
2397
|
+
/** Opens the file in the system. */
|
|
2398
|
+
web_url?: string;
|
|
2399
|
+
/** Bytes, as the system reports them. */
|
|
2400
|
+
size?: number;
|
|
2401
|
+
/** ISO 8601. */
|
|
2402
|
+
created_at?: string;
|
|
2403
|
+
/** ISO 8601: the last change the system recorded, to the bytes or to the file's metadata. */
|
|
2404
|
+
modified_at?: string;
|
|
2405
|
+
created_by?: ContentSourcePerson;
|
|
2406
|
+
modified_by?: ContentSourcePerson;
|
|
2407
|
+
/** Absent when the system did not report it. */
|
|
2408
|
+
sharing?: ContentSourceSharing;
|
|
2409
|
+
/** Changes whenever another field changes: the sync rewrites the block only then. */
|
|
2410
|
+
digest: string;
|
|
2411
|
+
}
|
|
2305
2412
|
export interface ContentMetadata {
|
|
2306
2413
|
type?: ContentNature;
|
|
2307
2414
|
size?: number;
|
|
@@ -2312,11 +2419,18 @@ export interface ContentMetadata {
|
|
|
2312
2419
|
/** ETag of text materialized from object properties by intake rendering. */
|
|
2313
2420
|
rendered_text_etag?: string;
|
|
2314
2421
|
renditions?: Rendition[];
|
|
2422
|
+
/** Renditions still being generated for the current content. Each name is removed once it is stored or abandoned. */
|
|
2423
|
+
pending_renditions?: PendingRenditionNames;
|
|
2315
2424
|
/**
|
|
2316
2425
|
* Embedded/technical metadata harvested from the source file by intake
|
|
2317
2426
|
* (office docProps, PDF docinfo). Free-form, nature-appropriate keys.
|
|
2318
2427
|
*/
|
|
2319
2428
|
embedded?: Record<string, unknown>;
|
|
2429
|
+
/**
|
|
2430
|
+
* What the external system a content source synced the object from reports about the file. Written only by the
|
|
2431
|
+
* sync; an update through the objects API keeps the stored value.
|
|
2432
|
+
*/
|
|
2433
|
+
source?: ContentSourceItemMetadata;
|
|
2320
2434
|
/** Type-detection provenance recorded by the intake sniff pipeline. */
|
|
2321
2435
|
type_detection?: TypeDetectionMetadata;
|
|
2322
2436
|
/** Locate-pass provenance: which pages the document map found relevant. */
|
|
@@ -2608,6 +2722,19 @@ export type SetFileMetadataPayload = Wire.SetFileMetadataPayload;
|
|
|
2608
2722
|
export type FileMetadataUpdateResult = Wire.FileMetadataUpdateResult;
|
|
2609
2723
|
export type BulkUploadUrlsPayload = Wire.BulkUploadUrlsPayload;
|
|
2610
2724
|
export type BulkUploadUrlsResponse = Wire.BulkUploadUrlsResponse;
|
|
2725
|
+
export type CreateUploadSessionPayload = Wire.CreateUploadSessionPayload;
|
|
2726
|
+
export type GcsResumableUploadSession = Wire.GcsResumableUploadSession;
|
|
2727
|
+
export type AzureBlockBlobUploadSession = Wire.AzureBlockBlobUploadSession;
|
|
2728
|
+
export type S3MultipartUploadSession = Wire.S3MultipartUploadSession;
|
|
2729
|
+
export type UploadSession = Wire.UploadSession;
|
|
2730
|
+
export type GetUploadPartUrlsPayload = Wire.GetUploadPartUrlsPayload;
|
|
2731
|
+
export type UploadPartUrl = Wire.UploadPartUrl;
|
|
2732
|
+
export type UploadPartUrlsResponse = Wire.UploadPartUrlsResponse;
|
|
2733
|
+
export type CompletedUploadPart = Wire.CompletedUploadPart;
|
|
2734
|
+
export type CompleteUploadSessionPayload = Wire.CompleteUploadSessionPayload;
|
|
2735
|
+
export type CompleteUploadSessionResponse = Wire.CompleteUploadSessionResponse;
|
|
2736
|
+
export type AbortUploadSessionPayload = Wire.AbortUploadSessionPayload;
|
|
2737
|
+
export type AbortUploadSessionResponse = Wire.AbortUploadSessionResponse;
|
|
2611
2738
|
export type FileBucketResponse = Wire.FileBucketResponse;
|
|
2612
2739
|
export type FileListResponse = Wire.FileListResponse;
|
|
2613
2740
|
export type FileMetadataQuery = Wire.FileMetadataQuery;
|
|
@@ -2874,6 +3001,7 @@ export type RecordRunPayload<TData = Record<string, unknown>, TSource = RunSourc
|
|
|
2874
3001
|
* has successfully started its workflow.
|
|
2875
3002
|
*/
|
|
2876
3003
|
export type BindRunWorkflowPayload = Wire.BindRunWorkflowPayload;
|
|
3004
|
+
export type TerminateAgentRunQuery = Wire.TerminateAgentRunQuery;
|
|
2877
3005
|
export type TerminateAgentRunResponse = Wire.TerminateAgentRunResponse;
|
|
2878
3006
|
export type AgentRunFeedbackRating = Wire.AgentRunFeedbackRating;
|
|
2879
3007
|
export type AgentRunFeedbackReasonCode = Wire.AgentRunFeedbackReasonCode;
|
|
@@ -3090,6 +3218,7 @@ export type CollectionSecuritySettingsResponse = Wire.CollectionSecuritySettings
|
|
|
3090
3218
|
export type CollectionPropagationResponse = Wire.CollectionPropagationResponse;
|
|
3091
3219
|
export type CollectionChildrenUpdateResult = Wire.CollectionChildrenUpdateResult;
|
|
3092
3220
|
export type CollectionMembersUpdatePayload = Wire.CollectionMembersUpdatePayload;
|
|
3221
|
+
export type CollectionPermissionsPayload = Wire.CollectionPermissionsPayload;
|
|
3093
3222
|
export type CollectionChildrenUpdatePayload = Wire.CollectionChildrenUpdatePayload;
|
|
3094
3223
|
export type CollectionMembersQuery = Wire.CollectionMembersQuery;
|
|
3095
3224
|
export type UpdateCollectionPayload = Wire.UpdateCollectionPayload;
|
|
@@ -3097,6 +3226,7 @@ export type UpdateCollectionPayload = Wire.UpdateCollectionPayload;
|
|
|
3097
3226
|
// -----------------------------------------------------------------------------
|
|
3098
3227
|
// @vertesia/common: store/process.d.ts
|
|
3099
3228
|
// -----------------------------------------------------------------------------
|
|
3229
|
+
import type { ModelOptions } from '@llumiverse/common';
|
|
3100
3230
|
import type { JSONSchema } from '../json-schema.js';
|
|
3101
3231
|
import type * as Wire from '../wire-types.generated.js';
|
|
3102
3232
|
export type JsonLogicRule = Wire.JsonLogicRule;
|
|
@@ -3134,7 +3264,26 @@ export interface BranchNodeBranchDefinition {
|
|
|
3134
3264
|
export type HumanTaskDefinition = Wire.HumanTaskDefinition;
|
|
3135
3265
|
export type ProcessNodeReturnsDefinition = Wire.ProcessNodeReturnsDefinition;
|
|
3136
3266
|
export type ParallelCollectDefinition = Wire.ParallelCollectDefinition;
|
|
3137
|
-
|
|
3267
|
+
/**
|
|
3268
|
+
* How a process, or one of its LLM nodes, chooses its model: an inference profile, or an environment with an
|
|
3269
|
+
* optional model and model options, the same choice an interaction offers. Each level is one whole choice: a node
|
|
3270
|
+
* that selects anything ignores the run config and definition selections, and a run config selection ignores the
|
|
3271
|
+
* definition's. A level that selects nothing falls through to the next, then to the interaction or agent defaults.
|
|
3272
|
+
*/
|
|
3273
|
+
export interface ProcessModelSelection {
|
|
3274
|
+
/** Inference profile supplying the environment, model and model options. Excludes the other fields. */
|
|
3275
|
+
inference_profile?: string;
|
|
3276
|
+
/** Environment id, with `model` or alone to use the environment default model. */
|
|
3277
|
+
environment?: string;
|
|
3278
|
+
/**
|
|
3279
|
+
* Model id in `environment`. A model without an environment is accepted only in definitions saved before
|
|
3280
|
+
* environments were required; saving one is rejected.
|
|
3281
|
+
*/
|
|
3282
|
+
model?: string;
|
|
3283
|
+
/** Model options for `environment` and `model`. */
|
|
3284
|
+
model_options?: ModelOptions;
|
|
3285
|
+
}
|
|
3286
|
+
export interface NodeDefinition extends ProcessModelSelection {
|
|
3138
3287
|
type: ProcessNodeType;
|
|
3139
3288
|
tool?: string;
|
|
3140
3289
|
/** Named entry in process resources.scripts for script nodes. */
|
|
@@ -3183,13 +3332,6 @@ export interface NodeDefinition {
|
|
|
3183
3332
|
excluded_tools?: string[];
|
|
3184
3333
|
/** Process-owned successful-tool phases and completion behavior for this agent node. */
|
|
3185
3334
|
agent_policy?: ProcessAgentExecutionPolicy;
|
|
3186
|
-
/**
|
|
3187
|
-
* Model id override for this node. If unset, falls back to the process
|
|
3188
|
-
* run's `config.model`, then to the project's default. Useful when a
|
|
3189
|
-
* specific node needs heavier reasoning (e.g. Opus for legal flagging)
|
|
3190
|
-
* while the rest of the process uses a cheaper default.
|
|
3191
|
-
*/
|
|
3192
|
-
model?: string;
|
|
3193
3335
|
task?: HumanTaskDefinition;
|
|
3194
3336
|
foreach?: string;
|
|
3195
3337
|
as?: string;
|
|
@@ -3203,12 +3345,11 @@ export interface NodeDefinition {
|
|
|
3203
3345
|
metadata?: ProcessDefinitionMetadata;
|
|
3204
3346
|
}
|
|
3205
3347
|
export type ProcessContextDefinition = Wire.ProcessContextDefinition;
|
|
3206
|
-
export interface ProcessDefinitionBody {
|
|
3348
|
+
export interface ProcessDefinitionBody extends ProcessModelSelection {
|
|
3207
3349
|
format_version: ProcessDefinitionFormatVersion;
|
|
3208
3350
|
process: string;
|
|
3209
3351
|
description?: string;
|
|
3210
3352
|
initial: string;
|
|
3211
|
-
model?: string;
|
|
3212
3353
|
resources?: ProcessResourcesDefinition;
|
|
3213
3354
|
context: ProcessContextDefinition;
|
|
3214
3355
|
nodes: Record<string, NodeDefinition>;
|
|
@@ -3264,26 +3405,19 @@ export interface CreateProcessDefinitionPayload {
|
|
|
3264
3405
|
* @deprecated Process definitions are created as drafts. Use the publish endpoint
|
|
3265
3406
|
* to create immutable published versions.
|
|
3266
3407
|
*/
|
|
3267
|
-
status?:
|
|
3408
|
+
status?: 'draft';
|
|
3268
3409
|
/**
|
|
3269
3410
|
* @deprecated Version is server-owned. Use the publish endpoint to create the next version.
|
|
3270
3411
|
*/
|
|
3271
|
-
version?:
|
|
3412
|
+
version?: 1;
|
|
3272
3413
|
tags?: string[];
|
|
3273
3414
|
definition: ProcessDefinitionBody;
|
|
3274
3415
|
}
|
|
3416
|
+
/** A draft edit. `status` and `version` are server-owned: use the publish, archive and revert endpoints. */
|
|
3275
3417
|
export interface UpdateProcessDefinitionPayload {
|
|
3276
3418
|
expected_edit_revision?: number;
|
|
3277
3419
|
name?: string;
|
|
3278
3420
|
description?: string;
|
|
3279
|
-
/**
|
|
3280
|
-
* @deprecated Status is server-owned. Use publish/archive endpoints instead of updating it directly.
|
|
3281
|
-
*/
|
|
3282
|
-
status?: ProcessDefinitionStatus;
|
|
3283
|
-
/**
|
|
3284
|
-
* @deprecated Version is server-owned. Use the publish endpoint to create the next version.
|
|
3285
|
-
*/
|
|
3286
|
-
version?: number;
|
|
3287
3421
|
tags?: string[];
|
|
3288
3422
|
definition?: ProcessDefinitionBody;
|
|
3289
3423
|
}
|
|
@@ -3496,6 +3630,9 @@ export type ChildWorkflowTask = Wire.ChildWorkflowTask;
|
|
|
3496
3630
|
export type SignalTask = Wire.SignalTask;
|
|
3497
3631
|
export type TimerTask = Wire.TimerTask;
|
|
3498
3632
|
export type WorkflowTask = Wire.WorkflowTask;
|
|
3633
|
+
export type WorkflowEventsHistory = Wire.WorkflowEventsHistory;
|
|
3634
|
+
export type WorkflowTasksHistory = Wire.WorkflowTasksHistory;
|
|
3635
|
+
export type WorkflowAgentHistory = Wire.WorkflowAgentHistory;
|
|
3499
3636
|
export type WorkflowHistory = Wire.WorkflowHistory;
|
|
3500
3637
|
export type AgentTask = Wire.AgentTask;
|
|
3501
3638
|
export type WorkflowRun = Wire.WorkflowRun;
|
|
@@ -3766,6 +3903,8 @@ export interface ConversationFileRemovedRef {
|
|
|
3766
3903
|
}
|
|
3767
3904
|
export type PlanTask = Wire.PlanTask;
|
|
3768
3905
|
export type Plan = Wire.Plan;
|
|
3906
|
+
/** Route explicitly to the environment's regular worker pool. */
|
|
3907
|
+
export declare const NORMAL_PRIORITY_TASK_QUEUE = "normal_priority";
|
|
3769
3908
|
export declare const LOW_PRIORITY_TASK_QUEUE = "low_priority";
|
|
3770
3909
|
/**
|
|
3771
3910
|
* WebSocket message types for bidirectional communication
|
|
@@ -3985,6 +4124,8 @@ export type AppInstallationProjectsQuery = Wire.AppInstallationProjectsQuery;
|
|
|
3985
4124
|
export type AppInstallationsQuery = Wire.AppInstallationsQuery;
|
|
3986
4125
|
export type AppListScope = Wire.AppListScope;
|
|
3987
4126
|
export type AppsQuery = Wire.AppsQuery;
|
|
4127
|
+
export type AppDeleteQuery = Wire.AppDeleteQuery;
|
|
4128
|
+
export type AppRepoCommitsQuery = Wire.AppRepoCommitsQuery;
|
|
3988
4129
|
export type ToolCollectionAuthType = Wire.ToolCollectionAuthType;
|
|
3989
4130
|
export type MCPOAuthConfig = Wire.MCPOAuthConfig;
|
|
3990
4131
|
/** Install-time provisioning blueprint for an `auth: 'api_key'` MCP collection. Never holds the key. */
|
|
@@ -4039,6 +4180,8 @@ export type AppCapabilities = Wire.AppCapabilities;
|
|
|
4039
4180
|
export declare const APP_VERSION_HEADER = "x-vertesia-app-version";
|
|
4040
4181
|
export type AppAvailableIn = Wire.AppAvailableIn;
|
|
4041
4182
|
export type AppVersionKind = Wire.AppVersionKind;
|
|
4183
|
+
export type AppDeploymentAlias = Wire.AppDeploymentAlias;
|
|
4184
|
+
export type AppDeploymentAliasTarget = Wire.AppDeploymentAliasTarget;
|
|
4042
4185
|
export type AppVersionState = Wire.AppVersionState;
|
|
4043
4186
|
export type AppVersionTarget = Wire.AppVersionTarget;
|
|
4044
4187
|
export type AppVersionGitRefType = Wire.AppVersionGitRefType;
|
|
@@ -4046,7 +4189,29 @@ export type AppBuildTrigger = Wire.AppBuildTrigger;
|
|
|
4046
4189
|
export type AppVersionStorage = Wire.AppVersionStorage;
|
|
4047
4190
|
export type AppVersionGitSource = Wire.AppVersionGitSource;
|
|
4048
4191
|
export type AppVersionUrls = Wire.AppVersionUrls;
|
|
4192
|
+
/**
|
|
4193
|
+
* Stable, user-defined deployment alias (for example `production` or `customer-preview`).
|
|
4194
|
+
*
|
|
4195
|
+
* Aliases are deliberately DNS-label compatible so the app gateway can expose each alias through
|
|
4196
|
+
* both a shared-origin path and a dedicated application hostname without a second naming rule.
|
|
4197
|
+
*/
|
|
4198
|
+
export declare const APP_DEPLOYMENT_ALIAS_PATTERN: RegExp;
|
|
4049
4199
|
export type AppVersionRecord = Wire.AppVersionRecord;
|
|
4200
|
+
export interface AppGenTemplateMetadata {
|
|
4201
|
+
name: string;
|
|
4202
|
+
version: number;
|
|
4203
|
+
runtime_features: Record<string, number>;
|
|
4204
|
+
}
|
|
4205
|
+
export declare const ADVANCED_APP_VERSION_LAUNCH_FEATURE = "advanced_launch";
|
|
4206
|
+
export declare const ADVANCED_APP_VERSION_LAUNCH_PROTOCOL_VERSION = 1;
|
|
4207
|
+
/** Read template provenance captured in an immutable AppGen version manifest. */
|
|
4208
|
+
export declare function getAppGenTemplateMetadata(manifest: unknown): AppGenTemplateMetadata | undefined;
|
|
4209
|
+
/** Return the protocol version implemented by one generated-app runtime feature. */
|
|
4210
|
+
export declare function getAppVersionRuntimeFeatureVersion(manifest: unknown, feature: string): number | undefined;
|
|
4211
|
+
export declare function supportsAdvancedAppVersionLaunch(manifest: unknown): boolean;
|
|
4212
|
+
export type AppVersionLaunchTarget = Wire.AppVersionLaunchTarget;
|
|
4213
|
+
export type CreateAppVersionLaunchRequest = Wire.CreateAppVersionLaunchRequest;
|
|
4214
|
+
export type CreateAppVersionLaunchResponse = Wire.CreateAppVersionLaunchResponse;
|
|
4050
4215
|
export type DeleteAppVersionResponse = Wire.DeleteAppVersionResponse;
|
|
4051
4216
|
export type UpsertAppVersionRequest = Wire.UpsertAppVersionRequest;
|
|
4052
4217
|
export interface AppVersionListQuery {
|
|
@@ -4093,6 +4258,8 @@ export type AppScaffoldProgress = Wire.AppScaffoldProgress;
|
|
|
4093
4258
|
* Declared on the manifest as the app's default. May be overridden per-installation.
|
|
4094
4259
|
*/
|
|
4095
4260
|
export type AppAccessControl = Wire.AppAccessControl;
|
|
4261
|
+
/** The set of tools an app exposes to an external integration through the platform MCP server. */
|
|
4262
|
+
export type AppMcpProfile = Wire.AppMcpProfile;
|
|
4096
4263
|
export type AppManifestData = Wire.AppManifestData;
|
|
4097
4264
|
export type UpdateAppPayload = Wire.UpdateAppPayload;
|
|
4098
4265
|
export type AppGitSourceConfig = Wire.AppGitSourceConfig;
|
|
@@ -4139,10 +4306,7 @@ export type AppDevelopmentTaskList = Wire.AppDevelopmentTaskList;
|
|
|
4139
4306
|
/** Development task details, including the latest parent assistant run when one exists. */
|
|
4140
4307
|
export type AppDevelopmentTaskDetails = Wire.AppDevelopmentTaskDetails;
|
|
4141
4308
|
/** Request to create a branch from an existing branch, tag, or commit. */
|
|
4142
|
-
export
|
|
4143
|
-
name: string;
|
|
4144
|
-
source_ref: string;
|
|
4145
|
-
}
|
|
4309
|
+
export type CreateAppRepoBranchRequest = Wire.CreateAppRepoBranchRequest;
|
|
4146
4310
|
/** A newly created app repository branch. */
|
|
4147
4311
|
export type AppRepoBranch = Wire.AppRepoBranch;
|
|
4148
4312
|
/**
|
|
@@ -4207,6 +4371,7 @@ export type AppApiKeyCollectionParams = Wire.AppApiKeyCollectionParams;
|
|
|
4207
4371
|
export type AppOAuthProviderParams = Wire.AppOAuthProviderParams;
|
|
4208
4372
|
export type AppInstallationPayload = Wire.AppInstallationPayload;
|
|
4209
4373
|
export type UpdateAppInstallationToolAllowlistPayload = Wire.UpdateAppInstallationToolAllowlistPayload;
|
|
4374
|
+
export type UpdateAppInstallationToolPermissionsPayload = Wire.UpdateAppInstallationToolPermissionsPayload;
|
|
4210
4375
|
export type AppInstallationKind = Wire.AppInstallationKind;
|
|
4211
4376
|
/**
|
|
4212
4377
|
* A description of the tools provided by an app
|
|
@@ -4235,6 +4400,7 @@ export type McpApiKeyStatus = Wire.McpApiKeyStatus;
|
|
|
4235
4400
|
export type McpOAuthTokenRequest = Wire.McpOAuthTokenRequest;
|
|
4236
4401
|
export type McpOAuthTokenResponse = Wire.McpOAuthTokenResponse;
|
|
4237
4402
|
export type McpOAuthConnectResponse = Wire.McpOAuthConnectResponse;
|
|
4403
|
+
export type McpOAuthExchangePayload = Wire.McpOAuthExchangePayload;
|
|
4238
4404
|
export type McpOAuthDisconnectResponse = Wire.McpOAuthDisconnectResponse;
|
|
4239
4405
|
/**
|
|
4240
4406
|
* Response from OAuth metadata endpoint
|
|
@@ -4324,6 +4490,12 @@ export interface CompositeAppMenuNavItem {
|
|
|
4324
4490
|
description?: string | null;
|
|
4325
4491
|
/** When true, this item is excluded from the Composite App dashboard cards */
|
|
4326
4492
|
hideFromDashboard?: boolean;
|
|
4493
|
+
/**
|
|
4494
|
+
* When true, this item navigates to the App Portal form of the URL
|
|
4495
|
+
* (`/apps/<appName><route>`) instead of the Composite App form (`/app/<appName><route>`),
|
|
4496
|
+
* so the app is opened standalone rather than inside the Composite App shell.
|
|
4497
|
+
*/
|
|
4498
|
+
openInAppPortal?: boolean;
|
|
4327
4499
|
/** Optional access control settings for this nav item */
|
|
4328
4500
|
permissions?: CompositeAppNavItemPermissions;
|
|
4329
4501
|
/** Ordered child nav-items */
|
|
@@ -4416,6 +4588,8 @@ export type InteractionExecutionError = Wire.InteractionExecutionError;
|
|
|
4416
4588
|
* to prevent JSON serialization issues and reduce storage bloat.
|
|
4417
4589
|
*/
|
|
4418
4590
|
export type ConversationStripOptions = Wire.ConversationStripOptions;
|
|
4591
|
+
/** On-demand compaction of a resumed conversation (`UserMessagePayload.compact_conversation`). */
|
|
4592
|
+
export type CompactConversationOptions = Wire.CompactConversationOptions;
|
|
4419
4593
|
/**
|
|
4420
4594
|
* Reference to an interaction in the catalog.
|
|
4421
4595
|
* Used in catalog listing. The id is composed of the namespace and the interaction name.
|
|
@@ -4423,6 +4597,13 @@ export type ConversationStripOptions = Wire.ConversationStripOptions;
|
|
|
4423
4597
|
* If no prefix is used it fallback on `oid:`.
|
|
4424
4598
|
*/
|
|
4425
4599
|
export type CatalogInteractionRef = Wire.CatalogInteractionRef;
|
|
4600
|
+
export type CatalogAgentSearchQuery = Wire.CatalogAgentSearchQuery;
|
|
4601
|
+
export type CatalogCallSearchQuery = Wire.CatalogCallSearchQuery;
|
|
4602
|
+
/** An interaction found by a catalog search: a system or app interaction, or a stored one with its model, prompts and update time. */
|
|
4603
|
+
export type CatalogSearchInteractionRef = Wire.CatalogSearchInteractionRef;
|
|
4604
|
+
export type CatalogTagCount = Wire.CatalogTagCount;
|
|
4605
|
+
/** A catalog search result: the matching interactions, their tag counts and the total. */
|
|
4606
|
+
export type CatalogSearchResult = Wire.CatalogSearchResult;
|
|
4426
4607
|
export interface CatalogTagQuery {
|
|
4427
4608
|
tag?: string;
|
|
4428
4609
|
}
|
|
@@ -4430,13 +4611,14 @@ export interface StoredCatalogInteractionsQuery extends CatalogTagQuery {
|
|
|
4430
4611
|
status?: string;
|
|
4431
4612
|
published?: boolean;
|
|
4432
4613
|
}
|
|
4433
|
-
export
|
|
4434
|
-
|
|
4435
|
-
|
|
4614
|
+
export type ExecuteNamedInteractionQuery = Wire.ExecuteNamedInteractionQuery;
|
|
4615
|
+
export type GetRunQuery = Wire.GetRunQuery;
|
|
4616
|
+
export type ExecuteInteractionByEndpointQuery = Wire.ExecuteInteractionByEndpointQuery;
|
|
4436
4617
|
export interface ExecuteInteractionByEndpointHeaders {
|
|
4437
4618
|
'x-interaction-tag'?: string;
|
|
4438
4619
|
}
|
|
4439
4620
|
export type ResolveInteractionQuery = Wire.ResolveInteractionQuery;
|
|
4621
|
+
export type DeleteInteractionQuery = Wire.DeleteInteractionQuery;
|
|
4440
4622
|
export type InCodePrompt = Wire.InCodePrompt;
|
|
4441
4623
|
export type InCodeInteraction = Wire.InCodeInteraction;
|
|
4442
4624
|
export type ResolvedCatalogInteraction = Wire.ResolvedCatalogInteraction;
|
|
@@ -4689,15 +4871,8 @@ export interface InteractionExecutionResult<P = unknown> extends Omit<ExecutionR
|
|
|
4689
4871
|
}
|
|
4690
4872
|
export type ExecutionRunRef = Wire.ExecutionRunRef;
|
|
4691
4873
|
export type InteractionExecutionConfiguration = Wire.InteractionExecutionConfiguration;
|
|
4692
|
-
export type GenerateInteractionPayload = Wire.GenerateInteractionPayload;
|
|
4693
4874
|
export type GenerateTestDataPayload = Wire.GenerateTestDataPayload;
|
|
4694
4875
|
export type GeneratedTestDataRecord = Wire.GeneratedTestDataRecord;
|
|
4695
|
-
export type ImprovePromptPayloadConfig = Wire.ImprovePromptPayloadConfig;
|
|
4696
|
-
export type ImprovePromptPayload = Wire.ImprovePromptPayload;
|
|
4697
|
-
export type GeneratedInteractionPromptTemplate = Wire.GeneratedInteractionPromptTemplate;
|
|
4698
|
-
export type GeneratedInteractionPromptSegment = Wire.GeneratedInteractionPromptSegment;
|
|
4699
|
-
export type GeneratedInteractionDefinition = Wire.GeneratedInteractionDefinition;
|
|
4700
|
-
export type PromptImprovementResponse = Wire.PromptImprovementResponse;
|
|
4701
4876
|
export type RateLimitRequestPayload = Wire.RateLimitRequestPayload;
|
|
4702
4877
|
export type RateLimitRequestResponse = Wire.RateLimitRequestResponse;
|
|
4703
4878
|
/**
|
|
@@ -5010,6 +5185,11 @@ export type DataStoreVersionTableState = Wire.DataStoreVersionTableState;
|
|
|
5010
5185
|
export type DataStoreVersion = Wire.DataStoreVersion;
|
|
5011
5186
|
export type ListDataStoreVersionsQuery = Wire.ListDataStoreVersionsQuery;
|
|
5012
5187
|
export type GetDataStoreTableQuery = Wire.GetDataStoreTableQuery;
|
|
5188
|
+
export type GetDataStoreSchemaQuery = Wire.GetDataStoreSchemaQuery;
|
|
5189
|
+
export type ListDataStoreSchemaHistoryQuery = Wire.ListDataStoreSchemaHistoryQuery;
|
|
5190
|
+
export type CreateDataStoreDownloadUrlQuery = Wire.CreateDataStoreDownloadUrlQuery;
|
|
5191
|
+
export type ListDashboardsQuery = Wire.ListDashboardsQuery;
|
|
5192
|
+
export type ListDashboardVersionsQuery = Wire.ListDashboardVersionsQuery;
|
|
5013
5193
|
/**
|
|
5014
5194
|
* Import job status.
|
|
5015
5195
|
*/
|
|
@@ -5039,6 +5219,12 @@ export type CreateTablePayload = Wire.CreateTablePayload;
|
|
|
5039
5219
|
export type CreateTablesPayload = Wire.CreateTablesPayload;
|
|
5040
5220
|
export type QueryValidationPayload = Wire.QueryValidationPayload;
|
|
5041
5221
|
export type BatchQueryPayload = Wire.BatchQueryPayload;
|
|
5222
|
+
export type AlterTableAddColumnOperation = Wire.AlterTableAddColumnOperation;
|
|
5223
|
+
export type AlterTableDropColumnOperation = Wire.AlterTableDropColumnOperation;
|
|
5224
|
+
export type AlterTableRenameColumnOperation = Wire.AlterTableRenameColumnOperation;
|
|
5225
|
+
export type AlterTableModifyColumnOperation = Wire.AlterTableModifyColumnOperation;
|
|
5226
|
+
export type AlterTableAddForeignKeyOperation = Wire.AlterTableAddForeignKeyOperation;
|
|
5227
|
+
export type AlterTableDropForeignKeyOperation = Wire.AlterTableDropForeignKeyOperation;
|
|
5042
5228
|
/**
|
|
5043
5229
|
* Schema change operation types.
|
|
5044
5230
|
*/
|
|
@@ -5111,6 +5297,7 @@ export type DataStoreSchemaResponse = Wire.DataStoreSchemaResponse;
|
|
|
5111
5297
|
export type DataStoreTableDetail = Wire.DataStoreTableDetail;
|
|
5112
5298
|
export type DataStoreTableDropResult = Wire.DataStoreTableDropResult;
|
|
5113
5299
|
export type DashboardArchiveResult = Wire.DashboardArchiveResult;
|
|
5300
|
+
export type DashboardBulkIdsPayload = Wire.DashboardBulkIdsPayload;
|
|
5114
5301
|
export type DashboardBulkArchiveResult = Wire.DashboardBulkArchiveResult;
|
|
5115
5302
|
export type DashboardBulkDeleteResult = Wire.DashboardBulkDeleteResult;
|
|
5116
5303
|
export type DashboardVersioningStatusResponse = Wire.DashboardVersioningStatusResponse;
|
|
@@ -5197,6 +5384,8 @@ export declare const DEFAULT_DASHBOARD_LAYOUT: DashboardLayout;
|
|
|
5197
5384
|
* Queries execute through Vertesia Store, so project/security filtering remains server-side.
|
|
5198
5385
|
*/
|
|
5199
5386
|
export type DashboardElasticsearchDsl = Wire.DashboardElasticsearchDsl;
|
|
5387
|
+
export type DashboardElasticsearchHitsMapping = Wire.DashboardElasticsearchHitsMapping;
|
|
5388
|
+
export type DashboardElasticsearchAggregationBucketsMapping = Wire.DashboardElasticsearchAggregationBucketsMapping;
|
|
5200
5389
|
/**
|
|
5201
5390
|
* How an Elasticsearch DSL result should be converted into Vega rows.
|
|
5202
5391
|
*/
|
|
@@ -5249,6 +5438,34 @@ export type CreateDashboardPayload = Wire.CreateDashboardPayload;
|
|
|
5249
5438
|
* Payload for updating a dashboard.
|
|
5250
5439
|
*/
|
|
5251
5440
|
export type UpdateDashboardPayload = Wire.UpdateDashboardPayload;
|
|
5441
|
+
/**
|
|
5442
|
+
* Options for exporting a saved dashboard as an image.
|
|
5443
|
+
*/
|
|
5444
|
+
export type ExportDashboardPayload = Wire.ExportDashboardPayload;
|
|
5445
|
+
/**
|
|
5446
|
+
* An unsaved dashboard (SQL query and Vega-Lite spec) to render as an image.
|
|
5447
|
+
*/
|
|
5448
|
+
export type ExportDashboardPreviewPayload = Wire.ExportDashboardPreviewPayload;
|
|
5449
|
+
/**
|
|
5450
|
+
* Status of a dashboard export.
|
|
5451
|
+
*/
|
|
5452
|
+
export declare const DashboardExportStatus: {
|
|
5453
|
+
/** The image is being rendered */
|
|
5454
|
+
readonly RUNNING: 'running';
|
|
5455
|
+
/** The image is ready to download */
|
|
5456
|
+
readonly COMPLETED: 'completed';
|
|
5457
|
+
/** The export failed; its `error` says why */
|
|
5458
|
+
readonly FAILED: 'failed';
|
|
5459
|
+
};
|
|
5460
|
+
export type DashboardExportStatus = Wire.DashboardExportStatus;
|
|
5461
|
+
/**
|
|
5462
|
+
* Why a dashboard export failed.
|
|
5463
|
+
*/
|
|
5464
|
+
export type DashboardExportError = Wire.DashboardExportError;
|
|
5465
|
+
/**
|
|
5466
|
+
* A dashboard export: `running` until it is `completed`, with a signed download URL, or `failed`.
|
|
5467
|
+
*/
|
|
5468
|
+
export type DashboardExport = Wire.DashboardExport;
|
|
5252
5469
|
/**
|
|
5253
5470
|
* Options for rendering a dashboard.
|
|
5254
5471
|
*/
|