google-apis-dialogflow_v2beta1 0.109.0 → 0.111.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -14228,6 +14228,39 @@ module Google
14228
14228
  end
14229
14229
  end
14230
14230
 
14231
+ # A common evalaution pipeline status.
14232
+ class GoogleCloudDialogflowV2beta1EvaluationStatus
14233
+ include Google::Apis::Core::Hashable
14234
+
14235
+ # Output only. If the value is `false`, it means the evaluation is still in
14236
+ # progress. If `true`, the operation is completed, and either `error` or `
14237
+ # response` is available.
14238
+ # Corresponds to the JSON property `done`
14239
+ # @return [Boolean]
14240
+ attr_accessor :done
14241
+ alias_method :done?, :done
14242
+
14243
+ # The `Status` type defines a logical error model that is suitable for different
14244
+ # programming environments, including REST APIs and RPC APIs. It is used by [
14245
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
14246
+ # data: error code, error message, and error details. You can find out more
14247
+ # about this error model and how to work with it in the [API Design Guide](https:
14248
+ # //cloud.google.com/apis/design/errors).
14249
+ # Corresponds to the JSON property `pipelineStatus`
14250
+ # @return [Google::Apis::DialogflowV2beta1::GoogleRpcStatus]
14251
+ attr_accessor :pipeline_status
14252
+
14253
+ def initialize(**args)
14254
+ update!(**args)
14255
+ end
14256
+
14257
+ # Update properties of this object
14258
+ def update!(**args)
14259
+ @done = args[:done] if args.key?(:done)
14260
+ @pipeline_status = args[:pipeline_status] if args.key?(:pipeline_status)
14261
+ end
14262
+ end
14263
+
14231
14264
  # Events allow for matching intents by event name instead of the natural
14232
14265
  # language input. For instance, input `` can trigger a personalized welcome
14233
14266
  # response. The parameter `name` may be used by the agent in the response: `"
@@ -15047,6 +15080,261 @@ module Google
15047
15080
  end
15048
15081
  end
15049
15082
 
