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