Class SearchResult (0.13.12)

SearchResult(mapping=None, *, ignore_unknown_fields=False, **kwargs)

Represents the search results.

Attributes
Name	Description
`id`	`str` Document.id of the searched Document.
`document`	`google.cloud.discoveryengine_v1.types.Document` The document data snippet in the search response. Only fields that are marked as `retrievable` are populated.
`chunk`	`google.cloud.discoveryengine_v1.types.Chunk` The chunk data in the search response if the SearchRequest.ContentSearchSpec.search_result_mode is set to CHUNKS.
`model_scores`	`MutableMapping[str, google.cloud.discoveryengine_v1.types.DoubleList]` Output only. Google provided available scores.
`rank_signals`	`google.cloud.discoveryengine_v1.types.SearchResponse.SearchResult.RankSignals` A set of ranking signals associated with the result.

Classes

ModelScoresEntry(mapping=None, *, ignore_unknown_fields=False, **kwargs)

The abstract base class for a message.

Parameters
Name	Description
`kwargs`	`dict` Keys and values corresponding to the fields of the message.
`mapping`	`Union[dict, .Message]` A dictionary or message to be used to determine the values for this message.
`ignore_unknown_fields`	`Optional(bool)` If True, do not raise errors for unknown fields. Only applied if `mapping` is a mapping type or there are keyword parameters.

RankSignals(mapping=None, *, ignore_unknown_fields=False, **kwargs)

A set of ranking signals.