Class: Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb

Overview

Data store connection feature output signals. Might be only partially field if processing stop before the final answer. Reasons for this can be, but are not limited to: empty UCS search results, positive RAI check outcome, grounding failure, ...

Defined Under Namespace

Classes: AnswerGenerationModelCallSignals, AnswerPart, CitedSnippet, GroundingSignals, RewriterModelCallSignals, SafetySignals, SearchSnippet

Instance Attribute Summary collapse

Instance Attribute Details

#answer ⇒ ::String

Returns Optional. The final compiled answer.

Returns:

  • (::String) —

    Optional. The final compiled answer.



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#answer_generation_model_call_signals ⇒ ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerGenerationModelCallSignals

Returns Optional. Diagnostic info related to the answer generation model call.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#answer_parts ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::AnswerPart>

Returns Optional. Answer parts with relevant citations. Concatenation of texts should add up the answer (not counting whitespaces).

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#cited_snippets ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::CitedSnippet>

Returns Optional. Snippets cited by the answer generation model from the most to least relevant.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#grounding_signals ⇒ ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals

Returns Optional. Grounding signals.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#rewriter_model_call_signals ⇒ ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::RewriterModelCallSignals

Returns Optional. Diagnostic info related to the rewriter model call.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#rewritten_query ⇒ ::String

Returns Optional. Rewritten string query used for search.

Returns:

  • (::String) —

    Optional. Rewritten string query used for search.



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#safety_signals ⇒ ::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals

Returns Optional. Safety check result.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end

#search_snippets ⇒ ::Array<::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet>

Returns Optional. Search snippets included in the answer generation prompt.

Returns:



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
 
# File 'proto_docs/google/cloud/dialogflow/cx/v3/data_store_connection.rb', line 75

class DataStoreConnectionSignals
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # Diagnostic info related to the rewriter model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class RewriterModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Search snippet details.
  # @!attribute [rw] document_title
  #   @return [::String]
  #     Title of the enclosing document.
  # @!attribute [rw] document_uri
  #   @return [::String]
  #     Uri for the document. Present if specified for the document.
  # @!attribute [rw] text
  #   @return [::String]
  #     Text included in the prompt.
  class SearchSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Diagnostic info related to the answer generation model call.
  # @!attribute [rw] rendered_prompt
  #   @return [::String]
  #     Prompt as sent to the model.
  # @!attribute [rw] model_output
  #   @return [::String]
  #     Output of the generative model.
  # @!attribute [rw] model
  #   @return [::String]
  #     Name of the generative model. For example, "gemini-ultra", "gemini-pro",
  #     "gemini-1.5-flash" etc. Defaults to "Other" if the model is unknown.
  class AnswerGenerationModelCallSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer part with citation.
  # @!attribute [rw] text
  #   @return [::String]
  #     Substring of the answer.
  # @!attribute [rw] supporting_indices
  #   @return [::Array<::Integer>]
  #     Citations for this answer part. Indices of `search_snippets`.
  class AnswerPart
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Snippet cited by the answer generation model.
  # @!attribute [rw] search_snippet
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SearchSnippet]
  #     Details of the snippet.
  # @!attribute [rw] snippet_index
  #   @return [::Integer]
  #     Index of the snippet in `search_snippets` field.
  class CitedSnippet
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Grounding signals.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingDecision]
  #     Represents the decision of the grounding check.
  # @!attribute [rw] score
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::GroundingSignals::GroundingScoreBucket]
  #     Grounding score bucket setting.
  class GroundingSignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the decision of the grounding check.
    module GroundingDecision
      # Decision not specified.
      GROUNDING_DECISION_UNSPECIFIED = 0

      # Grounding have accepted the answer.
      ACCEPTED_BY_GROUNDING = 1

      # Grounding have rejected the answer.
      REJECTED_BY_GROUNDING = 2
    end

    # Grounding score buckets.
    module GroundingScoreBucket
      # Score not specified.
      GROUNDING_SCORE_BUCKET_UNSPECIFIED = 0

      # We have very low confidence that the answer is grounded.
      VERY_LOW = 1

      # We have low confidence that the answer is grounded.
      LOW = 3

      # We have medium confidence that the answer is grounded.
      MEDIUM = 4

      # We have high confidence that the answer is grounded.
      HIGH = 5

      # We have very high confidence that the answer is grounded.
      VERY_HIGH = 6
    end
  end

  # Safety check results.
  # @!attribute [rw] decision
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::SafetyDecision]
  #     Safety decision.
  # @!attribute [rw] banned_phrase_match
  #   @return [::Google::Cloud::Dialogflow::CX::V3::DataStoreConnectionSignals::SafetySignals::BannedPhraseMatch]
  #     Specifies banned phrase match subject.
  # @!attribute [rw] matched_banned_phrase
  #   @return [::String]
  #     The matched banned phrase if there was a match.
  class SafetySignals
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Safety decision.
    # All kinds of check are incorporated into this final decision, including
    # banned phrases check.
    module SafetyDecision
      # Decision not specified.
      SAFETY_DECISION_UNSPECIFIED = 0

      # No manual or automatic safety check fired.
      ACCEPTED_BY_SAFETY_CHECK = 1

      # One ore more safety checks fired.
      REJECTED_BY_SAFETY_CHECK = 2
    end

    # Specifies banned phrase match subject.
    module BannedPhraseMatch
      # No banned phrase check was executed.
      BANNED_PHRASE_MATCH_UNSPECIFIED = 0

      # All banned phrase checks led to no match.
      BANNED_PHRASE_MATCH_NONE = 1

      # A banned phrase matched the query.
      BANNED_PHRASE_MATCH_QUERY = 2

      # A banned phrase matched the response.
      BANNED_PHRASE_MATCH_RESPONSE = 3
    end
  end
end