Google Cloud Discovery Engine V1 Client - Class UnstructuredDocumentInfo (1.3.0)

Reference documentation and code samples for the Google Cloud Discovery Engine V1 Client class UnstructuredDocumentInfo.

Unstructured document information.

Generated from protobuf message google.cloud.discoveryengine.v1.AnswerQueryRequest.SearchSpec.SearchResultList.SearchResult.UnstructuredDocumentInfo

Namespace

Google \ Cloud \ DiscoveryEngine \ V1 \ AnswerQueryRequest \ SearchSpec \ SearchResultList \ SearchResult

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ document string

Document resource name.

↳ uri string

URI for the document.

↳ title string

Title.

↳ document_contexts array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\DocumentContext>

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.

↳ extractive_segments array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveSegment>

List of extractive segments.

↳ extractive_answers array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveAnswer>

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.

getDocument

Document resource name.

Returns
Type Description
string

setDocument

Document resource name.

Parameter
Name Description
var string
Returns
Type Description
$this

getUri

URI for the document.

Returns
Type Description
string

setUri

URI for the document.

Parameter
Name Description
var string
Returns
Type Description
$this

getTitle

Title.

Returns
Type Description
string

setTitle

Title.

Parameter
Name Description
var string
Returns
Type Description
$this

getDocumentContexts

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setDocumentContexts

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.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\DocumentContext>
Returns
Type Description
$this

getExtractiveSegments

List of extractive segments.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExtractiveSegments

List of extractive segments.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveSegment>
Returns
Type Description
$this

getExtractiveAnswers

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.

Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setExtractiveAnswers

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.

Parameter
Name Description
var array<Google\Cloud\DiscoveryEngine\V1\AnswerQueryRequest\SearchSpec\SearchResultList\SearchResult\UnstructuredDocumentInfo\ExtractiveAnswer>
Returns
Type Description
$this