Google Cloud Discovery Engine V1 Client - Class DocumentProcessingConfig (1.3.1)

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

A singleton resource of DataStore. If it's empty when DataStore is created and DataStore is set to DataStore.ContentConfig.CONTENT_REQUIRED, the default parser will default to digital parser.

Generated from protobuf message google.cloud.discoveryengine.v1.DocumentProcessingConfig

Namespace

Google \ Cloud \ DiscoveryEngine \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ name string

The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.
↳ chunking_config DocumentProcessingConfig\ChunkingConfig

Whether chunking mode is enabled.
↳ default_parsing_config DocumentProcessingConfig\ParsingConfig

Configurations for default Document parser. If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.
↳ parsing_config_overrides array|Google\Protobuf\Internal\MapField

Map from file type to override the default parsing configuration based on the file type. Supported keys: * * pdf: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported. * * html: Override parsing config for HTML files, only digital parsing and layout parsing are supported. * * docx: Override parsing config for DOCX files, only digital parsing and layout parsing are supported. * * pptx: Override parsing config for PPTX files, only digital parsing and layout parsing are supported. * * xlsm: Override parsing config for XLSM files, only digital parsing and layout parsing are supported. * * xlsx: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.

getName

The full resource name of the Document Processing Config.

Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

Returns
Type Description
string

setName

The full resource name of the Document Processing Config.

Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

Parameter
Name Description
var string
Returns
Type Description
$this

getChunkingConfig

Whether chunking mode is enabled.

Returns
Type Description
DocumentProcessingConfig\ChunkingConfig|null

hasChunkingConfig

clearChunkingConfig

setChunkingConfig

Whether chunking mode is enabled.

Parameter
Name Description
var DocumentProcessingConfig\ChunkingConfig
Returns
Type Description
$this

getDefaultParsingConfig

Configurations for default Document parser.

If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.

Returns
Type Description
DocumentProcessingConfig\ParsingConfig|null

hasDefaultParsingConfig

clearDefaultParsingConfig

setDefaultParsingConfig

Configurations for default Document parser.

If not specified, we will configure it as default DigitalParsingConfig, and the default parsing config will be applied to all file types for Document parsing.

Parameter
Name Description
var DocumentProcessingConfig\ParsingConfig
Returns
Type Description
$this

getParsingConfigOverrides

Map from file type to override the default parsing configuration based on the file type. Supported keys:

  • pdf: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported.

  • html: Override parsing config for HTML files, only digital parsing and layout parsing are supported.

  • docx: Override parsing config for DOCX files, only digital parsing and layout parsing are supported.
  • pptx: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
  • xlsm: Override parsing config for XLSM files, only digital parsing and layout parsing are supported.
  • xlsx: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.
Returns
Type Description
Google\Protobuf\Internal\MapField

setParsingConfigOverrides

Map from file type to override the default parsing configuration based on the file type. Supported keys:

  • pdf: Override parsing config for PDF files, either digital parsing, ocr parsing or layout parsing is supported.

  • html: Override parsing config for HTML files, only digital parsing and layout parsing are supported.

  • docx: Override parsing config for DOCX files, only digital parsing and layout parsing are supported.
  • pptx: Override parsing config for PPTX files, only digital parsing and layout parsing are supported.
  • xlsm: Override parsing config for XLSM files, only digital parsing and layout parsing are supported.
  • xlsx: Override parsing config for XLSX files, only digital parsing and layout parsing are supported.
Parameter
Name Description
var array|Google\Protobuf\Internal\MapField
Returns
Type Description
$this