Interface Answer.Step.Action.Observation.SearchResultOrBuilder (0.48.0)

Version 0.48.0

• 0.49.0 (latest)
• 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 static interface Answer.Step.Action.Observation.SearchResultOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getChunkInfo(int index)

public abstract Answer.Step.Action.Observation.SearchResult.ChunkInfo getChunkInfo(int index)

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.ChunkInfo

getChunkInfoCount()

public abstract int getChunkInfoCount()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
int

getChunkInfoList()

public abstract List<Answer.Step.Action.Observation.SearchResult.ChunkInfo> getChunkInfoList()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
List<ChunkInfo>

getChunkInfoOrBuilder(int index)

public abstract Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder getChunkInfoOrBuilder(int index)

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder

getChunkInfoOrBuilderList()

public abstract List<? extends Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder> getChunkInfoOrBuilderList()

If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.ChunkInfoOrBuilder>

getDocument()

public abstract String getDocument()

Document resource name.

string document = 1;

Returns
Type	Description
String	The document.

getDocumentBytes()

public abstract ByteString getDocumentBytes()

Document resource name.

string document = 1;

Returns
Type	Description
ByteString	The bytes for document.

getSnippetInfo(int index)

public abstract Answer.Step.Action.Observation.SearchResult.SnippetInfo getSnippetInfo(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.SnippetInfo

getSnippetInfoCount()

public abstract int getSnippetInfoCount()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
int

getSnippetInfoList()

public abstract List<Answer.Step.Action.Observation.SearchResult.SnippetInfo> getSnippetInfoList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
List<SnippetInfo>

getSnippetInfoOrBuilder(int index)

public abstract Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder getSnippetInfoOrBuilder(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Parameter
Name	Description
index	int

Returns
Type	Description
Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder

getSnippetInfoOrBuilderList()

public abstract List<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder> getSnippetInfoOrBuilderList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfo snippet_info = 4;

Returns
Type	Description
List<? extends com.google.cloud.discoveryengine.v1.Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder>

getStructData()

public abstract Struct getStructData()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
Struct	The structData.

getStructDataOrBuilder()

public abstract StructOrBuilder getStructDataOrBuilder()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
StructOrBuilder

getTitle()

public abstract String getTitle()

Title.

string title = 3;

Returns
Type	Description
String	The title.

getTitleBytes()

public abstract ByteString getTitleBytes()

Title.

string title = 3;

Returns
Type	Description
ByteString	The bytes for title.

getUri()

public abstract String getUri()

URI for the document.

string uri = 2;

Returns
Type	Description
String	The uri.

getUriBytes()

public abstract ByteString getUriBytes()

URI for the document.

string uri = 2;

Returns
Type	Description
ByteString	The bytes for uri.

hasStructData()

public abstract boolean hasStructData()

Data representation. The structured JSON data for the document. It's populated from the struct data from the Document, or the Chunk in search result.

.google.protobuf.Struct struct_data = 6;

Returns
Type	Description
boolean	Whether the structData field is set.