GoogleCloudContentwarehouseV1SearchDocumentsResponse

AI Overview😉

  • The potential purpose of this module is to provide a response to a search query, including various types of results such as histogram query results, matching documents, and question answers. It also provides metadata about the search request and pagination information.
  • This module could impact search results by influencing the ranking and relevance of documents returned in response to a search query. The histogram query results, matching documents, and question answers could all contribute to a more nuanced understanding of the search query and the documents that match it, potentially leading to more accurate and relevant search results. The total size of matched documents and pagination information could also affect the search results, as they would determine which documents are displayed and how the user navigates through the results.
  • A website may change things to be more favorable for this function by optimizing their content to match the search queries and histogram queries, ensuring that their documents are accurately indexed and matched, and providing clear and concise answers to potential questions. They may also want to ensure that their content is structured in a way that allows for easy pagination and navigation, and that their metadata is accurate and complete. Additionally, they may want to consider how their content is being crawled and indexed, and make sure that it is accessible and crawlable by Google's algorithms.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponse (google_api_content_warehouse v0.4.0)

Response message for DocumentService.SearchDocuments.

Attributes

  • histogramQueryResults (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1HistogramQueryResult.t), default: nil) - The histogram results that match with the specified SearchDocumentsRequest.histogram_queries.
  • matchingDocuments (type: list(GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.t), default: nil) - The document entities that match the specified SearchDocumentsRequest.
  • metadata (type: GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ResponseMetadata.t, default: nil) - Additional information for the API invocation, such as the request tracking id.
  • nextPageToken (type: String.t, default: nil) - The token that specifies the starting position of the next page of results. This field is empty if there are no more results.
  • questionAnswer (type: String.t, default: nil) - Experimental. Question answer from the query against the document.
  • totalSize (type: integer(), default: nil) - The total number of matched documents which is available only if the client set SearchDocumentsRequest.require_total_size to true or set SearchDocumentsRequest.total_result_size to ESTIMATED_SIZE or ACTUAL_SIZE. Otherwise, the value will be -1. Typically a UI would handle this condition by displaying "of many", for example: "Displaying 10 of many".

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.GoogleCloudContentwarehouseV1SearchDocumentsResponse{
    histogramQueryResults:
      [
        GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1HistogramQueryResult.t()
      ]
      | nil,
    matchingDocuments:
      [
        GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1SearchDocumentsResponseMatchingDocument.t()
      ]
      | nil,
    metadata:
      GoogleApi.ContentWarehouse.V1.Model.GoogleCloudContentwarehouseV1ResponseMetadata.t()
      | nil,
    nextPageToken: String.t() | nil,
    questionAnswer: String.t() | nil,
    totalSize: integer() | nil
  }

Functions

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.