com.google.cloud.discoveryengine.v1

Interface ChunkOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

Chunk, Chunk.Builder

@Generated
public interface ChunkOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
String	getAnnotationContents(int index) Output only.
com.google.protobuf.ByteString	getAnnotationContentsBytes(int index) Output only.
int	getAnnotationContentsCount() Output only.
List<String>	getAnnotationContentsList() Output only.
Chunk.AnnotationMetadata	getAnnotationMetadata(int index) Output only.
int	getAnnotationMetadataCount() Output only.
List<Chunk.AnnotationMetadata>	getAnnotationMetadataList() Output only.
Chunk.AnnotationMetadataOrBuilder	getAnnotationMetadataOrBuilder(int index) Output only.
List<? extends Chunk.AnnotationMetadataOrBuilder>	getAnnotationMetadataOrBuilderList() Output only.
Chunk.ChunkMetadata	getChunkMetadata() Output only.
Chunk.ChunkMetadataOrBuilder	getChunkMetadataOrBuilder() Output only.
String	getContent() Content is a string from a document (parsed content).
com.google.protobuf.ByteString	getContentBytes() Content is a string from a document (parsed content).
String	getDataUrls(int index) Output only.
com.google.protobuf.ByteString	getDataUrlsBytes(int index) Output only.
int	getDataUrlsCount() Output only.
List<String>	getDataUrlsList() Output only.
com.google.protobuf.Struct	getDerivedStructData() Output only.
com.google.protobuf.StructOrBuilder	getDerivedStructDataOrBuilder() Output only.
Chunk.DocumentMetadata	getDocumentMetadata() Metadata of the document from the current chunk.
Chunk.DocumentMetadataOrBuilder	getDocumentMetadataOrBuilder() Metadata of the document from the current chunk.
String	getId() Unique chunk ID of the current chunk.
com.google.protobuf.ByteString	getIdBytes() Unique chunk ID of the current chunk.
String	getName() The full resource name of the chunk.
com.google.protobuf.ByteString	getNameBytes() The full resource name of the chunk.
Chunk.PageSpan	getPageSpan() Page span of the chunk.
Chunk.PageSpanOrBuilder	getPageSpanOrBuilder() Page span of the chunk.
double	getRelevanceScore() Output only.
boolean	hasChunkMetadata() Output only.
boolean	hasDerivedStructData() Output only.
boolean	hasDocumentMetadata() Metadata of the document from the current chunk.
boolean	hasPageSpan() Page span of the chunk.
boolean	hasRelevanceScore() Output only.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getName

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:

The name.

getNameBytes

com.google.protobuf.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:

The bytes for name.

getId

String getId()

 Unique chunk ID of the current chunk.
 

string id = 2;

Returns:

The id.

getIdBytes

com.google.protobuf.ByteString getIdBytes()

 Unique chunk ID of the current chunk.
 

string id = 2;

Returns:

The bytes for id.

getContent

String getContent()

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

string content = 3;

Returns:

The content.

getContentBytes

com.google.protobuf.ByteString getContentBytes()

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

string content = 3;

Returns:

The bytes for content.

hasRelevanceScore

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
 [SearchResponse][google.cloud.discoveryengine.v1.SearchResponse].
 

optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

Whether the relevanceScore field is set.

getRelevanceScore

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
 [SearchResponse][google.cloud.discoveryengine.v1.SearchResponse].
 

optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The relevanceScore.

hasDocumentMetadata

boolean hasDocumentMetadata()

 Metadata of the document from the current chunk.
 

.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;

Returns:

Whether the documentMetadata field is set.

getDocumentMetadata

Chunk.DocumentMetadata getDocumentMetadata()

 Metadata of the document from the current chunk.
 

.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;

Returns:

The documentMetadata.

getDocumentMetadataOrBuilder

Chunk.DocumentMetadataOrBuilder getDocumentMetadataOrBuilder()

 Metadata of the document from the current chunk.
 

.google.cloud.discoveryengine.v1.Chunk.DocumentMetadata document_metadata = 5;

hasDerivedStructData

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:

Whether the derivedStructData field is set.

getDerivedStructData

com.google.protobuf.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:

The derivedStructData.

getDerivedStructDataOrBuilder

com.google.protobuf.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];

hasPageSpan

