google-apis-dialogflow_v2 0.111.0 → 0.112.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.
@@ -10750,6 +10750,39 @@ module Google
10750
10750
  end
10751
10751
  end
10752
10752
 
10753
+ # A common evalaution pipeline status.
10754
+ class GoogleCloudDialogflowV2EvaluationStatus
10755
+ include Google::Apis::Core::Hashable
10756
+
10757
+ # Output only. If the value is `false`, it means the evaluation is still in
10758
+ # progress. If `true`, the operation is completed, and either `error` or `
10759
+ # response` is available.
10760
+ # Corresponds to the JSON property `done`
10761
+ # @return [Boolean]
10762
+ attr_accessor :done
10763
+ alias_method :done?, :done
10764
+
10765
+ # The `Status` type defines a logical error model that is suitable for different
10766
+ # programming environments, including REST APIs and RPC APIs. It is used by [
10767
+ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of
10768
+ # data: error code, error message, and error details. You can find out more
10769
+ # about this error model and how to work with it in the [API Design Guide](https:
10770
+ # //cloud.google.com/apis/design/errors).
10771
+ # Corresponds to the JSON property `pipelineStatus`
10772
+ # @return [Google::Apis::DialogflowV2::GoogleRpcStatus]
10773
+ attr_accessor :pipeline_status
10774
+
10775
+ def initialize(**args)
10776
+ update!(**args)
10777
+ end
10778
+
10779
+ # Update properties of this object
10780
+ def update!(**args)
10781
+ @done = args[:done] if args.key?(:done)
10782
+ @pipeline_status = args[:pipeline_status] if args.key?(:pipeline_status)
10783
+ end
10784
+ end
10785
+
10753
10786
  # Events allow for matching intents by event name instead of the natural
10754
10787
  # language input. For instance, input `` can trigger a personalized welcome
10755
10788
  # response. The parameter `name` may be used by the agent in the response: `"
@@ -11583,6 +11616,261 @@ module Google
11583
11616
  end
11584
11617
  end
11585
11618
 
