Reference documentation and code samples for the Google Cloud Document Ai V1 Client class ProcessorVersion.
A processor version is an implementation of a processor. Each processor can have multiple versions, pretrained by Google internally or uptrained by the customer. A processor can only have one default version at a time.
Its document-processing behavior is defined by that version.
Generated from protobuf message google.cloud.documentai.v1.ProcessorVersion
Namespace
Google \ Cloud \ DocumentAI \ V1Methods
__construct
Constructor.
Parameters | |
---|---|
Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Identifier. The resource name of the processor version. Format: |
↳ display_name |
string
The display name of the processor version. |
↳ document_schema |
Google\Cloud\DocumentAI\V1\DocumentSchema
The schema of the processor version. Describes the output. |
↳ state |
int
Output only. The state of the processor version. |
↳ create_time |
Google\Protobuf\Timestamp
The time the processor version was created. |
↳ latest_evaluation |
Google\Cloud\DocumentAI\V1\EvaluationReference
The most recently invoked evaluation for the processor version. |
↳ kms_key_name |
string
The KMS key name used for encryption. |
↳ kms_key_version_name |
string
The KMS key version with which data is encrypted. |
↳ google_managed |
bool
Output only. Denotes that this |
↳ deprecation_info |
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo
If set, information about the eventual deprecation of this version. |
↳ model_type |
int
Output only. The model type of this processor version. |
↳ satisfies_pzs |
bool
Output only. Reserved for future use. |
↳ satisfies_pzi |
bool
Output only. Reserved for future use. |
↳ gen_ai_model_info |
Google\Cloud\DocumentAI\V1\ProcessorVersion\GenAiModelInfo
Output only. Information about Generative AI model-based processor versions. |
getName
Identifier. The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
Returns | |
---|---|
Type | Description |
string |
setName
Identifier. The resource name of the processor version.
Format:
projects/{project}/locations/{location}/processors/{processor}/processorVersions/{processor_version}
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDisplayName
The display name of the processor version.
Returns | |
---|---|
Type | Description |
string |
setDisplayName
The display name of the processor version.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getDocumentSchema
The schema of the processor version. Describes the output.
Returns | |
---|---|
Type | Description |
Google\Cloud\DocumentAI\V1\DocumentSchema|null |
hasDocumentSchema
clearDocumentSchema
setDocumentSchema
The schema of the processor version. Describes the output.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DocumentAI\V1\DocumentSchema
|
Returns | |
---|---|
Type | Description |
$this |
getState
Output only. The state of the processor version.
Returns | |
---|---|
Type | Description |
int |
setState
Output only. The state of the processor version.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getCreateTime
The time the processor version was created.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Timestamp|null |
hasCreateTime
clearCreateTime
setCreateTime
The time the processor version was created.
Parameter | |
---|---|
Name | Description |
var |
Google\Protobuf\Timestamp
|
Returns | |
---|---|
Type | Description |
$this |
getLatestEvaluation
The most recently invoked evaluation for the processor version.
Returns | |
---|---|
Type | Description |
Google\Cloud\DocumentAI\V1\EvaluationReference|null |
hasLatestEvaluation
clearLatestEvaluation
setLatestEvaluation
The most recently invoked evaluation for the processor version.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DocumentAI\V1\EvaluationReference
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKeyName
The KMS key name used for encryption.
Returns | |
---|---|
Type | Description |
string |
setKmsKeyName
The KMS key name used for encryption.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getKmsKeyVersionName
The KMS key version with which data is encrypted.
Returns | |
---|---|
Type | Description |
string |
setKmsKeyVersionName
The KMS key version with which data is encrypted.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getGoogleManaged
Output only. Denotes that this ProcessorVersion
is managed by Google.
Returns | |
---|---|
Type | Description |
bool |
setGoogleManaged
Output only. Denotes that this ProcessorVersion
is managed by Google.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getDeprecationInfo
If set, information about the eventual deprecation of this version.
Returns | |
---|---|
Type | Description |
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo|null |
hasDeprecationInfo
clearDeprecationInfo
setDeprecationInfo
If set, information about the eventual deprecation of this version.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DocumentAI\V1\ProcessorVersion\DeprecationInfo
|
Returns | |
---|---|
Type | Description |
$this |
getModelType
Output only. The model type of this processor version.
Returns | |
---|---|
Type | Description |
int |
setModelType
Output only. The model type of this processor version.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |
getSatisfiesPzs
Output only. Reserved for future use.
Returns | |
---|---|
Type | Description |
bool |
setSatisfiesPzs
Output only. Reserved for future use.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getSatisfiesPzi
Output only. Reserved for future use.
Returns | |
---|---|
Type | Description |
bool |
setSatisfiesPzi
Output only. Reserved for future use.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getGenAiModelInfo
Output only. Information about Generative AI model-based processor versions.
Returns | |
---|---|
Type | Description |
Google\Cloud\DocumentAI\V1\ProcessorVersion\GenAiModelInfo|null |
hasGenAiModelInfo
clearGenAiModelInfo
setGenAiModelInfo
Output only. Information about Generative AI model-based processor versions.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\DocumentAI\V1\ProcessorVersion\GenAiModelInfo
|
Returns | |
---|---|
Type | Description |
$this |