GetDocumentResult class

Result data returned by getDocument.

Constructors

GetDocumentResult({required String contentUri, required String displayName, required bool enableAutoReload, required List<String> knowledgeTypes, required GoogleCloudDialogflowV2DocumentReloadStatusResponse latestReloadStatus, required Map<String, String> metadata, required String mimeType, required String name, required String rawContent, required String state})
Creates a new GetDocumentResult. contentUri The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. 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. displayName The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails. enableAutoReload 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. PERMISSION_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. knowledgeTypes The knowledge type of document content. latestReloadStatus The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded. metadata 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. mimeType The MIME type of this document. name Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/. rawContent The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types. state The current state of the document.
const
GetDocumentResult.fromMap(Map<String, dynamic> map)
factory

Properties

contentUri → String
The URI where the file content is located. For documents stored in Google Cloud Storage, these URIs must have the form gs:///. 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.
final
displayName → String
The display name of the document. The name must be 1024 bytes or less; otherwise, the creation request fails.
final
enableAutoReload → 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 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. PERMISSION_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.
final
hashCode → int
The hash code for this object.
no setterinherited
knowledgeTypes → List<String>
The knowledge type of document content.
final
latestReloadStatus → GoogleCloudDialogflowV2DocumentReloadStatusResponse
The time and status of the latest reload. This reload may have been triggered automatically or manually and may not have succeeded.
final
metadata → Map<String, String>
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.
final
mimeType → String
The MIME type of this document.
final
name → String
Optional. The document resource name. The name must be empty when creating a document. Format: projects//locations//knowledgeBases//documents/.
final
rawContent → String
The raw content of the document. This field is only permitted for EXTRACTIVE_QA and FAQ knowledge types.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
state → String
The current state of the document.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited