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