Class: Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/discoveryengine/v1/search_service.rb
Overview
A specification for configuring the behavior of content search.
Defined Under Namespace
Classes: ExtractiveContentSpec, SnippetSpec, SummarySpec
Instance Attribute Summary collapse
-
#extractive_content_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec
If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
-
#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec
If
snippetSpec
is not specified, snippets are not included in the search response. -
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec
If
summarySpec
is not specified, summaries are not included in the search response.
Instance Attribute Details
#extractive_content_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::ExtractiveContentSpec
Returns If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 |
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 495 class ContentSearchSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A specification for configuring snippets in a search response. # @!attribute [rw] max_snippet_count # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Integer] # [DEPRECATED] This field is deprecated. To control snippet return, use # `return_snippet` field. For backwards compatibility, we will return # snippet if max_snippet_count > 0. # @!attribute [rw] reference_only # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Boolean] # [DEPRECATED] This field is deprecated and will have no affect on the # snippet. # @!attribute [rw] return_snippet # @return [::Boolean] # If `true`, then return snippet. If no snippet can be generated, we # return "No snippet is available for this page." A `snippet_status` with # `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. class SnippetSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A specification for configuring a summary returned in a search # response. # @!attribute [rw] summary_result_count # @return [::Integer] # The number of top results to generate the summary from. If the number # of results returned is less than `summaryResultCount`, the summary is # generated from all of the results. # # At most 10 results for documents mode, or 50 for chunks mode, can be # used to generate a summary. The chunks mode is used when # [SearchRequest.ContentSearchSpec.search_result_mode][] is set to # [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. # @!attribute [rw] include_citations # @return [::Boolean] # Specifies whether to include citations in the summary. The default # value is `false`. # # When this field is set to `true`, summaries include in-line citation # numbers. # # Example summary including citations: # # BigQuery is Google Cloud's fully managed and completely serverless # enterprise data warehouse [1]. BigQuery supports all data types, works # across clouds, and has built-in machine learning and business # intelligence, all within a unified platform [2, 3]. # # The citation numbers refer to the returned search results and are # 1-indexed. For example, [1] means that the sentence is attributed to # the first search result. [2, 3] means that the sentence is attributed # to both the second and third search results. # @!attribute [rw] ignore_adversarial_query # @return [::Boolean] # Specifies whether to filter out adversarial queries. The default value # is `false`. # # Google employs search-query classification to detect adversarial # queries. No summary is returned if the search query is classified as an # adversarial query. For example, a user might ask a question regarding # negative comments about the company or submit a query designed to # generate unsafe, policy-violating output. If this field is set to # `true`, we skip generating summaries for adversarial queries and return # fallback messages instead. # @!attribute [rw] ignore_non_summary_seeking_query # @return [::Boolean] # Specifies whether to filter out queries that are not summary-seeking. # The default value is `false`. # # Google employs search-query classification to detect summary-seeking # queries. No summary is returned if the search query is classified as a # non-summary seeking query. For example, `why is the sky blue` and `Who # is the best soccer player in the world?` are summary-seeking queries, # but `SFO airport` and `world cup 2026` are not. They are most likely # navigational queries. If this field is set to `true`, we skip # generating summaries for non-summary seeking queries and return # fallback messages instead. # @!attribute [rw] model_prompt_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec] # If specified, the spec will be used to modify the prompt provided to # the LLM. # @!attribute [rw] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). # Note: This is an experimental feature. # @!attribute [rw] model_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec] # If specified, the spec will be used to modify the model specification # provided to the LLM. # @!attribute [rw] use_semantic_chunks # @return [::Boolean] # If true, answer will be generated from most relevant chunks from top # search results. This feature will improve summary quality. # Note that with this feature enabled, not all top search results # will be referenced and included in the reference list, so the citation # source index only points to the search results listed in the reference # list. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Specification of the prompt to use with the model. # @!attribute [rw] preamble # @return [::String] # Text at the beginning of the prompt that instructs the assistant. # Examples are available in the user guide. class ModelPromptSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specification of the model. # @!attribute [rw] version # @return [::String] # The model version used to generate the summary. # # Supported values are: # # * `stable`: string. Default value when no value is specified. Uses a # generally available, fine-tuned model. For more information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). # * `preview`: string. (Public preview) Uses a preview model. For more # information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # A specification for configuring the extractive content in a search # response. # @!attribute [rw] max_extractive_answer_count # @return [::Integer] # The maximum number of extractive answers returned in each search # result. # # An extractive answer is a verbatim answer extracted from the original # document, which provides a precise and contextually relevant answer to # the search query. # # If the number of matching answers is less than the # `max_extractive_answer_count`, return all of the answers. Otherwise, # return the `max_extractive_answer_count`. # # At most five answers are returned for each # {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult SearchResult}. # @!attribute [rw] max_extractive_segment_count # @return [::Integer] # The max number of extractive segments returned in each search result. # Only applied if the # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to # {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED} # or # {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types} # is # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}. # # An extractive segment is a text segment extracted from the original # document that is relevant to the search query, and, in general, more # verbose than an extractive answer. The segment could then be used as # input for LLMs to generate summaries and answers. # # If the number of matching segments is less than # `max_extractive_segment_count`, return all of the segments. Otherwise, # return the `max_extractive_segment_count`. # @!attribute [rw] return_extractive_segment_score # @return [::Boolean] # Specifies whether to return the confidence score from the extractive # segments in each search result. This feature is available only for new # or allowlisted data stores. To allowlist your data store, # contact your Customer Engineer. The default value is `false`. # @!attribute [rw] num_previous_segments # @return [::Integer] # Specifies whether to also include the adjacent from each selected # segments. # Return at most `num_previous_segments` segments before each selected # segments. # @!attribute [rw] num_next_segments # @return [::Integer] # Return at most `num_next_segments` segments after each selected # segments. class ExtractiveContentSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#snippet_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SnippetSpec
Returns If snippetSpec
is not specified, snippets are not included in the
search response.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 |
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 495 class ContentSearchSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A specification for configuring snippets in a search response. # @!attribute [rw] max_snippet_count # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Integer] # [DEPRECATED] This field is deprecated. To control snippet return, use # `return_snippet` field. For backwards compatibility, we will return # snippet if max_snippet_count > 0. # @!attribute [rw] reference_only # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Boolean] # [DEPRECATED] This field is deprecated and will have no affect on the # snippet. # @!attribute [rw] return_snippet # @return [::Boolean] # If `true`, then return snippet. If no snippet can be generated, we # return "No snippet is available for this page." A `snippet_status` with # `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. class SnippetSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A specification for configuring a summary returned in a search # response. # @!attribute [rw] summary_result_count # @return [::Integer] # The number of top results to generate the summary from. If the number # of results returned is less than `summaryResultCount`, the summary is # generated from all of the results. # # At most 10 results for documents mode, or 50 for chunks mode, can be # used to generate a summary. The chunks mode is used when # [SearchRequest.ContentSearchSpec.search_result_mode][] is set to # [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. # @!attribute [rw] include_citations # @return [::Boolean] # Specifies whether to include citations in the summary. The default # value is `false`. # # When this field is set to `true`, summaries include in-line citation # numbers. # # Example summary including citations: # # BigQuery is Google Cloud's fully managed and completely serverless # enterprise data warehouse [1]. BigQuery supports all data types, works # across clouds, and has built-in machine learning and business # intelligence, all within a unified platform [2, 3]. # # The citation numbers refer to the returned search results and are # 1-indexed. For example, [1] means that the sentence is attributed to # the first search result. [2, 3] means that the sentence is attributed # to both the second and third search results. # @!attribute [rw] ignore_adversarial_query # @return [::Boolean] # Specifies whether to filter out adversarial queries. The default value # is `false`. # # Google employs search-query classification to detect adversarial # queries. No summary is returned if the search query is classified as an # adversarial query. For example, a user might ask a question regarding # negative comments about the company or submit a query designed to # generate unsafe, policy-violating output. If this field is set to # `true`, we skip generating summaries for adversarial queries and return # fallback messages instead. # @!attribute [rw] ignore_non_summary_seeking_query # @return [::Boolean] # Specifies whether to filter out queries that are not summary-seeking. # The default value is `false`. # # Google employs search-query classification to detect summary-seeking # queries. No summary is returned if the search query is classified as a # non-summary seeking query. For example, `why is the sky blue` and `Who # is the best soccer player in the world?` are summary-seeking queries, # but `SFO airport` and `world cup 2026` are not. They are most likely # navigational queries. If this field is set to `true`, we skip # generating summaries for non-summary seeking queries and return # fallback messages instead. # @!attribute [rw] model_prompt_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec] # If specified, the spec will be used to modify the prompt provided to # the LLM. # @!attribute [rw] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). # Note: This is an experimental feature. # @!attribute [rw] model_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec] # If specified, the spec will be used to modify the model specification # provided to the LLM. # @!attribute [rw] use_semantic_chunks # @return [::Boolean] # If true, answer will be generated from most relevant chunks from top # search results. This feature will improve summary quality. # Note that with this feature enabled, not all top search results # will be referenced and included in the reference list, so the citation # source index only points to the search results listed in the reference # list. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Specification of the prompt to use with the model. # @!attribute [rw] preamble # @return [::String] # Text at the beginning of the prompt that instructs the assistant. # Examples are available in the user guide. class ModelPromptSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specification of the model. # @!attribute [rw] version # @return [::String] # The model version used to generate the summary. # # Supported values are: # # * `stable`: string. Default value when no value is specified. Uses a # generally available, fine-tuned model. For more information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). # * `preview`: string. (Public preview) Uses a preview model. For more # information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # A specification for configuring the extractive content in a search # response. # @!attribute [rw] max_extractive_answer_count # @return [::Integer] # The maximum number of extractive answers returned in each search # result. # # An extractive answer is a verbatim answer extracted from the original # document, which provides a precise and contextually relevant answer to # the search query. # # If the number of matching answers is less than the # `max_extractive_answer_count`, return all of the answers. Otherwise, # return the `max_extractive_answer_count`. # # At most five answers are returned for each # {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult SearchResult}. # @!attribute [rw] max_extractive_segment_count # @return [::Integer] # The max number of extractive segments returned in each search result. # Only applied if the # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to # {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED} # or # {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types} # is # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}. # # An extractive segment is a text segment extracted from the original # document that is relevant to the search query, and, in general, more # verbose than an extractive answer. The segment could then be used as # input for LLMs to generate summaries and answers. # # If the number of matching segments is less than # `max_extractive_segment_count`, return all of the segments. Otherwise, # return the `max_extractive_segment_count`. # @!attribute [rw] return_extractive_segment_score # @return [::Boolean] # Specifies whether to return the confidence score from the extractive # segments in each search result. This feature is available only for new # or allowlisted data stores. To allowlist your data store, # contact your Customer Engineer. The default value is `false`. # @!attribute [rw] num_previous_segments # @return [::Integer] # Specifies whether to also include the adjacent from each selected # segments. # Return at most `num_previous_segments` segments before each selected # segments. # @!attribute [rw] num_next_segments # @return [::Integer] # Return at most `num_next_segments` segments after each selected # segments. class ExtractiveContentSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec
Returns If summarySpec
is not specified, summaries are not included in the
search response.
495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 |
# File 'proto_docs/google/cloud/discoveryengine/v1/search_service.rb', line 495 class ContentSearchSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # A specification for configuring snippets in a search response. # @!attribute [rw] max_snippet_count # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Integer] # [DEPRECATED] This field is deprecated. To control snippet return, use # `return_snippet` field. For backwards compatibility, we will return # snippet if max_snippet_count > 0. # @!attribute [rw] reference_only # @deprecated This field is deprecated and may be removed in the next major version update. # @return [::Boolean] # [DEPRECATED] This field is deprecated and will have no affect on the # snippet. # @!attribute [rw] return_snippet # @return [::Boolean] # If `true`, then return snippet. If no snippet can be generated, we # return "No snippet is available for this page." A `snippet_status` with # `SUCCESS` or `NO_SNIPPET_AVAILABLE` will also be returned. class SnippetSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # A specification for configuring a summary returned in a search # response. # @!attribute [rw] summary_result_count # @return [::Integer] # The number of top results to generate the summary from. If the number # of results returned is less than `summaryResultCount`, the summary is # generated from all of the results. # # At most 10 results for documents mode, or 50 for chunks mode, can be # used to generate a summary. The chunks mode is used when # [SearchRequest.ContentSearchSpec.search_result_mode][] is set to # [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS]. # @!attribute [rw] include_citations # @return [::Boolean] # Specifies whether to include citations in the summary. The default # value is `false`. # # When this field is set to `true`, summaries include in-line citation # numbers. # # Example summary including citations: # # BigQuery is Google Cloud's fully managed and completely serverless # enterprise data warehouse [1]. BigQuery supports all data types, works # across clouds, and has built-in machine learning and business # intelligence, all within a unified platform [2, 3]. # # The citation numbers refer to the returned search results and are # 1-indexed. For example, [1] means that the sentence is attributed to # the first search result. [2, 3] means that the sentence is attributed # to both the second and third search results. # @!attribute [rw] ignore_adversarial_query # @return [::Boolean] # Specifies whether to filter out adversarial queries. The default value # is `false`. # # Google employs search-query classification to detect adversarial # queries. No summary is returned if the search query is classified as an # adversarial query. For example, a user might ask a question regarding # negative comments about the company or submit a query designed to # generate unsafe, policy-violating output. If this field is set to # `true`, we skip generating summaries for adversarial queries and return # fallback messages instead. # @!attribute [rw] ignore_non_summary_seeking_query # @return [::Boolean] # Specifies whether to filter out queries that are not summary-seeking. # The default value is `false`. # # Google employs search-query classification to detect summary-seeking # queries. No summary is returned if the search query is classified as a # non-summary seeking query. For example, `why is the sky blue` and `Who # is the best soccer player in the world?` are summary-seeking queries, # but `SFO airport` and `world cup 2026` are not. They are most likely # navigational queries. If this field is set to `true`, we skip # generating summaries for non-summary seeking queries and return # fallback messages instead. # @!attribute [rw] model_prompt_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelPromptSpec] # If specified, the spec will be used to modify the prompt provided to # the LLM. # @!attribute [rw] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt). # Note: This is an experimental feature. # @!attribute [rw] model_spec # @return [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::ContentSearchSpec::SummarySpec::ModelSpec] # If specified, the spec will be used to modify the model specification # provided to the LLM. # @!attribute [rw] use_semantic_chunks # @return [::Boolean] # If true, answer will be generated from most relevant chunks from top # search results. This feature will improve summary quality. # Note that with this feature enabled, not all top search results # will be referenced and included in the reference list, so the citation # source index only points to the search results listed in the reference # list. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Specification of the prompt to use with the model. # @!attribute [rw] preamble # @return [::String] # Text at the beginning of the prompt that instructs the assistant. # Examples are available in the user guide. class ModelPromptSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Specification of the model. # @!attribute [rw] version # @return [::String] # The model version used to generate the summary. # # Supported values are: # # * `stable`: string. Default value when no value is specified. Uses a # generally available, fine-tuned model. For more information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). # * `preview`: string. (Public preview) Uses a preview model. For more # information, see # [Answer generation model versions and # lifecycle](https://cloud.google.com/generative-ai-app-builder/docs/answer-generation-models). class ModelSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end # A specification for configuring the extractive content in a search # response. # @!attribute [rw] max_extractive_answer_count # @return [::Integer] # The maximum number of extractive answers returned in each search # result. # # An extractive answer is a verbatim answer extracted from the original # document, which provides a precise and contextually relevant answer to # the search query. # # If the number of matching answers is less than the # `max_extractive_answer_count`, return all of the answers. Otherwise, # return the `max_extractive_answer_count`. # # At most five answers are returned for each # {::Google::Cloud::DiscoveryEngine::V1::SearchResponse::SearchResult SearchResult}. # @!attribute [rw] max_extractive_segment_count # @return [::Integer] # The max number of extractive segments returned in each search result. # Only applied if the # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore} is set to # {::Google::Cloud::DiscoveryEngine::V1::DataStore::ContentConfig::CONTENT_REQUIRED DataStore.ContentConfig.CONTENT_REQUIRED} # or # {::Google::Cloud::DiscoveryEngine::V1::DataStore#solution_types DataStore.solution_types} # is # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}. # # An extractive segment is a text segment extracted from the original # document that is relevant to the search query, and, in general, more # verbose than an extractive answer. The segment could then be used as # input for LLMs to generate summaries and answers. # # If the number of matching segments is less than # `max_extractive_segment_count`, return all of the segments. Otherwise, # return the `max_extractive_segment_count`. # @!attribute [rw] return_extractive_segment_score # @return [::Boolean] # Specifies whether to return the confidence score from the extractive # segments in each search result. This feature is available only for new # or allowlisted data stores. To allowlist your data store, # contact your Customer Engineer. The default value is `false`. # @!attribute [rw] num_previous_segments # @return [::Integer] # Specifies whether to also include the adjacent from each selected # segments. # Return at most `num_previous_segments` segments before each selected # segments. # @!attribute [rw] num_next_segments # @return [::Integer] # Return at most `num_next_segments` segments after each selected # segments. class ExtractiveContentSpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |