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

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
NameDescription
dataarray

Optional. Data for populating the Message object.

↳ namestring

The full resource name of the Document Processing Config. Format: projects/*/locations/*/collections/*/dataStores/*/documentProcessingConfig.

↳ chunking_configDocumentProcessingConfig\ChunkingConfig

Whether chunking mode is enabled.

↳ default_parsing_configDocumentProcessingConfig\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_overridesarray|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
TypeDescription
string

setName

The full resource name of the Document Processing Config.

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

Parameter
NameDescription
varstring
Returns
TypeDescription
$this

getChunkingConfig

Whether chunking mode is enabled.

Returns
TypeDescription
DocumentProcessingConfig\ChunkingConfig|null

hasChunkingConfig

clearChunkingConfig

setChunkingConfig

Whether chunking mode is enabled.

Parameter
NameDescription
varDocumentProcessingConfig\ChunkingConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
varDocumentProcessingConfig\ParsingConfig
Returns
TypeDescription
$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
TypeDescription
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
NameDescription
vararray|Google\Protobuf\Internal\MapField
Returns
TypeDescription
$this