RepositoryWebrefPreprocessingNameEntityMetadata

AI Overview😉

The potential purpose of this module is to process and analyze name entities in search queries, such as identifying whether a name is a compound name, a generated name, a dictionary term, or a strong identifier. It also tracks metadata about the name, like its original version and whether it should be tokenized or not.
This module could impact search results by influencing how names are matched and ranked in search queries. For example, if a name is marked as a strong identifier, it may be given more weight in the search results. Similarly, if a name is bypassed due to too many entities, it may not be considered in the search results.
To be more favorable for this function, a website may want to ensure that its names and entities are accurately represented and easily machine-readable. This could involve using standardized naming conventions, providing clear and concise metadata about entities, and ensuring that names are not overly complex or ambiguous. Additionally, websites may want to consider optimizing their content to be more easily crawled and indexed by search engines.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

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

Metadata about a name. There are two metadata protos, whose content is meant to be similar but their usage different: NameEntityMetadata for readability and ConceptNameMetadata for size / decoding speed. NameEntityMetadata is propagated to GlobalNameInfo and EntityJoin tables, while ConceptNameMetadata is propagated from EntityJoins to the name matching tables and later to the Webref's/QRef's output. To add a new metadata field in the Names pipeline, and propagate it to EntityJoins and Names matching tables, it is necessary to: (1) Add the field to NameEntityMetadata, and a corresponding data representation in ConceptNameMetadata. (2) Populate the field in NameVariantSignals.name_metadata, from any source. This can be done in a corresponding NameProcessor. (3) Update the library name-metadata.h/cc to make sure that the metadata field is: a) merged correctly when merging two NameSignals; and b) transformed to the corresponding field in ConceptNameMetadata proto. Next available tag: 22.

Attributes

isBypassedName (type: boolean(), default: nil) - There is a limit of entities per name for which we can keep name signals and score. This flag is set to true for names that by-passed per-name-scoring, as there were too many entities for the name.
isCompoundName (type: boolean(), default: nil) - This name is a generated compound name to pass primary pruning.
isCompoundRetrievalKey (type: boolean(), default: nil) - Indicates special compound retrieval keys, like "Compound $mid1 $mid2"
isDictionaryTerm (type: boolean(), default: nil) - This is set to true if the entity corresponds to a dictionary term.
isEventRetrievalKey (type: boolean(), default: nil) - If true, this name is an event retrieval key.
isGeneratedName (type: boolean(), default: nil) - This name is generated from other names.
isGeneratedStreetname (type: boolean(), default: nil) - This name is a generated street name.
isHierarchyPropagated (type: boolean(), default: nil) - This name is added by name propagation in hierarchy.
isIsbn (type: boolean(), default: nil) - This name is an ISBN.
isLyricsContent (type: boolean(), default: nil) - This name comes from recording lyrics content.
isPhoneNumber (type: boolean(), default: nil) - This name is a phone number.
isRefconName (type: boolean(), default: nil) - This name is used for refcon.
isReferenceName (type: boolean(), default: nil) - This name is a reference name, only for internal usage, this name should not go into matching table without support of other signals.
isRefpageUrl (type: boolean(), default: nil) - This name is the URL of a reference page.
isReverseUniquePropertyName (type: boolean(), default: nil) - This name is generated from a reverse unique property of the entity.
isStrongIdentifier (type: boolean(), default: nil) - This name is a strong identifier for this entity.
isSynonymOrFuzzyMatch (type: boolean(), default: nil) - Set if the name is coming from synonyms.
isTrustedAllcapsName (type: boolean(), default: nil) - If true, this name is a trusted name if it is in ALLCAPS.
isUnnormalizedName (type: boolean(), default: nil) - If true, do not do tokenization when compute fprint hash for this name.
notGeneratedName (type: boolean(), default: nil) - This name is clearly not generated(aka. at least one source of this name is not generated). This field is added for simplifying generated name tag while merging. Do not use this metadata directly.
originalNames (type: GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefPreprocessingOriginalNames.t, default: nil) - Original versions of the name (before normalization). Used as query for the entity by Explicit Entity Search.
suppressTokenization (type: boolean(), default: nil) - Whether or not to suppress tokenization on this name.

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.RepositoryWebrefPreprocessingNameEntityMetadata{
    isBypassedName: boolean() | nil,
    isCompoundName: boolean() | nil,
    isCompoundRetrievalKey: boolean() | nil,
    isDictionaryTerm: boolean() | nil,
    isEventRetrievalKey: boolean() | nil,
    isGeneratedName: boolean() | nil,
    isGeneratedStreetname: boolean() | nil,
    isHierarchyPropagated: boolean() | nil,
    isIsbn: boolean() | nil,
    isLyricsContent: boolean() | nil,
    isPhoneNumber: boolean() | nil,
    isRefconName: boolean() | nil,
    isReferenceName: boolean() | nil,
    isRefpageUrl: boolean() | nil,
    isReverseUniquePropertyName: boolean() | nil,
    isStrongIdentifier: boolean() | nil,
    isSynonymOrFuzzyMatch: boolean() | nil,
    isTrustedAllcapsName: boolean() | nil,
    isUnnormalizedName: boolean() | nil,
    notGeneratedName: boolean() | nil,
    originalNames:
      GoogleApi.ContentWarehouse.V1.Model.RepositoryWebrefPreprocessingOriginalNames.t()
      | nil,
    suppressTokenization: boolean() | nil
  }

Functions

Link to this function

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.