Class: Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec
- Inherits:
-
Object
- Object
- Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::ContentSearchSpec
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/discoveryengine/v1beta/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::V1beta::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::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec
If
snippetSpec
is not specified, snippets are not included in the search response. -
#summary_spec ⇒ ::Google::Cloud::DiscoveryEngine::V1beta::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::V1beta::SearchRequest::ContentSearchSpec::ExtractiveContentSpec
Returns If there is no extractive_content_spec provided, there will be no extractive answer in the search response.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 470 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 five results can be used to generate a summary. # @!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] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt]. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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 one answer is returned for each # {::Google::Cloud::DiscoveryEngine::V1beta::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 # [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to # [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] # or # [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] # is # [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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. 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::V1beta::SearchRequest::ContentSearchSpec::SnippetSpec
Returns If snippetSpec
is not specified, snippets are not included in the
search response.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 470 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 five results can be used to generate a summary. # @!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] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt]. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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 one answer is returned for each # {::Google::Cloud::DiscoveryEngine::V1beta::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 # [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to # [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] # or # [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] # is # [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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. 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::V1beta::SearchRequest::ContentSearchSpec::SummarySpec
Returns If summarySpec
is not specified, summaries are not included in the
search response.
470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 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 |
# File 'proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb', line 470 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 five results can be used to generate a summary. # @!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] language_code # @return [::String] # Language code for Summary. Use language tags defined by # [BCP47][https://www.rfc-editor.org/rfc/bcp/bcp47.txt]. class SummarySpec include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods 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 one answer is returned for each # {::Google::Cloud::DiscoveryEngine::V1beta::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 # [DataStore][google.cloud.discoveryengine.v1beta.DataStore] is set to # [DataStore.ContentConfig.CONTENT_REQUIRED][google.cloud.discoveryengine.v1beta.DataStore.ContentConfig.CONTENT_REQUIRED] # or # [DataStore.solution_types][google.cloud.discoveryengine.v1beta.DataStore.solution_types] # is # [SOLUTION_TYPE_CHAT][google.cloud.discoveryengine.v1beta.SolutionType.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. 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 |