boolean hasPageSpan()

 Page span of the chunk.
 

.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;

Returns:

Whether the pageSpan field is set.

getPageSpan

Chunk.PageSpan getPageSpan()

 Page span of the chunk.
 

.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;

Returns:

The pageSpan.

getPageSpanOrBuilder

Chunk.PageSpanOrBuilder getPageSpanOrBuilder()

 Page span of the chunk.
 

.google.cloud.discoveryengine.v1.Chunk.PageSpan page_span = 6;

hasChunkMetadata

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:

Whether the chunkMetadata field is set.

getChunkMetadata

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:

The chunkMetadata.

getChunkMetadataOrBuilder

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];

getDataUrlsList

List<String> getDataUrlsList()

 Output only. Image Data URLs if the current chunk contains images.
 Data URLs are composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if non-textual,
 and the data itself:
 data:[<mediatype>][;base64],<data>
 

repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the dataUrls.

getDataUrlsCount

int getDataUrlsCount()

 Output only. Image Data URLs if the current chunk contains images.
 Data URLs are composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if non-textual,
 and the data itself:
 data:[<mediatype>][;base64],<data>
 

repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of dataUrls.

getDataUrls

String getDataUrls(int index)

 Output only. Image Data URLs if the current chunk contains images.
 Data URLs are composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if non-textual,
 and the data itself:
 data:[<mediatype>][;base64],<data>
 

repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the element to return.

Returns:

The dataUrls at the given index.

getDataUrlsBytes

com.google.protobuf.ByteString getDataUrlsBytes(int index)

 Output only. Image Data URLs if the current chunk contains images.
 Data URLs are composed of four parts: a prefix (data:), a MIME type
 indicating the type of data, an optional base64 token if non-textual,
 and the data itself:
 data:[<mediatype>][;base64],<data>
 

repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the dataUrls at the given index.

getAnnotationContentsList

List<String> getAnnotationContentsList()

 Output only. Annotation contents if the current chunk contains annotations.
 

repeated string annotation_contents = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

A list containing the annotationContents.

getAnnotationContentsCount

int getAnnotationContentsCount()

 Output only. Annotation contents if the current chunk contains annotations.
 

repeated string annotation_contents = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns:

The count of annotationContents.

getAnnotationContents

String getAnnotationContents(int index)

 Output only. Annotation contents if the current chunk contains annotations.
 

repeated string annotation_contents = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the element to return.

Returns:

The annotationContents at the given index.

getAnnotationContentsBytes

com.google.protobuf.ByteString getAnnotationContentsBytes(int index)

 Output only. Annotation contents if the current chunk contains annotations.
 

repeated string annotation_contents = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameters:

index - The index of the value to return.

Returns:

The bytes of the annotationContents at the given index.

getAnnotationMetadataList

List<Chunk.AnnotationMetadata> getAnnotationMetadataList()

 Output only. The annotation metadata includes structured content in the
 current chunk.
 

repeated .google.cloud.discoveryengine.v1.Chunk.AnnotationMetadata annotation_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAnnotationMetadata

Chunk.AnnotationMetadata getAnnotationMetadata(int index)

 Output only. The annotation metadata includes structured content in the
 current chunk.
 

repeated .google.cloud.discoveryengine.v1.Chunk.AnnotationMetadata annotation_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAnnotationMetadataCount

int getAnnotationMetadataCount()

 Output only. The annotation metadata includes structured content in the
 current chunk.
 

repeated .google.cloud.discoveryengine.v1.Chunk.AnnotationMetadata annotation_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAnnotationMetadataOrBuilderList

List<? extends Chunk.AnnotationMetadataOrBuilder> getAnnotationMetadataOrBuilderList()

 Output only. The annotation metadata includes structured content in the
 current chunk.
 

repeated .google.cloud.discoveryengine.v1.Chunk.AnnotationMetadata annotation_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];

getAnnotationMetadataOrBuilder

Chunk.AnnotationMetadataOrBuilder getAnnotationMetadataOrBuilder(int index)

 Output only. The annotation metadata includes structured content in the
 current chunk.
 

repeated .google.cloud.discoveryengine.v1.Chunk.AnnotationMetadata annotation_metadata = 12 [(.google.api.field_behavior) = OUTPUT_ONLY];