@vertesia/appgen-docs 1.6.0-dev.20261022.120426Z → 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 +6706 -3862
- package/lib/docs/ui-interfaces.d.ts +81 -9
- package/lib/docs/vertesia-client.d.ts +276 -60
- package/lib/docs/vertesia-common.d.ts +207 -33
- package/package.json +10 -9
|
@@ -39,9 +39,9 @@ export type { AsyncExecutionResult };
|
|
|
39
39
|
// -----------------------------------------------------------------------------
|
|
40
40
|
// @vertesia/client: client.d.ts
|
|
41
41
|
// -----------------------------------------------------------------------------
|
|
42
|
-
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';
|
|
43
43
|
import type { AppSessionTokenRequest, AppSessionTokenResponse } from '@vertesia/common';
|
|
44
|
-
import { type AuthTokenPayload, type AuthTokenResponse } from '@vertesia/common';
|
|
44
|
+
import { type AuthTokenPayload, type AuthTokenResponse, type ContentSecurity } from '@vertesia/common';
|
|
45
45
|
import AccountApi from './AccountApi.js';
|
|
46
46
|
import AccountsApi from './AccountsApi.js';
|
|
47
47
|
import AnalyticsApi from './AnalyticsApi.js';
|
|
@@ -91,10 +91,14 @@ export type VertesiaClientProps = {
|
|
|
91
91
|
storeUrl?: string;
|
|
92
92
|
tokenServerUrl?: string;
|
|
93
93
|
apikey?: string;
|
|
94
|
+
/** Supplies the complete Authorization header; takes precedence over apikey. */
|
|
95
|
+
authCallback?: () => Promise<string>;
|
|
94
96
|
sessionTags?: string | string[];
|
|
97
|
+
requestIdentity?: RequestIdentityProvider;
|
|
95
98
|
onRequest?: (request: Request) => void;
|
|
96
99
|
onResponse?: (response: Response) => void;
|
|
97
100
|
retryPolicy?: IRequestRetryPolicy;
|
|
101
|
+
pacingRetry?: IPacingRetryPolicy | false;
|
|
98
102
|
/**
|
|
99
103
|
* Default request timeout in ms applied to every request (studio + store) unless overridden
|
|
100
104
|
* per-request via `timeoutMs`. `false`/`null`/`0` disables it. Aborts the whole request
|
|
@@ -108,6 +112,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
108
112
|
* The JWT token linked to the API KEY (sk or pk)
|
|
109
113
|
*/
|
|
110
114
|
_jwt: string | null;
|
|
115
|
+
private abacResolution?;
|
|
111
116
|
/**
|
|
112
117
|
* The store client
|
|
113
118
|
*/
|
|
@@ -161,6 +166,12 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
161
166
|
withApiKey(apiKey: string | null): Promise<this>;
|
|
162
167
|
getRawJWT(): Promise<string | null>;
|
|
163
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>;
|
|
164
175
|
getProject(): Promise<import("@vertesia/common/wire-types").ProjectRef | null>;
|
|
165
176
|
getAccount(): Promise<import("@vertesia/common/wire-types").AccountRef | null>;
|
|
166
177
|
/**
|
|
@@ -176,6 +187,7 @@ export declare class VertesiaClient extends AbstractFetchClient<VertesiaClient>
|
|
|
176
187
|
*/
|
|
177
188
|
get objects(): import("./index.js").ObjectsApi;
|
|
178
189
|
get files(): import("./index.js").FilesApi;
|
|
190
|
+
get contentSources(): import("./index.js").ContentSourcesApi;
|
|
179
191
|
get processes(): import("./index.js").ProcessApi;
|
|
180
192
|
get processTestRuns(): import("./index.js").ProcessTestRunApi;
|
|
181
193
|
get tasks(): import("./index.js").TaskApi;
|
|
@@ -236,10 +248,12 @@ export declare function decodeEndpoints(endpoints: string | Record<string, strin
|
|
|
236
248
|
// @vertesia/client: AppsApi.d.ts
|
|
237
249
|
// -----------------------------------------------------------------------------
|
|
238
250
|
import { ApiTopic, type ClientBase } from '@vertesia/api-fetch-client';
|
|
239
|
-
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';
|
|
240
252
|
export type { OrphanedAppInstallation } from '@vertesia/common';
|
|
241
253
|
export default class AppsApi extends ApiTopic {
|
|
242
254
|
constructor(parent: ClientBase);
|
|
255
|
+
/** The publisher-managed OAuth registration shared by all installations of an app. */
|
|
256
|
+
getOAuthClient(appId: string): Promise<OAuthClient>;
|
|
243
257
|
create(manifest: AppManifestData): Promise<AppManifest>;
|
|
244
258
|
update(id: string, manifest: UpdateAppPayload): Promise<AppManifest>;
|
|
245
259
|
/**
|
|
@@ -270,6 +284,14 @@ export default class AppsApi extends ApiTopic {
|
|
|
270
284
|
upsertVersion(payload: UpsertAppVersionRequest): Promise<AppVersionRecord>;
|
|
271
285
|
getVersion(recordId: string): Promise<AppVersionRecord>;
|
|
272
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>;
|
|
273
295
|
rebuildVersion(recordId: string): Promise<StartAppBuildResponse>;
|
|
274
296
|
deleteVersion(recordId: string): Promise<DeleteAppVersionResponse>;
|
|
275
297
|
startBuild(appIdOrRecordId: string, payload: StartAppBuildRequest): Promise<StartAppBuildResponse>;
|
|
@@ -376,7 +398,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
376
398
|
* package-resolved (no per-id route), so this is how a client reads the full definition — type
|
|
377
399
|
* schema, interaction prompt, process definition, dashboard spec — to visualize an exposed id.
|
|
378
400
|
*/
|
|
379
|
-
getAppPackage(appIdOrName: string, scope?: AppPackageScope | AppPackageScope[]): Promise<AppPackage>;
|
|
401
|
+
getAppPackage(appIdOrName: string, scope?: AppPackageScope | AppPackageScope[], deploymentAlias?: string): Promise<AppPackage>;
|
|
380
402
|
/**
|
|
381
403
|
* Get package capabilities exposed by an app installation.
|
|
382
404
|
*/
|
|
@@ -405,7 +427,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
405
427
|
client_id?: string;
|
|
406
428
|
client_secret?: string;
|
|
407
429
|
scopes?: string[];
|
|
408
|
-
}>, 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>;
|
|
409
431
|
/**
|
|
410
432
|
* Remove the given app from the current project.
|
|
411
433
|
* @param installationId - the id of the app installation
|
|
@@ -457,6 +479,11 @@ export default class AppsApi extends ApiTopic {
|
|
|
457
479
|
* Pass null to remove all restrictions (all tools permitted).
|
|
458
480
|
*/
|
|
459
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>;
|
|
460
487
|
/**
|
|
461
488
|
* Validate that a URL is safe to use as a remote tool/activity endpoint.
|
|
462
489
|
* Throws a ServerError(400) if the URL is blocked (SSRF protection).
|
|
@@ -468,7 +495,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
468
495
|
// @vertesia/client: InteractionsApi.d.ts
|
|
469
496
|
// -----------------------------------------------------------------------------
|
|
470
497
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
471
|
-
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';
|
|
472
499
|
import { type ExecuteInteractionRequestOptions } from './execute.js';
|
|
473
500
|
import { InteractionCatalogApi } from './InteractionCatalogApi.js';
|
|
474
501
|
import { type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
@@ -594,20 +621,10 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
594
621
|
executeAsync(payload: AsyncExecutionPayload): Promise<AsyncExecutionResult>;
|
|
595
622
|
publish(id: string, payload: InteractionPublishPayload): Promise<Interaction>;
|
|
596
623
|
fork(id: string, payload: InteractionForkPayload): Promise<Interaction>;
|
|
597
|
-
/**
|
|
598
|
-
* Generate Composable definition of an interaction
|
|
599
|
-
**/
|
|
600
|
-
generateInteraction(id: string, payload: GenerateInteractionPayload): Promise<GeneratedInteractionDefinition[]>;
|
|
601
624
|
/**
|
|
602
625
|
* Generate Test Data for an interaction
|
|
603
626
|
**/
|
|
604
627
|
generateTestData(id: string, payload: GenerateTestDataPayload): Promise<GeneratedTestDataRecord[]>;
|
|
605
|
-
/**
|
|
606
|
-
* Suggest Improvement for a prompt
|
|
607
|
-
* @deprecated use suggestPromptImprovements instead
|
|
608
|
-
*/
|
|
609
|
-
suggestImprovements(id: string, payload: ImprovePromptPayloadConfig): Promise<PromptImprovementResponse>;
|
|
610
|
-
suggestPromptImprovements(payload: ImprovePromptPayload): Promise<PromptImprovementResponse>;
|
|
611
628
|
/**
|
|
612
629
|
* List the versions of the interaction. Returns an empty array if no versions are found
|
|
613
630
|
* @param id
|
|
@@ -623,7 +640,8 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
623
640
|
/**
|
|
624
641
|
* Request a time slot to execute an interaction with a given environment / model
|
|
625
642
|
* @param payload RateLimitRequestPayload
|
|
626
|
-
* @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
|
|
627
645
|
*/
|
|
628
646
|
requestSlot(payload: RateLimitRequestPayload): Promise<RateLimitRequestResponse>;
|
|
629
647
|
/**
|
|
@@ -850,11 +868,12 @@ export declare class RunsApi extends ApiTopic {
|
|
|
850
868
|
// -----------------------------------------------------------------------------
|
|
851
869
|
// @vertesia/client: store/client.d.ts
|
|
852
870
|
// -----------------------------------------------------------------------------
|
|
853
|
-
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';
|
|
854
872
|
import { type BulkOperationPayload, type BulkOperationResponse } from '@vertesia/common';
|
|
855
873
|
import { AgentsApi } from './AgentsApi.js';
|
|
856
874
|
import { CollectionsApi } from './CollectionsApi.js';
|
|
857
875
|
import { ContentApi } from './ContentApi.js';
|
|
876
|
+
import { ContentSourcesApi } from './ContentSourcesApi.js';
|
|
858
877
|
import { CostApi } from './CostApi.js';
|
|
859
878
|
import { DataApi } from './DataApi.js';
|
|
860
879
|
import { EmailApi } from './EmailApi.js';
|
|
@@ -862,6 +881,7 @@ import { EmbeddingsApi } from './EmbeddingsApi.js';
|
|
|
862
881
|
import { EventsApi } from './EventsApi.js';
|
|
863
882
|
import { FilesApi } from './FilesApi.js';
|
|
864
883
|
import { IndexingApi } from './IndexingApi.js';
|
|
884
|
+
import { NotificationsApi } from './NotificationsApi.js';
|
|
865
885
|
import { ObjectsApi } from './ObjectsApi.js';
|
|
866
886
|
import { PendingAsksApi } from './PendingAsksApi.js';
|
|
867
887
|
import { ProcessApi } from './ProcessApi.js';
|
|
@@ -877,9 +897,13 @@ export interface ZenoClientProps {
|
|
|
877
897
|
serverUrl?: string;
|
|
878
898
|
tokenServerUrl?: string;
|
|
879
899
|
apikey?: string;
|
|
900
|
+
/** Supplies the complete Authorization header; takes precedence over apikey. */
|
|
901
|
+
authCallback?: () => Promise<string>;
|
|
902
|
+
requestIdentity?: RequestIdentityProvider;
|
|
880
903
|
onRequest?: (request: Request) => void;
|
|
881
904
|
onResponse?: (response: Response) => void;
|
|
882
905
|
retryPolicy?: IRequestRetryPolicy;
|
|
906
|
+
pacingRetry?: IPacingRetryPolicy | false;
|
|
883
907
|
timeout?: number | false | null;
|
|
884
908
|
fetch?: FETCH_FN | Promise<FETCH_FN>;
|
|
885
909
|
}
|
|
@@ -900,6 +924,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
900
924
|
types: TypesApi;
|
|
901
925
|
workflows: WorkflowsApi;
|
|
902
926
|
schedules: SchedulesApi;
|
|
927
|
+
contentSources: ContentSourcesApi;
|
|
903
928
|
processes: ProcessApi;
|
|
904
929
|
processTestRuns: ProcessTestRunApi;
|
|
905
930
|
tasks: TaskApi;
|
|
@@ -911,6 +936,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
911
936
|
/** @deprecated Use events.subscriptions. */
|
|
912
937
|
eventSubscriptions: import("./EventSubscriptionsApi.js").EventSubscriptionsApi;
|
|
913
938
|
pendingAsks: PendingAsksApi;
|
|
939
|
+
notifications: NotificationsApi;
|
|
914
940
|
data: DataApi;
|
|
915
941
|
indexing: IndexingApi;
|
|
916
942
|
query: QueryApi;
|
|
@@ -922,7 +948,7 @@ export declare class ZenoClient extends AbstractFetchClient<ZenoClient> {
|
|
|
922
948
|
// @vertesia/client: store/ObjectsApi.d.ts
|
|
923
949
|
// -----------------------------------------------------------------------------
|
|
924
950
|
import { ApiTopic } from '@vertesia/api-fetch-client';
|
|
925
|
-
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';
|
|
926
952
|
export { getSupportedRenditionFormats, supportsVisualRendition } from '@vertesia/common';
|
|
927
953
|
export { canGenerateRendition };
|
|
928
954
|
import { StreamSource } from '../StreamSource.js';
|
|
@@ -1069,6 +1095,11 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
1069
1095
|
bulkUpdate(updates: Record<string, Record<string, unknown>>, options?: BulkObjectUpdateOptions): Promise<BulkObjectUpdateResult>;
|
|
1070
1096
|
bulkCreate(objects: CreateContentObjectPayload[], options?: BulkObjectCreateOptions): Promise<BulkObjectCreateResult>;
|
|
1071
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>;
|
|
1072
1103
|
listRenditions(documentId: string): Promise<ContentObjectItem[]>;
|
|
1073
1104
|
getRendition(documentId: string, options: GetRenditionParams): Promise<GetRenditionResponse>;
|
|
1074
1105
|
/**
|
|
@@ -1511,7 +1542,7 @@ export declare class TypesApi extends ApiTopic {
|
|
|
1511
1542
|
// @vertesia/client: store/FilesApi.d.ts
|
|
1512
1543
|
// -----------------------------------------------------------------------------
|
|
1513
1544
|
import { ApiTopic, type ClientBase } from '@vertesia/api-fetch-client';
|
|
1514
|
-
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';
|
|
1515
1546
|
import { StreamSource } from '../StreamSource.js';
|
|
1516
1547
|
export declare const MEMORIES_PREFIX = "memories";
|
|
1517
1548
|
export declare const ARTIFACTS_PREFIX = "agents";
|
|
@@ -1556,6 +1587,17 @@ export declare class FilesApi extends ApiTopic {
|
|
|
1556
1587
|
getBucketCreateAccessStatus(principal: string): Promise<BucketCreateAccessStatusResponse>;
|
|
1557
1588
|
list(prefix: string): Promise<FileListResponse>;
|
|
1558
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>;
|
|
1559
1601
|
getDownloadUrl(file: string, name?: string, disposition?: 'inline' | 'attachment'): Promise<GetFileUrlResponse>;
|
|
1560
1602
|
getDownloadUrlWithOptions(payload: GetFileUrlPayload): Promise<GetFileUrlResponse>;
|
|
1561
1603
|
/**
|
|
@@ -1595,11 +1637,14 @@ export declare class FilesApi extends ApiTopic {
|
|
|
1595
1637
|
id: string;
|
|
1596
1638
|
path: string;
|
|
1597
1639
|
}>;
|
|
1640
|
+
/** Upload a source under a file id and name that may differ from its own. */
|
|
1641
|
+
private uploadSource;
|
|
1598
1642
|
/**
|
|
1599
1643
|
*
|
|
1600
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)
|
|
1601
1645
|
* @returns ReadableStream
|
|
1602
1646
|
*/
|
|
1647
|
+
fetchDownloadUrl(url: string): Promise<Response>;
|
|
1603
1648
|
downloadFile(location: string): Promise<ReadableStream<Uint8Array<ArrayBuffer>>>;
|
|
1604
1649
|
/**
|
|
1605
1650
|
* Copy a file to a new destination within the same bucket.
|
|
@@ -1868,7 +1913,7 @@ export declare class DataApi extends ApiTopic {
|
|
|
1868
1913
|
* Named snapshots are kept indefinitely (not subject to 30-day cleanup).
|
|
1869
1914
|
*
|
|
1870
1915
|
* @param id - Data store ID
|
|
1871
|
-
* @param payload - Snapshot name and
|
|
1916
|
+
* @param payload - Snapshot name and message, both non-empty
|
|
1872
1917
|
* @returns The created version/snapshot
|
|
1873
1918
|
*
|
|
1874
1919
|
* @example
|
|
@@ -2006,21 +2051,21 @@ export declare class DataApi extends ApiTopic {
|
|
|
2006
2051
|
* // List dashboards
|
|
2007
2052
|
* const dashboards = await client.data.dashboards(storeId).list();
|
|
2008
2053
|
*
|
|
2009
|
-
* // Preview a dashboard before creating
|
|
2010
|
-
* const preview = await client.data.dashboards(storeId).
|
|
2011
|
-
*
|
|
2012
|
-
*
|
|
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: { ... } },
|
|
2013
2058
|
* });
|
|
2014
2059
|
*
|
|
2015
2060
|
* // Create a dashboard
|
|
2016
2061
|
* const dashboard = await client.data.dashboards(storeId).create({
|
|
2017
2062
|
* name: 'Sales Overview',
|
|
2018
|
-
*
|
|
2019
|
-
*
|
|
2063
|
+
* query: 'SELECT region, SUM(amount) AS total FROM sales GROUP BY region',
|
|
2064
|
+
* spec: { mark: 'bar', encoding: { ... } },
|
|
2020
2065
|
* });
|
|
2021
2066
|
*
|
|
2022
|
-
* //
|
|
2023
|
-
* const
|
|
2067
|
+
* // Export the dashboard as a PNG (signed download URL)
|
|
2068
|
+
* const { url } = await client.data.dashboards(storeId).export(dashboard.id);
|
|
2024
2069
|
* ```
|
|
2025
2070
|
*/
|
|
2026
2071
|
dashboards(storeId: string): DashboardApi;
|
|
@@ -2283,6 +2328,12 @@ export declare enum ContentNature {
|
|
|
2283
2328
|
Code = "code",
|
|
2284
2329
|
Other = "other"
|
|
2285
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;
|
|
2286
2337
|
export interface Dimensions {
|
|
2287
2338
|
width: number;
|
|
2288
2339
|
height: number;
|
|
@@ -2303,6 +2354,61 @@ export declare const POSTER_RENDITION_NAME = "Poster";
|
|
|
2303
2354
|
export declare const AUDIO_RENDITION_NAME = "Audio";
|
|
2304
2355
|
export declare const WEB_VIDEO_RENDITION_NAME = "Web";
|
|
2305
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
|
+
}
|
|
2306
2412
|
export interface ContentMetadata {
|
|
2307
2413
|
type?: ContentNature;
|
|
2308
2414
|
size?: number;
|
|
@@ -2313,11 +2419,18 @@ export interface ContentMetadata {
|
|
|
2313
2419
|
/** ETag of text materialized from object properties by intake rendering. */
|
|
2314
2420
|
rendered_text_etag?: string;
|
|
2315
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;
|
|
2316
2424
|
/**
|
|
2317
2425
|
* Embedded/technical metadata harvested from the source file by intake
|
|
2318
2426
|
* (office docProps, PDF docinfo). Free-form, nature-appropriate keys.
|
|
2319
2427
|
*/
|
|
2320
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;
|
|
2321
2434
|
/** Type-detection provenance recorded by the intake sniff pipeline. */
|
|
2322
2435
|
type_detection?: TypeDetectionMetadata;
|
|
2323
2436
|
/** Locate-pass provenance: which pages the document map found relevant. */
|
|
@@ -2609,6 +2722,19 @@ export type SetFileMetadataPayload = Wire.SetFileMetadataPayload;
|
|
|
2609
2722
|
export type FileMetadataUpdateResult = Wire.FileMetadataUpdateResult;
|
|
2610
2723
|
export type BulkUploadUrlsPayload = Wire.BulkUploadUrlsPayload;
|
|
2611
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;
|
|
2612
2738
|
export type FileBucketResponse = Wire.FileBucketResponse;
|
|
2613
2739
|
export type FileListResponse = Wire.FileListResponse;
|
|
2614
2740
|
export type FileMetadataQuery = Wire.FileMetadataQuery;
|
|
@@ -2875,6 +3001,7 @@ export type RecordRunPayload<TData = Record<string, unknown>, TSource = RunSourc
|
|
|
2875
3001
|
* has successfully started its workflow.
|
|
2876
3002
|
*/
|
|
2877
3003
|
export type BindRunWorkflowPayload = Wire.BindRunWorkflowPayload;
|
|
3004
|
+
export type TerminateAgentRunQuery = Wire.TerminateAgentRunQuery;
|
|
2878
3005
|
export type TerminateAgentRunResponse = Wire.TerminateAgentRunResponse;
|
|
2879
3006
|
export type AgentRunFeedbackRating = Wire.AgentRunFeedbackRating;
|
|
2880
3007
|
export type AgentRunFeedbackReasonCode = Wire.AgentRunFeedbackReasonCode;
|
|
@@ -3091,6 +3218,7 @@ export type CollectionSecuritySettingsResponse = Wire.CollectionSecuritySettings
|
|
|
3091
3218
|
export type CollectionPropagationResponse = Wire.CollectionPropagationResponse;
|
|
3092
3219
|
export type CollectionChildrenUpdateResult = Wire.CollectionChildrenUpdateResult;
|
|
3093
3220
|
export type CollectionMembersUpdatePayload = Wire.CollectionMembersUpdatePayload;
|
|
3221
|
+
export type CollectionPermissionsPayload = Wire.CollectionPermissionsPayload;
|
|
3094
3222
|
export type CollectionChildrenUpdatePayload = Wire.CollectionChildrenUpdatePayload;
|
|
3095
3223
|
export type CollectionMembersQuery = Wire.CollectionMembersQuery;
|
|
3096
3224
|
export type UpdateCollectionPayload = Wire.UpdateCollectionPayload;
|
|
@@ -3098,6 +3226,7 @@ export type UpdateCollectionPayload = Wire.UpdateCollectionPayload;
|
|
|
3098
3226
|
// -----------------------------------------------------------------------------
|
|
3099
3227
|
// @vertesia/common: store/process.d.ts
|
|
3100
3228
|
// -----------------------------------------------------------------------------
|
|
3229
|
+
import type { ModelOptions } from '@llumiverse/common';
|
|
3101
3230
|
import type { JSONSchema } from '../json-schema.js';
|
|
3102
3231
|
import type * as Wire from '../wire-types.generated.js';
|
|
3103
3232
|
export type JsonLogicRule = Wire.JsonLogicRule;
|
|
@@ -3135,7 +3264,26 @@ export interface BranchNodeBranchDefinition {
|
|
|
3135
3264
|
export type HumanTaskDefinition = Wire.HumanTaskDefinition;
|
|
3136
3265
|
export type ProcessNodeReturnsDefinition = Wire.ProcessNodeReturnsDefinition;
|
|
3137
3266
|
export type ParallelCollectDefinition = Wire.ParallelCollectDefinition;
|
|
3138
|
-
|
|
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 {
|
|
3139
3287
|
type: ProcessNodeType;
|
|
3140
3288
|
tool?: string;
|
|
3141
3289
|
/** Named entry in process resources.scripts for script nodes. */
|
|
@@ -3184,13 +3332,6 @@ export interface NodeDefinition {
|
|
|
3184
3332
|
excluded_tools?: string[];
|
|
3185
3333
|
/** Process-owned successful-tool phases and completion behavior for this agent node. */
|
|
3186
3334
|
agent_policy?: ProcessAgentExecutionPolicy;
|
|
3187
|
-
/**
|
|
3188
|
-
* Model id override for this node. If unset, falls back to the process
|
|
3189
|
-
* run's `config.model`, then to the project's default. Useful when a
|
|
3190
|
-
* specific node needs heavier reasoning (e.g. Opus for legal flagging)
|
|
3191
|
-
* while the rest of the process uses a cheaper default.
|
|
3192
|
-
*/
|
|
3193
|
-
model?: string;
|
|
3194
3335
|
task?: HumanTaskDefinition;
|
|
3195
3336
|
foreach?: string;
|
|
3196
3337
|
as?: string;
|
|
@@ -3204,12 +3345,11 @@ export interface NodeDefinition {
|
|
|
3204
3345
|
metadata?: ProcessDefinitionMetadata;
|
|
3205
3346
|
}
|
|
3206
3347
|
export type ProcessContextDefinition = Wire.ProcessContextDefinition;
|
|
3207
|
-
export interface ProcessDefinitionBody {
|
|
3348
|
+
export interface ProcessDefinitionBody extends ProcessModelSelection {
|
|
3208
3349
|
format_version: ProcessDefinitionFormatVersion;
|
|
3209
3350
|
process: string;
|
|
3210
3351
|
description?: string;
|
|
3211
3352
|
initial: string;
|
|
3212
|
-
model?: string;
|
|
3213
3353
|
resources?: ProcessResourcesDefinition;
|
|
3214
3354
|
context: ProcessContextDefinition;
|
|
3215
3355
|
nodes: Record<string, NodeDefinition>;
|
|
@@ -3265,26 +3405,19 @@ export interface CreateProcessDefinitionPayload {
|
|
|
3265
3405
|
* @deprecated Process definitions are created as drafts. Use the publish endpoint
|
|
3266
3406
|
* to create immutable published versions.
|
|
3267
3407
|
*/
|
|
3268
|
-
status?:
|
|
3408
|
+
status?: 'draft';
|
|
3269
3409
|
/**
|
|
3270
3410
|
* @deprecated Version is server-owned. Use the publish endpoint to create the next version.
|
|
3271
3411
|
*/
|
|
3272
|
-
version?:
|
|
3412
|
+
version?: 1;
|
|
3273
3413
|
tags?: string[];
|
|
3274
3414
|
definition: ProcessDefinitionBody;
|
|
3275
3415
|
}
|
|
3416
|
+
/** A draft edit. `status` and `version` are server-owned: use the publish, archive and revert endpoints. */
|
|
3276
3417
|
export interface UpdateProcessDefinitionPayload {
|
|
3277
3418
|
expected_edit_revision?: number;
|
|
3278
3419
|
name?: string;
|
|
3279
3420
|
description?: string;
|
|
3280
|
-
/**
|
|
3281
|
-
* @deprecated Status is server-owned. Use publish/archive endpoints instead of updating it directly.
|
|
3282
|
-
*/
|
|
3283
|
-
status?: ProcessDefinitionStatus;
|
|
3284
|
-
/**
|
|
3285
|
-
* @deprecated Version is server-owned. Use the publish endpoint to create the next version.
|
|
3286
|
-
*/
|
|
3287
|
-
version?: number;
|
|
3288
3421
|
tags?: string[];
|
|
3289
3422
|
definition?: ProcessDefinitionBody;
|
|
3290
3423
|
}
|
|
@@ -3497,6 +3630,9 @@ export type ChildWorkflowTask = Wire.ChildWorkflowTask;
|
|
|
3497
3630
|
export type SignalTask = Wire.SignalTask;
|
|
3498
3631
|
export type TimerTask = Wire.TimerTask;
|
|
3499
3632
|
export type WorkflowTask = Wire.WorkflowTask;
|
|
3633
|
+
export type WorkflowEventsHistory = Wire.WorkflowEventsHistory;
|
|
3634
|
+
export type WorkflowTasksHistory = Wire.WorkflowTasksHistory;
|
|
3635
|
+
export type WorkflowAgentHistory = Wire.WorkflowAgentHistory;
|
|
3500
3636
|
export type WorkflowHistory = Wire.WorkflowHistory;
|
|
3501
3637
|
export type AgentTask = Wire.AgentTask;
|
|
3502
3638
|
export type WorkflowRun = Wire.WorkflowRun;
|
|
@@ -3767,6 +3903,8 @@ export interface ConversationFileRemovedRef {
|
|
|
3767
3903
|
}
|
|
3768
3904
|
export type PlanTask = Wire.PlanTask;
|
|
3769
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";
|
|
3770
3908
|
export declare const LOW_PRIORITY_TASK_QUEUE = "low_priority";
|
|
3771
3909
|
/**
|
|
3772
3910
|
* WebSocket message types for bidirectional communication
|
|
@@ -3986,6 +4124,8 @@ export type AppInstallationProjectsQuery = Wire.AppInstallationProjectsQuery;
|
|
|
3986
4124
|
export type AppInstallationsQuery = Wire.AppInstallationsQuery;
|
|
3987
4125
|
export type AppListScope = Wire.AppListScope;
|
|
3988
4126
|
export type AppsQuery = Wire.AppsQuery;
|
|
4127
|
+
export type AppDeleteQuery = Wire.AppDeleteQuery;
|
|
4128
|
+
export type AppRepoCommitsQuery = Wire.AppRepoCommitsQuery;
|
|
3989
4129
|
export type ToolCollectionAuthType = Wire.ToolCollectionAuthType;
|
|
3990
4130
|
export type MCPOAuthConfig = Wire.MCPOAuthConfig;
|
|
3991
4131
|
/** Install-time provisioning blueprint for an `auth: 'api_key'` MCP collection. Never holds the key. */
|
|
@@ -4040,6 +4180,8 @@ export type AppCapabilities = Wire.AppCapabilities;
|
|
|
4040
4180
|
export declare const APP_VERSION_HEADER = "x-vertesia-app-version";
|
|
4041
4181
|
export type AppAvailableIn = Wire.AppAvailableIn;
|
|
4042
4182
|
export type AppVersionKind = Wire.AppVersionKind;
|
|
4183
|
+
export type AppDeploymentAlias = Wire.AppDeploymentAlias;
|
|
4184
|
+
export type AppDeploymentAliasTarget = Wire.AppDeploymentAliasTarget;
|
|
4043
4185
|
export type AppVersionState = Wire.AppVersionState;
|
|
4044
4186
|
export type AppVersionTarget = Wire.AppVersionTarget;
|
|
4045
4187
|
export type AppVersionGitRefType = Wire.AppVersionGitRefType;
|
|
@@ -4047,7 +4189,29 @@ export type AppBuildTrigger = Wire.AppBuildTrigger;
|
|
|
4047
4189
|
export type AppVersionStorage = Wire.AppVersionStorage;
|
|
4048
4190
|
export type AppVersionGitSource = Wire.AppVersionGitSource;
|
|
4049
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;
|
|
4050
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;
|
|
4051
4215
|
export type DeleteAppVersionResponse = Wire.DeleteAppVersionResponse;
|
|
4052
4216
|
export type UpsertAppVersionRequest = Wire.UpsertAppVersionRequest;
|
|
4053
4217
|
export interface AppVersionListQuery {
|
|
@@ -4094,6 +4258,8 @@ export type AppScaffoldProgress = Wire.AppScaffoldProgress;
|
|
|
4094
4258
|
* Declared on the manifest as the app's default. May be overridden per-installation.
|
|
4095
4259
|
*/
|
|
4096
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;
|
|
4097
4263
|
export type AppManifestData = Wire.AppManifestData;
|
|
4098
4264
|
export type UpdateAppPayload = Wire.UpdateAppPayload;
|
|
4099
4265
|
export type AppGitSourceConfig = Wire.AppGitSourceConfig;
|
|
@@ -4140,10 +4306,7 @@ export type AppDevelopmentTaskList = Wire.AppDevelopmentTaskList;
|
|
|
4140
4306
|
/** Development task details, including the latest parent assistant run when one exists. */
|
|
4141
4307
|
export type AppDevelopmentTaskDetails = Wire.AppDevelopmentTaskDetails;
|
|
4142
4308
|
/** Request to create a branch from an existing branch, tag, or commit. */
|
|
4143
|
-
export
|
|
4144
|
-
name: string;
|
|
4145
|
-
source_ref: string;
|
|
4146
|
-
}
|
|
4309
|
+
export type CreateAppRepoBranchRequest = Wire.CreateAppRepoBranchRequest;
|
|
4147
4310
|
/** A newly created app repository branch. */
|
|
4148
4311
|
export type AppRepoBranch = Wire.AppRepoBranch;
|
|
4149
4312
|
/**
|
|
@@ -4208,6 +4371,7 @@ export type AppApiKeyCollectionParams = Wire.AppApiKeyCollectionParams;
|
|
|
4208
4371
|
export type AppOAuthProviderParams = Wire.AppOAuthProviderParams;
|
|
4209
4372
|
export type AppInstallationPayload = Wire.AppInstallationPayload;
|
|
4210
4373
|
export type UpdateAppInstallationToolAllowlistPayload = Wire.UpdateAppInstallationToolAllowlistPayload;
|
|
4374
|
+
export type UpdateAppInstallationToolPermissionsPayload = Wire.UpdateAppInstallationToolPermissionsPayload;
|
|
4211
4375
|
export type AppInstallationKind = Wire.AppInstallationKind;
|
|
4212
4376
|
/**
|
|
4213
4377
|
* A description of the tools provided by an app
|
|
@@ -4236,6 +4400,7 @@ export type McpApiKeyStatus = Wire.McpApiKeyStatus;
|
|
|
4236
4400
|
export type McpOAuthTokenRequest = Wire.McpOAuthTokenRequest;
|
|
4237
4401
|
export type McpOAuthTokenResponse = Wire.McpOAuthTokenResponse;
|
|
4238
4402
|
export type McpOAuthConnectResponse = Wire.McpOAuthConnectResponse;
|
|
4403
|
+
export type McpOAuthExchangePayload = Wire.McpOAuthExchangePayload;
|
|
4239
4404
|
export type McpOAuthDisconnectResponse = Wire.McpOAuthDisconnectResponse;
|
|
4240
4405
|
/**
|
|
4241
4406
|
* Response from OAuth metadata endpoint
|
|
@@ -4325,6 +4490,12 @@ export interface CompositeAppMenuNavItem {
|
|
|
4325
4490
|
description?: string | null;
|
|
4326
4491
|
/** When true, this item is excluded from the Composite App dashboard cards */
|
|
4327
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;
|
|
4328
4499
|
/** Optional access control settings for this nav item */
|
|
4329
4500
|
permissions?: CompositeAppNavItemPermissions;
|
|
4330
4501
|
/** Ordered child nav-items */
|
|
@@ -4417,6 +4588,8 @@ export type InteractionExecutionError = Wire.InteractionExecutionError;
|
|
|
4417
4588
|
* to prevent JSON serialization issues and reduce storage bloat.
|
|
4418
4589
|
*/
|
|
4419
4590
|
export type ConversationStripOptions = Wire.ConversationStripOptions;
|
|
4591
|
+
/** On-demand compaction of a resumed conversation (`UserMessagePayload.compact_conversation`). */
|
|
4592
|
+
export type CompactConversationOptions = Wire.CompactConversationOptions;
|
|
4420
4593
|
/**
|
|
4421
4594
|
* Reference to an interaction in the catalog.
|
|
4422
4595
|
* Used in catalog listing. The id is composed of the namespace and the interaction name.
|
|
@@ -4424,6 +4597,13 @@ export type ConversationStripOptions = Wire.ConversationStripOptions;
|
|
|
4424
4597
|
* If no prefix is used it fallback on `oid:`.
|
|
4425
4598
|
*/
|
|
4426
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;
|
|
4427
4607
|
export interface CatalogTagQuery {
|
|
4428
4608
|
tag?: string;
|
|
4429
4609
|
}
|
|
@@ -4438,6 +4618,7 @@ export interface ExecuteInteractionByEndpointHeaders {
|
|
|
4438
4618
|
'x-interaction-tag'?: string;
|
|
4439
4619
|
}
|
|
4440
4620
|
export type ResolveInteractionQuery = Wire.ResolveInteractionQuery;
|
|
4621
|
+
export type DeleteInteractionQuery = Wire.DeleteInteractionQuery;
|
|
4441
4622
|
export type InCodePrompt = Wire.InCodePrompt;
|
|
4442
4623
|
export type InCodeInteraction = Wire.InCodeInteraction;
|
|
4443
4624
|
export type ResolvedCatalogInteraction = Wire.ResolvedCatalogInteraction;
|
|
@@ -4690,15 +4871,8 @@ export interface InteractionExecutionResult<P = unknown> extends Omit<ExecutionR
|
|
|
4690
4871
|
}
|
|
4691
4872
|
export type ExecutionRunRef = Wire.ExecutionRunRef;
|
|
4692
4873
|
export type InteractionExecutionConfiguration = Wire.InteractionExecutionConfiguration;
|
|
4693
|
-
export type GenerateInteractionPayload = Wire.GenerateInteractionPayload;
|
|
4694
4874
|
export type GenerateTestDataPayload = Wire.GenerateTestDataPayload;
|
|
4695
4875
|
export type GeneratedTestDataRecord = Wire.GeneratedTestDataRecord;
|
|
4696
|
-
export type ImprovePromptPayloadConfig = Wire.ImprovePromptPayloadConfig;
|
|
4697
|
-
export type ImprovePromptPayload = Wire.ImprovePromptPayload;
|
|
4698
|
-
export type GeneratedInteractionPromptTemplate = Wire.GeneratedInteractionPromptTemplate;
|
|
4699
|
-
export type GeneratedInteractionPromptSegment = Wire.GeneratedInteractionPromptSegment;
|
|
4700
|
-
export type GeneratedInteractionDefinition = Wire.GeneratedInteractionDefinition;
|
|
4701
|
-
export type PromptImprovementResponse = Wire.PromptImprovementResponse;
|
|
4702
4876
|
export type RateLimitRequestPayload = Wire.RateLimitRequestPayload;
|
|
4703
4877
|
export type RateLimitRequestResponse = Wire.RateLimitRequestResponse;
|
|
4704
4878
|
/**
|
|
@@ -5011,6 +5185,11 @@ export type DataStoreVersionTableState = Wire.DataStoreVersionTableState;
|
|
|
5011
5185
|
export type DataStoreVersion = Wire.DataStoreVersion;
|
|
5012
5186
|
export type ListDataStoreVersionsQuery = Wire.ListDataStoreVersionsQuery;
|
|
5013
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;
|
|
5014
5193
|
/**
|
|
5015
5194
|
* Import job status.
|
|
5016
5195
|
*/
|
|
@@ -5040,6 +5219,12 @@ export type CreateTablePayload = Wire.CreateTablePayload;
|
|
|
5040
5219
|
export type CreateTablesPayload = Wire.CreateTablesPayload;
|
|
5041
5220
|
export type QueryValidationPayload = Wire.QueryValidationPayload;
|
|
5042
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;
|
|
5043
5228
|
/**
|
|
5044
5229
|
* Schema change operation types.
|
|
5045
5230
|
*/
|
|
@@ -5112,6 +5297,7 @@ export type DataStoreSchemaResponse = Wire.DataStoreSchemaResponse;
|
|
|
5112
5297
|
export type DataStoreTableDetail = Wire.DataStoreTableDetail;
|
|
5113
5298
|
export type DataStoreTableDropResult = Wire.DataStoreTableDropResult;
|
|
5114
5299
|
export type DashboardArchiveResult = Wire.DashboardArchiveResult;
|
|
5300
|
+
export type DashboardBulkIdsPayload = Wire.DashboardBulkIdsPayload;
|
|
5115
5301
|
export type DashboardBulkArchiveResult = Wire.DashboardBulkArchiveResult;
|
|
5116
5302
|
export type DashboardBulkDeleteResult = Wire.DashboardBulkDeleteResult;
|
|
5117
5303
|
export type DashboardVersioningStatusResponse = Wire.DashboardVersioningStatusResponse;
|
|
@@ -5198,6 +5384,8 @@ export declare const DEFAULT_DASHBOARD_LAYOUT: DashboardLayout;
|
|
|
5198
5384
|
* Queries execute through Vertesia Store, so project/security filtering remains server-side.
|
|
5199
5385
|
*/
|
|
5200
5386
|
export type DashboardElasticsearchDsl = Wire.DashboardElasticsearchDsl;
|
|
5387
|
+
export type DashboardElasticsearchHitsMapping = Wire.DashboardElasticsearchHitsMapping;
|
|
5388
|
+
export type DashboardElasticsearchAggregationBucketsMapping = Wire.DashboardElasticsearchAggregationBucketsMapping;
|
|
5201
5389
|
/**
|
|
5202
5390
|
* How an Elasticsearch DSL result should be converted into Vega rows.
|
|
5203
5391
|
*/
|
|
@@ -5250,6 +5438,34 @@ export type CreateDashboardPayload = Wire.CreateDashboardPayload;
|
|
|
5250
5438
|
* Payload for updating a dashboard.
|
|
5251
5439
|
*/
|
|
5252
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;
|
|
5253
5469
|
/**
|
|
5254
5470
|
* Options for rendering a dashboard.
|
|
5255
5471
|
*/
|