GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter

AI Overview😉

  • Potential purpose of module in simple language: This module appears to be a filter for a histogram query in Google's Content Warehouse. It allows users to specify which document schemas and property names to include in the query, and how to display the results on the y-axis.
  • How it could impact search results: This module could impact search results by allowing Google to more accurately and efficiently generate histograms for specific document schemas and property names. This could lead to more relevant and useful results for users searching for specific types of data or information. By filtering out irrelevant data, the histogram query can provide a more accurate representation of the data, which can improve the overall search experience.
  • How a website may change things to be more favorable for this function: To be more favorable for this function, a website could ensure that its document schemas and property names are well-defined and accurately represented in the Content Warehouse. This could involve using a consistent naming convention for property names, and ensuring that the `is_filterable` flag is set to `true` for relevant properties. Additionally, websites could consider optimizing their document schemas to make it easier for Google to generate accurate histograms.

Interesting Module? Vote 👇

Voting helps other researchers find interesting modules.

Current Votes: 0

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

Attributes

  • documentSchemas (type: list(String.t), default: nil) - This filter specifies the exact document schema(s) Document.document_schema_name to run histogram query against. It is optional. It will perform histogram for property names for all the document schemas if it is not set. At most 10 document schema names are allowed. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.
  • propertyNames (type: list(String.t), default: nil) - It is optional. It will perform histogram for all the property names if it is not set. The properties need to be defined with the is_filterable flag set to true and the name of the property should be in the format: "schemaId.propertyName". The property needs to be defined in the schema. Example: the schema id is abc. Then the name of property for property MORTGAGE_TYPE will be "abc.MORTGAGE_TYPE".
  • yAxis (type: String.t, default: nil) - By default, the y_axis is HISTOGRAM_YAXIS_DOCUMENT if this field is not set.

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.GoogleCloudContentwarehouseV1HistogramQueryPropertyNameFilter{
    documentSchemas: [String.t()] | nil,
    propertyNames: [String.t()] | nil,
    yAxis: 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.