Class: Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo

Inherits:

Object

Object
Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo

show all

Extended by:: Protobuf::MessageExts::ClassMethods

Includes:: Protobuf::MessageExts

Defined in:: proto_docs/google/cloud/dialogflow/v2/participant.rb

Overview

Debug information related to Knowledge Assist feature.

Defined Under Namespace

Modules: QueryCategorizationFailureReason, QueryGenerationFailureReason Classes: KnowledgeAssistBehavior

Instance Attribute Summary collapse

#datastore_response_reason ⇒ ::Google::Cloud::Dialogflow::V2::DatastoreResponseReason
Response reason from datastore which indicates data serving status or answer quality degradation.
#ingested_context_reference_debug_info ⇒ ::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo
Information about parameters ingested for search knowledge.
#knowledge_assist_behavior ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior
Configured behaviors for Knowedge Assist.
#query_categorization_failure_reason ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason
Reason for query categorization.
#query_generation_failure_reason ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason
Reason for query generation.
#service_latency ⇒ ::Google::Cloud::Dialogflow::V2::ServiceLatency
The latency of the service.

Instance Attribute Details

#datastore_response_reason ⇒ `::Google::Cloud::Dialogflow::V2::DatastoreResponseReason`

Returns Response reason from datastore which indicates data serving status or answer quality degradation.

Returns:

(::Google::Cloud::Dialogflow::V2::DatastoreResponseReason) —
Response reason from datastore which indicates data serving status or answer quality degradation.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

#ingested_context_reference_debug_info ⇒ `::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo`

Returns Information about parameters ingested for search knowledge.

Returns:

(::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo) —
Information about parameters ingested for search knowledge.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

#knowledge_assist_behavior ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior`

Returns Configured behaviors for Knowedge Assist.

Returns:

(::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior) —
Configured behaviors for Knowedge Assist.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

#query_categorization_failure_reason ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason`

Returns Reason for query categorization.

Returns:

(::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason) —
Reason for query categorization.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

#query_generation_failure_reason ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason`

Returns Reason for query generation.

Returns:

(::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason) —
Reason for query generation.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

#service_latency ⇒ `::Google::Cloud::Dialogflow::V2::ServiceLatency`

Returns The latency of the service.

Returns:

(::Google::Cloud::Dialogflow::V2::ServiceLatency) —
The latency of the service.

