- 0.63.0 (latest)
- 0.60.0
- 0.59.0
- 0.58.0
- 0.56.0
- 0.55.0
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.0
- 0.8.0
- 0.7.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
public interface ChunkOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getAnnotationContents(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The annotationContents at the given index. |
getAnnotationContentsBytes(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the annotationContents at the given index. |
getAnnotationContentsCount()
public abstract int getAnnotationContentsCount()Output only. Annotation contents if the current chunk contains annotations.
repeated string annotation_contents = 11 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of annotationContents. |
getAnnotationContentsList()
public abstract 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 | |
|---|---|
| Type | Description |
List<String> |
A list containing the annotationContents. |
getAnnotationMetadata(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Chunk.AnnotationMetadata |
|
getAnnotationMetadataCount()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
int |
|
getAnnotationMetadataList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<AnnotationMetadata> |
|
getAnnotationMetadataOrBuilder(int index)
public abstract 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];
| Parameter | |
|---|---|
| Name | Description |
index |
int |
| Returns | |
|---|---|
| Type | Description |
Chunk.AnnotationMetadataOrBuilder |
|
getAnnotationMetadataOrBuilderList()
public abstract 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];
| Returns | |
|---|---|
| Type | Description |
List<? extends com.google.cloud.discoveryengine.v1.Chunk.AnnotationMetadataOrBuilder> |
|
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. |
getDataUrls(int index)
public abstract 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>,<data>
repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The dataUrls at the given index. |
getDataUrlsBytes(int index)
public abstract 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>,<data>
repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the dataUrls at the given index. |
getDataUrlsCount()
public abstract 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>,<data>
repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
int |
The count of dataUrls. |
getDataUrlsList()
public abstract 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>,<data>
repeated string data_urls = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the dataUrls. |
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 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 SearchResponse.
optional double relevance_score = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];
| Returns | |
|---|---|
| Type | Description |
boolean |
Whether the relevanceScore field is set. |