@liquidmetal-ai/drizzle 0.3.5 → 0.4.1

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.
@@ -1,41 +1,42 @@
1
1
  import type { GenFile, GenMessage, GenService } from "@bufbuild/protobuf/codegenv1";
2
+ import type { BucketLocator, BucketResponse } from "./bucket_name_pb.js";
2
3
  import type { Message } from "@bufbuild/protobuf";
3
4
  /**
4
5
  * Describes the file liquidmetal/v1alpha1/search_agent.proto.
5
6
  */
6
7
  export declare const file_liquidmetal_v1alpha1_search_agent: GenFile;
7
8
  /**
8
- * DocumentChatRequest initiates or continues a conversation about a specific document.
9
- * The system maintains conversation context for natural, flowing dialogue about
10
- * document content.
11
- *
12
9
  * @generated from message liquidmetal.v1alpha1.DocumentChatRequest
13
10
  */
14
11
  export type DocumentChatRequest = Message<"liquidmetal.v1alpha1.DocumentChatRequest"> & {
15
12
  /**
16
- * The storage bucket containing the target document
17
- * Must be a valid, registered Smart Bucket
13
+ * __DESCRIPTION__ The storage bucket containing the target document. Must be a valid, registered Smart Bucket. Used to identify which bucket to query against
14
+ * __EXAMPLE__ {"bucket": {"name": "my-bucket", "version": "01jtgtraw3b5qbahrhvrj3ygbb", "applicationName": "my-app"}}
15
+ * __REQUIRED__ TRUE
18
16
  *
19
- * @generated from field: string bucket_id = 1;
17
+ * @generated from field: liquidmetal.v1alpha1.BucketLocator bucket_location = 1;
20
18
  */
21
- bucketId: string;
19
+ bucketLocation?: BucketLocator;
22
20
  /**
23
- * Document identifier within the bucket
24
- * Typically matches the storage path or key
21
+ * __DESCRIPTION__ Document identifier within the bucket. Typically matches the storage path or key. Used to identify which document to chat with
22
+ * __EXAMPLE__ "document.pdf"
23
+ * __REQUIRED__ TRUE
25
24
  *
26
25
  * @generated from field: string object_id = 2;
27
26
  */
28
27
  objectId: string;
29
28
  /**
30
- * User's input or question about the document
31
- * Can be natural language questions, commands, or requests
29
+ * __DESCRIPTION__ User's input or question about the document. Can be natural language questions, commands, or requests. The system will process this against the document content
30
+ * __EXAMPLE__ "What are the key points in this document?"
31
+ * __REQUIRED__ TRUE
32
32
  *
33
33
  * @generated from field: string input = 3;
34
34
  */
35
35
  input: string;
36
36
  /**
37
- * Conversation session identifier
38
- * Use the same ID for follow-up questions to maintain context
37
+ * __DESCRIPTION__ Client-provided conversation session identifier. Required for maintaining context in follow-up questions. We recommend using a UUID or ULID for this value
38
+ * __EXAMPLE__ "123e4567-e89b-12d3-a456-426614174000"
39
+ * __REQUIRED__ TRUE
39
40
  *
40
41
  * @generated from field: string request_id = 4;
41
42
  */
@@ -55,20 +56,12 @@ export type DocumentChatRequest = Message<"liquidmetal.v1alpha1.DocumentChatRequ
55
56
  */
56
57
  export declare const DocumentChatRequestSchema: GenMessage<DocumentChatRequest>;
57
58
  /**
58
- * DocumentChatResponse contains the AI's response based on document content
59
- * and conversation context. Responses are generated considering both the
60
- * current question and previous conversation history.
61
- *
62
59
  * @generated from message liquidmetal.v1alpha1.DocumentChatResponse
63
60
  */
64
61
  export type DocumentChatResponse = Message<"liquidmetal.v1alpha1.DocumentChatResponse"> & {
65
62
  /**
66
- * AI-generated response that may include:
67
- * - Direct document quotes
68
- * - Content summaries
69
- * - Contextual explanations
70
- * - References to specific sections
71
- * - Related content suggestions
63
+ * __DESCRIPTION__ AI-generated response that may include direct document quotes, content summaries, contextual explanations, references to specific sections, and related content suggestions
64
+ * __EXAMPLE__ "Based on the document, the key points are..."
72
65
  *
73
66
  * @generated from field: string answer = 1;
74
67
  */
@@ -80,34 +73,33 @@ export type DocumentChatResponse = Message<"liquidmetal.v1alpha1.DocumentChatRes
80
73
  */
81
74
  export declare const DocumentChatResponseSchema: GenMessage<DocumentChatResponse>;
82
75
  /**
83
- * RagSearchRequest enables semantic search across document collections using
84
- * natural language queries. The system automatically optimizes the search
85
- * strategy based on the query content.
86
- *
87
76
  * @generated from message liquidmetal.v1alpha1.RagSearchRequest
88
77
  */
89
78
  export type RagSearchRequest = Message<"liquidmetal.v1alpha1.RagSearchRequest"> & {
90
79
  /**
91
- * Natural language query or question
92
- * Can include complex criteria and relationships
80
+ * __DESCRIPTION__ Natural language query or question. Can include complex criteria and relationships. The system will optimize the search strategy based on this input
81
+ * __EXAMPLE__ "Find documents about revenue in Q4 2023"
82
+ * __REQUIRED__ TRUE
93
83
  *
94
84
  * @generated from field: string input = 1;
95
85
  */
96
86
  input: string;
97
87
  /**
98
- * Search session identifier for result tracking
99
- * Used for pagination and result caching
88
+ * __DESCRIPTION__ Client-provided search session identifier. Required for pagination and result tracking. We recommend using a UUID or ULID for this value
89
+ * __EXAMPLE__ "123e4567-e89b-12d3-a456-426614174000"
90
+ * __REQUIRED__ TRUE
100
91
  *
101
92
  * @generated from field: string request_id = 2;
102
93
  */
103
94
  requestId: string;
104
95
  /**
105
- * Bucket IDs to search
106
- * If provided, the search will only return results from these buckets
96
+ * __DESCRIPTION__ The buckets to search. If provided, the search will only return results from these buckets
97
+ * __EXAMPLE__ [{"bucket": {"name": "my-bucket", "version": "01jtgtraw3b5qbahrhvrj3ygbb", "applicationName": "my-app"}}]
98
+ * __REQUIRED__ TRUE
107
99
  *
108
- * @generated from field: repeated string bucket_ids = 3;
100
+ * @generated from field: repeated liquidmetal.v1alpha1.BucketLocator bucket_locations = 3;
109
101
  */
110
- bucketIds: string[];
102
+ bucketLocations: BucketLocator[];
111
103
  /**
112
104
  * @generated from field: string user_id = 4;
113
105
  */
@@ -123,16 +115,12 @@ export type RagSearchRequest = Message<"liquidmetal.v1alpha1.RagSearchRequest">
123
115
  */
124
116
  export declare const RagSearchRequestSchema: GenMessage<RagSearchRequest>;
125
117
  /**
126
- * RagSearchResponse provides semantically relevant results with metadata
127
- * and relevance scoring. Results are automatically filtered for PII
128
- * and ranked by relevance.
129
- *
130
118
  * @generated from message liquidmetal.v1alpha1.RagSearchResponse
131
119
  */
132
120
  export type RagSearchResponse = Message<"liquidmetal.v1alpha1.RagSearchResponse"> & {
133
121
  /**
134
- * Ordered list of relevant text segments
135
- * Each result includes full context and metadata
122
+ * __DESCRIPTION__ Ordered list of relevant text segments. Each result includes full context and metadata
123
+ * __EXAMPLE__ [{"chunkSignature": "chunk_123abc", "text": "Sample text", "score": 0.95}]
136
124
  *
137
125
  * @generated from field: repeated liquidmetal.v1alpha1.TextResult results = 1;
138
126
  */
@@ -148,13 +136,15 @@ export declare const RagSearchResponseSchema: GenMessage<RagSearchResponse>;
148
136
  */
149
137
  export type SourceResult = Message<"liquidmetal.v1alpha1.SourceResult"> & {
150
138
  /**
151
- * The bucket identifier containing this result
139
+ * __DESCRIPTION__ The bucket information containing this result
140
+ * __EXAMPLE__ {"moduleId": "01jt3vs2nyt2xwk2f54x2bkn84", "bucketName": "mr-bucket"}
152
141
  *
153
- * @generated from field: string bucket = 1;
142
+ * @generated from field: liquidmetal.v1alpha1.BucketResponse bucket = 1;
154
143
  */
155
- bucket: string;
144
+ bucket?: BucketResponse;
156
145
  /**
157
- * The object key within the bucket
146
+ * __DESCRIPTION__ The object key within the bucket
147
+ * __EXAMPLE__ "document.pdf"
158
148
  *
159
149
  * @generated from field: string object = 2;
160
150
  */
@@ -166,59 +156,54 @@ export type SourceResult = Message<"liquidmetal.v1alpha1.SourceResult"> & {
166
156
  */
167
157
  export declare const SourceResultSchema: GenMessage<SourceResult>;
168
158
  /**
169
- * TextResult represents a single search result with comprehensive metadata
170
- * and relevance information. This structure provides all necessary context
171
- * for understanding and displaying the result.
172
- *
173
159
  * @generated from message liquidmetal.v1alpha1.TextResult
174
160
  */
175
161
  export type TextResult = Message<"liquidmetal.v1alpha1.TextResult"> & {
176
162
  /**
177
- * Unique identifier for this text segment
178
- * Used for deduplication and result tracking
163
+ * __DESCRIPTION__ Unique identifier for this text segment. Used for deduplication and result tracking
164
+ * __EXAMPLE__ "51abb575a5e438a2db5fa064611995dfd76aa14d9e4b2a44c29a6374203126a5"
179
165
  *
180
166
  * @generated from field: optional string chunk_signature = 1;
181
167
  */
182
168
  chunkSignature?: string;
183
169
  /**
184
- * The actual content of the result
185
- * May be a document excerpt or full content
170
+ * __DESCRIPTION__ The actual content of the result. May be a document excerpt or full content
171
+ * __EXAMPLE__ "This is a sample text chunk from the document"
186
172
  *
187
173
  * @generated from field: optional string text = 2;
188
174
  */
189
175
  text?: string;
190
176
  /**
191
- * List of source document references
192
- * Contains bucket and object information for each source
193
- * Multiple sources may be provided for results aggregated across documents
177
+ * __DESCRIPTION__ Source document references. Contains bucket and object information
178
+ * __EXAMPLE__ {"bucket": {"moduleId": "01jt3vs2nyt2xwk2f54x2bkn84", "bucketName": "mr-bucket"}, "object": "document.pdf"}
194
179
  *
195
180
  * @generated from field: liquidmetal.v1alpha1.SourceResult source = 3;
196
181
  */
197
182
  source?: SourceResult;
198
183
  /**
199
- * Parent document identifier
200
- * Links related content chunks together
184
+ * __DESCRIPTION__ Parent document identifier. Links related content chunks together
185
+ * __EXAMPLE__ "e2ec3b118e205ff5d627e0c866224a25ba52e6d3ab758a3ef3d49e80908d7444"
201
186
  *
202
187
  * @generated from field: optional string payload_signature = 4;
203
188
  */
204
189
  payloadSignature?: string;
205
190
  /**
206
- * Relevance score (0.0 to 1.0)
207
- * Higher scores indicate better matches
191
+ * __DESCRIPTION__ Relevance score (0.0 to 1.0). Higher scores indicate better matches
192
+ * __EXAMPLE__ 0.95
208
193
  *
209
194
  * @generated from field: optional double score = 5;
210
195
  */
211
196
  score?: number;
212
197
  /**
213
- * Vector representation for similarity matching
214
- * Used in semantic search operations
198
+ * __DESCRIPTION__ Vector representation for similarity matching. Used in semantic search operations
199
+ * __EXAMPLE__ "base64_encoded_vector_data"
215
200
  *
216
201
  * @generated from field: optional string embed = 6;
217
202
  */
218
203
  embed?: string;
219
204
  /**
220
- * Content MIME type
221
- * Helps with proper result rendering
205
+ * __DESCRIPTION__ Content MIME type. Helps with proper result rendering
206
+ * __EXAMPLE__ "application/pdf"
222
207
  *
223
208
  * @generated from field: optional string type = 7;
224
209
  */
@@ -230,42 +215,40 @@ export type TextResult = Message<"liquidmetal.v1alpha1.TextResult"> & {
230
215
  */
231
216
  export declare const TextResultSchema: GenMessage<TextResult>;
232
217
  /**
233
- * PaginationInfo provides detailed pagination metadata for implementing
234
- * UI controls and managing result navigation. Supports both traditional
235
- * pagination and infinite scroll patterns.
236
- *
237
218
  * @generated from message liquidmetal.v1alpha1.PaginationInfo
238
219
  */
239
220
  export type PaginationInfo = Message<"liquidmetal.v1alpha1.PaginationInfo"> & {
240
221
  /**
241
- * Total number of available results
222
+ * __DESCRIPTION__ Total number of available results
223
+ * __EXAMPLE__ 1020
242
224
  *
243
225
  * @generated from field: int32 total = 1;
244
226
  */
245
227
  total: number;
246
228
  /**
247
- * Current page number (1-based)
229
+ * __DESCRIPTION__ Current page number (1-based)
230
+ * __EXAMPLE__ 1
248
231
  *
249
232
  * @generated from field: int32 page = 2;
250
233
  */
251
234
  page: number;
252
235
  /**
253
- * Results per page
254
- * May be adjusted for performance
236
+ * __DESCRIPTION__ Results per page. May be adjusted for performance
237
+ * __EXAMPLE__ 15
255
238
  *
256
239
  * @generated from field: int32 page_size = 3;
257
240
  */
258
241
  pageSize: number;
259
242
  /**
260
- * Total available pages
261
- * Calculated as ceil(total/page_size)
243
+ * __DESCRIPTION__ Total available pages. Calculated as ceil(total/pageSize)
244
+ * __EXAMPLE__ 68
262
245
  *
263
246
  * @generated from field: int32 total_pages = 4;
264
247
  */
265
248
  totalPages: number;
266
249
  /**
267
- * Indicates more results available
268
- * Used for infinite scroll implementation
250
+ * __DESCRIPTION__ Indicates more results available. Used for infinite scroll implementation
251
+ * __EXAMPLE__ true
269
252
  *
270
253
  * @generated from field: bool has_more = 5;
271
254
  */
@@ -277,27 +260,29 @@ export type PaginationInfo = Message<"liquidmetal.v1alpha1.PaginationInfo"> & {
277
260
  */
278
261
  export declare const PaginationInfoSchema: GenMessage<PaginationInfo>;
279
262
  /**
280
- * CreatePageSummaryRequest requests an AI-generated summary of search results
281
- * for a specific page. Helps users quickly understand large result sets.
282
- *
283
263
  * @generated from message liquidmetal.v1alpha1.CreatePageSummaryRequest
284
264
  */
285
265
  export type CreatePageSummaryRequest = Message<"liquidmetal.v1alpha1.CreatePageSummaryRequest"> & {
286
266
  /**
287
- * Target page number (1-based)
267
+ * __DESCRIPTION__ Target page number (1-based)
268
+ * __EXAMPLE__ 1
269
+ * __REQUIRED__ TRUE
288
270
  *
289
271
  * @generated from field: int32 page = 1;
290
272
  */
291
273
  page: number;
292
274
  /**
293
- * Results per page
294
- * Affects summary granularity
275
+ * __DESCRIPTION__ Results per page. Affects summary granularity
276
+ * __EXAMPLE__ 10
277
+ * __REQUIRED__ TRUE
295
278
  *
296
279
  * @generated from field: int32 page_size = 2;
297
280
  */
298
281
  pageSize: number;
299
282
  /**
300
- * Original search session identifier
283
+ * __DESCRIPTION__ Original search session identifier from the initial search
284
+ * __EXAMPLE__ "123e4567-e89b-12d3-a456-426614174000"
285
+ * __REQUIRED__ TRUE
301
286
  *
302
287
  * @generated from field: string request_id = 3;
303
288
  */
@@ -317,18 +302,12 @@ export type CreatePageSummaryRequest = Message<"liquidmetal.v1alpha1.CreatePageS
317
302
  */
318
303
  export declare const CreatePageSummaryRequestSchema: GenMessage<CreatePageSummaryRequest>;
319
304
  /**
320
- * CreatePageSummaryResponse provides an AI-generated overview of the
321
- * search results page, highlighting key themes and patterns.
322
- *
323
305
  * @generated from message liquidmetal.v1alpha1.CreatePageSummaryResponse
324
306
  */
325
307
  export type CreatePageSummaryResponse = Message<"liquidmetal.v1alpha1.CreatePageSummaryResponse"> & {
326
308
  /**
327
- * AI-generated summary including:
328
- * - Key themes and topics
329
- * - Content type distribution
330
- * - Important findings
331
- * - Document relationships
309
+ * __DESCRIPTION__ AI-generated summary including key themes and topics, content type distribution, important findings, and document relationships
310
+ * __EXAMPLE__ "The search results contain information about..."
332
311
  *
333
312
  * @generated from field: string summary = 1;
334
313
  */
@@ -340,34 +319,33 @@ export type CreatePageSummaryResponse = Message<"liquidmetal.v1alpha1.CreatePage
340
319
  */
341
320
  export declare const CreatePageSummaryResponseSchema: GenMessage<CreatePageSummaryResponse>;
342
321
  /**
343
- * RunSupervisorAgentRequest initiates a new semantic search operation
344
- * using natural language queries. The supervisor coordinates multiple
345
- * search strategies for comprehensive results.
346
- *
347
322
  * @generated from message liquidmetal.v1alpha1.RunSupervisorAgentRequest
348
323
  */
349
324
  export type RunSupervisorAgentRequest = Message<"liquidmetal.v1alpha1.RunSupervisorAgentRequest"> & {
350
325
  /**
351
- * Natural language search query
352
- * Can include complex criteria
326
+ * __DESCRIPTION__ Natural language search query that can include complex criteria. Supports queries like finding documents with specific content types, PII, or semantic meaning
327
+ * __EXAMPLE__ "Show me documents containing credit card numbers or social security numbers"
328
+ * __REQUIRED__ TRUE
353
329
  *
354
330
  * @generated from field: string input = 1;
355
331
  */
356
332
  input: string;
357
333
  /**
358
- * Search session identifier
359
- * Used for result tracking
334
+ * __DESCRIPTION__ Client-provided search session identifier. Required for pagination and result tracking. We recommend using a UUID or ULID for this value
335
+ * __EXAMPLE__ "123e4567-e89b-12d3-a456-426614174000"
336
+ * __REQUIRED__ TRUE
360
337
  *
361
338
  * @generated from field: string request_id = 2;
362
339
  */
363
340
  requestId: string;
364
341
  /**
365
- * Bucket IDs to search
366
- * If provided, the search will only return results from these buckets
342
+ * __DESCRIPTION__ The buckets to search. If provided, the search will only return results from these buckets
343
+ * __EXAMPLE__ [{"bucket": {"name": "my-bucket", "version": "01jtgtraw3b5qbahrhvrj3ygbb", "applicationName": "my-app"}}]
344
+ * __REQUIRED__ TRUE
367
345
  *
368
- * @generated from field: repeated string bucket_ids = 3;
346
+ * @generated from field: repeated liquidmetal.v1alpha1.BucketLocator bucket_locations = 3;
369
347
  */
370
- bucketIds: string[];
348
+ bucketLocations: BucketLocator[];
371
349
  /**
372
350
  * @generated from field: string user_id = 4;
373
351
  */
@@ -383,20 +361,19 @@ export type RunSupervisorAgentRequest = Message<"liquidmetal.v1alpha1.RunSupervi
383
361
  */
384
362
  export declare const RunSupervisorAgentRequestSchema: GenMessage<RunSupervisorAgentRequest>;
385
363
  /**
386
- * RunSupervisorAgentResponse provides the initial set of search results
387
- * along with pagination information for result navigation.
388
- *
389
364
  * @generated from message liquidmetal.v1alpha1.RunSupervisorAgentResponse
390
365
  */
391
366
  export type RunSupervisorAgentResponse = Message<"liquidmetal.v1alpha1.RunSupervisorAgentResponse"> & {
392
367
  /**
393
- * Matched results with metadata
368
+ * __DESCRIPTION__ Matched results with metadata
369
+ * __EXAMPLE__ [{"chunkSignature": "chunk_123abc", "text": "Sample text", "score": 0.95}]
394
370
  *
395
371
  * @generated from field: repeated liquidmetal.v1alpha1.TextResult results = 1;
396
372
  */
397
373
  results: TextResult[];
398
374
  /**
399
- * Pagination details for result navigation
375
+ * __DESCRIPTION__ Pagination details for result navigation
376
+ * __EXAMPLE__ {"total": 100, "page": 1, "pageSize": 10, "totalPages": 10, "hasMore": true}
400
377
  *
401
378
  * @generated from field: liquidmetal.v1alpha1.PaginationInfo pagination = 2;
402
379
  */
@@ -408,26 +385,29 @@ export type RunSupervisorAgentResponse = Message<"liquidmetal.v1alpha1.RunSuperv
408
385
  */
409
386
  export declare const RunSupervisorAgentResponseSchema: GenMessage<RunSupervisorAgentResponse>;
410
387
  /**
411
- * GetPaginatedResultsRequest retrieves additional pages from a previous
412
- * search operation. Maintains result consistency across pages.
413
- *
414
388
  * @generated from message liquidmetal.v1alpha1.GetPaginatedResultsRequest
415
389
  */
416
390
  export type GetPaginatedResultsRequest = Message<"liquidmetal.v1alpha1.GetPaginatedResultsRequest"> & {
417
391
  /**
418
- * Original search session identifier
392
+ * __DESCRIPTION__ Original search session identifier from the initial search
393
+ * __EXAMPLE__ "123e4567-e89b-12d3-a456-426614174000"
394
+ * __REQUIRED__ TRUE
419
395
  *
420
396
  * @generated from field: string request_id = 1;
421
397
  */
422
398
  requestId: string;
423
399
  /**
424
- * Requested page number
400
+ * __DESCRIPTION__ Requested page number
401
+ * __EXAMPLE__ 2
402
+ * __REQUIRED__ TRUE
425
403
  *
426
404
  * @generated from field: optional int32 page = 2;
427
405
  */
428
406
  page?: number;
429
407
  /**
430
- * Results per page
408
+ * __DESCRIPTION__ Results per page
409
+ * __EXAMPLE__ 10
410
+ * __REQUIRED__ TRUE
431
411
  *
432
412
  * @generated from field: optional int32 page_size = 3;
433
413
  */
@@ -447,20 +427,19 @@ export type GetPaginatedResultsRequest = Message<"liquidmetal.v1alpha1.GetPagina
447
427
  */
448
428
  export declare const GetPaginatedResultsRequestSchema: GenMessage<GetPaginatedResultsRequest>;
449
429
  /**
450
- * GetPaginatedResultsResponse provides the requested page of results
451
- * with updated pagination information.
452
- *
453
430
  * @generated from message liquidmetal.v1alpha1.GetPaginatedResultsResponse
454
431
  */
455
432
  export type GetPaginatedResultsResponse = Message<"liquidmetal.v1alpha1.GetPaginatedResultsResponse"> & {
456
433
  /**
457
- * Page results with full metadata
434
+ * __DESCRIPTION__ Page results with full metadata
435
+ * __EXAMPLE__ [{"chunkSignature": "chunk_123abc", "text": "Sample text", "score": 0.95}]
458
436
  *
459
437
  * @generated from field: repeated liquidmetal.v1alpha1.TextResult results = 1;
460
438
  */
461
439
  results: TextResult[];
462
440
  /**
463
- * Updated pagination information
441
+ * __DESCRIPTION__ Updated pagination information
442
+ * __EXAMPLE__ {"total": 100, "page": 2, "pageSize": 10, "totalPages": 10, "hasMore": true}
464
443
  *
465
444
  * @generated from field: liquidmetal.v1alpha1.PaginationInfo pagination = 2;
466
445
  */
@@ -472,41 +451,29 @@ export type GetPaginatedResultsResponse = Message<"liquidmetal.v1alpha1.GetPagin
472
451
  */
473
452
  export declare const GetPaginatedResultsResponseSchema: GenMessage<GetPaginatedResultsResponse>;
474
453
  /**
475
- * SearchAgentService provides the core functionality for Smart Buckets - Raindrop's intelligent
476
- * object storage service designed specifically for AI applications. When files are uploaded
477
- * to a Smart Bucket, they undergo advanced AI decomposition that analyzes and indexes content
478
- * using state-of-the-art AI models. This includes:
479
- *
480
- * - Automated document indexing and processing
481
- * - Extraction of structured data
482
- * - Processing through specialized AI models
483
- * - Storage in optimized formats for AI querying
484
- * - Automatic PII detection and classification
485
- *
486
- * The service supports multiple file types including:
487
- * - application/pdf
488
- * - image/jpeg, image/png
489
- * - audio/webm, audio/wav, audio/mp4, audio/mpeg
490
- * - text/plain
454
+ * __TITLE__ Query
455
+ * The query endpoints provide advanced AI-driven search, conversation, and summarization capabilities for documents and media stored in SmartBuckets.
456
+ * It enables users and agents to interact naturally with content through conversational chat (DocumentChat), semantic search (RagSearch), and multi-modal queries across text, images, and audio (document_query). The service also supports intelligent summarization of search results (summarize_page) and paginated result navigation.
457
+ * Designed for seamless integration into AI workflows, these endpoints make complex document exploration, PII detection, and knowledge extraction accessible via simple APIs, eliminating the need for custom pipelines or infrastructure.
491
458
  *
492
459
  * @generated from service liquidmetal.v1alpha1.SearchAgentService
493
460
  */
494
461
  export declare const SearchAgentService: GenService<{
495
462
  /**
496
- * DocumentChat enables natural conversational interactions with documents stored in Smart Buckets.
497
- * This creates an intelligent interface for document exploration through natural dialogue, allowing
498
- * users to ask questions, request summaries, and extract insights from any supported document type.
463
+ * Enables natural conversational interactions with documents stored in SmartBuckets. This endpoint allows users
464
+ * to ask questions, request summaries, and explore document content through an intuitive conversational interface.
465
+ * The system understands context and can handle complex queries about document contents.
499
466
  *
500
- * The chat system maintains conversation context, enabling follow-up questions and deep exploration
467
+ * The query system maintains conversation context throught the request_id, enabling follow-up questions and deep exploration
501
468
  * of document content. It works across all supported file types and automatically handles multi-page
502
- * documents, making complex document interaction as simple as having a conversation.
469
+ * documents, making complex file interaction as simple as having a conversation.
503
470
  *
504
471
  * The system will:
505
- * - Maintain conversation history for context
506
- * - Process questions against document content
472
+ * - Maintain conversation history for context when using the same request_id
473
+ * - Process questions against file content
507
474
  * - Generate contextual, relevant responses
508
- * - Handle document references and citations
509
- * - Support multi-turn conversations about document content
475
+ *
476
+ * Document query is supported for all file types, including PDFs, images, and audio files.
510
477
  *
511
478
  * @generated from rpc liquidmetal.v1alpha1.SearchAgentService.DocumentChat
512
479
  */
@@ -516,22 +483,13 @@ export declare const SearchAgentService: GenService<{
516
483
  output: typeof DocumentChatResponseSchema;
517
484
  };
518
485
  /**
519
- * RagSearch (Retrieval-Augmented Generation) provides an advanced search capability that serves
520
- * as a complete drop-in replacement for traditional RAG pipelines. This system enables AI agents
521
- * to leverage private data stored in Smart Buckets with zero additional configuration.
522
- *
523
- * The RAG system automatically:
524
- * - Processes and indexes uploaded content
525
- * - Maintains optimal chunk sizes (max 450 tokens)
526
- * - Handles document metadata
527
- * - Provides relevance scoring
528
- * - Manages document versioning
486
+ * Chunk Search provides search capabilities that serve as a complete
487
+ * drop-in replacement for traditional RAG pipelines. This system enables
488
+ * AI agents to leverage private data stored in SmartBuckets with zero
489
+ * additional configuration.
529
490
  *
530
- * This creates a foundation for:
531
- * - Training AI models with private data
532
- * - Building intelligent knowledge bases
533
- * - Creating context-aware chatbots
534
- * - Implementing semantic search systems
491
+ * Each input query is processed by our AI agent to determine the best way to search the data.
492
+ * The system will then return the most relevant results from the data ranked by relevance on the input query.
535
493
  *
536
494
  * @generated from rpc liquidmetal.v1alpha1.SearchAgentService.RagSearch
537
495
  */
@@ -541,9 +499,9 @@ export declare const SearchAgentService: GenService<{
541
499
  output: typeof RagSearchResponseSchema;
542
500
  };
543
501
  /**
544
- * CreatePageSummary generates intelligent summaries of search result pages, helping users
502
+ * Generates intelligent summaries of search result pages, helping users
545
503
  * quickly understand large result sets without reading through every document. The system
546
- * analyzes the content of all results on a given page and generates a comprehensive overview.
504
+ * analyzes the content of all results on a given page and generates a detailed overview.
547
505
  *
548
506
  * The summary system:
549
507
  * - Identifies key themes and topics
@@ -566,22 +524,22 @@ export declare const SearchAgentService: GenService<{
566
524
  output: typeof CreatePageSummaryResponseSchema;
567
525
  };
568
526
  /**
569
- * RunSupervisorAgent is the primary search interface for Smart Buckets, providing
570
- * advanced semantic search capabilities that go far beyond traditional keyword matching.
571
- * The supervisor agent orchestrates multiple specialized search strategies to provide
572
- * comprehensive, intelligent results.
527
+ * Primary search endpoint that provides advanced search capabilities across all document types stored in SmartBuckets.
528
+ *
529
+ * Supports recursive object search within objects, enabling nested content search like embedded images, text content,
530
+ * and personally identifiable information (PII).
573
531
  *
574
532
  * The system supports complex queries like:
575
- * - "Show me documents containing credit card numbers or social security numbers"
576
- * - "Find images of landscapes taken during sunset"
577
- * - "Get documents mentioning revenue forecasts from Q4 2023"
578
- * - "Find me all PDF documents that contain pictures of a cat"
533
+ * - 'Show me documents containing credit card numbers or social security numbers'
534
+ * - 'Find images of landscapes taken during sunset'
535
+ * - 'Get documents mentioning revenue forecasts from Q4 2023'
536
+ * - 'Find me all PDF documents that contain pictures of a cat'
537
+ * - 'Find me all audio files that contain information about the weather in SF in 2024'
579
538
  *
580
539
  * Key capabilities:
581
540
  * - Natural language query understanding
582
- * - Content-based search across text and images
583
- * - Automatic PII detection and filtering
584
- * - Cross-document relationship analysis
541
+ * - Content-based search across text, images, and audio
542
+ * - Automatic PII detection
585
543
  * - Multi-modal search (text, images, audio)
586
544
  *
587
545
  * @generated from rpc liquidmetal.v1alpha1.SearchAgentService.RunSupervisorAgent
@@ -592,16 +550,9 @@ export declare const SearchAgentService: GenService<{
592
550
  output: typeof RunSupervisorAgentResponseSchema;
593
551
  };
594
552
  /**
595
- * GetPaginatedResults enables efficient navigation through large result sets while
596
- * maintaining search context and result relevance. This method is optimized for
597
- * handling large document collections and implementing modern UI patterns.
598
- *
599
- * Features:
600
- * - Consistent result ordering
601
- * - Configurable page sizes
602
- * - Efficient result caching
603
- * - Cursor-based pagination
604
- * - Support for infinite scroll
553
+ * Retrieve additional pages from a previous search. This endpoint enables
554
+ * navigation through large result sets while maintaining search context and result relevance.
555
+ * Retrieving paginated results requires a valid request_id from a previously completed search.
605
556
  *
606
557
  * @generated from rpc liquidmetal.v1alpha1.SearchAgentService.GetPaginatedResults
607
558
  */