Class: Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec

Inherits:

Object

• Object
• Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec

Extended by:

Protobuf::MessageExts::ClassMethods

Includes:

Protobuf::MessageExts

Defined in:

proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb

Overview

Answer generation specification.

Defined Under Namespace

Classes: ModelSpec, PromptSpec

Instance Attribute Summary

• #answer_language_code ⇒ ::String

  Language code for Answer.

• #ignore_adversarial_query ⇒ ::Boolean

  Specifies whether to filter out adversarial queries.

• #ignore_jail_breaking_query ⇒ ::Boolean

  Optional.

• #ignore_low_relevant_content ⇒ ::Boolean

  Specifies whether to filter out queries that have low relevance.

• #ignore_non_answer_seeking_query ⇒ ::Boolean

  Specifies whether to filter out queries that are not answer-seeking.

• #include_citations ⇒ ::Boolean

  Specifies whether to include citation metadata in the answer.

• #model_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec

  Answer generation model specification.

• #prompt_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::PromptSpec

  Answer generation prompt specification.

Instance Attribute Details

#answer_language_code ⇒ ::String

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_adversarial_query ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_jail_breaking_query ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_low_relevant_content ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#ignore_non_answer_seeking_query ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#include_citations ⇒ ::Boolean

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#model_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::ModelSpec

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#prompt_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::AnswerQueryRequest::AnswerGenerationSpec::PromptSpec

# File 'proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb', line 467

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

  # Answer Generation Model specification.
  # @!attribute [rw] model_version
  #   @return [::String]
  #     Model version. If not set, it will use the default stable model.
  #     Allowed values are: stable, preview.
  class ModelSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Answer generation prompt specification.
  # @!attribute [rw] preamble
  #   @return [::String]
  #     Customized preamble.
  class PromptSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end