@vertesia/appgen-docs 1.6.0-dev.20261019.172735Z → 1.6.0-dev.20261022.120426Z
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/lib/docs/symbol-index.json +2538 -2538
- package/lib/docs/vertesia-client.d.ts +13 -12
- package/lib/docs/vertesia-common.d.ts +3 -3
- package/package.json +11 -6
|
@@ -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';
|
|
@@ -468,6 +469,7 @@ export default class AppsApi extends ApiTopic {
|
|
|
468
469
|
// -----------------------------------------------------------------------------
|
|
469
470
|
import { ApiTopic, type ClientBase, type IRequestParams } from '@vertesia/api-fetch-client';
|
|
470
471
|
import type { AsyncExecutionPayload, AsyncExecutionResult, ComputedFacetResponse, ComputeInteractionFacetPayload, DeleteByIdResult, GeneratedInteractionDefinition, GeneratedTestDataRecord, GenerateInteractionPayload, GenerateTestDataPayload, ImprovePromptPayload, ImprovePromptPayloadConfig, Interaction, InteractionCreatePayload, InteractionDeletePayload, InteractionEndpoint, InteractionEndpointQuery, InteractionExecutionPayload, InteractionForkPayload, InteractionPublishPayload, InteractionRef, InteractionRefWithSchema, InteractionSearchPayload, InteractionSearchQuery, InteractionsExportPayload, InteractionTags, InteractionUpdatePayload, PromptImprovementResponse, RateLimitRequestPayload, RateLimitRequestResponse, ResolvedInteractionExecutionInfo, ResolveInteractionQuery } from '@vertesia/common';
|
|
472
|
+
import { type ExecuteInteractionRequestOptions } from './execute.js';
|
|
471
473
|
import { InteractionCatalogApi } from './InteractionCatalogApi.js';
|
|
472
474
|
import { type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
473
475
|
export default class InteractionsApi extends ApiTopic {
|
|
@@ -580,9 +582,10 @@ export default class InteractionsApi extends ApiTopic {
|
|
|
580
582
|
* @param nameWithTag
|
|
581
583
|
* @param payload
|
|
582
584
|
* @param onChunk
|
|
585
|
+
* @param requestOptions request options, e.g. `{ query: { include_prompt: false } }` to omit the rendered prompt
|
|
583
586
|
* @returns
|
|
584
587
|
*/
|
|
585
|
-
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?:
|
|
588
|
+
executeByName<ResultT = unknown, ParamsT = unknown>(nameWithTag: string, payload?: InteractionExecutionPayload, onChunk?: (chunk: string) => void, requestOptions?: ExecuteInteractionRequestOptions): Promise<EnhancedInteractionExecutionResult<ResultT, ParamsT>>;
|
|
586
589
|
/**
|
|
587
590
|
* Execute an interaction in an workflow
|
|
588
591
|
* @param payload
|
|
@@ -781,7 +784,7 @@ export default class SkillsApi extends ApiTopic {
|
|
|
781
784
|
// -----------------------------------------------------------------------------
|
|
782
785
|
import type { ExecutionResponse } from '@llumiverse/common';
|
|
783
786
|
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';
|
|
787
|
+
import type { ComputeRunFacetPayload, ComputeRunFacetsResponse, ExecutionRunDocRef, ExecutionRunRef, FindPayload, FindRunResult, GetRunQuery, PopulatedExecutionRun, RunClonePayload, RunCreatePayload, RunListingFilters, RunListingQueryOptions, RunSearchPayload, ToolResultsPayload, UserMessagePayload } from '@vertesia/common';
|
|
785
788
|
import { type EnhancedExecutionRun, type EnhancedInteractionExecutionResult } from './InteractionOutput.js';
|
|
786
789
|
export interface FilterOption {
|
|
787
790
|
id: string;
|
|
@@ -804,9 +807,10 @@ export declare class RunsApi extends ApiTopic {
|
|
|
804
807
|
* Get a run by id
|
|
805
808
|
*
|
|
806
809
|
* @param id
|
|
810
|
+
* @param query response options, e.g. `{ include_prompt: false }` to omit the rendered prompt
|
|
807
811
|
* @returns InteractionResult
|
|
808
812
|
**/
|
|
809
|
-
retrieve<ResultT = unknown, ParamsT = unknown>(id: string): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
813
|
+
retrieve<ResultT = unknown, ParamsT = unknown>(id: string, query?: GetRunQuery): Promise<EnhancedExecutionRun<ResultT, ParamsT>>;
|
|
810
814
|
retrievePopulated<P = unknown>(id: string): Promise<PopulatedExecutionRun<P>>;
|
|
811
815
|
/**
|
|
812
816
|
* Get filter options for a field
|
|
@@ -969,12 +973,6 @@ export declare class ObjectsApi extends ApiTopic {
|
|
|
969
973
|
exportContentObjectShardViaBulk(payload: ZenoBulkContentObjectExportShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportShardResult>;
|
|
970
974
|
splitContentObjectExportShardViaBulk(payload: ZenoBulkContentObjectExportSplitShardRequest, timeoutMs?: number | false | null): Promise<ZenoBulkContentObjectExportSplitShardResponse>;
|
|
971
975
|
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
976
|
private zenoBulkPost;
|
|
979
977
|
listFolders(_path?: string): void;
|
|
980
978
|
/** Find object based on query */
|
|
@@ -1205,6 +1203,9 @@ export declare class AgentsApi extends ApiTopic {
|
|
|
1205
1203
|
/**
|
|
1206
1204
|
* Create and start a new agent run.
|
|
1207
1205
|
* Returns the created AgentRun with its stable id.
|
|
1206
|
+
*
|
|
1207
|
+
* Set `idempotency_key` on an agent run to make the call safe to retry: the client's retry policy
|
|
1208
|
+
* then applies, and a replayed request returns the run the first one started.
|
|
1208
1209
|
*/
|
|
1209
1210
|
start<TData = Record<string, unknown>>(payload: CreateAgentRunPayload<TData>): Promise<AgentRun<TData>>;
|
|
1210
1211
|
start<TData = Record<string, unknown>>(payload: CreateProcessRunPayload<TData>): Promise<ProcessRun>;
|
|
@@ -4430,9 +4431,9 @@ export interface StoredCatalogInteractionsQuery extends CatalogTagQuery {
|
|
|
4430
4431
|
status?: string;
|
|
4431
4432
|
published?: boolean;
|
|
4432
4433
|
}
|
|
4433
|
-
export
|
|
4434
|
-
|
|
4435
|
-
|
|
4434
|
+
export type ExecuteNamedInteractionQuery = Wire.ExecuteNamedInteractionQuery;
|
|
4435
|
+
export type GetRunQuery = Wire.GetRunQuery;
|
|
4436
|
+
export type ExecuteInteractionByEndpointQuery = Wire.ExecuteInteractionByEndpointQuery;
|
|
4436
4437
|
export interface ExecuteInteractionByEndpointHeaders {
|
|
4437
4438
|
'x-interaction-tag'?: string;
|
|
4438
4439
|
}
|
|
@@ -940,9 +940,9 @@ export interface StoredCatalogInteractionsQuery extends CatalogTagQuery {
|
|
|
940
940
|
status?: string;
|
|
941
941
|
published?: boolean;
|
|
942
942
|
}
|
|
943
|
-
export
|
|
944
|
-
|
|
945
|
-
|
|
943
|
+
export type ExecuteNamedInteractionQuery = Wire.ExecuteNamedInteractionQuery;
|
|
944
|
+
export type GetRunQuery = Wire.GetRunQuery;
|
|
945
|
+
export type ExecuteInteractionByEndpointQuery = Wire.ExecuteInteractionByEndpointQuery;
|
|
946
946
|
export interface ExecuteInteractionByEndpointHeaders {
|
|
947
947
|
'x-interaction-tag'?: string;
|
|
948
948
|
}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vertesia/appgen-docs",
|
|
3
|
-
"version": "1.6.0-dev.
|
|
3
|
+
"version": "1.6.0-dev.20261022.120426Z",
|
|
4
4
|
"description": "Generated SDK references and development guidance for Vertesia app agents",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "./lib/index.js",
|
|
@@ -16,11 +16,11 @@
|
|
|
16
16
|
}
|
|
17
17
|
},
|
|
18
18
|
"devDependencies": {
|
|
19
|
-
"@types/node": "^24.19.
|
|
20
|
-
"@vertesia/client": "1.6.0-dev.
|
|
21
|
-
"@vertesia/common": "1.6.0-dev.
|
|
19
|
+
"@types/node": "^24.19.2",
|
|
20
|
+
"@vertesia/client": "1.6.0-dev.20261022.120426Z",
|
|
21
|
+
"@vertesia/common": "1.6.0-dev.20261022.120426Z",
|
|
22
22
|
"@vertesia/tsconfig": "0.1.0",
|
|
23
|
-
"@vertesia/ui": "1.6.0-dev.
|
|
23
|
+
"@vertesia/ui": "1.6.0-dev.20261022.120426Z",
|
|
24
24
|
"typescript": "7.0.2"
|
|
25
25
|
},
|
|
26
26
|
"repository": {
|
|
@@ -34,7 +34,12 @@
|
|
|
34
34
|
"documentation",
|
|
35
35
|
"app-development"
|
|
36
36
|
],
|
|
37
|
-
"gitHead": "
|
|
37
|
+
"gitHead": "bcaa7879b601ce9ccc394bcd3257822da13869cd",
|
|
38
|
+
"releaseIdentity": {
|
|
39
|
+
"source_sha": "bcaa7879b601ce9ccc394bcd3257822da13869cd",
|
|
40
|
+
"dependency_sha": "93466e47b06db23ac3c800e248d170afe65e5006",
|
|
41
|
+
"lock_sha256": "117e1c8068aa07d59117323a51ceccfc96cab543e50c03eb7efc19709d6f5e6b"
|
|
42
|
+
},
|
|
38
43
|
"scripts": {
|
|
39
44
|
"build": "pnpm run clean && tsc --checkers 1 -p tsconfig.json && node ./scripts/generate-docs.mjs",
|
|
40
45
|
"clean": "rimraf ./lib ./docs ./tsconfig.tsbuildinfo",
|