Reference documentation and code samples for the Google Cloud Dialogflow V2 Client class Document.
A knowledge document to be used by a KnowledgeBase.
For more information, see the knowledge base
guide.
Note: The projects.agent.knowledgeBases.documents resource is deprecated;
only use projects.knowledgeBases.documents.
Generated from protobuf message google.cloud.dialogflow.v2.Document
Methods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ name |
string
Optional. The document resource name. The name must be empty when creating a document. Format: |
↳ display_name |
string
Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails. |
↳ mime_type |
string
Required. The MIME type of this document. |
↳ knowledge_types |
array
Required. The knowledge type of document content. |
↳ content_uri |
string
The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form |
↳ raw_content |
string
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. |
↳ enable_auto_reload |
bool
Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document. Currently you can only enable automatic reload for documents sourced from a public url, see |
↳ latest_reload_status |
Google\Cloud\Dialogflow\V2\Document\ReloadStatus
Output only. The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded. |
↳ metadata |
array|Google\Protobuf\Internal\MapField
Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc. The max size of a |
↳ state |
int
Output only. The current state of the document. |
getName
Optional. The document resource name.
The name must be empty when creating a document.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
string | |
setName
Optional. The document resource name.
The name must be empty when creating a document.
Format: projects/<Project ID>/locations/<Location
ID>/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>.
Generated from protobuf field string name = 1 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getDisplayName
Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setDisplayName
Required. The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
Generated from protobuf field string display_name = 2 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMimeType
Required. The MIME type of this document.
Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
string | |
setMimeType
Required. The MIME type of this document.
Generated from protobuf field string mime_type = 3 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getKnowledgeTypes
Required. The knowledge type of document content.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\RepeatedField | |
setKnowledgeTypes
Required. The knowledge type of document content.
Generated from protobuf field repeated .google.cloud.dialogflow.v2.Document.KnowledgeType knowledge_types = 4 [(.google.api.field_behavior) = REQUIRED];
| Parameter | |
|---|---|
| Name | Description |
var |
int[]
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getContentUri
The URI where the file content is located.
For documents stored in Google Cloud Storage, these URIs must have
the form gs://<bucket-name>/<object-name>.
NOTE: External URLs must correspond to public webpages, i.e., they must
be indexed by Google Search. In particular, URLs for showing documents in
Google Cloud Storage (i.e. the URL in your browser) are not supported.
Instead use the gs:// format URI described above.
Generated from protobuf field string content_uri = 5;
| Returns | |
|---|---|
| Type | Description |
string | |
hasContentUri
setContentUri
The URI where the file content is located.
For documents stored in Google Cloud Storage, these URIs must have
the form gs://<bucket-name>/<object-name>.
NOTE: External URLs must correspond to public webpages, i.e., they must
be indexed by Google Search. In particular, URLs for showing documents in
Google Cloud Storage (i.e. the URL in your browser) are not supported.
Instead use the gs:// format URI described above.
Generated from protobuf field string content_uri = 5;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getRawContent
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
Generated from protobuf field bytes raw_content = 9;
| Returns | |
|---|---|
| Type | Description |
string | |
hasRawContent
setRawContent
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
Generated from protobuf field bytes raw_content = 9;
| Parameter | |
|---|---|
| Name | Description |
var |
string
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getEnableAutoReload
Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document.
Currently you can only enable automatic reload for documents sourced from
a public url, see source field for the source types.
Reload status can be tracked in latest_reload_status. If a reload
fails, we will keep the document unchanged.
If a reload fails with internal errors, the system will try to reload the
document on the next day.
If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
system will not try to reload the document anymore. You need to manually
reload the document successfully by calling ReloadDocument and clear the
errors.
Generated from protobuf field bool enable_auto_reload = 11 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
bool | |
setEnableAutoReload
Optional. If true, we try to automatically reload the document every day (at a time picked by the system). If false or unspecified, we don't try to automatically reload the document.
Currently you can only enable automatic reload for documents sourced from
a public url, see source field for the source types.
Reload status can be tracked in latest_reload_status. If a reload
fails, we will keep the document unchanged.
If a reload fails with internal errors, the system will try to reload the
document on the next day.
If a reload fails with non-retriable errors (e.g. PERMISION_DENIED), the
system will not try to reload the document anymore. You need to manually
reload the document successfully by calling ReloadDocument and clear the
errors.
Generated from protobuf field bool enable_auto_reload = 11 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
bool
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getLatestReloadStatus
Output only. The time and status of the latest reload.
This reload may have been triggered automatically or manually and may not have succeeded.
Generated from protobuf field .google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
Google\Cloud\Dialogflow\V2\Document\ReloadStatus|null | |
hasLatestReloadStatus
clearLatestReloadStatus
setLatestReloadStatus
Output only. The time and status of the latest reload.
This reload may have been triggered automatically or manually and may not have succeeded.
Generated from protobuf field .google.cloud.dialogflow.v2.Document.ReloadStatus latest_reload_status = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Cloud\Dialogflow\V2\Document\ReloadStatus
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getMetadata
Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc.
The max size of a key or a value of the metadata is 1024 bytes.
Generated from protobuf field map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Internal\MapField | |
setMetadata
Optional. Metadata for the document. The metadata supports arbitrary key-value pairs. Suggested use cases include storing a document's title, an external URL distinct from the document's content_uri, etc.
The max size of a key or a value of the metadata is 1024 bytes.
Generated from protobuf field map<string, string> metadata = 7 [(.google.api.field_behavior) = OPTIONAL];
| Parameter | |
|---|---|
| Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getState
Output only. The current state of the document.
Generated from protobuf field .google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int | |
setState
Output only. The current state of the document.
Generated from protobuf field .google.cloud.dialogflow.v2.Document.State state = 13 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
var |
int
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getSource
| Returns | |
|---|---|
| Type | Description |
string | |