11619
+ # Represents evaluation result of a generator.
11620
+ class GoogleCloudDialogflowV2GeneratorEvaluation
11621
+ include Google::Apis::Core::Hashable
11622
+
11623
+ # Output only. Completion time of this generator evaluation.
11624
+ # Corresponds to the JSON property `completeTime`
11625
+ # @return [String]
11626
+ attr_accessor :complete_time
11627
+
11628
+ # Output only. Creation time of this generator evaluation.
11629
+ # Corresponds to the JSON property `createTime`
11630
+ # @return [String]
11631
+ attr_accessor :create_time
11632
+
11633
+ # Optional. The display name of the generator evaluation. At most 64 bytes long.
11634
+ # Corresponds to the JSON property `displayName`
11635
+ # @return [String]
11636
+ attr_accessor :display_name
11637
+
11638
+ # A common evalaution pipeline status.
11639
+ # Corresponds to the JSON property `evaluationStatus`
11640
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2EvaluationStatus]
11641
+ attr_accessor :evaluation_status
11642
+
11643
+ # Generator evaluation input config.
11644
+ # Corresponds to the JSON property `generatorEvaluationConfig`
11645
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluationConfig]
11646
+ attr_accessor :generator_evaluation_config
11647
+
11648
+ # LLM generator.
11649
+ # Corresponds to the JSON property `initialGenerator`
11650
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2Generator]
11651
+ attr_accessor :initial_generator
11652
+
11653
+ # Output only. Identifier. The resource name of the evaluation. Format: `
11654
+ # projects//locations//generators// evaluations/`
11655
+ # Corresponds to the JSON property `name`
11656
+ # @return [String]
11657
+ attr_accessor :name
11658
+
11659
+ # Evaluation metrics for summarization generator.
11660
+ # Corresponds to the JSON property `summarizationMetrics`
11661
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetrics]
11662
+ attr_accessor :summarization_metrics
11663
+
11664
+ def initialize(**args)
11665
+ update!(**args)
11666
+ end
11667
+
11668
+ # Update properties of this object
11669
+ def update!(**args)
11670
+ @complete_time = args[:complete_time] if args.key?(:complete_time)
11671
+ @create_time = args[:create_time] if args.key?(:create_time)
11672
+ @display_name = args[:display_name] if args.key?(:display_name)
11673
+ @evaluation_status = args[:evaluation_status] if args.key?(:evaluation_status)
11674
+ @generator_evaluation_config = args[:generator_evaluation_config] if args.key?(:generator_evaluation_config)
11675
+ @initial_generator = args[:initial_generator] if args.key?(:initial_generator)
11676
+ @name = args[:name] if args.key?(:name)
11677
+ @summarization_metrics = args[:summarization_metrics] if args.key?(:summarization_metrics)
11678
+ end
11679
+ end
11680
+
11681
+ # Generator evaluation input config.
11682
+ class GoogleCloudDialogflowV2GeneratorEvaluationConfig
11683
+ include Google::Apis::Core::Hashable
11684
+
11685
+ # Input data config details
11686
+ # Corresponds to the JSON property `inputDataConfig`
11687
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig]
11688
+ attr_accessor :input_data_config
11689
+
11690
+ # Required. The output Cloud Storage bucket path to store eval files, e.g.
11691
+ # per_summary_accuracy_score report. This path is provided by customer and files
11692
+ # stored in it are visible to customer, no internal data should be stored in
11693
+ # this path.
11694
+ # Corresponds to the JSON property `outputGcsBucketPath`
11695
+ # @return [String]
11696
+ attr_accessor :output_gcs_bucket_path
11697
+
11698
+ # Evaluation configs for summarization generator.
11699
+ # Corresponds to the JSON property `summarizationConfig`
11700
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig]
11701
+ attr_accessor :summarization_config
11702
+
11703
+ def initialize(**args)
11704
+ update!(**args)
11705
+ end
11706
+
11707
+ # Update properties of this object
11708
+ def update!(**args)
11709
+ @input_data_config = args[:input_data_config] if args.key?(:input_data_config)
11710
+ @output_gcs_bucket_path = args[:output_gcs_bucket_path] if args.key?(:output_gcs_bucket_path)
11711
+ @summarization_config = args[:summarization_config] if args.key?(:summarization_config)
11712
+ end
11713
+ end
11714
+
11715
+ # The distinctive configs for Agent Assist conversations as the conversation
11716
+ # source.
11717
+ class GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig
11718
+ include Google::Apis::Core::Hashable
11719
+
11720
+ # Required. The end of the time range for conversations to be evaluated. Only
11721
+ # conversations ended at or before this timestamp will be sampled.
11722
+ # Corresponds to the JSON property `endTime`
11723
+ # @return [String]
11724
+ attr_accessor :end_time
11725
+
11726
+ # Required. The start of the time range for conversations to be evaluated. Only
11727
+ # conversations created at or after this timestamp will be sampled.
11728
+ # Corresponds to the JSON property `startTime`
11729
+ # @return [String]
11730
+ attr_accessor :start_time
11731
+
11732
+ def initialize(**args)
11733
+ update!(**args)
11734
+ end
11735
+
11736
+ # Update properties of this object
11737
+ def update!(**args)
11738
+ @end_time = args[:end_time] if args.key?(:end_time)
11739
+ @start_time = args[:start_time] if args.key?(:start_time)
11740
+ end
11741
+ end
11742
+
11743
+ # The distinctive configs for dataset as the conversation source.
11744
+ class GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig
11745
+ include Google::Apis::Core::Hashable
11746
+
11747
+ # Required. The identifier of the dataset to be evaluated. Format: `projects//
11748
+ # locations//datasets/`.
11749
+ # Corresponds to the JSON property `dataset`
11750
+ # @return [String]
11751
+ attr_accessor :dataset
11752
+
11753
+ def initialize(**args)
11754
+ update!(**args)
11755
+ end
11756
+
11757
+ # Update properties of this object
11758
+ def update!(**args)
11759
+ @dataset = args[:dataset] if args.key?(:dataset)
11760
+ end
11761
+ end
11762
+
11763
+ # Input data config details
11764
+ class GoogleCloudDialogflowV2GeneratorEvaluationConfigInputDataConfig
11765
+ include Google::Apis::Core::Hashable
11766
+
11767
+ # The distinctive configs for Agent Assist conversations as the conversation
11768
+ # source.
11769
+ # Corresponds to the JSON property `agentAssistInputDataConfig`
11770
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluationConfigAgentAssistInputDataConfig]
11771
+ attr_accessor :agent_assist_input_data_config
11772
+
11773
+ # The distinctive configs for dataset as the conversation source.
11774
+ # Corresponds to the JSON property `datasetInputDataConfig`
11775
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluationConfigDatasetInputDataConfig]
11776
+ attr_accessor :dataset_input_data_config
11777
+
11778
+ # Optional. The end timestamp to fetch conversation data.
11779
+ # Corresponds to the JSON property `endTime`
11780
+ # @return [String]
11781
+ attr_accessor :end_time
11782
+
11783
+ # Required. The source type of input data.
11784
+ # Corresponds to the JSON property `inputDataSourceType`
11785
+ # @return [String]
11786
+ attr_accessor :input_data_source_type
11787
+
11788
+ # Optional. Whether the summary generation is allowed when the pre-existing
11789
+ # qualified summaries are insufficient to cover the sample size.
11790
+ # Corresponds to the JSON property `isSummaryGenerationAllowed`
11791
+ # @return [Boolean]
11792
+ attr_accessor :is_summary_generation_allowed
11793
+ alias_method :is_summary_generation_allowed?, :is_summary_generation_allowed
11794
+
11795
+ # Optional. Desired number of conversation-summary pairs to be evaluated.
11796
+ # Corresponds to the JSON property `sampleSize`
11797
+ # @return [Fixnum]
11798
+ attr_accessor :sample_size
11799
+
11800
+ # Optional. The start timestamp to fetch conversation data.
11801
+ # Corresponds to the JSON property `startTime`
11802
+ # @return [String]
11803
+ attr_accessor :start_time
11804
+
11805
+ # Optional. Option to control whether summaries are generated during evaluation.
11806
+ # Corresponds to the JSON property `summaryGenerationOption`
11807
+ # @return [String]
11808
+ attr_accessor :summary_generation_option
11809
+
11810
+ def initialize(**args)
11811
+ update!(**args)
11812
+ end
11813
+
11814
+ # Update properties of this object
11815
+ def update!(**args)
11816
+ @agent_assist_input_data_config = args[:agent_assist_input_data_config] if args.key?(:agent_assist_input_data_config)
11817
+ @dataset_input_data_config = args[:dataset_input_data_config] if args.key?(:dataset_input_data_config)
11818
+ @end_time = args[:end_time] if args.key?(:end_time)
11819
+ @input_data_source_type = args[:input_data_source_type] if args.key?(:input_data_source_type)
11820
+ @is_summary_generation_allowed = args[:is_summary_generation_allowed] if args.key?(:is_summary_generation_allowed)
11821
+ @sample_size = args[:sample_size] if args.key?(:sample_size)
11822
+ @start_time = args[:start_time] if args.key?(:start_time)
11823
+ @summary_generation_option = args[:summary_generation_option] if args.key?(:summary_generation_option)
11824
+ end
11825
+ end
11826
+
11827
+ # Evaluation configs for summarization generator.
11828
+ class GoogleCloudDialogflowV2GeneratorEvaluationConfigSummarizationConfig
11829
+ include Google::Apis::Core::Hashable
11830
+
11831
+ # Optional. Version for summarization accuracy. This will determine the prompt
11832
+ # and model used at backend.
11833
+ # Corresponds to the JSON property `accuracyEvaluationVersion`
11834
+ # @return [String]
11835
+ attr_accessor :accuracy_evaluation_version
11836
+
11837
+ # Optional. Version for summarization completeness. This will determine the
11838
+ # prompt and model used at backend.
11839
+ # Corresponds to the JSON property `completenessEvaluationVersion`
11840
+ # @return [String]
11841
+ attr_accessor :completeness_evaluation_version
11842
+
11843
+ # Optional. Enable accuracy evaluation.
11844
+ # Corresponds to the JSON property `enableAccuracyEvaluation`
11845
+ # @return [Boolean]
11846
+ attr_accessor :enable_accuracy_evaluation
11847
+ alias_method :enable_accuracy_evaluation?, :enable_accuracy_evaluation
11848
+
11849
+ # Optional. Enable completeness evaluation.
11850
+ # Corresponds to the JSON property `enableCompletenessEvaluation`
11851
+ # @return [Boolean]
11852
+ attr_accessor :enable_completeness_evaluation
11853
+ alias_method :enable_completeness_evaluation?, :enable_completeness_evaluation
11854
+
11855
+ # Output only. Version for summarization evaluation.
11856
+ # Corresponds to the JSON property `evaluatorVersion`
11857
+ # @return [String]
11858
+ attr_accessor :evaluator_version
11859
+
11860
+ def initialize(**args)
11861
+ update!(**args)
11862
+ end
11863
+
11864
+ # Update properties of this object
11865
+ def update!(**args)
11866
+ @accuracy_evaluation_version = args[:accuracy_evaluation_version] if args.key?(:accuracy_evaluation_version)
11867
+ @completeness_evaluation_version = args[:completeness_evaluation_version] if args.key?(:completeness_evaluation_version)
11868
+ @enable_accuracy_evaluation = args[:enable_accuracy_evaluation] if args.key?(:enable_accuracy_evaluation)
11869
+ @enable_completeness_evaluation = args[:enable_completeness_evaluation] if args.key?(:enable_completeness_evaluation)
11870
+ @evaluator_version = args[:evaluator_version] if args.key?(:evaluator_version)
11871
+ end
11872
+ end
11873
+
11586
11874
  # Suggestion generated using a Generator.
11587
11875
  class GoogleCloudDialogflowV2GeneratorSuggestion
11588
11876
  include Google::Apis::Core::Hashable
@@ -14584,6 +14872,32 @@ module Google
14584
14872
  end
14585
14873
  end
14586
14874
 
14875
+ # Response of ListGeneratorEvaluations.
14876
+ class GoogleCloudDialogflowV2ListGeneratorEvaluationsResponse
14877
+ include Google::Apis::Core::Hashable
14878
+
14879
+ # The list of evaluations to return.
14880
+ # Corresponds to the JSON property `generatorEvaluations`
14881
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2GeneratorEvaluation>]
14882
+ attr_accessor :generator_evaluations
14883
+
14884
+ # Token to retrieve the next page of results, or empty if there are no more
14885
+ # results in the list.
14886
+ # Corresponds to the JSON property `nextPageToken`
14887
+ # @return [String]
14888
+ attr_accessor :next_page_token
14889
+
14890
+ def initialize(**args)
14891
+ update!(**args)
14892
+ end
14893
+
14894
+ # Update properties of this object
14895
+ def update!(**args)
14896
+ @generator_evaluations = args[:generator_evaluations] if args.key?(:generator_evaluations)
14897
+ @next_page_token = args[:next_page_token] if args.key?(:next_page_token)
14898
+ end
14899
+ end
14900
+
14587
14901
  # Response of ListGenerators.
