Interface AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfoOrBuilder (0.50.0)

public static interface AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfoOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDocument()

public abstract String getDocument()

Document resource name.

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

Returns
Type Description
String

The document.

getDocumentBytes()

public abstract ByteString getDocumentBytes()

Document resource name.

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

Returns
Type Description
ByteString

The bytes for document.

getDocumentContexts(int index)

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

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.