Class SearchResult (0.12.0)

Version 0.12.0

• 0.13.5 (latest)
• 0.13.4
• 0.12.3
• 0.11.14
• 0.10.0
• 0.9.1
• 0.8.1
• 0.7.0
• 0.6.0
• 0.5.0
• 0.4.1
• 0.3.1
• 0.2.1
• 0.1.1

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

Attributes
Name	Description
document	str Document resource name.
uri	str URI for the document.
title	str Title.
snippet_info	MutableSequence[google.cloud.discoveryengine_v1.types.Answer.Step.Action.Observation.SearchResult.SnippetInfo] If citation_type is DOCUMENT_LEVEL_CITATION, populate document level snippets.
chunk_info	MutableSequence[google.cloud.discoveryengine_v1.types.Answer.Step.Action.Observation.SearchResult.ChunkInfo] If citation_type is CHUNK_LEVEL_CITATION and chunk mode is on, populate chunk info.
struct_data	google.protobuf.struct_pb2.Struct Data representation. The structured JSON data for the document. It's populated from the struct data from the Document (code pointer: http://shortn/_objzAfIiHq), or the Chunk in search result (code pointer: http://shortn/_Ipo6KFFGBL).

Classes

ChunkInfo

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

Chunk information.

.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields

SnippetInfo

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

Snippet information.