# File 'proto_docs/google/cloud/dialogflow/v2/participant.rb', line 1347

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

  # Configured behaviors for Knowedge Assist.
  # @!attribute [rw] answer_generation_rewriter_on
  #   @return [::Boolean]
  #     Whether data store agent rewriter was turned off for the request.
  # @!attribute [rw] end_user_metadata_included
  #   @return [::Boolean]
  #     Whether end_user_metadata is included in the data store agent call.
  # @!attribute [rw] return_query_only
  #   @return [::Boolean]
  #     Whether customers configured to return query only in the
  #     conversation profile.
  # @!attribute [rw] use_pubsub_delivery
  #   @return [::Boolean]
  #     Whether customers configured to use pubsub to deliver.
  # @!attribute [rw] disable_sync_delivery
  #   @return [::Boolean]
  #     Whether customers configured to disable the synchronous delivery of
  #     Knowedge Assist response.
  # @!attribute [rw] previous_queries_included
  #   @return [::Boolean]
  #     Whether previously suggested queries are included in the query generation
  #     process.
  # @!attribute [rw] use_translated_message
  #   @return [::Boolean]
  #     Translated message is included in query generation process.
  # @!attribute [rw] use_custom_safety_filter_level
  #   @return [::Boolean]
  #     Safety filter is adjusted by user.
  # @!attribute [rw] conversation_transcript_has_mixed_languages
  #   @return [::Boolean]
  #     Conversation transcript has mixed languages.
  # @!attribute [rw] query_generation_agent_language_mismatch
  #   @return [::Boolean]
  #     Whether the agent language from the translation generator mismatches the
  #     end-user language.
  # @!attribute [rw] query_generation_end_user_language_mismatch
  #   @return [::Boolean]
  #     Whether the end-user language from the translation generator mismatches
  #     the end-user language.
  # @!attribute [rw] third_party_connector_allowed
  #   @return [::Boolean]
  #     This field indicates whether third party connectors are enabled for the
  #     project
  # @!attribute [rw] multiple_queries_generated
  #   @return [::Boolean]
  #     Indicates that the query generation model generated multiple queries.
  # @!attribute [rw] query_contained_search_context
  #   @return [::Boolean]
  #     Indicates that the generated query contains search context.
  # @!attribute [rw] invalid_items_query_suggestion_skipped
  #   @return [::Boolean]
  #     Indicates that invalid items were skipped when parsing the LLM response.
  # @!attribute [rw] primary_query_redacted_and_replaced
  #   @return [::Boolean]
  #     True if the primary suggested query was redacted and replaced by an
  #     additional query.
  # @!attribute [rw] appended_search_context_count
  #   @return [::Integer]
  #     The number of search contexts appended to the query.
  class KnowledgeAssistBehavior
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Reason for query generation failure.
  module QueryGenerationFailureReason
    # Default value.
    QUERY_GENERATION_FAILURE_REASON_UNSPECIFIED = 0

    # Query generation is blocked due to out of quota.
    QUERY_GENERATION_OUT_OF_QUOTA = 1

    # Call to Knowedge Assist query generation model fails.
    QUERY_GENERATION_FAILED = 2

    # Query generation model decides that there is no new topic change or
    # there has been similar queries generated in the previous turns.
    QUERY_GENERATION_NO_QUERY_GENERATED = 3

    # Knowedge Assist generated query is blocked by RAI (Responsible AI).
    QUERY_GENERATION_RAI_FAILED = 4

    # Query generation is blocked by Knowledge Assist conversation profile
    # level / agent id level filtering.
    NOT_IN_ALLOWLIST = 5

    # The generated query is blocked due to redaction.
    QUERY_GENERATION_QUERY_REDACTED = 6

    # Query generation failed due to LLM response parse failure.
    QUERY_GENERATION_LLM_RESPONSE_PARSE_FAILED = 10

    # The conversation has no messages.
    QUERY_GENERATION_EMPTY_CONVERSATION = 11

    # The last message in the conversation is empty.
    QUERY_GENERATION_EMPTY_LAST_MESSAGE = 12

    # The trigger event condition is not met.
    # This occurs in the following scenarios:
    # 1. The trigger_event is CUSTOMER_MESSAGE or UNSPECIFIED, but the last
    #    message is not from the customer.
    # 2. The trigger_event is AGENT_MESSAGE, but the last message is not from
    #    the agent.
    QUERY_GENERATION_TRIGGERING_EVENT_CONDITION_NOT_MET = 13
  end

  # Reason for query categorization failure.
  module QueryCategorizationFailureReason
    # Default value.
    QUERY_CATEGORIZATION_FAILURE_REASON_UNSPECIFIED = 0

    # Vertex AI Search config supplied for query categorization is invalid.
    QUERY_CATEGORIZATION_INVALID_CONFIG = 1

    # Vertex AI Search result does not contain a query categorization result.
    QUERY_CATEGORIZATION_RESULT_NOT_FOUND = 2

    # Vertex AI Search call fails.
    QUERY_CATEGORIZATION_FAILED = 3
  end
end

Class: Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo

Overview

Defined Under Namespace

Instance Attribute Summary collapse

Instance Attribute Details

#datastore_response_reason ⇒ ::Google::Cloud::Dialogflow::V2::DatastoreResponseReason

#ingested_context_reference_debug_info ⇒ ::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo

#knowledge_assist_behavior ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior

#query_categorization_failure_reason ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason

#query_generation_failure_reason ⇒ ::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason

#service_latency ⇒ ::Google::Cloud::Dialogflow::V2::ServiceLatency

#datastore_response_reason ⇒ `::Google::Cloud::Dialogflow::V2::DatastoreResponseReason`

#ingested_context_reference_debug_info ⇒ `::Google::Cloud::Dialogflow::V2::IngestedContextReferenceDebugInfo`

#knowledge_assist_behavior ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::KnowledgeAssistBehavior`

#query_categorization_failure_reason ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryCategorizationFailureReason`

#query_generation_failure_reason ⇒ `::Google::Cloud::Dialogflow::V2::KnowledgeAssistDebugInfo::QueryGenerationFailureReason`

#service_latency ⇒ `::Google::Cloud::Dialogflow::V2::ServiceLatency`