Document captures all raw metadata information of items to be recommended or searched.

Attributes

• aclInfo (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentAclInfo.t, default: nil) - Access control information for the document.
• content (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentContent.t, default: nil) - The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
• derivedStructData (type: map(), default: nil) - Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
• id (type: String.t, default: nil) - Immutable. The identifier of the document. Id should conform to RFC-1034 standard with a length limit of 128 characters.
• indexStatus (type: GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1DocumentIndexStatus.t, default: nil) - Output only. The index status of the document. If document is indexed successfully, the index_time field is populated. Otherwise, if document is not indexed due to errors, the error_samples field is populated. * Otherwise, if document's index is in progress, the pending_message field is populated.
• indexTime (type: DateTime.t, default: nil) - Output only. The last time the document was indexed. If this field is set, the document could be returned in search results. This field is OUTPUT_ONLY. If this field is not populated, it means the document has never been indexed.
• jsonData (type: String.t, default: nil) - The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.
• name (type: String.t, default: nil) - Immutable. The full resource name of the document. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}. This field must be a UTF-8 encoded string with a length limit of 1024 characters.
• parentDocumentId (type: String.t, default: nil) - The identifier of the parent document. Currently supports at most two level document hierarchy. Id should conform to RFC-1034 standard with a length limit of 63 characters.
• schemaId (type: String.t, default: nil) - The identifier of the schema located in the same data store.
• structData (type: map(), default: nil) - The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown.