Class: Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig

Inherits:

Object

• Object
• Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb

Overview

Generator evaluation input config.

Defined Under Namespace

Modules: InputDataSourceType Classes: AgentAssistInputDataConfig, DatasetInputDataConfig, InputDataConfig, SummarizationConfig

Instance Attribute Summary

• #input_data_config ⇒ ::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig

  Required.

• #output_gcs_bucket_path ⇒ ::String

  Required.

• #summarization_config ⇒ ::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::SummarizationConfig

  Evaluation configs for summarization generator.

Instance Attribute Details

#input_data_config ⇒ ::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig

Returns Required. The config/source of input data.

Returns:

• (::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig) —

  Required. The config/source of input data.

# File 'proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb', line 392

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

  # The distinctive configs for Agent Assist conversations as the conversation
  # source.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The start of the time range for conversations to be evaluated.
  #     Only conversations created at or after this timestamp will be sampled.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The end of the time range for conversations to be evaluated.
  #     Only conversations ended at or before this timestamp will be sampled.
  class AgentAssistInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The distinctive configs for dataset as the conversation source.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The identifier of the dataset to be evaluated.
  #     Format:
  #     `projects/<ProjectId>/locations/<LocationID>/datasets/<DatasetID>`.
  class DatasetInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Input data config details
  # @!attribute [rw] input_data_source_type
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataSourceType]
  #     Required. The source type of input data.
  # @!attribute [rw] start_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The start timestamp to fetch conversation data.
  # @!attribute [rw] end_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp to fetch conversation data.
  # @!attribute [rw] sample_size
  #   @return [::Integer]
  #     Optional. Desired number of conversation-summary pairs to be evaluated.
  # @!attribute [rw] is_summary_generation_allowed
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Whether the summary generation is allowed when the pre-existing
  #     qualified summaries are insufficient to cover the sample size.
  # @!attribute [rw] summary_generation_option
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig::SummaryGenerationOption]
  #     Optional. Option to control whether summaries are generated during
  #     evaluation.
  # @!attribute [rw] agent_assist_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::AgentAssistInputDataConfig]
  #     The distinctive configs for Agent Assist conversations as the
  #     conversation source.
  #
  #     Note: The following fields are mutually exclusive: `agent_assist_input_data_config`, `dataset_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] dataset_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::DatasetInputDataConfig]
  #     The distinctive configs for dataset as the conversation source.
  #
  #     Note: The following fields are mutually exclusive: `dataset_input_data_config`, `agent_assist_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class InputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summary generation options.
    module SummaryGenerationOption
      # Default option will not be used
      SUMMARY_GENERATION_OPTION_UNSPECIFIED = 0

      # Always Generate summary for all conversations.
      ALWAYS_GENERATE = 1

      # Gnerate only missing summaries.
      GENERATE_IF_MISSING = 2

      # Do not generate new summaries. Only use existing summaries found.
      DO_NOT_GENERATE = 3
    end
  end

  # Evaluation configs for summarization generator.
  # @!attribute [rw] enable_accuracy_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable accuracy evaluation.
  # @!attribute [rw] accuracy_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization accuracy. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] enable_completeness_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable completeness evaluation.
  # @!attribute [rw] completeness_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization completeness. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] evaluator_version
  #   @return [::String]
  #     Optional. Version for summarization evaluation.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of input data source type.
  module InputDataSourceType
    # Unspecified InputDataSourceType. Should not be used.
    INPUT_DATA_SOURCE_TYPE_UNSPECIFIED = 0

    # Fetch data from Agent Assist storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    AGENT_ASSIST_CONVERSATIONS = 1

    # Fetch data from Insights storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    INSIGHTS_CONVERSATIONS = 2
  end
end

#output_gcs_bucket_path ⇒ ::String

Returns Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.

Returns:

• (::String) —

  Required. The output Cloud Storage bucket path to store eval files, e.g. per_summary_accuracy_score report. This path is provided by customer and files stored in it are visible to customer, no internal data should be stored in this path.

# File 'proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb', line 392

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

  # The distinctive configs for Agent Assist conversations as the conversation
  # source.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The start of the time range for conversations to be evaluated.
  #     Only conversations created at or after this timestamp will be sampled.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The end of the time range for conversations to be evaluated.
  #     Only conversations ended at or before this timestamp will be sampled.
  class AgentAssistInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The distinctive configs for dataset as the conversation source.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The identifier of the dataset to be evaluated.
  #     Format:
  #     `projects/<ProjectId>/locations/<LocationID>/datasets/<DatasetID>`.
  class DatasetInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Input data config details
  # @!attribute [rw] input_data_source_type
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataSourceType]
  #     Required. The source type of input data.
  # @!attribute [rw] start_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The start timestamp to fetch conversation data.
  # @!attribute [rw] end_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp to fetch conversation data.
  # @!attribute [rw] sample_size
  #   @return [::Integer]
  #     Optional. Desired number of conversation-summary pairs to be evaluated.
  # @!attribute [rw] is_summary_generation_allowed
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Whether the summary generation is allowed when the pre-existing
  #     qualified summaries are insufficient to cover the sample size.
  # @!attribute [rw] summary_generation_option
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig::SummaryGenerationOption]
  #     Optional. Option to control whether summaries are generated during
  #     evaluation.
  # @!attribute [rw] agent_assist_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::AgentAssistInputDataConfig]
  #     The distinctive configs for Agent Assist conversations as the
  #     conversation source.
  #
  #     Note: The following fields are mutually exclusive: `agent_assist_input_data_config`, `dataset_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] dataset_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::DatasetInputDataConfig]
  #     The distinctive configs for dataset as the conversation source.
  #
  #     Note: The following fields are mutually exclusive: `dataset_input_data_config`, `agent_assist_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class InputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summary generation options.
    module SummaryGenerationOption
      # Default option will not be used
      SUMMARY_GENERATION_OPTION_UNSPECIFIED = 0

      # Always Generate summary for all conversations.
      ALWAYS_GENERATE = 1

      # Gnerate only missing summaries.
      GENERATE_IF_MISSING = 2

      # Do not generate new summaries. Only use existing summaries found.
      DO_NOT_GENERATE = 3
    end
  end

  # Evaluation configs for summarization generator.
  # @!attribute [rw] enable_accuracy_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable accuracy evaluation.
  # @!attribute [rw] accuracy_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization accuracy. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] enable_completeness_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable completeness evaluation.
  # @!attribute [rw] completeness_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization completeness. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] evaluator_version
  #   @return [::String]
  #     Optional. Version for summarization evaluation.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of input data source type.
  module InputDataSourceType
    # Unspecified InputDataSourceType. Should not be used.
    INPUT_DATA_SOURCE_TYPE_UNSPECIFIED = 0

    # Fetch data from Agent Assist storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    AGENT_ASSIST_CONVERSATIONS = 1

    # Fetch data from Insights storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    INSIGHTS_CONVERSATIONS = 2
  end
