/
question.pb.go
1970 lines (1773 loc) · 86.9 KB
/
question.pb.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Copyright 2020 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.25.0
// protoc v3.13.0
// source: google/cloud/dataqna/v1alpha/question.proto
package dataqna
import (
reflect "reflect"
sync "sync"
proto "github.com/golang/protobuf/proto"
_ "google.golang.org/genproto/googleapis/api/annotations"
status "google.golang.org/genproto/googleapis/rpc/status"
protoreflect "google.golang.org/protobuf/reflect/protoreflect"
protoimpl "google.golang.org/protobuf/runtime/protoimpl"
anypb "google.golang.org/protobuf/types/known/anypb"
timestamppb "google.golang.org/protobuf/types/known/timestamppb"
)
const (
// Verify that this generated code is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion)
// Verify that runtime/protoimpl is sufficiently up-to-date.
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// This is a compile-time assertion that a sufficiently up-to-date version
// of the legacy proto package is being used.
const _ = proto.ProtoPackageIsVersion4
// Query entities of an interpretation.
type InterpretEntity int32
const (
// No interpret entity was specified.
InterpretEntity_INTERPRET_ENTITY_UNSPECIFIED InterpretEntity = 0
// A dimenstion entity.
InterpretEntity_DIMENSION InterpretEntity = 1
// A metric entity.
InterpretEntity_METRIC InterpretEntity = 2
)
// Enum value maps for InterpretEntity.
var (
InterpretEntity_name = map[int32]string{
0: "INTERPRET_ENTITY_UNSPECIFIED",
1: "DIMENSION",
2: "METRIC",
}
InterpretEntity_value = map[string]int32{
"INTERPRET_ENTITY_UNSPECIFIED": 0,
"DIMENSION": 1,
"METRIC": 2,
}
)
func (x InterpretEntity) Enum() *InterpretEntity {
p := new(InterpretEntity)
*p = x
return p
}
func (x InterpretEntity) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (InterpretEntity) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[0].Descriptor()
}
func (InterpretEntity) Type() protoreflect.EnumType {
return &file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[0]
}
func (x InterpretEntity) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use InterpretEntity.Descriptor instead.
func (InterpretEntity) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{0}
}
// The interpret error code provides an error category why the interpretation
// failed.
type InterpretError_InterpretErrorCode int32
const (
// No interpret error code was specified.
InterpretError_INTERPRET_ERROR_CODE_UNSPECIFIED InterpretError_InterpretErrorCode = 0
// The query is not valid.
InterpretError_INVALID_QUERY InterpretError_InterpretErrorCode = 1
// The interpreter failed to understand the question. For example, because
// it was too ambiguous.
InterpretError_FAILED_TO_UNDERSTAND InterpretError_InterpretErrorCode = 2
// The interpreter could understand the question, but was not able to arrive
// at an answer. For example, because a requested operation is not
// supported.
InterpretError_FAILED_TO_ANSWER InterpretError_InterpretErrorCode = 3
)
// Enum value maps for InterpretError_InterpretErrorCode.
var (
InterpretError_InterpretErrorCode_name = map[int32]string{
0: "INTERPRET_ERROR_CODE_UNSPECIFIED",
1: "INVALID_QUERY",
2: "FAILED_TO_UNDERSTAND",
3: "FAILED_TO_ANSWER",
}
InterpretError_InterpretErrorCode_value = map[string]int32{
"INTERPRET_ERROR_CODE_UNSPECIFIED": 0,
"INVALID_QUERY": 1,
"FAILED_TO_UNDERSTAND": 2,
"FAILED_TO_ANSWER": 3,
}
)
func (x InterpretError_InterpretErrorCode) Enum() *InterpretError_InterpretErrorCode {
p := new(InterpretError_InterpretErrorCode)
*p = x
return p
}
func (x InterpretError_InterpretErrorCode) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (InterpretError_InterpretErrorCode) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[1].Descriptor()
}
func (InterpretError_InterpretErrorCode) Type() protoreflect.EnumType {
return &file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[1]
}
func (x InterpretError_InterpretErrorCode) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use InterpretError_InterpretErrorCode.Descriptor instead.
func (InterpretError_InterpretErrorCode) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{1, 0}
}
// Enum of possible job execution statuses.
type ExecutionInfo_JobExecutionState int32
const (
// No job execution was specified.
ExecutionInfo_JOB_EXECUTION_STATE_UNSPECIFIED ExecutionInfo_JobExecutionState = 0
// No job execution was requested, yet.
ExecutionInfo_NOT_EXECUTED ExecutionInfo_JobExecutionState = 1
// The job is running.
ExecutionInfo_RUNNING ExecutionInfo_JobExecutionState = 2
// The job completed successfully.
ExecutionInfo_SUCCEEDED ExecutionInfo_JobExecutionState = 3
// The job completed unsuccessfully.
ExecutionInfo_FAILED ExecutionInfo_JobExecutionState = 4
)
// Enum value maps for ExecutionInfo_JobExecutionState.
var (
ExecutionInfo_JobExecutionState_name = map[int32]string{
0: "JOB_EXECUTION_STATE_UNSPECIFIED",
1: "NOT_EXECUTED",
2: "RUNNING",
3: "SUCCEEDED",
4: "FAILED",
}
ExecutionInfo_JobExecutionState_value = map[string]int32{
"JOB_EXECUTION_STATE_UNSPECIFIED": 0,
"NOT_EXECUTED": 1,
"RUNNING": 2,
"SUCCEEDED": 3,
"FAILED": 4,
}
)
func (x ExecutionInfo_JobExecutionState) Enum() *ExecutionInfo_JobExecutionState {
p := new(ExecutionInfo_JobExecutionState)
*p = x
return p
}
func (x ExecutionInfo_JobExecutionState) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (ExecutionInfo_JobExecutionState) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[2].Descriptor()
}
func (ExecutionInfo_JobExecutionState) Type() protoreflect.EnumType {
return &file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[2]
}
func (x ExecutionInfo_JobExecutionState) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use ExecutionInfo_JobExecutionState.Descriptor instead.
func (ExecutionInfo_JobExecutionState) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{2, 0}
}
// Enumeration of visualzation types to use for query response data.
type InterpretationStructure_VisualizationType int32
const (
// No visualization type was specified.
InterpretationStructure_VISUALIZATION_TYPE_UNSPECIFIED InterpretationStructure_VisualizationType = 0
// Show a table.
InterpretationStructure_TABLE InterpretationStructure_VisualizationType = 1
// Show a [bar
// chart](https://developers.google.com/chart/interactive/docs/gallery/barchart).
InterpretationStructure_BAR_CHART InterpretationStructure_VisualizationType = 2
// Show a [column
// chart](https://developers.google.com/chart/interactive/docs/gallery/columnchart).
InterpretationStructure_COLUMN_CHART InterpretationStructure_VisualizationType = 3
// Show a
// [timeline](https://developers.google.com/chart/interactive/docs/gallery/timeline).
InterpretationStructure_TIMELINE InterpretationStructure_VisualizationType = 4
// Show a [scatter
// plot](https://developers.google.com/chart/interactive/docs/gallery/scatterchart).
InterpretationStructure_SCATTER_PLOT InterpretationStructure_VisualizationType = 5
// Show a [pie
// chart](https://developers.google.com/chart/interactive/docs/gallery/piechart).
InterpretationStructure_PIE_CHART InterpretationStructure_VisualizationType = 6
// Show a [line
// chart](https://developers.google.com/chart/interactive/docs/gallery/linechart).
InterpretationStructure_LINE_CHART InterpretationStructure_VisualizationType = 7
// Show an [area
// chart](https://developers.google.com/chart/interactive/docs/gallery/areachart).
InterpretationStructure_AREA_CHART InterpretationStructure_VisualizationType = 8
// Show a [combo
// chart](https://developers.google.com/chart/interactive/docs/gallery/combochart).
InterpretationStructure_COMBO_CHART InterpretationStructure_VisualizationType = 9
// Show a
// [histogram](https://developers.google.com/chart/interactive/docs/gallery/histogram).
InterpretationStructure_HISTOGRAM InterpretationStructure_VisualizationType = 10
// This denotes queries when the user has not specified the particular type
// of chart and has mentioned only a generic chart name such as "Chart",
// "Plot", "Graph", etc. This will differentiate it from specific charting
// terms such as "Bar chart", "Pie chart", etc.
InterpretationStructure_GENERIC_CHART InterpretationStructure_VisualizationType = 11
// The user tried to specify a chart type, but the interpreter could not
// understand the type. The client should display a generic chart and may
// give a hint to the user that the requested type was not understood.
InterpretationStructure_CHART_NOT_UNDERSTOOD InterpretationStructure_VisualizationType = 12
)
// Enum value maps for InterpretationStructure_VisualizationType.
var (
InterpretationStructure_VisualizationType_name = map[int32]string{
0: "VISUALIZATION_TYPE_UNSPECIFIED",
1: "TABLE",
2: "BAR_CHART",
3: "COLUMN_CHART",
4: "TIMELINE",
5: "SCATTER_PLOT",
6: "PIE_CHART",
7: "LINE_CHART",
8: "AREA_CHART",
9: "COMBO_CHART",
10: "HISTOGRAM",
11: "GENERIC_CHART",
12: "CHART_NOT_UNDERSTOOD",
}
InterpretationStructure_VisualizationType_value = map[string]int32{
"VISUALIZATION_TYPE_UNSPECIFIED": 0,
"TABLE": 1,
"BAR_CHART": 2,
"COLUMN_CHART": 3,
"TIMELINE": 4,
"SCATTER_PLOT": 5,
"PIE_CHART": 6,
"LINE_CHART": 7,
"AREA_CHART": 8,
"COMBO_CHART": 9,
"HISTOGRAM": 10,
"GENERIC_CHART": 11,
"CHART_NOT_UNDERSTOOD": 12,
}
)
func (x InterpretationStructure_VisualizationType) Enum() *InterpretationStructure_VisualizationType {
p := new(InterpretationStructure_VisualizationType)
*p = x
return p
}
func (x InterpretationStructure_VisualizationType) String() string {
return protoimpl.X.EnumStringOf(x.Descriptor(), protoreflect.EnumNumber(x))
}
func (InterpretationStructure_VisualizationType) Descriptor() protoreflect.EnumDescriptor {
return file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[3].Descriptor()
}
func (InterpretationStructure_VisualizationType) Type() protoreflect.EnumType {
return &file_google_cloud_dataqna_v1alpha_question_proto_enumTypes[3]
}
func (x InterpretationStructure_VisualizationType) Number() protoreflect.EnumNumber {
return protoreflect.EnumNumber(x)
}
// Deprecated: Use InterpretationStructure_VisualizationType.Descriptor instead.
func (InterpretationStructure_VisualizationType) EnumDescriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{7, 0}
}
// The question resource represents a natural language query, its settings,
// understanding generated by the system, and answer retrieval status.
// A question cannot be modified.
type Question struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Output only. Immutable. The unique identifier for the Question. The ID is server-generated.
// Example: `projects/foo/locations/bar/questions/123`
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// Required. Immutable. Scopes to be used for the question. A scope defines the relevant data set
// scope. It can be a reference to a specific data source or a collection of
// data sources. Currently, support is limited to a single BigQuery table.
// There must be exactly one `scopes` element.
//
// Example:
// `//bigquery.googleapis.com/projects/test-project/datasets/foo/tables/bar`
Scopes []string `protobuf:"bytes,2,rep,name=scopes,proto3" json:"scopes,omitempty"`
// Required. Immutable. The query in natural language.
Query string `protobuf:"bytes,3,opt,name=query,proto3" json:"query,omitempty"`
// A list of annotations to use instead of the default annotation of a data
// source (set in the data source reference resource). There must not be
// more than one annotation with the same data source reference.
DataSourceAnnotations []string `protobuf:"bytes,4,rep,name=data_source_annotations,json=dataSourceAnnotations,proto3" json:"data_source_annotations,omitempty"`
// An error field explaining why interpretation failed. This is only populated
// if the interpretation failed.
//
// Note: This is different from getting a status error on the request itself.
// This is not a client or server error and the Question resource is still
// persisted, but the service could not interpret the question. Clients should
// present the error to the user so the user can rephrase the question.
InterpretError *InterpretError `protobuf:"bytes,5,opt,name=interpret_error,json=interpretError,proto3" json:"interpret_error,omitempty"`
// A list of interpretations for this question.
Interpretations []*Interpretation `protobuf:"bytes,6,rep,name=interpretations,proto3" json:"interpretations,omitempty"`
// Time when the question was created.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// Output only. The e-mail address of the user that created this question.
UserEmail string `protobuf:"bytes,8,opt,name=user_email,json=userEmail,proto3" json:"user_email,omitempty"`
// Input only. Immutable. Flags to request additional information for debugging purposes.
DebugFlags *DebugFlags `protobuf:"bytes,9,opt,name=debug_flags,json=debugFlags,proto3" json:"debug_flags,omitempty"`
// Top level debug information.
// This will be stored as the type DebugInformation.
// Using Any so clients don't need to pull in anything
// inside the debug message.
DebugInfo *anypb.Any `protobuf:"bytes,10,opt,name=debug_info,json=debugInfo,proto3" json:"debug_info,omitempty"`
}
func (x *Question) Reset() {
*x = Question{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[0]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Question) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Question) ProtoMessage() {}
func (x *Question) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[0]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Question.ProtoReflect.Descriptor instead.
func (*Question) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{0}
}
func (x *Question) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *Question) GetScopes() []string {
if x != nil {
return x.Scopes
}
return nil
}
func (x *Question) GetQuery() string {
if x != nil {
return x.Query
}
return ""
}
func (x *Question) GetDataSourceAnnotations() []string {
if x != nil {
return x.DataSourceAnnotations
}
return nil
}
func (x *Question) GetInterpretError() *InterpretError {
if x != nil {
return x.InterpretError
}
return nil
}
func (x *Question) GetInterpretations() []*Interpretation {
if x != nil {
return x.Interpretations
}
return nil
}
func (x *Question) GetCreateTime() *timestamppb.Timestamp {
if x != nil {
return x.CreateTime
}
return nil
}
func (x *Question) GetUserEmail() string {
if x != nil {
return x.UserEmail
}
return ""
}
func (x *Question) GetDebugFlags() *DebugFlags {
if x != nil {
return x.DebugFlags
}
return nil
}
func (x *Question) GetDebugInfo() *anypb.Any {
if x != nil {
return x.DebugInfo
}
return nil
}
// Details on the failure to interpret the question.
type InterpretError struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Error message explaining why this question could not be interpreted.
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
// The code for the error category why the interpretation failed.
Code InterpretError_InterpretErrorCode `protobuf:"varint,2,opt,name=code,proto3,enum=google.cloud.dataqna.v1alpha.InterpretError_InterpretErrorCode" json:"code,omitempty"`
// Details on interpretation failure.
Details *InterpretError_InterpretErrorDetails `protobuf:"bytes,3,opt,name=details,proto3" json:"details,omitempty"`
}
func (x *InterpretError) Reset() {
*x = InterpretError{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[1]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *InterpretError) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*InterpretError) ProtoMessage() {}
func (x *InterpretError) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[1]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use InterpretError.ProtoReflect.Descriptor instead.
func (*InterpretError) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{1}
}
func (x *InterpretError) GetMessage() string {
if x != nil {
return x.Message
}
return ""
}
func (x *InterpretError) GetCode() InterpretError_InterpretErrorCode {
if x != nil {
return x.Code
}
return InterpretError_INTERPRET_ERROR_CODE_UNSPECIFIED
}
func (x *InterpretError) GetDetails() *InterpretError_InterpretErrorDetails {
if x != nil {
return x.Details
}
return nil
}
// Information about the backend status (such as BigQuery) of the execution.
type ExecutionInfo struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Status returned by the backend when the job was created.
JobCreationStatus *status.Status `protobuf:"bytes,1,opt,name=job_creation_status,json=jobCreationStatus,proto3" json:"job_creation_status,omitempty"`
// Status of the job execution.
JobExecutionState ExecutionInfo_JobExecutionState `protobuf:"varint,2,opt,name=job_execution_state,json=jobExecutionState,proto3,enum=google.cloud.dataqna.v1alpha.ExecutionInfo_JobExecutionState" json:"job_execution_state,omitempty"`
// Time when the execution was triggered.
CreateTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
// BigQuery job information.
// Future versions will have different backends. Hence, clients must make sure
// they can handle it when this field is not populated.
BigqueryJob *BigQueryJob `protobuf:"bytes,4,opt,name=bigquery_job,json=bigqueryJob,proto3" json:"bigquery_job,omitempty"`
}
func (x *ExecutionInfo) Reset() {
*x = ExecutionInfo{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ExecutionInfo) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ExecutionInfo) ProtoMessage() {}
func (x *ExecutionInfo) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[2]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use ExecutionInfo.ProtoReflect.Descriptor instead.
func (*ExecutionInfo) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{2}
}
func (x *ExecutionInfo) GetJobCreationStatus() *status.Status {
if x != nil {
return x.JobCreationStatus
}
return nil
}
func (x *ExecutionInfo) GetJobExecutionState() ExecutionInfo_JobExecutionState {
if x != nil {
return x.JobExecutionState
}
return ExecutionInfo_JOB_EXECUTION_STATE_UNSPECIFIED
}
func (x *ExecutionInfo) GetCreateTime() *timestamppb.Timestamp {
if x != nil {
return x.CreateTime
}
return nil
}
func (x *ExecutionInfo) GetBigqueryJob() *BigQueryJob {
if x != nil {
return x.BigqueryJob
}
return nil
}
// BigQuery job information. This can be used to query the BigQuery API and
// retrieve the current job's status (using
// [jobs.get](https://cloud.google.com/bigquery/docs/reference/rest/v2/jobs/get)).
type BigQueryJob struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The job ID.
JobId string `protobuf:"bytes,1,opt,name=job_id,json=jobId,proto3" json:"job_id,omitempty"`
// The project ID of the job.
ProjectId string `protobuf:"bytes,2,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
// The location where the job is running.
Location string `protobuf:"bytes,3,opt,name=location,proto3" json:"location,omitempty"`
}
func (x *BigQueryJob) Reset() {
*x = BigQueryJob{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *BigQueryJob) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*BigQueryJob) ProtoMessage() {}
func (x *BigQueryJob) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[3]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use BigQueryJob.ProtoReflect.Descriptor instead.
func (*BigQueryJob) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{3}
}
func (x *BigQueryJob) GetJobId() string {
if x != nil {
return x.JobId
}
return ""
}
func (x *BigQueryJob) GetProjectId() string {
if x != nil {
return x.ProjectId
}
return ""
}
func (x *BigQueryJob) GetLocation() string {
if x != nil {
return x.Location
}
return ""
}
// An interpretation of a natural language query.
type Interpretation struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// List of data sources used in the current understanding.
DataSources []string `protobuf:"bytes,1,rep,name=data_sources,json=dataSources,proto3" json:"data_sources,omitempty"`
// The level of confidence that one of the interpretations is correct. This is
// a value in the range [0, 1] where a value of 0.5 or below is to be
// considered a low confidence.
Confidence float64 `protobuf:"fixed64,2,opt,name=confidence,proto3" json:"confidence,omitempty"`
// A list of unused phrases. Clients should display a Did You Mean (DYM)
// dialog if this is non-empty, even if this is the only interpretation.
UnusedPhrases []string `protobuf:"bytes,3,rep,name=unused_phrases,json=unusedPhrases,proto3" json:"unused_phrases,omitempty"`
// Human readable representation of the query.
HumanReadable *HumanReadable `protobuf:"bytes,4,opt,name=human_readable,json=humanReadable,proto3" json:"human_readable,omitempty"`
// Information about the interpretation structure that helps to understand and
// visualize the response.
InterpretationStructure *InterpretationStructure `protobuf:"bytes,5,opt,name=interpretation_structure,json=interpretationStructure,proto3" json:"interpretation_structure,omitempty"`
// Representation of the data query to be sent to the backend.
DataQuery *DataQuery `protobuf:"bytes,6,opt,name=data_query,json=dataQuery,proto3" json:"data_query,omitempty"`
// Information about the backend response. This is populated only if execution
// of an interpretation was requested.
ExecutionInfo *ExecutionInfo `protobuf:"bytes,7,opt,name=execution_info,json=executionInfo,proto3" json:"execution_info,omitempty"`
}
func (x *Interpretation) Reset() {
*x = Interpretation{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *Interpretation) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*Interpretation) ProtoMessage() {}
func (x *Interpretation) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[4]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use Interpretation.ProtoReflect.Descriptor instead.
func (*Interpretation) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{4}
}
func (x *Interpretation) GetDataSources() []string {
if x != nil {
return x.DataSources
}
return nil
}
func (x *Interpretation) GetConfidence() float64 {
if x != nil {
return x.Confidence
}
return 0
}
func (x *Interpretation) GetUnusedPhrases() []string {
if x != nil {
return x.UnusedPhrases
}
return nil
}
func (x *Interpretation) GetHumanReadable() *HumanReadable {
if x != nil {
return x.HumanReadable
}
return nil
}
func (x *Interpretation) GetInterpretationStructure() *InterpretationStructure {
if x != nil {
return x.InterpretationStructure
}
return nil
}
func (x *Interpretation) GetDataQuery() *DataQuery {
if x != nil {
return x.DataQuery
}
return nil
}
func (x *Interpretation) GetExecutionInfo() *ExecutionInfo {
if x != nil {
return x.ExecutionInfo
}
return nil
}
// Representation of the data query for the backend.
// This is provided for informational purposes only. Clients should not use
// it to send it to the backend directly, but rather use the `execute` RPC
// to trigger the execution. Using the `execute` RPC is needed in order to
// track the state of a question and report on it correctly to the data
// administrators.
type DataQuery struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The generated SQL query to be sent to the backend.
Sql string `protobuf:"bytes,1,opt,name=sql,proto3" json:"sql,omitempty"`
}
func (x *DataQuery) Reset() {
*x = DataQuery{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *DataQuery) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*DataQuery) ProtoMessage() {}
func (x *DataQuery) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[5]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use DataQuery.ProtoReflect.Descriptor instead.
func (*DataQuery) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{5}
}
func (x *DataQuery) GetSql() string {
if x != nil {
return x.Sql
}
return ""
}
// Human readable interpretation.
type HumanReadable struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Generated query explaining the interpretation.
GeneratedInterpretation *AnnotatedString `protobuf:"bytes,1,opt,name=generated_interpretation,json=generatedInterpretation,proto3" json:"generated_interpretation,omitempty"`
// Annotations on the original query.
OriginalQuestion *AnnotatedString `protobuf:"bytes,2,opt,name=original_question,json=originalQuestion,proto3" json:"original_question,omitempty"`
}
func (x *HumanReadable) Reset() {
*x = HumanReadable{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[6]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *HumanReadable) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*HumanReadable) ProtoMessage() {}
func (x *HumanReadable) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[6]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use HumanReadable.ProtoReflect.Descriptor instead.
func (*HumanReadable) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{6}
}
func (x *HumanReadable) GetGeneratedInterpretation() *AnnotatedString {
if x != nil {
return x.GeneratedInterpretation
}
return nil
}
func (x *HumanReadable) GetOriginalQuestion() *AnnotatedString {
if x != nil {
return x.OriginalQuestion
}
return nil
}
// Information about the interpretation structure that helps to understand and
// visualize the response.
type InterpretationStructure struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// List of possible visualization types to apply for this interpretation. The
// order has no relevance.
VisualizationTypes []InterpretationStructure_VisualizationType `protobuf:"varint,1,rep,packed,name=visualization_types,json=visualizationTypes,proto3,enum=google.cloud.dataqna.v1alpha.InterpretationStructure_VisualizationType" json:"visualization_types,omitempty"`
// Information about the output columns, that is, the columns that will be
// returned by the backend.
ColumnInfo []*InterpretationStructure_ColumnInfo `protobuf:"bytes,2,rep,name=column_info,json=columnInfo,proto3" json:"column_info,omitempty"`
}
func (x *InterpretationStructure) Reset() {
*x = InterpretationStructure{}
if protoimpl.UnsafeEnabled {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[7]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *InterpretationStructure) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*InterpretationStructure) ProtoMessage() {}
func (x *InterpretationStructure) ProtoReflect() protoreflect.Message {
mi := &file_google_cloud_dataqna_v1alpha_question_proto_msgTypes[7]
if protoimpl.UnsafeEnabled && x != nil {
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
if ms.LoadMessageInfo() == nil {
ms.StoreMessageInfo(mi)
}
return ms
}
return mi.MessageOf(x)
}
// Deprecated: Use InterpretationStructure.ProtoReflect.Descriptor instead.
func (*InterpretationStructure) Descriptor() ([]byte, []int) {
return file_google_cloud_dataqna_v1alpha_question_proto_rawDescGZIP(), []int{7}
}
func (x *InterpretationStructure) GetVisualizationTypes() []InterpretationStructure_VisualizationType {
if x != nil {
return x.VisualizationTypes
}
return nil
}
func (x *InterpretationStructure) GetColumnInfo() []*InterpretationStructure_ColumnInfo {
if x != nil {
return x.ColumnInfo
}
return nil
}
// Configuriation of debug flags.
type DebugFlags struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// Whether to include the original VAQuery.
IncludeVaQuery bool `protobuf:"varint,1,opt,name=include_va_query,json=includeVaQuery,proto3" json:"include_va_query,omitempty"`
// Whether to include the original nested VAQuery.
IncludeNestedVaQuery bool `protobuf:"varint,2,opt,name=include_nested_va_query,json=includeNestedVaQuery,proto3" json:"include_nested_va_query,omitempty"`
// Whether to include the original human interpretation strings generated
// by Analyza.
IncludeHumanInterpretation bool `protobuf:"varint,3,opt,name=include_human_interpretation,json=includeHumanInterpretation,proto3" json:"include_human_interpretation,omitempty"`
// Whether to include the Aqua debug response.
IncludeAquaDebugResponse bool `protobuf:"varint,4,opt,name=include_aqua_debug_response,json=includeAquaDebugResponse,proto3" json:"include_aqua_debug_response,omitempty"`
// The time in milliseconds from Unix epoch to be used
// to process the query. This is useful for testing
// the queries at different time period.
// If not set or time_override <= 0, then the current
// time is used.
TimeOverride int64 `protobuf:"varint,5,opt,name=time_override,json=timeOverride,proto3" json:"time_override,omitempty"`
// Set to true if request is initiated by an internal Google user.
IsInternalGoogleUser bool `protobuf:"varint,6,opt,name=is_internal_google_user,json=isInternalGoogleUser,proto3" json:"is_internal_google_user,omitempty"`
// Determines whether cache needs to be ignored. If set to
// true, cache won't be queried and updated.
IgnoreCache bool `protobuf:"varint,7,opt,name=ignore_cache,json=ignoreCache,proto3" json:"ignore_cache,omitempty"`
// Whether to include the request/response pair from the call to the