Package com.google.cloud.discoveryengine.v1beta

Interface SearchRequest.ContentSearchSpec.ExtractiveContentSpecOrBuilder

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      int getMaxExtractiveAnswerCount()
      The maximum number of extractive answers returned in each search result.
      int getMaxExtractiveSegmentCount()
      The max number of extractive segments returned in each search result.
      int getNumNextSegments()
      Return at most `num_next_segments` segments after each selected segments.
      int getNumPreviousSegments()
      Specifies whether to also include the adjacent from each selected segments.
      boolean getReturnExtractiveSegmentScore()
      Specifies whether to return the confidence score from the extractive segments in each search result.

      • Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

        isInitialized

      • Methods inherited from interface com.google.protobuf.MessageOrBuilder

        findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

    • Method Detail

      • getMaxExtractiveAnswerCount

        int getMaxExtractiveAnswerCount()
         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
 [SearchResult][google.cloud.discoveryengine.v1beta.SearchResponse.SearchResult].
        int32 max_extractive_answer_count = 1;
        Returns:
        The maxExtractiveAnswerCount.

      • getMaxExtractiveSegmentCount

        int getMaxExtractiveSegmentCount()
         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`.
        int32 max_extractive_segment_count = 2;
        Returns:
        The maxExtractiveSegmentCount.

      • getReturnExtractiveSegmentScore

        boolean getReturnExtractiveSegmentScore()
         Specifies whether to return the confidence score from the extractive
 segments in each search result. The default value is `false`.
        bool return_extractive_segment_score = 3;
        Returns:
        The returnExtractiveSegmentScore.

      • getNumPreviousSegments

        int getNumPreviousSegments()
         Specifies whether to also include the adjacent from each selected
 segments.
 Return at most `num_previous_segments` segments before each selected
 segments.
        int32 num_previous_segments = 4;
        Returns:
        The numPreviousSegments.

      • getNumNextSegments

        int getNumNextSegments()
         Return at most `num_next_segments` segments after each selected
 segments.
        int32 num_next_segments = 5;
        Returns:
        The numNextSegments.