Class Document (0.12.2)

Document(mapping=None, *, ignore_unknown_fields=False, **kwargs)

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

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

Attributes

Name Description
struct_data google.protobuf.struct_pb2.Struct
The structured JSON data for the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown. This field is a member of oneof_ data.
json_data str
The JSON string representation of the document. It should conform to the registered Schema or an INVALID_ARGUMENT error is thrown. This field is a member of oneof_ data.
name str
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.
id str
Immutable. The identifier of the document. Id should conform to RFC-1034 __ standard with a length limit of 63 characters.
schema_id str
The identifier of the schema located in the same data store.
content google.cloud.discoveryengine_v1alpha.types.Document.Content
The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.
parent_document_id str
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.
derived_struct_data google.protobuf.struct_pb2.Struct
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
acl_info google.cloud.discoveryengine_v1alpha.types.Document.AclInfo
Access control information for the document.
index_time google.protobuf.timestamp_pb2.Timestamp
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.
index_status google.cloud.discoveryengine_v1alpha.types.Document.IndexStatus
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, index_status is unset.

Classes

AclInfo

AclInfo(mapping=None, *, ignore_unknown_fields=False, **kwargs)

ACL Information of the Document.

Content

Content(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Unstructured data linked to this document.

This message has oneof_ fields (mutually exclusive fields). For each oneof, at most one member field can be set at the same time. Setting any member of the oneof automatically clears all other members.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

IndexStatus

IndexStatus(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Index status of the document.