end

#summarization_config ⇒ ::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::SummarizationConfig

Returns Evaluation configs for summarization generator.

Returns:

• (::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::SummarizationConfig) —

  Evaluation configs for summarization generator.

# File 'proto_docs/google/cloud/dialogflow/v2/generator_evaluation.rb', line 392

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

  # The distinctive configs for Agent Assist conversations as the conversation
  # source.
  # @!attribute [rw] start_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The start of the time range for conversations to be evaluated.
  #     Only conversations created at or after this timestamp will be sampled.
  # @!attribute [rw] end_time
  #   @return [::Google::Protobuf::Timestamp]
  #     Required. The end of the time range for conversations to be evaluated.
  #     Only conversations ended at or before this timestamp will be sampled.
  class AgentAssistInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The distinctive configs for dataset as the conversation source.
  # @!attribute [rw] dataset
  #   @return [::String]
  #     Required. The identifier of the dataset to be evaluated.
  #     Format:
  #     `projects/<ProjectId>/locations/<LocationID>/datasets/<DatasetID>`.
  class DatasetInputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Input data config details
  # @!attribute [rw] input_data_source_type
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataSourceType]
  #     Required. The source type of input data.
  # @!attribute [rw] start_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The start timestamp to fetch conversation data.
  # @!attribute [rw] end_time
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Google::Protobuf::Timestamp]
  #     Optional. The end timestamp to fetch conversation data.
  # @!attribute [rw] sample_size
  #   @return [::Integer]
  #     Optional. Desired number of conversation-summary pairs to be evaluated.
  # @!attribute [rw] is_summary_generation_allowed
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Whether the summary generation is allowed when the pre-existing
  #     qualified summaries are insufficient to cover the sample size.
  # @!attribute [rw] summary_generation_option
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::InputDataConfig::SummaryGenerationOption]
  #     Optional. Option to control whether summaries are generated during
  #     evaluation.
  # @!attribute [rw] agent_assist_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::AgentAssistInputDataConfig]
  #     The distinctive configs for Agent Assist conversations as the
  #     conversation source.
  #
  #     Note: The following fields are mutually exclusive: `agent_assist_input_data_config`, `dataset_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  # @!attribute [rw] dataset_input_data_config
  #   @return [::Google::Cloud::Dialogflow::V2::GeneratorEvaluationConfig::DatasetInputDataConfig]
  #     The distinctive configs for dataset as the conversation source.
  #
  #     Note: The following fields are mutually exclusive: `dataset_input_data_config`, `agent_assist_input_data_config`. If a field in that set is populated, all other fields in the set will automatically be cleared.
  class InputDataConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Summary generation options.
    module SummaryGenerationOption
      # Default option will not be used
      SUMMARY_GENERATION_OPTION_UNSPECIFIED = 0

      # Always Generate summary for all conversations.
      ALWAYS_GENERATE = 1

      # Gnerate only missing summaries.
      GENERATE_IF_MISSING = 2

      # Do not generate new summaries. Only use existing summaries found.
      DO_NOT_GENERATE = 3
    end
  end

  # Evaluation configs for summarization generator.
  # @!attribute [rw] enable_accuracy_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable accuracy evaluation.
  # @!attribute [rw] accuracy_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization accuracy. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] enable_completeness_evaluation
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::Boolean]
  #     Optional. Enable completeness evaluation.
  # @!attribute [rw] completeness_evaluation_version
  #   @deprecated This field is deprecated and may be removed in the next major version update.
  #   @return [::String]
  #     Optional. Version for summarization completeness. This will determine the
  #     prompt and model used at backend.
  # @!attribute [rw] evaluator_version
  #   @return [::String]
  #     Optional. Version for summarization evaluation.
  class SummarizationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Enumeration of input data source type.
  module InputDataSourceType
    # Unspecified InputDataSourceType. Should not be used.
    INPUT_DATA_SOURCE_TYPE_UNSPECIFIED = 0

    # Fetch data from Agent Assist storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    AGENT_ASSIST_CONVERSATIONS = 1

    # Fetch data from Insights storage. If this source type is chosen,
    # input_data_config.start_time and input_data_config.end_timestamp must be
    # provided.
    INSIGHTS_CONVERSATIONS = 2
  end
end