Discovery Engine v1 API - Class Chunk (1.3.0) 

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

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

Chunk captures all raw metadata information of items to be recommended or searched in the chunk mode.

Inheritance

object > Chunk

Namespace

Google.Cloud.DiscoveryEngine.V1

Assembly

Google.Cloud.DiscoveryEngine.V1.dll

Constructors

Chunk()

public Chunk()

Chunk(Chunk)

public Chunk(Chunk other)
Parameter
Name Description
other Chunk

Properties

ChunkMetadata

public Chunk.Types.ChunkMetadata ChunkMetadata { get; set; }

Output only. Metadata of the current chunk.

Property Value
Type Description
ChunkTypesChunkMetadata

ChunkName

public ChunkName ChunkName { get; set; }

ChunkName-typed view over the Name resource name property.

Property Value
Type Description
ChunkName

Content

public string Content { get; set; }

Content is a string from a document (parsed content).

Property Value
Type Description
string

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

DocumentMetadata

public Chunk.Types.DocumentMetadata DocumentMetadata { get; set; }

Metadata of the document from the current chunk.

Property Value
Type Description
ChunkTypesDocumentMetadata

HasRelevanceScore

public bool HasRelevanceScore { get; }

Gets whether the "relevance_score" field is set

Property Value
Type Description
bool

Id

public string Id { get; set; }

Unique chunk ID of the current chunk.

Property Value
Type Description
string

Name

public string Name { get; set; }

The full resource name of the chunk. Format: projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}/documents/{document_id}/chunks/{chunk_id}.

This field must be a UTF-8 encoded string with a length limit of 1024 characters.

Property Value
Type Description
string

PageSpan

public Chunk.Types.PageSpan PageSpan { get; set; }

Page span of the chunk.

Property Value
Type Description
ChunkTypesPageSpan

RelevanceScore

public double RelevanceScore { get; set; }

Output only. Represents the relevance score based on similarity. Higher score indicates higher chunk relevance. The score is in range [-1.0, 1.0]. Only populated on [SearchService.SearchResponse][].

Property Value
Type Description
double