Class Answer.Step.Action.Observation.SearchResult.Builder (0.51.0)

public static final class Answer.Step.Action.Observation.SearchResult.Builder extends GeneratedMessageV3.Builder<Answer.Step.Action.Observation.SearchResult.Builder> implements Answer.Step.Action.Observation.SearchResultOrBuilder

Protobuf type google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addAllChunkInfo(Iterable<? extends Answer.Step.Action.Observation.SearchResult.ChunkInfo> values)

public Answer.Step.Action.Observation.SearchResult.Builder addAllChunkInfo(Iterable<? extends Answer.Step.Action.Observation.SearchResult.ChunkInfo> values)

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

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo>
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addAllSnippetInfo(Iterable<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfo> values)

public Answer.Step.Action.Observation.SearchResult.Builder addAllSnippetInfo(Iterable<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfo> values)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
values Iterable<? extends com.google.cloud.discoveryengine.v1alpha.Answer.Step.Action.Observation.SearchResult.SnippetInfo>
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addChunkInfo(Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder addChunkInfo(Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

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

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

Parameter
Name Description
value Answer.Step.Action.Observation.SearchResult.ChunkInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addChunkInfo(Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder addChunkInfo(Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

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

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

Parameter
Name Description
builderForValue Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder addChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

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

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

Parameters
Name Description
index int
value Answer.Step.Action.Observation.SearchResult.ChunkInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder addChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addChunkInfoBuilder()

public Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder addChunkInfoBuilder()

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

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

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

addChunkInfoBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder addChunkInfoBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Answer.Step.Action.Observation.SearchResult.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

addSnippetInfo(Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder addSnippetInfo(Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
value Answer.Step.Action.Observation.SearchResult.SnippetInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addSnippetInfo(Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder addSnippetInfo(Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
builderForValue Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder addSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameters
Name Description
index int
value Answer.Step.Action.Observation.SearchResult.SnippetInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder addSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameters
Name Description
index int
builderForValue Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

addSnippetInfoBuilder()

public Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder addSnippetInfoBuilder()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

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

addSnippetInfoBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder addSnippetInfoBuilder(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder

build()

public Answer.Step.Action.Observation.SearchResult build()
Returns
Type Description
Answer.Step.Action.Observation.SearchResult

buildPartial()

public Answer.Step.Action.Observation.SearchResult buildPartial()
Returns
Type Description
Answer.Step.Action.Observation.SearchResult

clear()

public Answer.Step.Action.Observation.SearchResult.Builder clear()
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

clearChunkInfo()

public Answer.Step.Action.Observation.SearchResult.Builder clearChunkInfo()

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

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

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

clearDocument()

public Answer.Step.Action.Observation.SearchResult.Builder clearDocument()

Document resource name.

string document = 1;

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

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Answer.Step.Action.Observation.SearchResult.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Answer.Step.Action.Observation.SearchResult.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

clearSnippetInfo()

public Answer.Step.Action.Observation.SearchResult.Builder clearSnippetInfo()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

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

clearStructData()

public Answer.Step.Action.Observation.SearchResult.Builder clearStructData()

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
Answer.Step.Action.Observation.SearchResult.Builder

clearTitle()

public Answer.Step.Action.Observation.SearchResult.Builder clearTitle()

Title.

string title = 3;

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

This builder for chaining.

clearUri()

public Answer.Step.Action.Observation.SearchResult.Builder clearUri()

URI for the document.

string uri = 2;

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

This builder for chaining.

clone()

public Answer.Step.Action.Observation.SearchResult.Builder clone()
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

getChunkInfo(int index)

public 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.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.ChunkInfo

getChunkInfoBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder getChunkInfoBuilder(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder

getChunkInfoBuilderList()

public List<Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder> getChunkInfoBuilderList()

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

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

Returns
Type Description
List<Builder>

getChunkInfoCount()

public int getChunkInfoCount()

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

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

Returns
Type Description
int

getChunkInfoList()

public 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.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

Returns
Type Description
List<ChunkInfo>

getChunkInfoOrBuilder(int index)

public 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.v1alpha.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 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.v1alpha.Answer.Step.Action.Observation.SearchResult.ChunkInfo chunk_info = 5;

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

getDefaultInstanceForType()

public Answer.Step.Action.Observation.SearchResult getDefaultInstanceForType()
Returns
Type Description
Answer.Step.Action.Observation.SearchResult

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDocument()

public String getDocument()

Document resource name.

string document = 1;

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Document resource name.

string document = 1;

Returns
Type Description
ByteString

The bytes for document.

getSnippetInfo(int index)

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

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.SnippetInfo

getSnippetInfoBuilder(int index)

public Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder getSnippetInfoBuilder(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder

getSnippetInfoBuilderList()

public List<Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder> getSnippetInfoBuilderList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Returns
Type Description
List<Builder>

getSnippetInfoCount()

public int getSnippetInfoCount()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Returns
Type Description
int

getSnippetInfoList()

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

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Returns
Type Description
List<SnippetInfo>

getSnippetInfoOrBuilder(int index)

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

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

repeated .google.cloud.discoveryengine.v1alpha.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 List<? extends Answer.Step.Action.Observation.SearchResult.SnippetInfoOrBuilder> getSnippetInfoOrBuilderList()

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

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

getStructData()

public 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.

getStructDataBuilder()

public Struct.Builder getStructDataBuilder()

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
Builder

getStructDataOrBuilder()

public 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 String getTitle()

Title.

string title = 3;

Returns
Type Description
String

The title.

getTitleBytes()

public ByteString getTitleBytes()

Title.

string title = 3;

Returns
Type Description
ByteString

The bytes for title.

getUri()

public String getUri()

URI for the document.

string uri = 2;

Returns
Type Description
String

The uri.

getUriBytes()

public ByteString getUriBytes()

URI for the document.

string uri = 2;

Returns
Type Description
ByteString

The bytes for uri.

hasStructData()

public 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.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(Answer.Step.Action.Observation.SearchResult other)

public Answer.Step.Action.Observation.SearchResult.Builder mergeFrom(Answer.Step.Action.Observation.SearchResult other)
Parameter
Name Description
other Answer.Step.Action.Observation.SearchResult
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Answer.Step.Action.Observation.SearchResult.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public Answer.Step.Action.Observation.SearchResult.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

mergeStructData(Struct value)

public Answer.Step.Action.Observation.SearchResult.Builder mergeStructData(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Answer.Step.Action.Observation.SearchResult.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

removeChunkInfo(int index)

public Answer.Step.Action.Observation.SearchResult.Builder removeChunkInfo(int index)

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

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

removeSnippetInfo(int index)

public Answer.Step.Action.Observation.SearchResult.Builder removeSnippetInfo(int index)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameter
Name Description
index int
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder setChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo value)

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

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

Parameters
Name Description
index int
value Answer.Step.Action.Observation.SearchResult.ChunkInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder setChunkInfo(int index, Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder builderForValue)

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

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

Parameters
Name Description
index int
builderForValue Answer.Step.Action.Observation.SearchResult.ChunkInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setDocument(String value)

public Answer.Step.Action.Observation.SearchResult.Builder setDocument(String value)

Document resource name.

string document = 1;

Parameter
Name Description
value String

The document to set.

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

This builder for chaining.

setDocumentBytes(ByteString value)

public Answer.Step.Action.Observation.SearchResult.Builder setDocumentBytes(ByteString value)

Document resource name.

string document = 1;

Parameter
Name Description
value ByteString

The bytes for document to set.

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

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public Answer.Step.Action.Observation.SearchResult.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Answer.Step.Action.Observation.SearchResult.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

setSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

public Answer.Step.Action.Observation.SearchResult.Builder setSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo value)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameters
Name Description
index int
value Answer.Step.Action.Observation.SearchResult.SnippetInfo
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder setSnippetInfo(int index, Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder builderForValue)

If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.

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

Parameters
Name Description
index int
builderForValue Answer.Step.Action.Observation.SearchResult.SnippetInfo.Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setStructData(Struct value)

public Answer.Step.Action.Observation.SearchResult.Builder setStructData(Struct value)

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;

Parameter
Name Description
value Struct
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setStructData(Struct.Builder builderForValue)

public Answer.Step.Action.Observation.SearchResult.Builder setStructData(Struct.Builder builderForValue)

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;

Parameter
Name Description
builderForValue Builder
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder

setTitle(String value)

public Answer.Step.Action.Observation.SearchResult.Builder setTitle(String value)

Title.

string title = 3;

Parameter
Name Description
value String

The title to set.

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

This builder for chaining.

setTitleBytes(ByteString value)

public Answer.Step.Action.Observation.SearchResult.Builder setTitleBytes(ByteString value)

Title.

string title = 3;

Parameter
Name Description
value ByteString

The bytes for title to set.

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

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Answer.Step.Action.Observation.SearchResult.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
Answer.Step.Action.Observation.SearchResult.Builder
Overrides

setUri(String value)

public Answer.Step.Action.Observation.SearchResult.Builder setUri(String value)

URI for the document.

string uri = 2;

Parameter
Name Description
value String

The uri to set.

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

This builder for chaining.

setUriBytes(ByteString value)

public Answer.Step.Action.Observation.SearchResult.Builder setUriBytes(ByteString value)

URI for the document.

string uri = 2;

Parameter
Name Description
value ByteString

The bytes for uri to set.

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

This builder for chaining.