RepositoryWebrefImageQueryIndices

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefImageQueryIndices

Table of Contents ▼

Jump to a specific part of the page:

Description

Identifies a set of Image NavBoost queries in the CompositeDoc. Each CompositeDoc can contain several images, so we store the image index from the CompositeDoc::doc_images with the index of the particular query inside ImageData::image_data_navboost.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. canonicalDocid (type: String.t, default: nil)
    - The (canonical) image docid of the ImageData this image query is part of. Useful for identifying the ImageData even after doc_images are updated in between Webref annotation runs. Use docid only when canonical_docid == 0.
  2. docid (type: String.t, default: nil)
    -
  3. imageIndex (type: integer(), default: nil)
    - WARNING: The doc_images in docjoins are subject to updates including non-deterministic reordering of doc_images and their image_nb_data extensions. This means that without re-running WebrefAnnotator one cannot rely on the accuracy or even consistency of either image_index or query_index when parsing a cdoc from docjoins. In those situations one ought to rely on canonical_docid (or docid when canonical_docid is absent viz. 0). The index of the source image in CompositeDoc::doc_images.
  4. queryIndex (type: GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefQueryIndices, default: nil)
    - Queries index in ImageData::image_data_navboost.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefImageQueryIndices{
canonicalDocid: String.t() | nil,
docid: String.t() | nil,
imageIndex: integer() | nil,
queryIndex: GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefQueryIndices.t() | nil
}

Function

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

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefImageQueryIndices