com.google.api.services.discoveryengine.v1.model

Class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.discoveryengine.v1.model.GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec
extends com.google.api.client.json.GenericJson

A specification for configuring the extractive content in a search response.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Discovery Engine API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

com.google.api.client.util.GenericData.Flags

Nested classes/interfaces inherited from class java.util.AbstractMap

AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec()

Method Summary

Modifier and Type	Method and Description
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	clone()
Integer	getMaxExtractiveAnswerCount() The maximum number of extractive answers returned in each search result.
Integer	getMaxExtractiveSegmentCount() The max number of extractive segments returned in each search result.
Integer	getNumNextSegments() Return at most `num_next_segments` segments after each selected segments.
Integer	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.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	set(String fieldName, Object value)
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	setMaxExtractiveAnswerCount(Integer maxExtractiveAnswerCount) The maximum number of extractive answers returned in each search result.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	setMaxExtractiveSegmentCount(Integer maxExtractiveSegmentCount) The max number of extractive segments returned in each search result.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	setNumNextSegments(Integer numNextSegments) Return at most `num_next_segments` segments after each selected segments.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	setNumPreviousSegments(Integer numPreviousSegments) Specifies whether to also include the adjacent from each selected segments.
GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec	setReturnExtractiveSegmentScore(Boolean returnExtractiveSegmentScore) Specifies whether to return the confidence score from the extractive segments in each search result.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

Methods inherited from class com.google.api.client.util.GenericData

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

Methods inherited from class java.util.AbstractMap

clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec()

Method Detail

getMaxExtractiveAnswerCount

public Integer 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 five answers are returned for each SearchResult.

Returns:

value or null for none

setMaxExtractiveAnswerCount

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec setMaxExtractiveAnswerCount(Integer maxExtractiveAnswerCount)

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 SearchResult.

Parameters:

maxExtractiveAnswerCount - maxExtractiveAnswerCount or null for none

getMaxExtractiveSegmentCount

public Integer getMaxExtractiveSegmentCount()

The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is 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`.

Returns:

value or null for none

setMaxExtractiveSegmentCount

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec setMaxExtractiveSegmentCount(Integer maxExtractiveSegmentCount)

The max number of extractive segments returned in each search result. Only applied if the DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED or DataStore.solution_types is 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`.

Parameters:

maxExtractiveSegmentCount - maxExtractiveSegmentCount or null for none

getNumNextSegments

public Integer getNumNextSegments()

Return at most `num_next_segments` segments after each selected segments.

Returns:

value or null for none

setNumNextSegments

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec setNumNextSegments(Integer numNextSegments)

Return at most `num_next_segments` segments after each selected segments.

Parameters:

numNextSegments - numNextSegments or null for none

getNumPreviousSegments

public Integer getNumPreviousSegments()

Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.

Returns:

value or null for none

setNumPreviousSegments

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec setNumPreviousSegments(Integer numPreviousSegments)

Specifies whether to also include the adjacent from each selected segments. Return at most `num_previous_segments` segments before each selected segments.

Parameters:

numPreviousSegments - numPreviousSegments or null for none

getReturnExtractiveSegmentScore

public Boolean getReturnExtractiveSegmentScore()

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`.

Returns:

value or null for none

setReturnExtractiveSegmentScore

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec setReturnExtractiveSegmentScore(Boolean returnExtractiveSegmentScore)

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`.

Parameters:

returnExtractiveSegmentScore - returnExtractiveSegmentScore or null for none

set

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec set(String fieldName,
                                                                                               Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public GoogleCloudDiscoveryengineV1betaSearchRequestContentSearchSpecExtractiveContentSpec clone()

Overrides:

clone in class com.google.api.client.json.GenericJson