@vibexp/api-client 0.8.0 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/axios/index.d.ts +2 -2
- package/dist/axios/index.js +1 -1
- package/dist/axios/sdk.gen.d.ts +53 -17
- package/dist/axios/sdk.gen.js +104 -29
- package/dist/axios/types.gen.d.ts +183 -77
- package/dist/schema.d.ts +360 -137
- package/package.json +1 -1
|
@@ -667,6 +667,10 @@ export type EmbeddingProvider = {
|
|
|
667
667
|
* Overlap between adjacent chunks.
|
|
668
668
|
*/
|
|
669
669
|
chunk_overlap: number;
|
|
670
|
+
/**
|
|
671
|
+
* Maximum number of simultaneous embedding requests VibeXP issues to this provider. Keep at 1 for single-threaded providers.
|
|
672
|
+
*/
|
|
673
|
+
concurrency: number;
|
|
670
674
|
is_default: boolean;
|
|
671
675
|
base_url?: string | null;
|
|
672
676
|
configuration: string;
|
|
@@ -695,6 +699,10 @@ export type CreateEmbeddingProviderRequest = {
|
|
|
695
699
|
* Optional chunk overlap; defaults to 200 when omitted.
|
|
696
700
|
*/
|
|
697
701
|
chunk_overlap?: number;
|
|
702
|
+
/**
|
|
703
|
+
* Optional max simultaneous embedding requests to this provider; defaults to 1 when omitted.
|
|
704
|
+
*/
|
|
705
|
+
concurrency?: number;
|
|
698
706
|
is_default?: boolean;
|
|
699
707
|
base_url?: string;
|
|
700
708
|
api_key?: string | null;
|
|
@@ -708,6 +716,7 @@ export type UpdateEmbeddingProviderRequest = {
|
|
|
708
716
|
model?: string;
|
|
709
717
|
chunk_size?: number;
|
|
710
718
|
chunk_overlap?: number;
|
|
719
|
+
concurrency?: number;
|
|
711
720
|
is_default?: boolean;
|
|
712
721
|
base_url?: string;
|
|
713
722
|
api_key?: string;
|
|
@@ -747,6 +756,48 @@ export type ValidateEmbeddingProviderResponse = {
|
|
|
747
756
|
error_details?: string;
|
|
748
757
|
};
|
|
749
758
|
};
|
|
759
|
+
/**
|
|
760
|
+
* Embedding coverage for a single entity type: how many entities exist, how many have an embedding under the team's active model, how many are still pending, and the embedded percentage.
|
|
761
|
+
*/
|
|
762
|
+
export type EmbeddingCoverageItem = {
|
|
763
|
+
/**
|
|
764
|
+
* The embeddable entity type this row reports on.
|
|
765
|
+
*/
|
|
766
|
+
entity_type: 'prompt' | 'artifact' | 'memory' | 'blueprint' | 'feed_item';
|
|
767
|
+
/**
|
|
768
|
+
* Total embeddable entities of this type owned by the team.
|
|
769
|
+
*/
|
|
770
|
+
total: number;
|
|
771
|
+
/**
|
|
772
|
+
* Entities of this type that already have an embedding under the team's active model.
|
|
773
|
+
*/
|
|
774
|
+
embedded: number;
|
|
775
|
+
/**
|
|
776
|
+
* Entities still missing an embedding (total − embedded).
|
|
777
|
+
*/
|
|
778
|
+
pending: number;
|
|
779
|
+
/**
|
|
780
|
+
* Rounded percentage of entities embedded (embedded / total * 100); 0 when there are no entities of this type.
|
|
781
|
+
*/
|
|
782
|
+
embedded_percent: number;
|
|
783
|
+
};
|
|
784
|
+
/**
|
|
785
|
+
* Derived, team-scoped embedding coverage per entity type under the team's active provider model. Counts are computed from existing rows (no per-entity state); a non-decreasing pending count is the signal that embedding is stuck. When the team has no active provider, has_active_provider is false, active_model is null, and every type reports all entities as pending (0%).
|
|
786
|
+
*/
|
|
787
|
+
export type EmbeddingCoverageResponse = {
|
|
788
|
+
/**
|
|
789
|
+
* Whether the team has an active embedding provider configured.
|
|
790
|
+
*/
|
|
791
|
+
has_active_provider: boolean;
|
|
792
|
+
/**
|
|
793
|
+
* The active provider's embedding model the embedded counts are measured against, or null when no provider is configured.
|
|
794
|
+
*/
|
|
795
|
+
active_model: string | null;
|
|
796
|
+
/**
|
|
797
|
+
* One entry per embeddable entity type, in a stable order.
|
|
798
|
+
*/
|
|
799
|
+
coverage: Array<EmbeddingCoverageItem>;
|
|
800
|
+
};
|
|
750
801
|
export type ResourceUsageItem = {
|
|
751
802
|
/**
|
|
752
803
|
* Type of resource (e.g., prompt, memory, artifact)
|
|
@@ -2266,55 +2317,6 @@ export type UserActivityRow = {
|
|
|
2266
2317
|
*/
|
|
2267
2318
|
total_agent_executions_run?: number;
|
|
2268
2319
|
};
|
|
2269
|
-
/**
|
|
2270
|
-
* Configuration for an embedding backfill run. The scope is explicit: set exactly one of `all` or a non-empty `entity_types`. Sending neither, or both, is rejected with a 400.
|
|
2271
|
-
*/
|
|
2272
|
-
export type EmbeddingBackfillRequest = {
|
|
2273
|
-
/**
|
|
2274
|
-
* Backfill every supported entity type. Mutually exclusive with `entity_types`.
|
|
2275
|
-
*/
|
|
2276
|
-
all?: boolean;
|
|
2277
|
-
/**
|
|
2278
|
-
* Restrict the run to these entity types. Mutually exclusive with `all`.
|
|
2279
|
-
*/
|
|
2280
|
-
entity_types?: Array<'prompt' | 'artifact' | 'memory' | 'blueprint' | 'feed_item'>;
|
|
2281
|
-
/**
|
|
2282
|
-
* When true, only publish for entities that do not already have an embedding for the currently configured model. Honored by `dry_run`.
|
|
2283
|
-
*/
|
|
2284
|
-
missing_only?: boolean;
|
|
2285
|
-
/**
|
|
2286
|
-
* When true, count the entities that would be republished without publishing any event.
|
|
2287
|
-
*/
|
|
2288
|
-
dry_run?: boolean;
|
|
2289
|
-
};
|
|
2290
|
-
/**
|
|
2291
|
-
* Per-entity-type outcome of a backfill run.
|
|
2292
|
-
*/
|
|
2293
|
-
export type EmbeddingBackfillTypeResult = {
|
|
2294
|
-
entity_type: string;
|
|
2295
|
-
/**
|
|
2296
|
-
* Number of source entities seen for this type.
|
|
2297
|
-
*/
|
|
2298
|
-
total: number;
|
|
2299
|
-
/**
|
|
2300
|
-
* Number of `.created` events successfully republished (0 on a dry run).
|
|
2301
|
-
*/
|
|
2302
|
-
published: number;
|
|
2303
|
-
/**
|
|
2304
|
-
* Number of entities whose event publish failed (log-and-continue).
|
|
2305
|
-
*/
|
|
2306
|
-
failed: number;
|
|
2307
|
-
};
|
|
2308
|
-
/**
|
|
2309
|
-
* Aggregated result of an embedding backfill run.
|
|
2310
|
-
*/
|
|
2311
|
-
export type EmbeddingBackfillResult = {
|
|
2312
|
-
dry_run: boolean;
|
|
2313
|
-
results: Array<EmbeddingBackfillTypeResult>;
|
|
2314
|
-
total_seen: number;
|
|
2315
|
-
total_published: number;
|
|
2316
|
-
total_failed: number;
|
|
2317
|
-
};
|
|
2318
2320
|
/**
|
|
2319
2321
|
* Usage and growth data response
|
|
2320
2322
|
*/
|
|
@@ -6753,34 +6755,6 @@ export type GetUsageAndGrowthResponses = {
|
|
|
6753
6755
|
200: UsageAndGrowthResponse;
|
|
6754
6756
|
};
|
|
6755
6757
|
export type GetUsageAndGrowthResponse = GetUsageAndGrowthResponses[keyof GetUsageAndGrowthResponses];
|
|
6756
|
-
export type BackfillEmbeddingsData = {
|
|
6757
|
-
body: EmbeddingBackfillRequest;
|
|
6758
|
-
path?: never;
|
|
6759
|
-
query?: never;
|
|
6760
|
-
url: '/bo/v1/embeddings/backfill';
|
|
6761
|
-
};
|
|
6762
|
-
export type BackfillEmbeddingsErrors = {
|
|
6763
|
-
/**
|
|
6764
|
-
* Invalid request body, no scope (`all` and `entity_types` both empty), an ambiguous scope (both `all` and `entity_types` set), or an unsupported entity type was requested.
|
|
6765
|
-
*/
|
|
6766
|
-
400: ErrorResponse;
|
|
6767
|
-
/**
|
|
6768
|
-
* Unauthorized - Missing or invalid back office admin API key
|
|
6769
|
-
*/
|
|
6770
|
-
401: ErrorResponse;
|
|
6771
|
-
/**
|
|
6772
|
-
* Internal server error
|
|
6773
|
-
*/
|
|
6774
|
-
500: ErrorResponse;
|
|
6775
|
-
};
|
|
6776
|
-
export type BackfillEmbeddingsError = BackfillEmbeddingsErrors[keyof BackfillEmbeddingsErrors];
|
|
6777
|
-
export type BackfillEmbeddingsResponses = {
|
|
6778
|
-
/**
|
|
6779
|
-
* Backfill completed; per-entity-type and aggregate counts returned.
|
|
6780
|
-
*/
|
|
6781
|
-
200: EmbeddingBackfillResult;
|
|
6782
|
-
};
|
|
6783
|
-
export type BackfillEmbeddingsResponse = BackfillEmbeddingsResponses[keyof BackfillEmbeddingsResponses];
|
|
6784
6758
|
export type GetGitHubStatusData = {
|
|
6785
6759
|
body?: never;
|
|
6786
6760
|
path: {
|
|
@@ -10049,6 +10023,35 @@ export type CreateEmbeddingProviderResponses = {
|
|
|
10049
10023
|
200: EmbeddingProviderResponse;
|
|
10050
10024
|
};
|
|
10051
10025
|
export type CreateEmbeddingProviderResponse = CreateEmbeddingProviderResponses[keyof CreateEmbeddingProviderResponses];
|
|
10026
|
+
export type GetEmbeddingCoverageData = {
|
|
10027
|
+
body?: never;
|
|
10028
|
+
path: {
|
|
10029
|
+
/**
|
|
10030
|
+
* Team whose embedding coverage is reported.
|
|
10031
|
+
*/
|
|
10032
|
+
team_id: string;
|
|
10033
|
+
};
|
|
10034
|
+
query?: never;
|
|
10035
|
+
url: '/api/v1/{team_id}/embedding-providers/coverage';
|
|
10036
|
+
};
|
|
10037
|
+
export type GetEmbeddingCoverageErrors = {
|
|
10038
|
+
/**
|
|
10039
|
+
* Unauthorized
|
|
10040
|
+
*/
|
|
10041
|
+
401: ErrorResponse;
|
|
10042
|
+
/**
|
|
10043
|
+
* Failed to retrieve embedding coverage (`DATABASE_ERROR`)
|
|
10044
|
+
*/
|
|
10045
|
+
500: ErrorResponse;
|
|
10046
|
+
};
|
|
10047
|
+
export type GetEmbeddingCoverageError = GetEmbeddingCoverageErrors[keyof GetEmbeddingCoverageErrors];
|
|
10048
|
+
export type GetEmbeddingCoverageResponses = {
|
|
10049
|
+
/**
|
|
10050
|
+
* Embedding coverage retrieved successfully
|
|
10051
|
+
*/
|
|
10052
|
+
200: EmbeddingCoverageResponse;
|
|
10053
|
+
};
|
|
10054
|
+
export type GetEmbeddingCoverageResponse = GetEmbeddingCoverageResponses[keyof GetEmbeddingCoverageResponses];
|
|
10052
10055
|
export type DeleteEmbeddingProviderData = {
|
|
10053
10056
|
body?: never;
|
|
10054
10057
|
path: {
|
|
@@ -10168,6 +10171,43 @@ export type UpdateEmbeddingProviderResponses = {
|
|
|
10168
10171
|
200: EmbeddingProviderResponse;
|
|
10169
10172
|
};
|
|
10170
10173
|
export type UpdateEmbeddingProviderResponse = UpdateEmbeddingProviderResponses[keyof UpdateEmbeddingProviderResponses];
|
|
10174
|
+
export type ReprocessEmbeddingProviderData = {
|
|
10175
|
+
body?: never;
|
|
10176
|
+
path: {
|
|
10177
|
+
/**
|
|
10178
|
+
* Team that owns the embedding provider(s).
|
|
10179
|
+
*/
|
|
10180
|
+
team_id: string;
|
|
10181
|
+
/**
|
|
10182
|
+
* Embedding provider ID
|
|
10183
|
+
*/
|
|
10184
|
+
id: string;
|
|
10185
|
+
};
|
|
10186
|
+
query?: never;
|
|
10187
|
+
url: '/api/v1/{team_id}/embedding-providers/{id}/reprocess';
|
|
10188
|
+
};
|
|
10189
|
+
export type ReprocessEmbeddingProviderErrors = {
|
|
10190
|
+
/**
|
|
10191
|
+
* Unauthorized
|
|
10192
|
+
*/
|
|
10193
|
+
401: ErrorResponse;
|
|
10194
|
+
/**
|
|
10195
|
+
* Embedding provider not found (`PROVIDER_NOT_FOUND`)
|
|
10196
|
+
*/
|
|
10197
|
+
404: ErrorResponse;
|
|
10198
|
+
/**
|
|
10199
|
+
* Failed to load the provider before reprocess (`DATABASE_ERROR`)
|
|
10200
|
+
*/
|
|
10201
|
+
500: ErrorResponse;
|
|
10202
|
+
};
|
|
10203
|
+
export type ReprocessEmbeddingProviderError = ReprocessEmbeddingProviderErrors[keyof ReprocessEmbeddingProviderErrors];
|
|
10204
|
+
export type ReprocessEmbeddingProviderResponses = {
|
|
10205
|
+
/**
|
|
10206
|
+
* Reprocess accepted; embeddings are regenerated in the background.
|
|
10207
|
+
*/
|
|
10208
|
+
202: SuccessResponse;
|
|
10209
|
+
};
|
|
10210
|
+
export type ReprocessEmbeddingProviderResponse = ReprocessEmbeddingProviderResponses[keyof ReprocessEmbeddingProviderResponses];
|
|
10171
10211
|
export type ValidateEmbeddingProviderData = {
|
|
10172
10212
|
body: ValidateEmbeddingProviderRequest;
|
|
10173
10213
|
path: {
|
|
@@ -10267,6 +10307,35 @@ export type CreateEmbeddingProviderSettingsResponses = {
|
|
|
10267
10307
|
200: EmbeddingProviderResponse;
|
|
10268
10308
|
};
|
|
10269
10309
|
export type CreateEmbeddingProviderSettingsResponse = CreateEmbeddingProviderSettingsResponses[keyof CreateEmbeddingProviderSettingsResponses];
|
|
10310
|
+
export type GetEmbeddingCoverageSettingsData = {
|
|
10311
|
+
body?: never;
|
|
10312
|
+
path: {
|
|
10313
|
+
/**
|
|
10314
|
+
* Team whose embedding coverage is reported.
|
|
10315
|
+
*/
|
|
10316
|
+
team_id: string;
|
|
10317
|
+
};
|
|
10318
|
+
query?: never;
|
|
10319
|
+
url: '/api/v1/{team_id}/settings/embedding-providers/coverage';
|
|
10320
|
+
};
|
|
10321
|
+
export type GetEmbeddingCoverageSettingsErrors = {
|
|
10322
|
+
/**
|
|
10323
|
+
* Unauthorized
|
|
10324
|
+
*/
|
|
10325
|
+
401: ErrorResponse;
|
|
10326
|
+
/**
|
|
10327
|
+
* Failed to retrieve embedding coverage (`DATABASE_ERROR`)
|
|
10328
|
+
*/
|
|
10329
|
+
500: ErrorResponse;
|
|
10330
|
+
};
|
|
10331
|
+
export type GetEmbeddingCoverageSettingsError = GetEmbeddingCoverageSettingsErrors[keyof GetEmbeddingCoverageSettingsErrors];
|
|
10332
|
+
export type GetEmbeddingCoverageSettingsResponses = {
|
|
10333
|
+
/**
|
|
10334
|
+
* Embedding coverage retrieved successfully
|
|
10335
|
+
*/
|
|
10336
|
+
200: EmbeddingCoverageResponse;
|
|
10337
|
+
};
|
|
10338
|
+
export type GetEmbeddingCoverageSettingsResponse = GetEmbeddingCoverageSettingsResponses[keyof GetEmbeddingCoverageSettingsResponses];
|
|
10270
10339
|
export type DeleteEmbeddingProviderSettingsData = {
|
|
10271
10340
|
body?: never;
|
|
10272
10341
|
path: {
|
|
@@ -10386,6 +10455,43 @@ export type UpdateEmbeddingProviderSettingsResponses = {
|
|
|
10386
10455
|
200: EmbeddingProviderResponse;
|
|
10387
10456
|
};
|
|
10388
10457
|
export type UpdateEmbeddingProviderSettingsResponse = UpdateEmbeddingProviderSettingsResponses[keyof UpdateEmbeddingProviderSettingsResponses];
|
|
10458
|
+
export type ReprocessEmbeddingProviderSettingsData = {
|
|
10459
|
+
body?: never;
|
|
10460
|
+
path: {
|
|
10461
|
+
/**
|
|
10462
|
+
* Team that owns the embedding provider(s).
|
|
10463
|
+
*/
|
|
10464
|
+
team_id: string;
|
|
10465
|
+
/**
|
|
10466
|
+
* Embedding provider ID
|
|
10467
|
+
*/
|
|
10468
|
+
id: string;
|
|
10469
|
+
};
|
|
10470
|
+
query?: never;
|
|
10471
|
+
url: '/api/v1/{team_id}/settings/embedding-providers/{id}/reprocess';
|
|
10472
|
+
};
|
|
10473
|
+
export type ReprocessEmbeddingProviderSettingsErrors = {
|
|
10474
|
+
/**
|
|
10475
|
+
* Unauthorized
|
|
10476
|
+
*/
|
|
10477
|
+
401: ErrorResponse;
|
|
10478
|
+
/**
|
|
10479
|
+
* Embedding provider not found (`PROVIDER_NOT_FOUND`)
|
|
10480
|
+
*/
|
|
10481
|
+
404: ErrorResponse;
|
|
10482
|
+
/**
|
|
10483
|
+
* Failed to load the provider before reprocess (`DATABASE_ERROR`)
|
|
10484
|
+
*/
|
|
10485
|
+
500: ErrorResponse;
|
|
10486
|
+
};
|
|
10487
|
+
export type ReprocessEmbeddingProviderSettingsError = ReprocessEmbeddingProviderSettingsErrors[keyof ReprocessEmbeddingProviderSettingsErrors];
|
|
10488
|
+
export type ReprocessEmbeddingProviderSettingsResponses = {
|
|
10489
|
+
/**
|
|
10490
|
+
* Reprocess accepted; embeddings are regenerated in the background.
|
|
10491
|
+
*/
|
|
10492
|
+
202: SuccessResponse;
|
|
10493
|
+
};
|
|
10494
|
+
export type ReprocessEmbeddingProviderSettingsResponse = ReprocessEmbeddingProviderSettingsResponses[keyof ReprocessEmbeddingProviderSettingsResponses];
|
|
10389
10495
|
export type ValidateEmbeddingProviderSettingsData = {
|
|
10390
10496
|
body: ValidateEmbeddingProviderRequest;
|
|
10391
10497
|
path: {
|