Google Cloud Discovery Engine V1 Client - Class ChunkSpec (1.2.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class ChunkSpec.

Specifies the chunk spec to be returned from the search response.

Only available if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS

Generated from protobuf message google.cloud.discoveryengine.v1.SearchRequest.ContentSearchSpec.ChunkSpec

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ SearchRequest \ ContentSearchSpec

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ num_previous_chunks int

The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no previous chunks will be returned.

↳ num_next_chunks int

The number of next chunks to be returned of the current chunk. The maximum allowed value is 3. If not specified, no next chunks will be returned.

getNumPreviousChunks

The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3.

If not specified, no previous chunks will be returned.

Returns
Type Description
int

setNumPreviousChunks

The number of previous chunks to be returned of the current chunk. The maximum allowed value is 3.

If not specified, no previous chunks will be returned.

Parameter
Name Description
var int
Returns
Type Description
$this

getNumNextChunks

The number of next chunks to be returned of the current chunk. The maximum allowed value is 3.

If not specified, no next chunks will be returned.

Returns
Type Description
int

setNumNextChunks

The number of next chunks to be returned of the current chunk. The maximum allowed value is 3.

If not specified, no next chunks will be returned.

Parameter
Name Description
var int
Returns
Type Description
$this