Class AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo (0.72.0) 

public static final class AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo extends GeneratedMessageV3 implements AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfoOrBuilder

Unstructured document information.

Protobuf type google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo

Static Fields

DOCUMENT_CONTEXTS_FIELD_NUMBER

public static final int DOCUMENT_CONTEXTS_FIELD_NUMBER
Field Value
Type Description
int

DOCUMENT_FIELD_NUMBER

public static final int DOCUMENT_FIELD_NUMBER
Field Value
Type Description
int

EXTRACTIVE_ANSWERS_FIELD_NUMBER

public static final int EXTRACTIVE_ANSWERS_FIELD_NUMBER
Field Value
Type Description
int

EXTRACTIVE_SEGMENTS_FIELD_NUMBER

public static final int EXTRACTIVE_SEGMENTS_FIELD_NUMBER
Field Value
Type Description
int

TITLE_FIELD_NUMBER

public static final int TITLE_FIELD_NUMBER
Field Value
Type Description
int

URI_FIELD_NUMBER

public static final int URI_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo getDefaultInstance()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo

getDescriptor()

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

newBuilder()

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder newBuilder()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder

newBuilder(AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo prototype)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder newBuilder(AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo prototype)
Parameter
Name Description
prototype AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder

parseDelimitedFrom(InputStream input)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo> parser()
Returns
Type Description
Parser<UnstructuredDocumentInfo>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo getDefaultInstanceForType()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo

getDocument()

public String getDocument()

Document resource name.

string document = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
String

The document.

getDocumentBytes()

public ByteString getDocumentBytes()

Document resource name.

string document = 1 [(.google.api.resource_reference) = { ... }

Returns
Type Description
ByteString

The bytes for document.

getDocumentContexts(int index)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext getDocumentContexts(int index)

List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4;

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext

getDocumentContextsCount()

public int getDocumentContextsCount()

List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4;

Returns
Type Description
int

getDocumentContextsList()

public List<AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext> getDocumentContextsList()

List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4;

Returns
Type Description
List<DocumentContext>

getDocumentContextsOrBuilder(int index)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContextOrBuilder getDocumentContextsOrBuilder(int index)

List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4;

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContextOrBuilder

getDocumentContextsOrBuilderList()

public List<? extends AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContextOrBuilder> getDocumentContextsOrBuilderList()

List of document contexts. The content will be used for Answer Generation. This is supposed to be the main content of the document that can be long and comprehensive.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContext document_contexts = 4;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.DocumentContextOrBuilder>

getExtractiveAnswers(int index) (deprecated)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer getExtractiveAnswers(int index)

Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer

getExtractiveAnswersCount() (deprecated)

public int getExtractiveAnswersCount()

Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true];

Returns
Type Description
int

getExtractiveAnswersList() (deprecated)

public List<AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer> getExtractiveAnswersList()

Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true];

Returns
Type Description
List<ExtractiveAnswer>

getExtractiveAnswersOrBuilder(int index) (deprecated)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswerOrBuilder getExtractiveAnswersOrBuilder(int index)

Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true];

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswerOrBuilder

getExtractiveAnswersOrBuilderList() (deprecated)

public List<? extends AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswerOrBuilder> getExtractiveAnswersOrBuilderList()

Deprecated: This field is deprecated and will have no effect on the Answer generation. Please use document_contexts and extractive_segments fields. List of extractive answers.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswer extractive_answers = 6 [deprecated = true];

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveAnswerOrBuilder>

getExtractiveSegments(int index)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment getExtractiveSegments(int index)

List of extractive segments.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment extractive_segments = 5;

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment

getExtractiveSegmentsCount()

public int getExtractiveSegmentsCount()

List of extractive segments.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment extractive_segments = 5;

Returns
Type Description
int

getExtractiveSegmentsList()

public List<AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment> getExtractiveSegmentsList()

List of extractive segments.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment extractive_segments = 5;

Returns
Type Description
List<ExtractiveSegment>

getExtractiveSegmentsOrBuilder(int index)

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegmentOrBuilder getExtractiveSegmentsOrBuilder(int index)

List of extractive segments.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment extractive_segments = 5;

Parameter
Name Description
index int
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegmentOrBuilder

getExtractiveSegmentsOrBuilderList()

public List<? extends AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegmentOrBuilder> getExtractiveSegmentsOrBuilderList()

List of extractive segments.

repeated .google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegment extractive_segments = 5;

Returns
Type Description
List<? extends com.google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.ExtractiveSegmentOrBuilder>

getParserForType()

public Parser<AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo> getParserForType()
Returns
Type Description
Parser<UnstructuredDocumentInfo>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder newBuilderForType()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder toBuilder()
Returns
Type Description
AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException