Discovery Engine v1 API - Class Document (1.1.0)

public sealed class Document : IMessage<Document>, IEquatable<Document>, IDeepCloneable<Document>, IBufferMessage, IMessage

Reference documentation and code samples for the Discovery Engine v1 API class Document.

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

Inheritance

object > Document

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Document()

public Document()

Document(Document)

public Document(Document other)
Parameter
Name Description
other Document

Properties

Content

public Document.Types.Content Content { get; set; }

The unstructured data linked to this document. Content must be set if this document is under a CONTENT_REQUIRED data store.

Property Value
Type Description
DocumentTypesContent

DataCase

public Document.DataOneofCase DataCase { get; }
Property Value
Type Description
DocumentDataOneofCase

DerivedStructData

public Struct DerivedStructData { get; set; }

Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.

Property Value
Type Description
Struct

DocumentName

public DocumentName DocumentName { get; set; }

DocumentName-typed view over the Name resource name property.

Property Value
Type Description
DocumentName

HasJsonData

public bool HasJsonData { get; }

Gets whether the "json_data" field is set

Property Value
Type Description
bool

Id

public string Id { get; set; }

Immutable. The identifier of the document.

Id should conform to RFC-1034 standard with a length limit of 63 characters.

Property Value
Type Description
string

IndexTime

public Timestamp IndexTime { get; set; }

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.

Property Value
Type Description
Timestamp

JsonData

public string JsonData { get; set; }

The JSON string representation of the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1.Schema] or an INVALID_ARGUMENT error is thrown.

Property Value
Type Description
string

Name

public string Name { get; set; }

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.

Property Value
Type Description
string

ParentDocumentId

public string ParentDocumentId { get; set; }

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.

Property Value
Type Description
string

SchemaId

public string SchemaId { get; set; }

The identifier of the schema located in the same data store.

Property Value
Type Description
string

StructData

public Struct StructData { get; set; }

The structured JSON data for the document. It should conform to the registered [Schema][google.cloud.discoveryengine.v1.Schema] or an INVALID_ARGUMENT error is thrown.

Property Value
Type Description
Struct