15083
+ # Represents evaluation result of a generator.
15084
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluation
15085
+ include Google::Apis::Core::Hashable
15086
+
15087
+ # Output only. Completion time of this generator evaluation.
15088
+ # Corresponds to the JSON property `completeTime`
15089
+ # @return [String]
15090
+ attr_accessor :complete_time
15091
+
15092
+ # Output only. Creation time of this generator evaluation.
15093
+ # Corresponds to the JSON property `createTime`
15094
+ # @return [String]
15095
+ attr_accessor :create_time
15096
+
15097
+ # Optional. The display name of the generator evaluation. At most 64 bytes long.
15098
+ # Corresponds to the JSON property `displayName`
15099
+ # @return [String]
15100
+ attr_accessor :display_name
15101
+
15102
+ # A common evalaution pipeline status.
15103
+ # Corresponds to the JSON property `evaluationStatus`
15104
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1EvaluationStatus]
15105
+ attr_accessor :evaluation_status
15106
+
15107
+ # Generator evaluation input config.
15108
+ # Corresponds to the JSON property `generatorEvaluationConfig`
15109
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig]
15110
+ attr_accessor :generator_evaluation_config
15111
+
15112
+ # LLM generator.
15113
+ # Corresponds to the JSON property `initialGenerator`
15114
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1Generator]
15115
+ attr_accessor :initial_generator
15116
+
15117
+ # Output only. Identifier. The resource name of the evaluation. Format: `
15118
+ # projects//locations//generators// evaluations/`
15119
+ # Corresponds to the JSON property `name`
15120
+ # @return [String]
15121
+ attr_accessor :name
15122
+
15123
+ # Evaluation metrics for summarization generator.
15124
+ # Corresponds to the JSON property `summarizationMetrics`
15125
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics]
15126
+ attr_accessor :summarization_metrics
15127
+
15128
+ def initialize(**args)
15129
+ update!(**args)
15130
+ end
15131
+
15132
+ # Update properties of this object
15133
+ def update!(**args)
15134
+ @complete_time = args[:complete_time] if args.key?(:complete_time)
15135
+ @create_time = args[:create_time] if args.key?(:create_time)
15136
+ @display_name = args[:display_name] if args.key?(:display_name)
15137
+ @evaluation_status = args[:evaluation_status] if args.key?(:evaluation_status)
15138
+ @generator_evaluation_config = args[:generator_evaluation_config] if args.key?(:generator_evaluation_config)
15139
+ @initial_generator = args[:initial_generator] if args.key?(:initial_generator)
15140
+ @name = args[:name] if args.key?(:name)
15141
+ @summarization_metrics = args[:summarization_metrics] if args.key?(:summarization_metrics)
15142
+ end
15143
+ end
15144
+
15145
+ # Generator evaluation input config.
15146
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluationConfig
15147
+ include Google::Apis::Core::Hashable
15148
+
15149
+ # Input data config details
15150
+ # Corresponds to the JSON property `inputDataConfig`
15151
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig]
15152
+ attr_accessor :input_data_config
15153
+
15154
+ # Required. The output Cloud Storage bucket path to store eval files, e.g.
15155
+ # per_summary_accuracy_score report. This path is provided by customer and files
15156
+ # stored in it are visible to customer, no internal data should be stored in
15157
+ # this path.
15158
+ # Corresponds to the JSON property `outputGcsBucketPath`
15159
+ # @return [String]
15160
+ attr_accessor :output_gcs_bucket_path
15161
+
15162
+ # Evaluation configs for summarization generator.
15163
+ # Corresponds to the JSON property `summarizationConfig`
15164
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig]
15165
+ attr_accessor :summarization_config
15166
+
15167
+ def initialize(**args)
15168
+ update!(**args)
15169
+ end
15170
+
15171
+ # Update properties of this object
15172
+ def update!(**args)
15173
+ @input_data_config = args[:input_data_config] if args.key?(:input_data_config)
15174
+ @output_gcs_bucket_path = args[:output_gcs_bucket_path] if args.key?(:output_gcs_bucket_path)
15175
+ @summarization_config = args[:summarization_config] if args.key?(:summarization_config)
15176
+ end
15177
+ end
15178
+
15179
+ # The distinctive configs for Agent Assist conversations as the conversation
15180
+ # source.
15181
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig
15182
+ include Google::Apis::Core::Hashable
15183
+
15184
+ # Required. The end of the time range for conversations to be evaluated. Only
15185
+ # conversations ended at or before this timestamp will be sampled.
15186
+ # Corresponds to the JSON property `endTime`
15187
+ # @return [String]
15188
+ attr_accessor :end_time
15189
+
15190
+ # Required. The start of the time range for conversations to be evaluated. Only
15191
+ # conversations created at or after this timestamp will be sampled.
15192
+ # Corresponds to the JSON property `startTime`
15193
+ # @return [String]
15194
+ attr_accessor :start_time
15195
+
15196
+ def initialize(**args)
15197
+ update!(**args)
15198
+ end
15199
+
15200
+ # Update properties of this object
15201
+ def update!(**args)
15202
+ @end_time = args[:end_time] if args.key?(:end_time)
15203
+ @start_time = args[:start_time] if args.key?(:start_time)
15204
+ end
15205
+ end
15206
+
15207
+ # The distinctive configs for dataset as the conversation source.
15208
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig
15209
+ include Google::Apis::Core::Hashable
15210
+
15211
+ # Required. The identifier of the dataset to be evaluated. Format: `projects//
15212
+ # locations//datasets/`.
15213
+ # Corresponds to the JSON property `dataset`
15214
+ # @return [String]
15215
+ attr_accessor :dataset
15216
+
15217
+ def initialize(**args)
15218
+ update!(**args)
15219
+ end
15220
+
15221
+ # Update properties of this object
15222
+ def update!(**args)
15223
+ @dataset = args[:dataset] if args.key?(:dataset)
15224
+ end
15225
+ end
15226
+
15227
+ # Input data config details
15228
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigInputDataConfig
15229
+ include Google::Apis::Core::Hashable
15230
+
15231
+ # The distinctive configs for Agent Assist conversations as the conversation
15232
+ # source.
15233
+ # Corresponds to the JSON property `agentAssistInputDataConfig`
15234
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigAgentAssistInputDataConfig]
15235
+ attr_accessor :agent_assist_input_data_config
15236
+
15237
+ # The distinctive configs for dataset as the conversation source.
15238
+ # Corresponds to the JSON property `datasetInputDataConfig`
15239
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigDatasetInputDataConfig]
15240
+ attr_accessor :dataset_input_data_config
15241
+
15242
+ # Optional. The end timestamp to fetch conversation data.
15243
+ # Corresponds to the JSON property `endTime`
15244
+ # @return [String]
15245
+ attr_accessor :end_time
15246
+
15247
+ # Required. The source type of input data.
15248
+ # Corresponds to the JSON property `inputDataSourceType`
15249
+ # @return [String]
15250
+ attr_accessor :input_data_source_type
15251
+
15252
+ # Optional. Whether the summary generation is allowed when the pre-existing
15253
+ # qualified summaries are insufficient to cover the sample size.
15254
+ # Corresponds to the JSON property `isSummaryGenerationAllowed`
15255
+ # @return [Boolean]
15256
+ attr_accessor :is_summary_generation_allowed
15257
+ alias_method :is_summary_generation_allowed?, :is_summary_generation_allowed
15258
+
15259
+ # Optional. Desired number of conversation-summary pairs to be evaluated.
15260
+ # Corresponds to the JSON property `sampleSize`
15261
+ # @return [Fixnum]
15262
+ attr_accessor :sample_size
15263
+
15264
+ # Optional. The start timestamp to fetch conversation data.
15265
+ # Corresponds to the JSON property `startTime`
15266
+ # @return [String]
15267
+ attr_accessor :start_time
15268
+
15269
+ # Optional. Option to control whether summaries are generated during evaluation.
15270
+ # Corresponds to the JSON property `summaryGenerationOption`
15271
+ # @return [String]
15272
+ attr_accessor :summary_generation_option
15273
+
15274
+ def initialize(**args)
15275
+ update!(**args)
15276
+ end
15277
+
15278
+ # Update properties of this object
15279
+ def update!(**args)
15280
+ @agent_assist_input_data_config = args[:agent_assist_input_data_config] if args.key?(:agent_assist_input_data_config)
15281
+ @dataset_input_data_config = args[:dataset_input_data_config] if args.key?(:dataset_input_data_config)
15282
+ @end_time = args[:end_time] if args.key?(:end_time)
15283
+ @input_data_source_type = args[:input_data_source_type] if args.key?(:input_data_source_type)
15284
+ @is_summary_generation_allowed = args[:is_summary_generation_allowed] if args.key?(:is_summary_generation_allowed)
15285
+ @sample_size = args[:sample_size] if args.key?(:sample_size)
15286
+ @start_time = args[:start_time] if args.key?(:start_time)
15287
+ @summary_generation_option = args[:summary_generation_option] if args.key?(:summary_generation_option)
15288
+ end
15289
+ end
15290
+
15291
+ # Evaluation configs for summarization generator.
15292
+ class GoogleCloudDialogflowV2beta1GeneratorEvaluationConfigSummarizationConfig
15293
+ include Google::Apis::Core::Hashable
15294
+
15295
+ # Optional. Version for summarization accuracy. This will determine the prompt
15296
+ # and model used at backend.
15297
+ # Corresponds to the JSON property `accuracyEvaluationVersion`
15298
+ # @return [String]
15299
+ attr_accessor :accuracy_evaluation_version
15300
+
15301
+ # Optional. Version for summarization completeness. This will determine the
15302
+ # prompt and model used at backend.
15303
+ # Corresponds to the JSON property `completenessEvaluationVersion`
15304
+ # @return [String]
15305
+ attr_accessor :completeness_evaluation_version
15306
+
15307
+ # Optional. Enable accuracy evaluation.
15308
+ # Corresponds to the JSON property `enableAccuracyEvaluation`
15309
+ # @return [Boolean]
15310
+ attr_accessor :enable_accuracy_evaluation
15311
+ alias_method :enable_accuracy_evaluation?, :enable_accuracy_evaluation
15312
+
15313
+ # Optional. Enable completeness evaluation.
15314
+ # Corresponds to the JSON property `enableCompletenessEvaluation`
15315
+ # @return [Boolean]
15316
+ attr_accessor :enable_completeness_evaluation
15317
+ alias_method :enable_completeness_evaluation?, :enable_completeness_evaluation
15318
+
15319
+ # Output only. Version for summarization evaluation.
15320
+ # Corresponds to the JSON property `evaluatorVersion`
15321
+ # @return [String]
15322
+ attr_accessor :evaluator_version
15323
+
15324
+ def initialize(**args)
15325
+ update!(**args)
15326
+ end
15327
+
15328
+ # Update properties of this object
15329
+ def update!(**args)
15330
+ @accuracy_evaluation_version = args[:accuracy_evaluation_version] if args.key?(:accuracy_evaluation_version)
15331
+ @completeness_evaluation_version = args[:completeness_evaluation_version] if args.key?(:completeness_evaluation_version)
15332
+ @enable_accuracy_evaluation = args[:enable_accuracy_evaluation] if args.key?(:enable_accuracy_evaluation)
15333
+ @enable_completeness_evaluation = args[:enable_completeness_evaluation] if args.key?(:enable_completeness_evaluation)
15334
+ @evaluator_version = args[:evaluator_version] if args.key?(:evaluator_version)
15335
+ end
15336
+ end
15337
+
15050
15338
  # Suggestion generated using a Generator.
15051
15339
  class GoogleCloudDialogflowV2beta1GeneratorSuggestion
15052
15340
  include Google::Apis::Core::Hashable
@@ -18462,6 +18750,32 @@ module Google
18462
18750
  end
18463
18751
  end
18464
18752
 
18753
+ # Response of ListGeneratorEvaluations.
18754
+ class GoogleCloudDialogflowV2beta1ListGeneratorEvaluationsResponse
18755
+ include Google::Apis::Core::Hashable
18756
+
18757
+ # The list of evaluations to return.
18758
+ # Corresponds to the JSON property `generatorEvaluations`
18759
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1GeneratorEvaluation>]
18760
+ attr_accessor :generator_evaluations
18761
+
18762
+ # Token to retrieve the next page of results, or empty if there are no more
18763
+ # results in the list.
18764
+ # Corresponds to the JSON property `nextPageToken`
18765
+ # @return [String]
18766
+ attr_accessor :next_page_token
18767
+
18768
+ def initialize(**args)
18769
+ update!(**args)
18770
+ end
18771
+
18772
+ # Update properties of this object
18773
+ def update!(**args)
18774
+ @generator_evaluations = args[:generator_evaluations] if args.key?(:generator_evaluations)
18775
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
18776
+ end
18777
+ end
18778
+
18465
18779
  # Response of ListGenerators.
18466
18780
  class GoogleCloudDialogflowV2beta1ListGeneratorsResponse
18467
18781
  include Google::Apis::Core::Hashable
@@ -21490,6 +21804,451 @@ module Google
21490
21804
  end
21491
21805
  end
21492
21806
 
21807
+ # Evaluation metrics for summarization generator.
21808
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetrics
21809
+ include Google::Apis::Core::Hashable
21810
+
21811
+ # Output only. List of conversation details.
21812
+ # Corresponds to the JSON property `conversationDetails`
21813
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail>]
21814
+ attr_accessor :conversation_details
21815
+
21816
+ # Output only. A list of aggregated(average) scores per metric section.
21817
+ # Corresponds to the JSON property `overallMetrics`
21818
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric>]
21819
+ attr_accessor :overall_metrics
21820
+
21821
+ # Output only. Overall token per section. This is an aggregated(sum) result of
21822
+ # input token of summary acorss all conversations that are selected for
21823
+ # summarization evaluation.
21824
+ # Corresponds to the JSON property `overallSectionTokens`
21825
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken>]
21826
+ attr_accessor :overall_section_tokens
21827
+
21828
+ # Output only. User bucket uri for merged evaluation score and aggregation score
21829
+ # csv.
21830
+ # Corresponds to the JSON property `summarizationEvaluationMergedResultsUri`
21831
+ # @return [String]
21832
+ attr_accessor :summarization_evaluation_merged_results_uri
21833
+
21834
+ # Output only. A list of evaluation results per conversation(&summary), metric
21835
+ # and section.
21836
+ # Corresponds to the JSON property `summarizationEvaluationResults`
21837
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult>]
21838
+ attr_accessor :summarization_evaluation_results
21839
+
21840
+ def initialize(**args)
21841
+ update!(**args)
21842
+ end
21843
+
21844
+ # Update properties of this object
21845
+ def update!(**args)
21846
+ @conversation_details = args[:conversation_details] if args.key?(:conversation_details)
21847
+ @overall_metrics = args[:overall_metrics] if args.key?(:overall_metrics)
21848
+ @overall_section_tokens = args[:overall_section_tokens] if args.key?(:overall_section_tokens)
21849
+ @summarization_evaluation_merged_results_uri = args[:summarization_evaluation_merged_results_uri] if args.key?(:summarization_evaluation_merged_results_uri)
21850
+ @summarization_evaluation_results = args[:summarization_evaluation_results] if args.key?(:summarization_evaluation_results)
21851
+ end
21852
+ end
21853
+
21854
+ # Decomposition details for accuracy.
21855
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition
21856
+ include Google::Apis::Core::Hashable
21857
+
21858
+ # Output only. The accuracy reasoning of the breakdown point.
21859
+ # Corresponds to the JSON property `accuracyReasoning`
21860
+ # @return [String]
21861
+ attr_accessor :accuracy_reasoning
21862
+
21863
+ # Output only. Whether the breakdown point is accurate or not.
21864
+ # Corresponds to the JSON property `isAccurate`
21865
+ # @return [Boolean]
21866
+ attr_accessor :is_accurate
21867
+ alias_method :is_accurate?, :is_accurate
21868
+
21869
+ # Output only. The breakdown point of the summary.
21870
+ # Corresponds to the JSON property `point`
21871
+ # @return [String]
21872
+ attr_accessor :point
21873
+
21874
+ def initialize(**args)
21875
+ update!(**args)
21876
+ end
21877
+
21878
+ # Update properties of this object
21879
+ def update!(**args)
21880
+ @accuracy_reasoning = args[:accuracy_reasoning] if args.key?(:accuracy_reasoning)
21881
+ @is_accurate = args[:is_accurate] if args.key?(:is_accurate)
21882
+ @point = args[:point] if args.key?(:point)
21883
+ end
21884
+ end
21885
+
21886
+ # Decomposition details for adherence.
21887
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition
21888
+ include Google::Apis::Core::Hashable
21889
+
21890
+ # Output only. The adherence reasoning of the breakdown point.
21891
+ # Corresponds to the JSON property `adherenceReasoning`
21892
+ # @return [String]
21893
+ attr_accessor :adherence_reasoning
21894
+
21895
+ # Output only. Whether the breakdown point is adherent or not.
21896
+ # Corresponds to the JSON property `isAdherent`
21897
+ # @return [Boolean]
21898
+ attr_accessor :is_adherent
21899
+ alias_method :is_adherent?, :is_adherent
21900
+
21901
+ # Output only. The breakdown point of the given instructions.
21902
+ # Corresponds to the JSON property `point`
21903
+ # @return [String]
21904
+ attr_accessor :point
21905
+
21906
+ def initialize(**args)
21907
+ update!(**args)
21908
+ end
21909
+
21910
+ # Update properties of this object
21911
+ def update!(**args)
21912
+ @adherence_reasoning = args[:adherence_reasoning] if args.key?(:adherence_reasoning)
21913
+ @is_adherent = args[:is_adherent] if args.key?(:is_adherent)
21914
+ @point = args[:point] if args.key?(:point)
21915
+ end
21916
+ end
21917
+
21918
+ # Rubric result of the adherence evaluation. A rubric is ued to determine if the
21919
+ # summary adheres to all aspects of the given instructions.
21920
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric
21921
+ include Google::Apis::Core::Hashable
21922
+
21923
+ # Output only. A boolean that indicates whether the rubric question is addressed
21924
+ # or not.
21925
+ # Corresponds to the JSON property `isAddressed`
21926
+ # @return [Boolean]
21927
+ attr_accessor :is_addressed
21928
+ alias_method :is_addressed?, :is_addressed
21929
+
21930
+ # Output only. The question generated from instruction that used to evaluate
21931
+ # summary.
21932
+ # Corresponds to the JSON property `question`
21933
+ # @return [String]
21934
+ attr_accessor :question
21935
+
21936
+ # Output only. The reasoning of the rubric question is addressed or not.
21937
+ # Corresponds to the JSON property `reasoning`
21938
+ # @return [String]
21939
+ attr_accessor :reasoning
21940
+
21941
+ def initialize(**args)
21942
+ update!(**args)
21943
+ end
21944
+
21945
+ # Update properties of this object
21946
+ def update!(**args)
21947
+ @is_addressed = args[:is_addressed] if args.key?(:is_addressed)
21948
+ @question = args[:question] if args.key?(:question)
21949
+ @reasoning = args[:reasoning] if args.key?(:reasoning)
21950
+ end
21951
+ end
21952
+
21953
+ # Rubric details of the completeness evaluation result.
21954
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric
21955
+ include Google::Apis::Core::Hashable
21956
+
21957
+ # Output only. A boolean that indicates whether the rubric question is addressed
21958
+ # or not.
21959
+ # Corresponds to the JSON property `isAddressed`
21960
+ # @return [Boolean]
21961
+ attr_accessor :is_addressed
21962
+ alias_method :is_addressed?, :is_addressed
21963
+
21964
+ # Output only. The question generated from instruction that used to evaluate
21965
+ # summary.
21966
+ # Corresponds to the JSON property `question`
21967
+ # @return [String]
21968
+ attr_accessor :question
21969
+
21970
+ def initialize(**args)
21971
+ update!(**args)
21972
+ end
21973
+
21974
+ # Update properties of this object
21975
+ def update!(**args)
21976
+ @is_addressed = args[:is_addressed] if args.key?(:is_addressed)
21977
+ @question = args[:question] if args.key?(:question)
21978
+ end
21979
+ end
21980
+
21981
+ # Aggregated evaluation result on conversation level. This contains evaluation
21982
+ # results of all the metrics and sections.
21983
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetail
21984
+ include Google::Apis::Core::Hashable
21985
+
21986
+ # Output only. Conversation transcript that used for summarization evaluation as
21987
+ # a reference.
21988
+ # Corresponds to the JSON property `messageEntries`
21989
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1MessageEntry>]
21990
+ attr_accessor :message_entries
21991
+
21992
+ # Output only. List of metric details.
21993
+ # Corresponds to the JSON property `metricDetails`
21994
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail>]
21995
+ attr_accessor :metric_details
21996
+
21997
+ # Output only. Conversation level token count per section. This is an aggregated(
21998
+ # sum) result of input token of summary acorss all metrics for a single
21999
+ # conversation.
22000
+ # Corresponds to the JSON property `sectionTokens`
22001
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken>]
22002
+ attr_accessor :section_tokens
22003
+
22004
+ # Output only. Summary sections that used for summarization evaluation as a
22005
+ # reference.
22006
+ # Corresponds to the JSON property `summarySections`
22007
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarySuggestionSummarySection>]
22008
+ attr_accessor :summary_sections
22009
+
22010
+ def initialize(**args)
22011
+ update!(**args)
22012
+ end
22013
+
22014
+ # Update properties of this object
22015
+ def update!(**args)
22016
+ @message_entries = args[:message_entries] if args.key?(:message_entries)
22017
+ @metric_details = args[:metric_details] if args.key?(:metric_details)
22018
+ @section_tokens = args[:section_tokens] if args.key?(:section_tokens)
22019
+ @summary_sections = args[:summary_sections] if args.key?(:summary_sections)
22020
+ end
22021
+ end
22022
+
22023
+ # Aggregated result on metric level. This contains the evaluation results of all
22024
+ # the sections.
22025
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetail
22026
+ include Google::Apis::Core::Hashable
22027
+
22028
+ # Output only. Metrics name. e.g. accuracy, adherence, completeness.
22029
+ # Corresponds to the JSON property `metric`
22030
+ # @return [String]
22031
+ attr_accessor :metric
22032
+
22033
+ # Output only. Aggregated(average) score on this metric across all sections.
22034
+ # Corresponds to the JSON property `score`
22035
+ # @return [Float]
22036
+ attr_accessor :score
22037
+
22038
+ # Output only. List of section details.
22039
+ # Corresponds to the JSON property `sectionDetails`
22040
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail>]
22041
+ attr_accessor :section_details
22042
+
22043
+ def initialize(**args)
22044
+ update!(**args)
22045
+ end
22046
+
22047
+ # Update properties of this object
22048
+ def update!(**args)
22049
+ @metric = args[:metric] if args.key?(:metric)
22050
+ @score = args[:score] if args.key?(:score)
22051
+ @section_details = args[:section_details] if args.key?(:section_details)
22052
+ end
22053
+ end
22054
+
22055
+ # Section level result.
22056
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail
22057
+ include Google::Apis::Core::Hashable
22058
+
22059
+ # Output only. List of evaluation result. The list only contains one kind of the
22060
+ # evaluation result.
22061
+ # Corresponds to the JSON property `evaluationResults`
22062
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult>]
22063
+ attr_accessor :evaluation_results
22064
+
22065
+ # Output only. Aggregated(average) score on this section across all evaluation
22066
+ # results. Either decompositions or rubrics.
22067
+ # Corresponds to the JSON property `score`
22068
+ # @return [Float]
22069
+ attr_accessor :score
22070
+
22071
+ # Output only. The name of the summary instruction.
22072
+ # Corresponds to the JSON property `section`
22073
+ # @return [String]
22074
+ attr_accessor :section
22075
+
22076
+ # Output only. Summary for this section
22077
+ # Corresponds to the JSON property `sectionSummary`
22078
+ # @return [String]
22079
+ attr_accessor :section_summary
22080
+
22081
+ def initialize(**args)
22082
+ update!(**args)
22083
+ end
22084
+
22085
+ # Update properties of this object
22086
+ def update!(**args)
22087
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
22088
+ @score = args[:score] if args.key?(:score)
22089
+ @section = args[:section] if args.key?(:section)
22090
+ @section_summary = args[:section_summary] if args.key?(:section_summary)
22091
+ end
22092
+ end
22093
+
22094
+ # Decomposition details
22095
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition
22096
+ include Google::Apis::Core::Hashable
22097
+
22098
+ # Decomposition details for accuracy.
22099
+ # Corresponds to the JSON property `accuracyDecomposition`
22100
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition]
22101
+ attr_accessor :accuracy_decomposition
22102
+
22103
+ # Decomposition details for adherence.
22104
+ # Corresponds to the JSON property `adherenceDecomposition`
22105
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceDecomposition]
22106
+ attr_accessor :adherence_decomposition
22107
+
22108
+ def initialize(**args)
22109
+ update!(**args)
22110
+ end
22111
+
22112
+ # Update properties of this object
22113
+ def update!(**args)
22114
+ @accuracy_decomposition = args[:accuracy_decomposition] if args.key?(:accuracy_decomposition)
22115
+ @adherence_decomposition = args[:adherence_decomposition] if args.key?(:adherence_decomposition)
22116
+ end
22117
+ end
22118
+
22119
+ # Evaluation result that contains one of accuracy, adherence or completeness
22120
+ # evaluation result.
22121
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult
22122
+ include Google::Apis::Core::Hashable
22123
+
22124
+ # Decomposition details for accuracy.
22125
+ # Corresponds to the JSON property `accuracyDecomposition`
22126
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAccuracyDecomposition]
22127
+ attr_accessor :accuracy_decomposition
22128
+
22129
+ # Rubric result of the adherence evaluation. A rubric is ued to determine if the
22130
+ # summary adheres to all aspects of the given instructions.
22131
+ # Corresponds to the JSON property `adherenceRubric`
22132
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsAdherenceRubric]
22133
+ attr_accessor :adherence_rubric
22134
+
22135
+ # Rubric details of the completeness evaluation result.
22136
+ # Corresponds to the JSON property `completenessRubric`
22137
+ # @return [Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsCompletenessRubric]
22138
+ attr_accessor :completeness_rubric
22139
+
22140
+ def initialize(**args)
22141
+ update!(**args)
22142
+ end
22143
+
22144
+ # Update properties of this object
22145
+ def update!(**args)
22146
+ @accuracy_decomposition = args[:accuracy_decomposition] if args.key?(:accuracy_decomposition)
22147
+ @adherence_rubric = args[:adherence_rubric] if args.key?(:adherence_rubric)
22148
+ @completeness_rubric = args[:completeness_rubric] if args.key?(:completeness_rubric)
22149
+ end
22150
+ end
22151
+
22152
+ # Overall performance per metric. This is the aggregated score for each metric
22153
+ # across all conversations that are selected for summarization evaluation.
22154
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsOverallScoresByMetric
22155
+ include Google::Apis::Core::Hashable
22156
+
22157
+ # Output only. Metric name. e.g. accuracy, adherence, completeness.
22158
+ # Corresponds to the JSON property `metric`
22159
+ # @return [String]
22160
+ attr_accessor :metric
22161
+
22162
+ def initialize(**args)
22163
+ update!(**args)
22164
+ end
22165
+
22166
+ # Update properties of this object
22167
+ def update!(**args)
22168
+ @metric = args[:metric] if args.key?(:metric)
22169
+ end
22170
+ end
22171
+
22172
+ # A pair of section name and input token count of the input summary section.
22173
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSectionToken
22174
+ include Google::Apis::Core::Hashable
22175
+
22176
+ # Output only. The name of the summary instruction.
22177
+ # Corresponds to the JSON property `section`
22178
+ # @return [String]
22179
+ attr_accessor :section
22180
+
22181
+ # Output only. Token count.
22182
+ # Corresponds to the JSON property `tokenCount`
22183
+ # @return [Fixnum]
22184
+ attr_accessor :token_count
22185
+
22186
+ def initialize(**args)
22187
+ update!(**args)
22188
+ end
22189
+
22190
+ # Update properties of this object
22191
+ def update!(**args)
22192
+ @section = args[:section] if args.key?(:section)
22193
+ @token_count = args[:token_count] if args.key?(:token_count)
22194
+ end
22195
+ end
22196
+
22197
+ # Evaluation result per conversation(&summary), metric and section.
22198
+ class GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsSummarizationEvaluationResult
22199
+ include Google::Apis::Core::Hashable
22200
+
22201
+ # Output only. List of decompostion details
22202
+ # Corresponds to the JSON property `decompositions`
22203
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsDecomposition>]
22204
+ attr_accessor :decompositions
22205
+
22206
+ # Output only. List of evaluation results.
22207
+ # Corresponds to the JSON property `evaluationResults`
22208
+ # @return [Array<Google::Apis::DialogflowV2beta1::GoogleCloudDialogflowV2beta1SummarizationEvaluationMetricsEvaluationResult>]
22209
+ attr_accessor :evaluation_results
22210
+
22211
+ # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
22212
+ # Corresponds to the JSON property `metric`
22213
+ # @return [String]
22214
+ attr_accessor :metric
22215
+
22216
+ # Output only. score calculated from decompositions
22217
+ # Corresponds to the JSON property `score`
22218
+ # @return [Float]
22219
+ attr_accessor :score
22220
+
22221
+ # Output only. section/task name, e.g. action, situation, etc
22222
+ # Corresponds to the JSON property `section`
22223
+ # @return [String]
22224
+ attr_accessor :section
22225
+
22226
+ # Output only. Summary of this section
22227
+ # Corresponds to the JSON property `sectionSummary`
22228
+ # @return [String]
22229
+ attr_accessor :section_summary
22230
+
22231
+ # Output only. conversation session id
22232
+ # Corresponds to the JSON property `sessionId`
22233
+ # @return [String]
22234
+ attr_accessor :session_id
22235
+
22236
+ def initialize(**args)
22237
+ update!(**args)
22238
+ end
22239
+
22240
+ # Update properties of this object
22241
+ def update!(**args)
22242
+ @decompositions = args[:decompositions] if args.key?(:decompositions)
22243
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
22244
+ @metric = args[:metric] if args.key?(:metric)
22245
+ @score = args[:score] if args.key?(:score)
22246
+ @section = args[:section] if args.key?(:section)
22247
+ @section_summary = args[:section_summary] if args.key?(:section_summary)
22248
+ @session_id = args[:session_id] if args.key?(:session_id)
22249
+ end
22250
+ end
22251
+
21493
22252
  # Represents the section of summarization.
21494
22253
  class GoogleCloudDialogflowV2beta1SummarizationSection
21495
22254
  include Google::Apis::Core::Hashable