-
Notifications
You must be signed in to change notification settings - Fork 2.4k
/
discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
928 lines (879 loc) 路 64.3 KB
/
discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html
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
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<h1><a href="discoveryengine_v1alpha.html">Discovery Engine API</a> . <a href="discoveryengine_v1alpha.projects.html">projects</a> . <a href="discoveryengine_v1alpha.projects.locations.html">locations</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.html">collections</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.dataStores.html">dataStores</a> . <a href="discoveryengine_v1alpha.projects.locations.collections.dataStores.conversations.html">conversations</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#converse">converse(name, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Converses a conversation.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>
<p class="firstline">Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets a Conversation.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all Conversations by their parent DataStore.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p>
<p class="firstline">Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="converse">converse(name, body=None, x__xgafv=None)</code>
<pre>Converses a conversation.
Args:
name: string, Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for ConversationalSearchService.ConverseConversation method.
"boostSpec": { # Boost specification to boost certain documents. # Boost specification to boost certain documents in search results which may affect the converse response. For more information on boosting, see [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
"conditionBoostSpecs": [ # Condition boost specifications. If a document matches multiple conditions in the specifictions, boost scores from these specifications are all applied and combined in a non-linear way. Maximum number of specifications is 20.
{ # Boost applies to documents which match a condition.
"boost": 3.14, # Strength of the condition boost, which should be in [-1, 1]. Negative boost means demotion. Default is 0.0. Setting to 1.0 gives the document a big promotion. However, it does not necessarily mean that the boosted document will be the top result at all times, nor that other documents will be excluded. Results could still be shown even when none of them matches the condition. And results that are significantly more relevant to the search query can still trump your heavily favored but irrelevant documents. Setting to -1.0 gives the document a big demotion. However, results that are deeply relevant might still be shown. The document will have an upstream battle to get a fairly high ranking, but it is not blocked out completely. Setting to 0.0 means no boost applied. The boosting condition is ignored.
"condition": "A String", # An expression which specifies a boost condition. The syntax and supported fields are the same as a filter expression. See SearchRequest.filter for detail syntax and limitations. Examples: * To boost documents with document ID "doc_1" or "doc_2", and color "Red" or "Blue": * (document_id: ANY("doc_1", "doc_2")) AND (color: ANY("Red", "Blue"))
},
],
},
"conversation": { # External conversation proto definition. # The conversation to be used by auto session only. The name field will be ignored as we automatically assign new name for the conversation in auto session.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
},
"filter": "A String", # The filter syntax consists of an expression language for constructing a predicate from one or more fields of the documents being filtered. Filter expression is case-sensitive. This will be used to filter search results which may affect the summary response. If this field is unrecognizable, an `INVALID_ARGUMENT` is returned. Filtering in Vertex AI Search is done by mapping the LHS filter key to a key property defined in the Vertex AI Search backend -- this mapping is defined by the customer in their schema. For example a media customer might have a field 'name' in their schema. In this case the filter would look like this: filter --> name:'ANY("king kong")' For more information about filtering including syntax and filter operators, see [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
"name": "A String", # Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}`. Use `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/-` to activate auto session mode, which automatically creates a new conversation inside a ConverseConversation session.
"query": { # Defines text input. # Required. Current user input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
"safeSearch": True or False, # Whether to turn on safe search.
"servingConfig": "A String", # The resource name of the Serving Config to use. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/servingConfigs/{serving_config_id}` If this is not set, the default serving config will be used.
"summarySpec": { # A specification for configuring a summary returned in a search response. # A specification for configuring the summary returned in the response.
"ignoreAdversarialQuery": True or False, # Specifies whether to filter out adversarial queries. The default value is `false`. Google employs search-query classification to detect adversarial queries. No summary is returned if the search query is classified as an adversarial query. For example, a user might ask a question regarding negative comments about the company or submit a query designed to generate unsafe, policy-violating output. If this field is set to `true`, we skip generating summaries for adversarial queries and return fallback messages instead.
"ignoreNonSummarySeekingQuery": True or False, # Specifies whether to filter out queries that are not summary-seeking. The default value is `false`. Google employs search-query classification to detect summary-seeking queries. No summary is returned if the search query is classified as a non-summary seeking query. For example, `why is the sky blue` and `Who is the best soccer player in the world?` are summary-seeking queries, but `SFO airport` and `world cup 2026` are not. They are most likely navigational queries. If this field is set to `true`, we skip generating summaries for non-summary seeking queries and return fallback messages instead.
"includeCitations": True or False, # Specifies whether to include citations in the summary. The default value is `false`. When this field is set to `true`, summaries include in-line citation numbers. Example summary including citations: BigQuery is Google Cloud's fully managed and completely serverless enterprise data warehouse [1]. BigQuery supports all data types, works across clouds, and has built-in machine learning and business intelligence, all within a unified platform [2, 3]. The citation numbers refer to the returned search results and are 1-indexed. For example, [1] means that the sentence is attributed to the first search result. [2, 3] means that the sentence is attributed to both the second and third search results.
"languageCode": "A String", # Language code for Summary. Use language tags defined by [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). Note: This is an experimental feature.
"modelPromptSpec": { # Specification of the prompt to use with the model. # If specified, the spec will be used to modify the prompt provided to the LLM.
"preamble": "A String", # Text at the beginning of the prompt that instructs the assistant. Examples are available in the user guide.
},
"modelSpec": { # Specification of the model. # If specified, the spec will be used to modify the model specification provided to the LLM.
"version": "A String", # The model version used to generate the summary. Supported values are: * `stable`: string. Default value when no value is specified. Uses a generally available, fine-tuned version of the text-bison@001 model. * `preview`: string. (Public preview) Uses a fine-tuned version of the text-bison@002 model. This model works only for summaries in English.
},
"summaryResultCount": 42, # The number of top results to generate the summary from. If the number of results returned is less than `summaryResultCount`, the summary is generated from all of the results. At most five results can be used to generate a summary.
},
"userLabels": { # The user labels applied to a resource must meet the following requirements: * Each resource can have multiple labels, up to a maximum of 64. * Each label must be a key-value pair. * Keys have a minimum length of 1 character and a maximum length of 63 characters and cannot be empty. Values can be empty and have a maximum length of 63 characters. * Keys and values can contain only lowercase letters, numeric characters, underscores, and dashes. All characters must use UTF-8 encoding, and international characters are allowed. * The key portion of a label must be unique. However, you can use the same key with multiple resources. * Keys must start with a lowercase letter or international character. See [Google Cloud Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements) for more details.
"a_key": "A String",
},
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response message for ConversationalSearchService.ConverseConversation method.
"conversation": { # External conversation proto definition. # Updated conversation including the answer.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
},
"relatedQuestions": [ # Suggested related questions.
"A String",
],
"reply": { # Defines a reply message to user. # Answer to the current query.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"searchResults": [ # Search Results.
{ # Represents the search results.
"document": { # Document captures all raw metadata information of items to be recommended or searched. # The document data snippet in the search response. Only fields that are marked as retrievable are populated.
"aclInfo": { # ACL Information of the Document. # Access control information for the document.
"readers": [
{ # AclRestriction to model complex inheritance restrictions. Example: Modeling a "Both Permit" inheritance, where to access a child document, user needs to have access to parent document. Document Hierarchy - Space_S --> Page_P. Readers: Space_S: group_1, user_1 Page_P: group_2, group_3, user_2 Space_S ACL Restriction - { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ] } ] } } Page_P ACL Restriction. { "acl_info": { "readers": [ { "principals": [ { "group_id": "group_2" }, { "group_id": "group_3" }, { "user_id": "user_2" } ], }, { "principals": [ { "group_id": "group_1" }, { "user_id": "user_1" } ], } ] } }
"principals": [ # List of principals.
{ # Principal identifier of a user or a group.
"groupId": "A String", # Group identifier. For Google Workspace user account, group_id should be the google workspace group email. For non-google identity provider user account, group_id is the mapped group identifier configured during the workforcepool config.
"userId": "A String", # User identifier. For Google Workspace user account, user_id should be the google workspace user email. For non-google identity provider user account, user_id is the mapped user identifier configured during the workforcepool config.
},
],
},
],
},
"content": { # Unstructured data linked to this document. # The unstructured data linked to this document. Content must be set if this document is under a `CONTENT_REQUIRED` data store.
"mimeType": "A String", # The MIME type of the content. Supported types: * `application/pdf` (PDF, only native PDFs are supported for now) * `text/html` (HTML) * `application/vnd.openxmlformats-officedocument.wordprocessingml.document` (DOCX) * `application/vnd.openxmlformats-officedocument.presentationml.presentation` (PPTX) * `text/plain` (TXT) See https://www.iana.org/assignments/media-types/media-types.xhtml.
"rawBytes": "A String", # The content represented as a stream of bytes. The maximum length is 1,000,000 bytes (1 MB / ~0.95 MiB). Note: As with all `bytes` fields, this field is represented as pure binary in Protocol Buffers and base64-encoded string in JSON. For example, `abc123!?$*&()'-=@~` should be represented as `YWJjMTIzIT8kKiYoKSctPUB+` in JSON. See https://developers.google.com/protocol-buffers/docs/proto3#json.
"uri": "A String", # The URI of the content. Only Cloud Storage URIs (e.g. `gs://bucket-name/path/to/file`) are supported. The maximum file size is 2.5 MB for text-based formats, 100 MB for other formats.
},
"derivedStructData": { # Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
"a_key": "", # Properties of the object.
},
"id": "A String", # Immutable. The identifier of the document. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
"indexTime": "A String", # Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
"jsonData": "A String", # The JSON string representation of the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
"name": "A String", # Immutable. The full resource name of the document. Format: `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}`. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
"parentDocumentId": "A String", # The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to [RFC-1034](https://tools.ietf.org/html/rfc1034) standard with a length limit of 63 characters.
"schemaId": "A String", # The identifier of the schema located in the same data store.
"structData": { # The structured JSON data for the document. It should conform to the registered Schema or an `INVALID_ARGUMENT` error is thrown.
"a_key": "", # Properties of the object.
},
},
"id": "A String", # Document.id of the searched Document.
"modelScores": { # Google provided available scores.
"a_key": { # Double list.
"values": [ # Double values.
3.14,
],
},
},
},
],
}</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, x__xgafv=None)</code>
<pre>Creates a Conversation. If the Conversation to create already exists, an ALREADY_EXISTS error is returned.
Args:
parent: string, Required. Full resource name of parent data store. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
body: object, The request body.
The object takes the form of:
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, x__xgafv=None)</code>
<pre>Deletes a Conversation. If the Conversation to delete does not exist, a NOT_FOUND error is returned.
Args:
name: string, Required. The resource name of the Conversation to delete. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Gets a Conversation.
Args:
name: string, Required. The resource name of the Conversation to get. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}/conversations/{conversation_id}` (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all Conversations by their parent DataStore.
Args:
parent: string, Required. The data store resource name. Format: `projects/{project_number}/locations/{location_id}/collections/{collection}/dataStores/{data_store_id}` (required)
filter: string, A filter to apply on the list results. The supported features are: user_pseudo_id, state. Example: "user_pseudo_id = some_id"
orderBy: string, A comma-separated list of fields to order by, sorted in ascending order. Use "desc" after a field name for descending. Supported fields: * `update_time` * `create_time` * `conversation_name` Example: "update_time desc" "create_time"
pageSize: integer, Maximum number of results to return. If unspecified, defaults to 50. Max allowed value is 1000.
pageToken: string, A page token, received from a previous `ListConversations` call. Provide this to retrieve the subsequent page.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Response for ListConversations method.
"conversations": [ # All the Conversations for a given data store.
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
},
],
"nextPageToken": "A String", # Pagination token, if not returned indicates the last page.
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code>
<pre>Updates a Conversation. Conversation action type cannot be changed. If the Conversation to update does not exist, a NOT_FOUND error is returned.
Args:
name: string, Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`. (required)
body: object, The request body.
The object takes the form of:
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
}
updateMask: string, Indicates which fields in the provided Conversation to update. The following are NOT supported: * Conversation.name If not set or empty, all supported fields are updated.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # External conversation proto definition.
"endTime": "A String", # Output only. The time the conversation finished.
"messages": [ # Conversation messages.
{ # Defines a conversation message.
"createTime": "A String", # Output only. Message creation timestamp.
"reply": { # Defines a reply message to user. # Search reply.
"references": [ # References in the reply.
{ # Defines reference in reply.
"anchorText": "A String", # Anchor text.
"end": 42, # Anchor text end index.
"start": 42, # Anchor text start index.
"uri": "A String", # URI link reference.
},
],
"reply": "A String", # DEPRECATED: use `summary` instead. Text reply.
"summary": { # Summary of the top N search result specified by the summary spec. # Summary based on search results.
"safetyAttributes": { # Safety Attribute categories and their associated confidence scores. # A collection of Safety Attribute categories and their associated confidence scores.
"categories": [ # The display names of Safety Attribute categories associated with the generated content. Order matches the Scores.
"A String",
],
"scores": [ # The confidence scores of the each category, higher value means higher confidence. Order matches the Categories.
3.14,
],
},
"summarySkippedReasons": [ # Additional summary-skipped reasons. This provides the reason for ignored cases. If nothing is skipped, this field is not set.
"A String",
],
"summaryText": "A String", # The summary content.
"summaryWithMetadata": { # Summary with metadata information. # Summary with metadata information.
"citationMetadata": { # Citation metadata. # Citation metadata for given summary.
"citations": [ # Citations for segments.
{ # Citation info for a segment.
"endIndex": "A String", # End of the attributed segment, exclusive.
"sources": [ # Citation sources for the attributed segment.
{ # Citation source.
"referenceIndex": "A String", # Document reference index from SummaryWithMetadata.references. It is 0-indexed and the value will be zero if the reference_index is not set explicitly.
},
],
"startIndex": "A String", # Index indicates the start of the segment, measured in bytes/unicode.
},
],
},
"references": [ # Document References.
{ # Document reference.
"document": "A String", # Required. Document.name of the document. Full resource name of the referenced document, in the format `projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*`.
"title": "A String", # Title of the document.
"uri": "A String", # Cloud Storage or HTTP uri for the document.
},
],
"summary": "A String", # Summary text with no citation information.
},
},
},
"userInput": { # Defines text input. # User text input.
"context": { # Defines context of the conversation # Conversation context of the input.
"activeDocument": "A String", # The current active document the user opened. It contains the document resource reference.
"contextDocuments": [ # The current list of documents the user is seeing. It contains the document resource references.
"A String",
],
},
"input": "A String", # Text input.
},
},
],
"name": "A String", # Immutable. Fully qualified name `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*` or `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
"startTime": "A String", # Output only. The time the conversation started.
"state": "A String", # The state of the Conversation.
"userPseudoId": "A String", # A unique identifier for tracking users.
}</pre>
</div>
</body></html>