14588
14902
  class GoogleCloudDialogflowV2ListGeneratorsResponse
14589
14903
  include Google::Apis::Core::Hashable
@@ -17102,6 +17416,451 @@ module Google
17102
17416
  end
17103
17417
  end
17104
17418
 
17419
+ # Evaluation metrics for summarization generator.
17420
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetrics
17421
+ include Google::Apis::Core::Hashable
17422
+
17423
+ # Output only. List of conversation details.
17424
+ # Corresponds to the JSON property `conversationDetails`
17425
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail>]
17426
+ attr_accessor :conversation_details
17427
+
17428
+ # Output only. A list of aggregated(average) scores per metric section.
17429
+ # Corresponds to the JSON property `overallMetrics`
17430
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric>]
17431
+ attr_accessor :overall_metrics
17432
+
17433
+ # Output only. Overall token per section. This is an aggregated(sum) result of
17434
+ # input token of summary acorss all conversations that are selected for
17435
+ # summarization evaluation.
17436
+ # Corresponds to the JSON property `overallSectionTokens`
17437
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken>]
17438
+ attr_accessor :overall_section_tokens
17439
+
17440
+ # Output only. User bucket uri for merged evaluation score and aggregation score
17441
+ # csv.
17442
+ # Corresponds to the JSON property `summarizationEvaluationMergedResultsUri`
17443
+ # @return [String]
17444
+ attr_accessor :summarization_evaluation_merged_results_uri
17445
+
17446
+ # Output only. A list of evaluation results per conversation(&summary), metric
17447
+ # and section.
17448
+ # Corresponds to the JSON property `summarizationEvaluationResults`
17449
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult>]
17450
+ attr_accessor :summarization_evaluation_results
17451
+
17452
+ def initialize(**args)
17453
+ update!(**args)
17454
+ end
17455
+
17456
+ # Update properties of this object
17457
+ def update!(**args)
17458
+ @conversation_details = args[:conversation_details] if args.key?(:conversation_details)
17459
+ @overall_metrics = args[:overall_metrics] if args.key?(:overall_metrics)
17460
+ @overall_section_tokens = args[:overall_section_tokens] if args.key?(:overall_section_tokens)
17461
+ @summarization_evaluation_merged_results_uri = args[:summarization_evaluation_merged_results_uri] if args.key?(:summarization_evaluation_merged_results_uri)
17462
+ @summarization_evaluation_results = args[:summarization_evaluation_results] if args.key?(:summarization_evaluation_results)
17463
+ end
17464
+ end
17465
+
17466
+ # Decomposition details for accuracy.
17467
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition
17468
+ include Google::Apis::Core::Hashable
17469
+
17470
+ # Output only. The accuracy reasoning of the breakdown point.
17471
+ # Corresponds to the JSON property `accuracyReasoning`
17472
+ # @return [String]
17473
+ attr_accessor :accuracy_reasoning
17474
+
17475
+ # Output only. Whether the breakdown point is accurate or not.
17476
+ # Corresponds to the JSON property `isAccurate`
17477
+ # @return [Boolean]
17478
+ attr_accessor :is_accurate
17479
+ alias_method :is_accurate?, :is_accurate
17480
+
17481
+ # Output only. The breakdown point of the summary.
17482
+ # Corresponds to the JSON property `point`
17483
+ # @return [String]
17484
+ attr_accessor :point
17485
+
17486
+ def initialize(**args)
17487
+ update!(**args)
17488
+ end
17489
+
17490
+ # Update properties of this object
17491
+ def update!(**args)
17492
+ @accuracy_reasoning = args[:accuracy_reasoning] if args.key?(:accuracy_reasoning)
17493
+ @is_accurate = args[:is_accurate] if args.key?(:is_accurate)
17494
+ @point = args[:point] if args.key?(:point)
17495
+ end
17496
+ end
17497
+
17498
+ # Decomposition details for adherence.
17499
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition
17500
+ include Google::Apis::Core::Hashable
17501
+
17502
+ # Output only. The adherence reasoning of the breakdown point.
17503
+ # Corresponds to the JSON property `adherenceReasoning`
17504
+ # @return [String]
17505
+ attr_accessor :adherence_reasoning
17506
+
17507
+ # Output only. Whether the breakdown point is adherent or not.
17508
+ # Corresponds to the JSON property `isAdherent`
17509
+ # @return [Boolean]
17510
+ attr_accessor :is_adherent
17511
+ alias_method :is_adherent?, :is_adherent
17512
+
17513
+ # Output only. The breakdown point of the given instructions.
17514
+ # Corresponds to the JSON property `point`
17515
+ # @return [String]
17516
+ attr_accessor :point
17517
+
17518
+ def initialize(**args)
17519
+ update!(**args)
17520
+ end
17521
+
17522
+ # Update properties of this object
17523
+ def update!(**args)
17524
+ @adherence_reasoning = args[:adherence_reasoning] if args.key?(:adherence_reasoning)
17525
+ @is_adherent = args[:is_adherent] if args.key?(:is_adherent)
17526
+ @point = args[:point] if args.key?(:point)
17527
+ end
17528
+ end
17529
+
17530
+ # Rubric result of the adherence evaluation. A rubric is ued to determine if the
17531
+ # summary adheres to all aspects of the given instructions.
17532
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric
17533
+ include Google::Apis::Core::Hashable
17534
+
17535
+ # Output only. A boolean that indicates whether the rubric question is addressed
17536
+ # or not.
17537
+ # Corresponds to the JSON property `isAddressed`
17538
+ # @return [Boolean]
17539
+ attr_accessor :is_addressed
17540
+ alias_method :is_addressed?, :is_addressed
17541
+
17542
+ # Output only. The question generated from instruction that used to evaluate
17543
+ # summary.
17544
+ # Corresponds to the JSON property `question`
17545
+ # @return [String]
17546
+ attr_accessor :question
17547
+
17548
+ # Output only. The reasoning of the rubric question is addressed or not.
17549
+ # Corresponds to the JSON property `reasoning`
17550
+ # @return [String]
17551
+ attr_accessor :reasoning
17552
+
17553
+ def initialize(**args)
17554
+ update!(**args)
17555
+ end
17556
+
17557
+ # Update properties of this object
17558
+ def update!(**args)
17559
+ @is_addressed = args[:is_addressed] if args.key?(:is_addressed)
17560
+ @question = args[:question] if args.key?(:question)
17561
+ @reasoning = args[:reasoning] if args.key?(:reasoning)
17562
+ end
17563
+ end
17564
+
17565
+ # Rubric details of the completeness evaluation result.
17566
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric
17567
+ include Google::Apis::Core::Hashable
17568
+
17569
+ # Output only. A boolean that indicates whether the rubric question is addressed
17570
+ # or not.
17571
+ # Corresponds to the JSON property `isAddressed`
17572
+ # @return [Boolean]
17573
+ attr_accessor :is_addressed
17574
+ alias_method :is_addressed?, :is_addressed
17575
+
17576
+ # Output only. The question generated from instruction that used to evaluate
17577
+ # summary.
17578
+ # Corresponds to the JSON property `question`
17579
+ # @return [String]
17580
+ attr_accessor :question
17581
+
17582
+ def initialize(**args)
17583
+ update!(**args)
17584
+ end
17585
+
17586
+ # Update properties of this object
17587
+ def update!(**args)
17588
+ @is_addressed = args[:is_addressed] if args.key?(:is_addressed)
17589
+ @question = args[:question] if args.key?(:question)
17590
+ end
17591
+ end
17592
+
17593
+ # Aggregated evaluation result on conversation level. This conatins evaluation
17594
+ # results of all the metrics and sections.
17595
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetail
17596
+ include Google::Apis::Core::Hashable
17597
+
17598
+ # Output only. Conversation transcript that used for summarization evaluation as
17599
+ # a reference.
17600
+ # Corresponds to the JSON property `messageEntries`
17601
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2MessageEntry>]
17602
+ attr_accessor :message_entries
17603
+
17604
+ # Output only. List of metric details.
17605
+ # Corresponds to the JSON property `metricDetails`
17606
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail>]
17607
+ attr_accessor :metric_details
17608
+
17609
+ # Output only. Conversation level token count per section. This is an aggregated(
17610
+ # sum) result of input token of summary acorss all metrics for a single
17611
+ # conversation.
17612
+ # Corresponds to the JSON property `sectionTokens`
17613
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken>]
17614
+ attr_accessor :section_tokens
17615
+
17616
+ # Output only. Summary sections that used for summarization evaluation as a
17617
+ # reference.
17618
+ # Corresponds to the JSON property `summarySections`
17619
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarySuggestionSummarySection>]
17620
+ attr_accessor :summary_sections
17621
+
17622
+ def initialize(**args)
17623
+ update!(**args)
17624
+ end
17625
+
17626
+ # Update properties of this object
17627
+ def update!(**args)
17628
+ @message_entries = args[:message_entries] if args.key?(:message_entries)
17629
+ @metric_details = args[:metric_details] if args.key?(:metric_details)
17630
+ @section_tokens = args[:section_tokens] if args.key?(:section_tokens)
17631
+ @summary_sections = args[:summary_sections] if args.key?(:summary_sections)
17632
+ end
17633
+ end
17634
+
17635
+ # Aggregated result on metric level. This conatins the evaluation results of all
17636
+ # the sections.
17637
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetail
17638
+ include Google::Apis::Core::Hashable
17639
+
17640
+ # Output only. Metrics name. e.g. accuracy, adherence, completeness.
17641
+ # Corresponds to the JSON property `metric`
17642
+ # @return [String]
17643
+ attr_accessor :metric
17644
+
17645
+ # Output only. Aggregated(average) score on this metric across all sections.
17646
+ # Corresponds to the JSON property `score`
17647
+ # @return [Float]
17648
+ attr_accessor :score
17649
+
17650
+ # Output only. List of section details.
17651
+ # Corresponds to the JSON property `sectionDetails`
17652
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail>]
17653
+ attr_accessor :section_details
17654
+
17655
+ def initialize(**args)
17656
+ update!(**args)
17657
+ end
17658
+
17659
+ # Update properties of this object
17660
+ def update!(**args)
17661
+ @metric = args[:metric] if args.key?(:metric)
17662
+ @score = args[:score] if args.key?(:score)
17663
+ @section_details = args[:section_details] if args.key?(:section_details)
17664
+ end
17665
+ end
17666
+
17667
+ # Section level result.
17668
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsConversationDetailMetricDetailSectionDetail
17669
+ include Google::Apis::Core::Hashable
17670
+
17671
+ # Output only. List of evaluation result. The list only contains one kind of the
17672
+ # evaluation result.
17673
+ # Corresponds to the JSON property `evaluationResults`
17674
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult>]
17675
+ attr_accessor :evaluation_results
17676
+
17677
+ # Output only. Aggregated(average) score on this section across all evaluation
17678
+ # results. Either decompositions or rubrics.
17679
+ # Corresponds to the JSON property `score`
17680
+ # @return [Float]
17681
+ attr_accessor :score
17682
+
17683
+ # Output only. The name of the summary instruction.
17684
+ # Corresponds to the JSON property `section`
17685
+ # @return [String]
17686
+ attr_accessor :section
17687
+
17688
+ # Output only. Summary for this section
17689
+ # Corresponds to the JSON property `sectionSummary`
17690
+ # @return [String]
17691
+ attr_accessor :section_summary
17692
+
17693
+ def initialize(**args)
17694
+ update!(**args)
17695
+ end
17696
+
17697
+ # Update properties of this object
17698
+ def update!(**args)
17699
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
17700
+ @score = args[:score] if args.key?(:score)
17701
+ @section = args[:section] if args.key?(:section)
17702
+ @section_summary = args[:section_summary] if args.key?(:section_summary)
17703
+ end
17704
+ end
17705
+
17706
+ # Decomposition details
17707
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition
17708
+ include Google::Apis::Core::Hashable
17709
+
17710
+ # Decomposition details for accuracy.
17711
+ # Corresponds to the JSON property `accuracyDecomposition`
17712
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition]
17713
+ attr_accessor :accuracy_decomposition
17714
+
17715
+ # Decomposition details for adherence.
17716
+ # Corresponds to the JSON property `adherenceDecomposition`
17717
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceDecomposition]
17718
+ attr_accessor :adherence_decomposition
17719
+
17720
+ def initialize(**args)
17721
+ update!(**args)
17722
+ end
17723
+
17724
+ # Update properties of this object
17725
+ def update!(**args)
17726
+ @accuracy_decomposition = args[:accuracy_decomposition] if args.key?(:accuracy_decomposition)
17727
+ @adherence_decomposition = args[:adherence_decomposition] if args.key?(:adherence_decomposition)
17728
+ end
17729
+ end
17730
+
17731
+ # Evaluation result that contains one of accuracy, adherence or completeness
17732
+ # evaluation result.
17733
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult
17734
+ include Google::Apis::Core::Hashable
17735
+
17736
+ # Decomposition details for accuracy.
17737
+ # Corresponds to the JSON property `accuracyDecomposition`
17738
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsAccuracyDecomposition]
17739
+ attr_accessor :accuracy_decomposition
17740
+
17741
+ # Rubric result of the adherence evaluation. A rubric is ued to determine if the
17742
+ # summary adheres to all aspects of the given instructions.
17743
+ # Corresponds to the JSON property `adherenceRubric`
17744
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsAdherenceRubric]
17745
+ attr_accessor :adherence_rubric
17746
+
17747
+ # Rubric details of the completeness evaluation result.
17748
+ # Corresponds to the JSON property `completenessRubric`
17749
+ # @return [Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsCompletenessRubric]
17750
+ attr_accessor :completeness_rubric
17751
+
17752
+ def initialize(**args)
17753
+ update!(**args)
17754
+ end
17755
+
17756
+ # Update properties of this object
17757
+ def update!(**args)
17758
+ @accuracy_decomposition = args[:accuracy_decomposition] if args.key?(:accuracy_decomposition)
17759
+ @adherence_rubric = args[:adherence_rubric] if args.key?(:adherence_rubric)
17760
+ @completeness_rubric = args[:completeness_rubric] if args.key?(:completeness_rubric)
17761
+ end
17762
+ end
17763
+
17764
+ # Overall performance per metric. This is the aggregated score for each metric
17765
+ # across all conversations that are selected for summarization evaluation.
17766
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsOverallScoresByMetric
17767
+ include Google::Apis::Core::Hashable
17768
+
17769
+ # Output only. Metric name. e.g. accuracy, adherence, completeness.
17770
+ # Corresponds to the JSON property `metric`
17771
+ # @return [String]
17772
+ attr_accessor :metric
17773
+
17774
+ def initialize(**args)
17775
+ update!(**args)
17776
+ end
17777
+
17778
+ # Update properties of this object
17779
+ def update!(**args)
17780
+ @metric = args[:metric] if args.key?(:metric)
17781
+ end
17782
+ end
17783
+
17784
+ # A pair of section name and input token count of the input summary section.
17785
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsSectionToken
17786
+ include Google::Apis::Core::Hashable
17787
+
17788
+ # Output only. The name of the summary instruction.
17789
+ # Corresponds to the JSON property `section`
17790
+ # @return [String]
17791
+ attr_accessor :section
17792
+
17793
+ # Output only. Token count.
17794
+ # Corresponds to the JSON property `tokenCount`
17795
+ # @return [Fixnum]
17796
+ attr_accessor :token_count
17797
+
17798
+ def initialize(**args)
17799
+ update!(**args)
17800
+ end
17801
+
17802
+ # Update properties of this object
17803
+ def update!(**args)
17804
+ @section = args[:section] if args.key?(:section)
17805
+ @token_count = args[:token_count] if args.key?(:token_count)
17806
+ end
17807
+ end
17808
+
17809
+ # Evaluation result per conversation(&summary), metric and section.
17810
+ class GoogleCloudDialogflowV2SummarizationEvaluationMetricsSummarizationEvaluationResult
17811
+ include Google::Apis::Core::Hashable
17812
+
17813
+ # Output only. List of decompostion details
17814
+ # Corresponds to the JSON property `decompositions`
17815
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsDecomposition>]
17816
+ attr_accessor :decompositions
17817
+
17818
+ # Output only. List of evaluation results.
17819
+ # Corresponds to the JSON property `evaluationResults`
17820
+ # @return [Array<Google::Apis::DialogflowV2::GoogleCloudDialogflowV2SummarizationEvaluationMetricsEvaluationResult>]
17821
+ attr_accessor :evaluation_results
17822
+
17823
+ # Output only. metric name, e.g. accuracy, completeness, adherence, etc.
17824
+ # Corresponds to the JSON property `metric`
17825
+ # @return [String]
17826
+ attr_accessor :metric
17827
+
17828
+ # Output only. score calculated from decompositions
17829
+ # Corresponds to the JSON property `score`
17830
+ # @return [Float]
17831
+ attr_accessor :score
17832
+
17833
+ # Output only. section/task name, e.g. action, situation, etc
17834
+ # Corresponds to the JSON property `section`
17835
+ # @return [String]
17836
+ attr_accessor :section
17837
+
17838
+ # Output only. Summary of this section
17839
+ # Corresponds to the JSON property `sectionSummary`
17840
+ # @return [String]
17841
+ attr_accessor :section_summary
17842
+
17843
+ # Output only. conversation session id
17844
+ # Corresponds to the JSON property `sessionId`
17845
+ # @return [String]
17846
+ attr_accessor :session_id
17847
+
17848
+ def initialize(**args)
17849
+ update!(**args)
17850
+ end
17851
+
17852
+ # Update properties of this object
17853
+ def update!(**args)
17854
+ @decompositions = args[:decompositions] if args.key?(:decompositions)
17855
+ @evaluation_results = args[:evaluation_results] if args.key?(:evaluation_results)
17856
+ @metric = args[:metric] if args.key?(:metric)
17857
+ @score = args[:score] if args.key?(:score)
17858
+ @section = args[:section] if args.key?(:section)
17859
+ @section_summary = args[:section_summary] if args.key?(:section_summary)
17860
+ @session_id = args[:session_id] if args.key?(:session_id)
17861
+ end
17862
+ end
17863
+
17105
17864
  # Represents the section of summarization.
17106
17865
  class GoogleCloudDialogflowV2SummarizationSection
17107
17866
  include Google::Apis::Core::Hashable