View Source GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument (google_api_content_warehouse v0.5.0)

Document entry with metadata inside SearchDocumentsResponse

Attributes

document (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document.t, default: nil) - Document that matches the specified SearchDocumentsRequest. This document only contains indexed metadata information.
matchedTokenPageIndices (type: list(String.t), default: nil) - Return the 1-based page indices where those pages have one or more matched tokens.
qaResult (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1QAResult.t, default: nil) - Experimental. Additional result info if the question-answering feature is enabled.
searchTextSnippet (type: String.t, default: nil) - Contains snippets of text from the document full raw text that most closely match a search query's keywords, if available. All HTML tags in the original fields are stripped when returned in this field, and matching query keywords are enclosed in HTML bold tags. If the question-answering feature is enabled, this field will instead contain a snippet that answers the user's natural-language query. No HTML bold tags will be present, and highlights in the answer snippet can be found in QAResult.highlights.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument{
    document:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1Document.t()
      | nil,
    matchedTokenPageIndices: [String.t()] | nil,
    qaResult:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1QAResult.t()
      | nil,
    searchTextSnippet: String.t() | nil
  }

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.