GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument

AI Overview😉

  • The potential purpose of this module is to provide a detailed response to a search query, including the relevant document, page indices where the search terms are found, and a snippet of text that closely matches the search query. This module aims to improve the search result's relevance and accuracy by highlighting the most important information.
  • This module could impact search results by making them more informative and relevant to the user's query. The matchedTokenPageIndices feature helps users quickly locate the relevant sections of a document, while the searchTextSnippet provides a concise summary of the document's content. This could lead to more accurate and efficient search results, as users can quickly determine whether a document is relevant to their query.
  • A website may change things to be more favorable for this function by ensuring that their document's metadata is accurately indexed, making it easier for the search algorithm to match search queries with relevant documents. Additionally, using clear and concise language in the document's content, especially in the sections that are most relevant to the search query, can increase the chances of a document being returned as a top search result. Optimizing the document's structure and content to facilitate easy extraction of relevant snippets can also improve the search result's quality.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument (google_api_content_warehouse v0.4.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

Link to this type

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

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.