@agentuity/core 1.0.41 → 1.0.43
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/services/api-reference.d.ts +68 -0
- package/dist/services/api-reference.d.ts.map +1 -0
- package/dist/services/api-reference.js +91 -0
- package/dist/services/api-reference.js.map +1 -0
- package/dist/services/apikey/api-reference.d.ts +4 -0
- package/dist/services/apikey/api-reference.d.ts.map +1 -0
- package/dist/services/apikey/api-reference.js +96 -0
- package/dist/services/apikey/api-reference.js.map +1 -0
- package/dist/services/db/api-reference.d.ts +4 -0
- package/dist/services/db/api-reference.d.ts.map +1 -0
- package/dist/services/db/api-reference.js +149 -0
- package/dist/services/db/api-reference.js.map +1 -0
- package/dist/services/db/types.d.ts +7 -0
- package/dist/services/db/types.d.ts.map +1 -0
- package/dist/services/db/types.js +9 -0
- package/dist/services/db/types.js.map +1 -0
- package/dist/services/email/api-reference.d.ts +4 -0
- package/dist/services/email/api-reference.d.ts.map +1 -0
- package/dist/services/email/api-reference.js +342 -0
- package/dist/services/email/api-reference.js.map +1 -0
- package/dist/services/email/service.d.ts.map +1 -1
- package/dist/services/email/service.js +1 -2
- package/dist/services/email/service.js.map +1 -1
- package/dist/services/email/types.d.ts +13 -0
- package/dist/services/email/types.d.ts.map +1 -0
- package/dist/services/email/types.js +11 -0
- package/dist/services/email/types.js.map +1 -0
- package/dist/services/eval/api-reference.d.ts +4 -0
- package/dist/services/eval/api-reference.d.ts.map +1 -0
- package/dist/services/eval/api-reference.js +121 -0
- package/dist/services/eval/api-reference.js.map +1 -0
- package/dist/services/index.d.ts +2 -0
- package/dist/services/index.d.ts.map +1 -1
- package/dist/services/index.js +2 -0
- package/dist/services/index.js.map +1 -1
- package/dist/services/keyvalue/api-reference.d.ts +4 -0
- package/dist/services/keyvalue/api-reference.d.ts.map +1 -0
- package/dist/services/keyvalue/api-reference.js +270 -0
- package/dist/services/keyvalue/api-reference.js.map +1 -0
- package/dist/services/keyvalue/types.d.ts +18 -0
- package/dist/services/keyvalue/types.d.ts.map +1 -0
- package/dist/services/keyvalue/types.js +19 -0
- package/dist/services/keyvalue/types.js.map +1 -0
- package/dist/services/machine/api-reference.d.ts +4 -0
- package/dist/services/machine/api-reference.d.ts.map +1 -0
- package/dist/services/machine/api-reference.js +152 -0
- package/dist/services/machine/api-reference.js.map +1 -0
- package/dist/services/machine/types.d.ts +18 -0
- package/dist/services/machine/types.d.ts.map +1 -0
- package/dist/services/machine/types.js +15 -0
- package/dist/services/machine/types.js.map +1 -0
- package/dist/services/monitoring/index.d.ts +3 -0
- package/dist/services/monitoring/index.d.ts.map +1 -0
- package/dist/services/monitoring/index.js +3 -0
- package/dist/services/monitoring/index.js.map +1 -0
- package/dist/services/monitoring/service.d.ts +55 -0
- package/dist/services/monitoring/service.d.ts.map +1 -0
- package/dist/services/monitoring/service.js +503 -0
- package/dist/services/monitoring/service.js.map +1 -0
- package/dist/services/monitoring/types.d.ts +173 -0
- package/dist/services/monitoring/types.d.ts.map +1 -0
- package/dist/services/monitoring/types.js +2 -0
- package/dist/services/monitoring/types.js.map +1 -0
- package/dist/services/oauth/activity.d.ts +5 -0
- package/dist/services/oauth/activity.d.ts.map +1 -0
- package/dist/services/oauth/activity.js +17 -0
- package/dist/services/oauth/activity.js.map +1 -0
- package/dist/services/oauth/api-reference.d.ts +4 -0
- package/dist/services/oauth/api-reference.d.ts.map +1 -0
- package/dist/services/oauth/api-reference.js +344 -0
- package/dist/services/oauth/api-reference.js.map +1 -0
- package/dist/services/oauth/clients.d.ts +18 -0
- package/dist/services/oauth/clients.d.ts.map +1 -0
- package/dist/services/oauth/clients.js +66 -0
- package/dist/services/oauth/clients.js.map +1 -0
- package/dist/services/oauth/consent.d.ts +7 -0
- package/dist/services/oauth/consent.d.ts.map +1 -0
- package/dist/services/oauth/consent.js +17 -0
- package/dist/services/oauth/consent.js.map +1 -0
- package/dist/services/oauth/index.d.ts +9 -0
- package/dist/services/oauth/index.d.ts.map +1 -0
- package/dist/services/oauth/index.js +9 -0
- package/dist/services/oauth/index.js.map +1 -0
- package/dist/services/oauth/keys.d.ts +5 -0
- package/dist/services/oauth/keys.d.ts.map +1 -0
- package/dist/services/oauth/keys.js +10 -0
- package/dist/services/oauth/keys.js.map +1 -0
- package/dist/services/oauth/members.d.ts +4 -0
- package/dist/services/oauth/members.d.ts.map +1 -0
- package/dist/services/oauth/members.js +10 -0
- package/dist/services/oauth/members.js.map +1 -0
- package/dist/services/oauth/scopes.d.ts +4 -0
- package/dist/services/oauth/scopes.d.ts.map +1 -0
- package/dist/services/oauth/scopes.js +10 -0
- package/dist/services/oauth/scopes.js.map +1 -0
- package/dist/services/oauth/types.d.ts +587 -0
- package/dist/services/oauth/types.d.ts.map +1 -0
- package/dist/services/oauth/types.js +160 -0
- package/dist/services/oauth/types.js.map +1 -0
- package/dist/services/oauth/util.d.ts +23 -0
- package/dist/services/oauth/util.d.ts.map +1 -0
- package/dist/services/oauth/util.js +3 -0
- package/dist/services/oauth/util.js.map +1 -0
- package/dist/services/org/api-reference.d.ts +4 -0
- package/dist/services/org/api-reference.d.ts.map +1 -0
- package/dist/services/org/api-reference.js +145 -0
- package/dist/services/org/api-reference.js.map +1 -0
- package/dist/services/org/types.d.ts +8 -0
- package/dist/services/org/types.d.ts.map +1 -0
- package/dist/services/org/types.js +7 -0
- package/dist/services/org/types.js.map +1 -0
- package/dist/services/project/api-reference.d.ts +4 -0
- package/dist/services/project/api-reference.d.ts.map +1 -0
- package/dist/services/project/api-reference.js +618 -0
- package/dist/services/project/api-reference.js.map +1 -0
- package/dist/services/project/types.d.ts +29 -0
- package/dist/services/project/types.d.ts.map +1 -0
- package/dist/services/project/types.js +40 -0
- package/dist/services/project/types.js.map +1 -0
- package/dist/services/queue/api-reference.d.ts +4 -0
- package/dist/services/queue/api-reference.d.ts.map +1 -0
- package/dist/services/queue/api-reference.js +713 -0
- package/dist/services/queue/api-reference.js.map +1 -0
- package/dist/services/queue/types.d.ts +281 -0
- package/dist/services/queue/types.d.ts.map +1 -1
- package/dist/services/queue/types.js +81 -0
- package/dist/services/queue/types.js.map +1 -1
- package/dist/services/region/api-reference.d.ts +4 -0
- package/dist/services/region/api-reference.d.ts.map +1 -0
- package/dist/services/region/api-reference.js +98 -0
- package/dist/services/region/api-reference.js.map +1 -0
- package/dist/services/region/types.d.ts +18 -0
- package/dist/services/region/types.d.ts.map +1 -0
- package/dist/services/region/types.js +18 -0
- package/dist/services/region/types.js.map +1 -0
- package/dist/services/sandbox/api-reference.d.ts +4 -0
- package/dist/services/sandbox/api-reference.d.ts.map +1 -0
- package/dist/services/sandbox/api-reference.js +1006 -0
- package/dist/services/sandbox/api-reference.js.map +1 -0
- package/dist/services/sandbox/run.d.ts +1 -1
- package/dist/services/sandbox/types.d.ts +64 -1
- package/dist/services/sandbox/types.d.ts.map +1 -1
- package/dist/services/sandbox/types.js +87 -0
- package/dist/services/sandbox/types.js.map +1 -1
- package/dist/services/schedule/api-reference.d.ts +4 -0
- package/dist/services/schedule/api-reference.d.ts.map +1 -0
- package/dist/services/schedule/api-reference.js +216 -0
- package/dist/services/schedule/api-reference.js.map +1 -0
- package/dist/services/schedule/types.d.ts +36 -0
- package/dist/services/schedule/types.d.ts.map +1 -0
- package/dist/services/schedule/types.js +20 -0
- package/dist/services/schedule/types.js.map +1 -0
- package/dist/services/session/api-reference.d.ts +4 -0
- package/dist/services/session/api-reference.d.ts.map +1 -0
- package/dist/services/session/api-reference.js +154 -0
- package/dist/services/session/api-reference.js.map +1 -0
- package/dist/services/storage/api-reference.d.ts +4 -0
- package/dist/services/storage/api-reference.d.ts.map +1 -0
- package/dist/services/storage/api-reference.js +196 -0
- package/dist/services/storage/api-reference.js.map +1 -0
- package/dist/services/storage/types.d.ts.map +1 -1
- package/dist/services/storage/types.js +9 -3
- package/dist/services/storage/types.js.map +1 -1
- package/dist/services/stream/api-reference.d.ts +4 -0
- package/dist/services/stream/api-reference.d.ts.map +1 -0
- package/dist/services/stream/api-reference.js +153 -0
- package/dist/services/stream/api-reference.js.map +1 -0
- package/dist/services/stream/types.d.ts +49 -0
- package/dist/services/stream/types.d.ts.map +1 -0
- package/dist/services/stream/types.js +49 -0
- package/dist/services/stream/types.js.map +1 -0
- package/dist/services/task/api-reference.d.ts +4 -0
- package/dist/services/task/api-reference.d.ts.map +1 -0
- package/dist/services/task/api-reference.js +802 -0
- package/dist/services/task/api-reference.js.map +1 -0
- package/dist/services/task/service.d.ts.map +1 -1
- package/dist/services/task/service.js +35 -39
- package/dist/services/task/service.js.map +1 -1
- package/dist/services/task/types.d.ts +48 -0
- package/dist/services/task/types.d.ts.map +1 -0
- package/dist/services/task/types.js +55 -0
- package/dist/services/task/types.js.map +1 -0
- package/dist/services/thread/api-reference.d.ts +4 -0
- package/dist/services/thread/api-reference.d.ts.map +1 -0
- package/dist/services/thread/api-reference.js +89 -0
- package/dist/services/thread/api-reference.js.map +1 -0
- package/dist/services/user/api-reference.d.ts +4 -0
- package/dist/services/user/api-reference.d.ts.map +1 -0
- package/dist/services/user/api-reference.js +27 -0
- package/dist/services/user/api-reference.js.map +1 -0
- package/dist/services/vector/api-reference.d.ts +4 -0
- package/dist/services/vector/api-reference.d.ts.map +1 -0
- package/dist/services/vector/api-reference.js +213 -0
- package/dist/services/vector/api-reference.js.map +1 -0
- package/dist/services/vector/types.d.ts +63 -0
- package/dist/services/vector/types.d.ts.map +1 -0
- package/dist/services/vector/types.js +90 -0
- package/dist/services/vector/types.js.map +1 -0
- package/dist/services/webhook/api-reference.d.ts +4 -0
- package/dist/services/webhook/api-reference.d.ts.map +1 -0
- package/dist/services/webhook/api-reference.js +388 -0
- package/dist/services/webhook/api-reference.js.map +1 -0
- package/package.json +2 -2
- package/src/services/api-reference.ts +198 -0
- package/src/services/apikey/api-reference.ts +99 -0
- package/src/services/db/api-reference.ts +152 -0
- package/src/services/db/types.ts +12 -0
- package/src/services/email/api-reference.ts +349 -0
- package/src/services/email/service.ts +1 -6
- package/src/services/email/types.ts +15 -0
- package/src/services/eval/api-reference.ts +124 -0
- package/src/services/index.ts +2 -0
- package/src/services/keyvalue/api-reference.ts +280 -0
- package/src/services/keyvalue/types.ts +25 -0
- package/src/services/machine/api-reference.ts +158 -0
- package/src/services/machine/types.ts +21 -0
- package/src/services/monitoring/index.ts +2 -0
- package/src/services/monitoring/service.ts +639 -0
- package/src/services/monitoring/types.ts +209 -0
- package/src/services/oauth/activity.ts +41 -0
- package/src/services/oauth/api-reference.ts +380 -0
- package/src/services/oauth/clients.ts +161 -0
- package/src/services/oauth/consent.ts +33 -0
- package/src/services/oauth/index.ts +8 -0
- package/src/services/oauth/keys.ts +13 -0
- package/src/services/oauth/members.ts +13 -0
- package/src/services/oauth/scopes.ts +13 -0
- package/src/services/oauth/types.ts +240 -0
- package/src/services/oauth/util.ts +3 -0
- package/src/services/org/api-reference.ts +148 -0
- package/src/services/org/types.ts +9 -0
- package/src/services/project/api-reference.ts +636 -0
- package/src/services/project/types.ts +47 -0
- package/src/services/queue/api-reference.ts +734 -0
- package/src/services/queue/types.ts +112 -0
- package/src/services/region/api-reference.ts +105 -0
- package/src/services/region/types.ts +27 -0
- package/src/services/sandbox/api-reference.ts +1042 -0
- package/src/services/sandbox/types.ts +100 -0
- package/src/services/schedule/api-reference.ts +228 -0
- package/src/services/schedule/types.ts +26 -0
- package/src/services/session/api-reference.ts +160 -0
- package/src/services/storage/api-reference.ts +207 -0
- package/src/services/storage/types.ts +9 -3
- package/src/services/stream/api-reference.ts +163 -0
- package/src/services/stream/types.ts +64 -0
- package/src/services/task/api-reference.ts +830 -0
- package/src/services/task/service.ts +35 -93
- package/src/services/task/types.ts +73 -0
- package/src/services/thread/api-reference.ts +91 -0
- package/src/services/user/api-reference.ts +31 -0
- package/src/services/vector/api-reference.ts +231 -0
- package/src/services/vector/types.ts +112 -0
- package/src/services/webhook/api-reference.ts +403 -0
|
@@ -0,0 +1,213 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
import { VectorNamespaceStatsWithSamplesSchema, VectorSearchParamsSchema, VectorStatsPaginatedSchema, VectorUpsertBaseSchema, } from "./service.js";
|
|
3
|
+
import { VectorDeleteMultipleRequestSchema, VectorDeleteResponseSchema, VectorGetResponseSchema, VectorNamespaceListResponseSchema, VectorSearchResponseSchema, VectorUpsertResponseSchema, } from "./types.js";
|
|
4
|
+
const service = {
|
|
5
|
+
name: 'Vector Search',
|
|
6
|
+
slug: 'vector',
|
|
7
|
+
description: 'Semantic search with automatic embedding generation',
|
|
8
|
+
endpoints: [
|
|
9
|
+
{
|
|
10
|
+
id: 'upsert-vectors',
|
|
11
|
+
title: 'Upsert Vectors',
|
|
12
|
+
method: 'PUT',
|
|
13
|
+
path: '/vector/{namespace}',
|
|
14
|
+
description: 'Create or update vectors in a namespace. Provide either `document` (auto-embeds) or pre-computed `embeddings` per item.',
|
|
15
|
+
pathParams: [{ name: 'namespace', type: 'string', description: 'The namespace name' }],
|
|
16
|
+
queryParams: [],
|
|
17
|
+
requestBody: {
|
|
18
|
+
description: 'JSON array of vector documents to upsert.',
|
|
19
|
+
fields: { schema: VectorUpsertBaseSchema },
|
|
20
|
+
},
|
|
21
|
+
responseDescription: 'JSON response with inserted/updated vector IDs.',
|
|
22
|
+
responseFields: { schema: VectorUpsertResponseSchema },
|
|
23
|
+
statuses: [
|
|
24
|
+
{ code: 200, description: 'Vectors upserted successfully' },
|
|
25
|
+
{ code: 401, description: 'Unauthorized — invalid or missing API key' },
|
|
26
|
+
{ code: 402, description: 'Payment required — upgrade to a paid plan' },
|
|
27
|
+
],
|
|
28
|
+
examplePath: '/vector/products',
|
|
29
|
+
exampleBody: [
|
|
30
|
+
{
|
|
31
|
+
key: 'chair-001',
|
|
32
|
+
document: 'Comfortable office chair with lumbar support',
|
|
33
|
+
metadata: { category: 'furniture', price: 299 },
|
|
34
|
+
},
|
|
35
|
+
],
|
|
36
|
+
ttlNote: 'TTL behavior:\n- **Omitted**: Vector expires after 30 days (default)\n- **`null` or `0`**: Vector never expires\n- **60–7,776,000**: Expires after specified seconds (values outside range are clamped)',
|
|
37
|
+
},
|
|
38
|
+
{
|
|
39
|
+
id: 'get-vector',
|
|
40
|
+
title: 'Get Vector',
|
|
41
|
+
method: 'GET',
|
|
42
|
+
path: '/vector/{namespace}/{key}',
|
|
43
|
+
description: 'Fetch a vector by namespace and key.',
|
|
44
|
+
pathParams: [
|
|
45
|
+
{ name: 'namespace', type: 'string', description: 'The namespace name' },
|
|
46
|
+
{ name: 'key', type: 'string', description: 'The vector key' },
|
|
47
|
+
],
|
|
48
|
+
queryParams: [],
|
|
49
|
+
requestBody: null,
|
|
50
|
+
responseDescription: 'JSON response with vector data, metadata, similarity, and expiration fields.',
|
|
51
|
+
responseFields: { schema: VectorGetResponseSchema },
|
|
52
|
+
statuses: [
|
|
53
|
+
{ code: 200, description: 'Vector found and returned' },
|
|
54
|
+
{ code: 401, description: 'Unauthorized' },
|
|
55
|
+
{ code: 404, description: 'Vector not found' },
|
|
56
|
+
],
|
|
57
|
+
examplePath: '/vector/products/chair-001',
|
|
58
|
+
},
|
|
59
|
+
{
|
|
60
|
+
id: 'search-vectors',
|
|
61
|
+
title: 'Search Vectors',
|
|
62
|
+
method: 'POST',
|
|
63
|
+
path: '/vector/search/{namespace}',
|
|
64
|
+
description: 'Run semantic similarity search in a namespace.',
|
|
65
|
+
pathParams: [
|
|
66
|
+
{ name: 'namespace', type: 'string', description: 'The namespace to search' },
|
|
67
|
+
],
|
|
68
|
+
queryParams: [],
|
|
69
|
+
requestBody: {
|
|
70
|
+
description: 'Search criteria and filters.',
|
|
71
|
+
fields: {
|
|
72
|
+
schema: VectorSearchParamsSchema(z.record(z.string(), z.unknown())),
|
|
73
|
+
},
|
|
74
|
+
},
|
|
75
|
+
responseDescription: 'JSON response containing matching vectors and similarity scores.',
|
|
76
|
+
responseFields: { schema: VectorSearchResponseSchema },
|
|
77
|
+
statuses: [
|
|
78
|
+
{ code: 200, description: 'Search results returned' },
|
|
79
|
+
{ code: 401, description: 'Unauthorized' },
|
|
80
|
+
{ code: 404, description: 'Namespace not found (returns empty array)' },
|
|
81
|
+
],
|
|
82
|
+
examplePath: '/vector/search/products',
|
|
83
|
+
exampleBody: { query: 'comfortable seating for office', limit: 5, similarity: 0.7 },
|
|
84
|
+
},
|
|
85
|
+
{
|
|
86
|
+
id: 'delete-vector',
|
|
87
|
+
title: 'Delete Vector',
|
|
88
|
+
method: 'DELETE',
|
|
89
|
+
path: '/vector/{namespace}/{key}',
|
|
90
|
+
description: 'Delete a single vector by key.',
|
|
91
|
+
pathParams: [
|
|
92
|
+
{ name: 'namespace', type: 'string', description: 'The namespace name' },
|
|
93
|
+
{ name: 'key', type: 'string', description: 'The vector key to delete' },
|
|
94
|
+
],
|
|
95
|
+
queryParams: [],
|
|
96
|
+
requestBody: null,
|
|
97
|
+
responseDescription: 'JSON response with deleted row count.',
|
|
98
|
+
responseFields: { schema: VectorDeleteResponseSchema },
|
|
99
|
+
statuses: [
|
|
100
|
+
{ code: 200, description: 'Delete operation completed' },
|
|
101
|
+
{ code: 401, description: 'Unauthorized' },
|
|
102
|
+
{ code: 404, description: 'Vector not found (returns 0)' },
|
|
103
|
+
],
|
|
104
|
+
examplePath: '/vector/products/chair-001',
|
|
105
|
+
},
|
|
106
|
+
{
|
|
107
|
+
id: 'delete-multiple-vectors',
|
|
108
|
+
title: 'Delete Multiple Vectors',
|
|
109
|
+
method: 'DELETE',
|
|
110
|
+
path: '/vector/{namespace}',
|
|
111
|
+
description: 'Delete multiple vectors by key. If no body is provided, deletes the entire namespace.',
|
|
112
|
+
pathParams: [{ name: 'namespace', type: 'string', description: 'The namespace name' }],
|
|
113
|
+
queryParams: [],
|
|
114
|
+
requestBody: {
|
|
115
|
+
description: 'Optional JSON body specifying keys to delete.',
|
|
116
|
+
fields: { schema: VectorDeleteMultipleRequestSchema, stripRequired: true },
|
|
117
|
+
},
|
|
118
|
+
responseDescription: 'JSON response with number of deleted vectors.',
|
|
119
|
+
responseFields: { schema: VectorDeleteResponseSchema },
|
|
120
|
+
statuses: [
|
|
121
|
+
{ code: 200, description: 'Delete operation completed' },
|
|
122
|
+
{ code: 401, description: 'Unauthorized' },
|
|
123
|
+
],
|
|
124
|
+
examplePath: '/vector/products',
|
|
125
|
+
exampleBody: { keys: ['chair-001', 'desk-001'] },
|
|
126
|
+
},
|
|
127
|
+
{
|
|
128
|
+
id: 'get-vector-namespace-stats',
|
|
129
|
+
title: 'Get Namespace Stats',
|
|
130
|
+
method: 'GET',
|
|
131
|
+
path: '/vector/stats/{namespace}',
|
|
132
|
+
description: 'Get aggregate stats for a namespace.',
|
|
133
|
+
pathParams: [{ name: 'namespace', type: 'string', description: 'The namespace name' }],
|
|
134
|
+
queryParams: [],
|
|
135
|
+
requestBody: null,
|
|
136
|
+
responseDescription: 'JSON object with namespace size and usage statistics.',
|
|
137
|
+
responseFields: { schema: VectorNamespaceStatsWithSamplesSchema, omit: ['internal'] },
|
|
138
|
+
statuses: [
|
|
139
|
+
{ code: 200, description: 'Stats returned' },
|
|
140
|
+
{ code: 401, description: 'Unauthorized' },
|
|
141
|
+
{ code: 404, description: 'Namespace not found (returns zeros)' },
|
|
142
|
+
],
|
|
143
|
+
examplePath: '/vector/stats/products',
|
|
144
|
+
},
|
|
145
|
+
{
|
|
146
|
+
id: 'list-all-vector-namespace-stats',
|
|
147
|
+
title: 'List All Namespace Stats',
|
|
148
|
+
method: 'GET',
|
|
149
|
+
path: '/vector/stats',
|
|
150
|
+
description: 'List namespace stats with pagination, filtering, and sorting.',
|
|
151
|
+
pathParams: [],
|
|
152
|
+
queryParams: [
|
|
153
|
+
{
|
|
154
|
+
name: 'limit',
|
|
155
|
+
type: 'number',
|
|
156
|
+
description: 'Maximum namespaces to return (default: 100, max: 1000)',
|
|
157
|
+
required: false,
|
|
158
|
+
},
|
|
159
|
+
{
|
|
160
|
+
name: 'offset',
|
|
161
|
+
type: 'number',
|
|
162
|
+
description: 'Offset for pagination',
|
|
163
|
+
required: false,
|
|
164
|
+
},
|
|
165
|
+
{
|
|
166
|
+
name: 'sort',
|
|
167
|
+
type: 'string',
|
|
168
|
+
description: 'Sort by `name`, `size`, `records`, `created`, or `lastUsed`',
|
|
169
|
+
required: false,
|
|
170
|
+
},
|
|
171
|
+
{
|
|
172
|
+
name: 'direction',
|
|
173
|
+
type: 'string',
|
|
174
|
+
description: 'Sort direction: `asc` or `desc`',
|
|
175
|
+
required: false,
|
|
176
|
+
},
|
|
177
|
+
{
|
|
178
|
+
name: 'name',
|
|
179
|
+
type: 'string',
|
|
180
|
+
description: 'Filter namespaces by name',
|
|
181
|
+
required: false,
|
|
182
|
+
},
|
|
183
|
+
],
|
|
184
|
+
requestBody: null,
|
|
185
|
+
responseDescription: 'Paginated namespace stats response.',
|
|
186
|
+
responseFields: { schema: VectorStatsPaginatedSchema },
|
|
187
|
+
statuses: [
|
|
188
|
+
{ code: 200, description: 'Stats returned' },
|
|
189
|
+
{ code: 401, description: 'Unauthorized' },
|
|
190
|
+
],
|
|
191
|
+
examplePath: '/vector/stats?limit=10&sort=size&direction=desc',
|
|
192
|
+
},
|
|
193
|
+
{
|
|
194
|
+
id: 'list-vector-namespaces',
|
|
195
|
+
title: 'List Namespaces',
|
|
196
|
+
method: 'GET',
|
|
197
|
+
path: '/vector/namespaces',
|
|
198
|
+
description: 'List namespace names (up to 1000).',
|
|
199
|
+
pathParams: [],
|
|
200
|
+
queryParams: [],
|
|
201
|
+
requestBody: null,
|
|
202
|
+
responseDescription: 'JSON array of namespace names.',
|
|
203
|
+
responseFields: { schema: VectorNamespaceListResponseSchema, stripRequired: true },
|
|
204
|
+
statuses: [
|
|
205
|
+
{ code: 200, description: 'Namespace list returned' },
|
|
206
|
+
{ code: 401, description: 'Unauthorized' },
|
|
207
|
+
],
|
|
208
|
+
examplePath: '/vector/namespaces',
|
|
209
|
+
},
|
|
210
|
+
],
|
|
211
|
+
};
|
|
212
|
+
export default service;
|
|
213
|
+
//# sourceMappingURL=api-reference.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.js","sourceRoot":"","sources":["../../../src/services/vector/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AACxB,OAAO,EACN,qCAAqC,EACrC,wBAAwB,EACxB,0BAA0B,EAC1B,sBAAsB,GACtB,MAAM,cAAc,CAAC;AACtB,OAAO,EACN,iCAAiC,EACjC,0BAA0B,EAC1B,uBAAuB,EACvB,iCAAiC,EACjC,0BAA0B,EAC1B,0BAA0B,GAC1B,MAAM,YAAY,CAAC;AAGpB,MAAM,OAAO,GAAY;IACxB,IAAI,EAAE,eAAe;IACrB,IAAI,EAAE,QAAQ;IACd,WAAW,EAAE,qDAAqD;IAClE,SAAS,EAAE;QACV;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,qBAAqB;YAC3B,WAAW,EACV,yHAAyH;YAC1H,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;YACtF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,2CAA2C;gBACxD,MAAM,EAAE,EAAE,MAAM,EAAE,sBAAsB,EAAE;aAC1C;YACD,mBAAmB,EAAE,iDAAiD;YACtE,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,+BAA+B,EAAE;gBAC3D,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;gBACvE,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;aACvE;YACD,WAAW,EAAE,kBAAkB;YAC/B,WAAW,EAAE;gBACZ;oBACC,GAAG,EAAE,WAAW;oBAChB,QAAQ,EAAE,8CAA8C;oBACxD,QAAQ,EAAE,EAAE,QAAQ,EAAE,WAAW,EAAE,KAAK,EAAE,GAAG,EAAE;iBAC/C;aACD;YACD,OAAO,EACN,yMAAyM;SAC1M;QACD;YACC,EAAE,EAAE,YAAY;YAChB,KAAK,EAAE,YAAY;YACnB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,WAAW,EAAE,sCAAsC;YACnD,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBACxE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,gBAAgB,EAAE;aAC9D;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAClB,8EAA8E;YAC/E,cAAc,EAAE,EAAE,MAAM,EAAE,uBAAuB,EAAE;YACnD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2BAA2B,EAAE;gBACvD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,kBAAkB,EAAE;aAC9C;YACD,WAAW,EAAE,4BAA4B;SACzC;QACD;YACC,EAAE,EAAE,gBAAgB;YACpB,KAAK,EAAE,gBAAgB;YACvB,MAAM,EAAE,MAAM;YACd,IAAI,EAAE,4BAA4B;YAClC,WAAW,EAAE,gDAAgD;YAC7D,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,yBAAyB,EAAE;aAC7E;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,8BAA8B;gBAC3C,MAAM,EAAE;oBACP,MAAM,EAAE,wBAAwB,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;iBACnE;aACD;YACD,mBAAmB,EAAE,kEAAkE;YACvF,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE;gBACrD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,2CAA2C,EAAE;aACvE;YACD,WAAW,EAAE,yBAAyB;YACtC,WAAW,EAAE,EAAE,KAAK,EAAE,gCAAgC,EAAE,KAAK,EAAE,CAAC,EAAE,UAAU,EAAE,GAAG,EAAE;SACnF;QACD;YACC,EAAE,EAAE,eAAe;YACnB,KAAK,EAAE,eAAe;YACtB,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,2BAA2B;YACjC,WAAW,EAAE,gCAAgC;YAC7C,UAAU,EAAE;gBACX,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE;gBACxE,EAAE,IAAI,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,0BAA0B,EAAE;aACxE;YACD,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,uCAAuC;YAC5D,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,4BAA4B,EAAE;gBACxD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,8BAA8B,EAAE;aAC1D;YACD,WAAW,EAAE,4BAA4B;SACzC;QACD;YACC,EAAE,EAAE,yBAAyB;YAC7B,KAAK,EAAE,yBAAyB;YAChC,MAAM,EAAE,QAAQ;YAChB,IAAI,EAAE,qBAAqB;YAC3B,WAAW,EACV,uFAAuF;YACxF,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;YACtF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE;gBACZ,WAAW,EAAE,+CAA+C;gBAC5D,MAAM,EAAE,EAAE,MAAM,EAAE,iCAAiC,EAAE,aAAa,EAAE,IAAI,EAAE;aAC1E;YACD,mBAAmB,EAAE,+CAA+C;YACpE,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,4BAA4B,EAAE;gBACxD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,kBAAkB;YAC/B,WAAW,EAAE,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,UAAU,CAAC,EAAE;SAChD;QACD;YACC,EAAE,EAAE,4BAA4B;YAChC,KAAK,EAAE,qBAAqB;YAC5B,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,2BAA2B;YACjC,WAAW,EAAE,sCAAsC;YACnD,UAAU,EAAE,CAAC,EAAE,IAAI,EAAE,WAAW,EAAE,IAAI,EAAE,QAAQ,EAAE,WAAW,EAAE,oBAAoB,EAAE,CAAC;YACtF,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,uDAAuD;YAC5E,cAAc,EAAE,EAAE,MAAM,EAAE,qCAAqC,EAAE,IAAI,EAAE,CAAC,UAAU,CAAC,EAAE;YACrF,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;gBAC5C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;gBAC1C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,qCAAqC,EAAE;aACjE;YACD,WAAW,EAAE,wBAAwB;SACrC;QACD;YACC,EAAE,EAAE,iCAAiC;YACrC,KAAK,EAAE,0BAA0B;YACjC,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,eAAe;YACrB,WAAW,EAAE,+DAA+D;YAC5E,UAAU,EAAE,EAAE;YACd,WAAW,EAAE;gBACZ;oBACC,IAAI,EAAE,OAAO;oBACb,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,wDAAwD;oBACrE,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,QAAQ;oBACd,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,uBAAuB;oBACpC,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,6DAA6D;oBAC1E,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,WAAW;oBACjB,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,iCAAiC;oBAC9C,QAAQ,EAAE,KAAK;iBACf;gBACD;oBACC,IAAI,EAAE,MAAM;oBACZ,IAAI,EAAE,QAAQ;oBACd,WAAW,EAAE,2BAA2B;oBACxC,QAAQ,EAAE,KAAK;iBACf;aACD;YACD,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,qCAAqC;YAC1D,cAAc,EAAE,EAAE,MAAM,EAAE,0BAA0B,EAAE;YACtD,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,gBAAgB,EAAE;gBAC5C,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,iDAAiD;SAC9D;QACD;YACC,EAAE,EAAE,wBAAwB;YAC5B,KAAK,EAAE,iBAAiB;YACxB,MAAM,EAAE,KAAK;YACb,IAAI,EAAE,oBAAoB;YAC1B,WAAW,EAAE,oCAAoC;YACjD,UAAU,EAAE,EAAE;YACd,WAAW,EAAE,EAAE;YACf,WAAW,EAAE,IAAI;YACjB,mBAAmB,EAAE,gCAAgC;YACrD,cAAc,EAAE,EAAE,MAAM,EAAE,iCAAiC,EAAE,aAAa,EAAE,IAAI,EAAE;YAClF,QAAQ,EAAE;gBACT,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,yBAAyB,EAAE;gBACrD,EAAE,IAAI,EAAE,GAAG,EAAE,WAAW,EAAE,cAAc,EAAE;aAC1C;YACD,WAAW,EAAE,oBAAoB;SACjC;KACD;CACD,CAAC;AAEF,eAAe,OAAO,CAAC"}
|
|
@@ -0,0 +1,63 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
/**
|
|
3
|
+
* Response schema for the upsert-vectors endpoint.
|
|
4
|
+
*/
|
|
5
|
+
export declare const VectorUpsertResponseSchema: z.ZodObject<{
|
|
6
|
+
success: z.ZodBoolean;
|
|
7
|
+
data: z.ZodArray<z.ZodObject<{
|
|
8
|
+
id: z.ZodString;
|
|
9
|
+
}, z.core.$strip>>;
|
|
10
|
+
}, z.core.$strip>;
|
|
11
|
+
export type VectorUpsertResponse = z.infer<typeof VectorUpsertResponseSchema>;
|
|
12
|
+
/**
|
|
13
|
+
* Response schema for the get-vector endpoint.
|
|
14
|
+
*/
|
|
15
|
+
export declare const VectorGetResponseSchema: z.ZodObject<{
|
|
16
|
+
success: z.ZodBoolean;
|
|
17
|
+
data: z.ZodObject<{
|
|
18
|
+
id: z.ZodString;
|
|
19
|
+
key: z.ZodString;
|
|
20
|
+
document: z.ZodOptional<z.ZodString>;
|
|
21
|
+
embeddings: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
22
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
23
|
+
similarity: z.ZodNumber;
|
|
24
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
25
|
+
}, z.core.$strip>;
|
|
26
|
+
}, z.core.$strip>;
|
|
27
|
+
export type VectorGetResponse = z.infer<typeof VectorGetResponseSchema>;
|
|
28
|
+
/**
|
|
29
|
+
* Response schema for the search-vectors endpoint.
|
|
30
|
+
*/
|
|
31
|
+
export declare const VectorSearchResponseSchema: z.ZodObject<{
|
|
32
|
+
success: z.ZodBoolean;
|
|
33
|
+
data: z.ZodArray<z.ZodObject<{
|
|
34
|
+
id: z.ZodString;
|
|
35
|
+
key: z.ZodString;
|
|
36
|
+
metadata: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
|
|
37
|
+
similarity: z.ZodNumber;
|
|
38
|
+
expiresAt: z.ZodOptional<z.ZodNullable<z.ZodString>>;
|
|
39
|
+
}, z.core.$strip>>;
|
|
40
|
+
}, z.core.$strip>;
|
|
41
|
+
export type VectorSearchResponse = z.infer<typeof VectorSearchResponseSchema>;
|
|
42
|
+
/**
|
|
43
|
+
* Response schema for the delete-vector and delete-multiple-vectors endpoints.
|
|
44
|
+
*/
|
|
45
|
+
export declare const VectorDeleteResponseSchema: z.ZodObject<{
|
|
46
|
+
success: z.ZodBoolean;
|
|
47
|
+
data: z.ZodNumber;
|
|
48
|
+
}, z.core.$strip>;
|
|
49
|
+
export type VectorDeleteResponse = z.infer<typeof VectorDeleteResponseSchema>;
|
|
50
|
+
/**
|
|
51
|
+
* Request body schema for the delete-multiple-vectors endpoint.
|
|
52
|
+
*/
|
|
53
|
+
export declare const VectorDeleteMultipleRequestSchema: z.ZodObject<{
|
|
54
|
+
keys: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
55
|
+
}, z.core.$strip>;
|
|
56
|
+
export type VectorDeleteMultipleRequest = z.infer<typeof VectorDeleteMultipleRequestSchema>;
|
|
57
|
+
/**
|
|
58
|
+
* Response schema for the list-vector-namespaces endpoint.
|
|
59
|
+
* The endpoint returns a JSON array of namespace name strings (up to 1000).
|
|
60
|
+
*/
|
|
61
|
+
export declare const VectorNamespaceListResponseSchema: z.ZodArray<z.ZodString>;
|
|
62
|
+
export type VectorNamespaceListResponse = z.infer<typeof VectorNamespaceListResponseSchema>;
|
|
63
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/services/vector/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAMxB;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;iBAYrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;;;;;iBAsBlC,CAAC;AAEH,MAAM,MAAM,iBAAiB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAC;AAExE;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;;;;;;;iBAoBrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,0BAA0B;;;iBAKrC,CAAC;AAEH,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,0BAA0B,CAAC,CAAC;AAE9E;;GAEG;AACH,eAAO,MAAM,iCAAiC;;iBAG5C,CAAC;AAEH,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC;AAE5F;;;GAGG;AACH,eAAO,MAAM,iCAAiC,yBAEK,CAAC;AAEpD,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iCAAiC,CAAC,CAAC"}
|
|
@@ -0,0 +1,90 @@
|
|
|
1
|
+
import { z } from 'zod';
|
|
2
|
+
// ============================================================================
|
|
3
|
+
// API Response Schemas for Vector Service
|
|
4
|
+
// ============================================================================
|
|
5
|
+
/**
|
|
6
|
+
* Response schema for the upsert-vectors endpoint.
|
|
7
|
+
*/
|
|
8
|
+
export const VectorUpsertResponseSchema = z.object({
|
|
9
|
+
/** Whether the request succeeded */
|
|
10
|
+
success: z.boolean().describe('Whether the request succeeded'),
|
|
11
|
+
/** Array of upserted vector results */
|
|
12
|
+
data: z
|
|
13
|
+
.array(z.object({
|
|
14
|
+
/** Stored vector ID */
|
|
15
|
+
id: z.string().describe('Stored vector ID'),
|
|
16
|
+
}))
|
|
17
|
+
.describe('Array of upserted vector results'),
|
|
18
|
+
});
|
|
19
|
+
/**
|
|
20
|
+
* Response schema for the get-vector endpoint.
|
|
21
|
+
*/
|
|
22
|
+
export const VectorGetResponseSchema = z.object({
|
|
23
|
+
/** Whether the request succeeded */
|
|
24
|
+
success: z.boolean().describe('Whether the request succeeded'),
|
|
25
|
+
/** The vector data object */
|
|
26
|
+
data: z
|
|
27
|
+
.object({
|
|
28
|
+
/** Internal vector ID */
|
|
29
|
+
id: z.string().describe('Internal vector ID'),
|
|
30
|
+
/** Vector key */
|
|
31
|
+
key: z.string().describe('Vector key'),
|
|
32
|
+
/** Original source document text */
|
|
33
|
+
document: z.string().optional().describe('Original source document text'),
|
|
34
|
+
/** Stored embeddings array */
|
|
35
|
+
embeddings: z.array(z.number()).optional().describe('Stored embeddings array'),
|
|
36
|
+
/** Stored metadata */
|
|
37
|
+
metadata: z.record(z.string(), z.unknown()).optional().describe('Stored metadata'),
|
|
38
|
+
/** Similarity score when relevant */
|
|
39
|
+
similarity: z.number().describe('Similarity score when relevant'),
|
|
40
|
+
/** ISO 8601 expiration timestamp */
|
|
41
|
+
expiresAt: z.string().nullable().optional().describe('ISO 8601 expiration timestamp'),
|
|
42
|
+
})
|
|
43
|
+
.describe('The vector data object'),
|
|
44
|
+
});
|
|
45
|
+
/**
|
|
46
|
+
* Response schema for the search-vectors endpoint.
|
|
47
|
+
*/
|
|
48
|
+
export const VectorSearchResponseSchema = z.object({
|
|
49
|
+
/** Whether the request succeeded */
|
|
50
|
+
success: z.boolean().describe('Whether the request succeeded'),
|
|
51
|
+
/** Array of matching vector results */
|
|
52
|
+
data: z
|
|
53
|
+
.array(z.object({
|
|
54
|
+
/** Vector ID */
|
|
55
|
+
id: z.string().describe('Vector ID'),
|
|
56
|
+
/** Vector key */
|
|
57
|
+
key: z.string().describe('Vector key'),
|
|
58
|
+
/** Vector metadata */
|
|
59
|
+
metadata: z.record(z.string(), z.unknown()).optional().describe('Vector metadata'),
|
|
60
|
+
/** Similarity score (0–1) */
|
|
61
|
+
similarity: z.number().describe('Similarity score (0–1)'),
|
|
62
|
+
/** ISO 8601 expiration timestamp */
|
|
63
|
+
expiresAt: z.string().nullable().optional().describe('ISO 8601 expiration timestamp'),
|
|
64
|
+
}))
|
|
65
|
+
.describe('Array of matching vector results'),
|
|
66
|
+
});
|
|
67
|
+
/**
|
|
68
|
+
* Response schema for the delete-vector and delete-multiple-vectors endpoints.
|
|
69
|
+
*/
|
|
70
|
+
export const VectorDeleteResponseSchema = z.object({
|
|
71
|
+
/** Whether the request succeeded */
|
|
72
|
+
success: z.boolean().describe('Whether the request succeeded'),
|
|
73
|
+
/** Number of deleted vectors */
|
|
74
|
+
data: z.number().describe('Number of deleted vectors'),
|
|
75
|
+
});
|
|
76
|
+
/**
|
|
77
|
+
* Request body schema for the delete-multiple-vectors endpoint.
|
|
78
|
+
*/
|
|
79
|
+
export const VectorDeleteMultipleRequestSchema = z.object({
|
|
80
|
+
/** Vector keys to delete */
|
|
81
|
+
keys: z.array(z.string()).optional().describe('Vector keys to delete'),
|
|
82
|
+
});
|
|
83
|
+
/**
|
|
84
|
+
* Response schema for the list-vector-namespaces endpoint.
|
|
85
|
+
* The endpoint returns a JSON array of namespace name strings (up to 1000).
|
|
86
|
+
*/
|
|
87
|
+
export const VectorNamespaceListResponseSchema = z
|
|
88
|
+
.array(z.string().describe('Namespace name'))
|
|
89
|
+
.describe('Array of namespace names (up to 1000)');
|
|
90
|
+
//# sourceMappingURL=types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/services/vector/types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,+EAA+E;AAC/E,0CAA0C;AAC1C,+EAA+E;AAE/E;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC9D,uCAAuC;IACvC,IAAI,EAAE,CAAC;SACL,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACR,uBAAuB;QACvB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,kBAAkB,CAAC;KAC3C,CAAC,CACF;SACA,QAAQ,CAAC,kCAAkC,CAAC;CAC9C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,uBAAuB,GAAG,CAAC,CAAC,MAAM,CAAC;IAC/C,oCAAoC;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC9D,6BAA6B;IAC7B,IAAI,EAAE,CAAC;SACL,MAAM,CAAC;QACP,yBAAyB;QACzB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,oBAAoB,CAAC;QAC7C,iBAAiB;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;QACtC,oCAAoC;QACpC,QAAQ,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;QACzE,8BAA8B;QAC9B,UAAU,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,yBAAyB,CAAC;QAC9E,sBAAsB;QACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAClF,qCAAqC;QACrC,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gCAAgC,CAAC;QACjE,oCAAoC;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;KACrF,CAAC;SACD,QAAQ,CAAC,wBAAwB,CAAC;CACpC,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC9D,uCAAuC;IACvC,IAAI,EAAE,CAAC;SACL,KAAK,CACL,CAAC,CAAC,MAAM,CAAC;QACR,gBAAgB;QAChB,EAAE,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,WAAW,CAAC;QACpC,iBAAiB;QACjB,GAAG,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,YAAY,CAAC;QACtC,sBAAsB;QACtB,QAAQ,EAAE,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,iBAAiB,CAAC;QAClF,6BAA6B;QAC7B,UAAU,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,wBAAwB,CAAC;QACzD,oCAAoC;QACpC,SAAS,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;KACrF,CAAC,CACF;SACA,QAAQ,CAAC,kCAAkC,CAAC;CAC9C,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,0BAA0B,GAAG,CAAC,CAAC,MAAM,CAAC;IAClD,oCAAoC;IACpC,OAAO,EAAE,CAAC,CAAC,OAAO,EAAE,CAAC,QAAQ,CAAC,+BAA+B,CAAC;IAC9D,gCAAgC;IAChC,IAAI,EAAE,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,2BAA2B,CAAC;CACtD,CAAC,CAAC;AAIH;;GAEG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC,CAAC,MAAM,CAAC;IACzD,4BAA4B;IAC5B,IAAI,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,CAAC,QAAQ,EAAE,CAAC,QAAQ,CAAC,uBAAuB,CAAC;CACtE,CAAC,CAAC;AAIH;;;GAGG;AACH,MAAM,CAAC,MAAM,iCAAiC,GAAG,CAAC;KAChD,KAAK,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,QAAQ,CAAC,gBAAgB,CAAC,CAAC;KAC5C,QAAQ,CAAC,uCAAuC,CAAC,CAAC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"api-reference.d.ts","sourceRoot":"","sources":["../../../src/services/webhook/api-reference.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AAUnD,QAAA,MAAM,OAAO,EAAE,OAsYd,CAAC;AAEF,eAAe,OAAO,CAAC"}
|