public interface ChunkOrBuilder extends MessageOrBuilder
Implements
MessageOrBuilderMethods
getChunkMetadata()
public abstract Chunk.ChunkMetadata getChunkMetadata()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Chunk.ChunkMetadata |
The chunkMetadata. |
getChunkMetadataOrBuilder()
public abstract Chunk.ChunkMetadataOrBuilder getChunkMetadataOrBuilder()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Chunk.ChunkMetadataOrBuilder |
getContent()
public abstract String getContent()
Content is a string from a document (parsed content).
string content = 3;
Returns | |
---|---|
Type | Description |
String |
The content. |
getContentBytes()
public abstract ByteString getContentBytes()
Content is a string from a document (parsed content).
string content = 3;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for content. |
getDerivedStructData()
public abstract Struct getDerivedStructData()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
Struct |
The derivedStructData. |
getDerivedStructDataOrBuilder()
public abstract StructOrBuilder getDerivedStructDataOrBuilder()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
StructOrBuilder |
getDocumentMetadata()
public abstract Chunk.DocumentMetadata getDocumentMetadata()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;
Returns | |
---|---|
Type | Description |
Chunk.DocumentMetadata |
The documentMetadata. |
getDocumentMetadataOrBuilder()
public abstract Chunk.DocumentMetadataOrBuilder getDocumentMetadataOrBuilder()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;
Returns | |
---|---|
Type | Description |
Chunk.DocumentMetadataOrBuilder |
getId()
public abstract String getId()
Unique chunk ID of the current chunk.
string id = 2;
Returns | |
---|---|
Type | Description |
String |
The id. |
getIdBytes()
public abstract ByteString getIdBytes()
Unique chunk ID of the current chunk.
string id = 2;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for id. |
getName()
public abstract String getName()
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.
string name = 1;
Returns | |
---|---|
Type | Description |
String |
The name. |
getNameBytes()
public abstract ByteString getNameBytes()
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.
string name = 1;
Returns | |
---|---|
Type | Description |
ByteString |
The bytes for name. |
getPageSpan()
public abstract Chunk.PageSpan getPageSpan()
Page span of the chunk.
.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;
Returns | |
---|---|
Type | Description |
Chunk.PageSpan |
The pageSpan. |
getPageSpanOrBuilder()
public abstract Chunk.PageSpanOrBuilder getPageSpanOrBuilder()
Page span of the chunk.
.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;
Returns | |
---|---|
Type | Description |
Chunk.PageSpanOrBuilder |
getRelevanceScore()
public abstract double getRelevanceScore()
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][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
double |
The relevanceScore. |
hasChunkMetadata()
public abstract boolean hasChunkMetadata()
Output only. Metadata of the current chunk.
.google.cloud.discoveryengine.v1.Chunk.ChunkMetadata chunk_metadata = 7 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the chunkMetadata field is set. |
hasDerivedStructData()
public abstract boolean hasDerivedStructData()
Output only. This field is OUTPUT_ONLY. It contains derived data that are not in the original input document.
.google.protobuf.Struct derived_struct_data = 4 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the derivedStructData field is set. |
hasDocumentMetadata()
public abstract boolean hasDocumentMetadata()
Metadata of the document from the current chunk.
.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;
Returns | |
---|---|
Type | Description |
boolean |
Whether the documentMetadata field is set. |
hasPageSpan()
public abstract boolean hasPageSpan()
Page span of the chunk.
.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;
Returns | |
---|---|
Type | Description |
boolean |
Whether the pageSpan field is set. |
hasRelevanceScore()
public abstract boolean hasRelevanceScore()
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][].
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
Returns | |
---|---|
Type | Description |
boolean |
Whether the relevanceScore field is set. |