La clase FacetRefinement se usa para acotar los resultados de búsqueda en función del valor de una faceta.
La forma recomendada de usar el refinamiento por facetas es mediante su cadena de token. Cada FacetResult tendrá un token que se puede usar en lugar de esta clase. Para proporcionar FacetRefinement manual, se puede pasar una instancia de esta clase a SearchOptions.
FacetRefinement se define en el módulo google.appengine.api.search.
Constructor
El constructor de la clase FacetRefinement se define de la siguiente manera:
class FacetRefinement(name, value=None, facet_range=None)
Crea una instancia de la clase
FacetRefinement.NOTA: Se debe definir el valor o el facet_range, pero no ambos.
Argumentos
- name
Define la propiedad name.
- value
Define la propiedad value.
- facet_range
Define la propiedad facet_range.
Valor de resultado
Una nueva instancia de la clase
FacetRefinement.
Excepciones
- TypeError
Si alguno de los parámetros tiene un tipo no válido o se pasa un atributo desconocido.
- ValueError
Si alguno de los parámetros tiene valores no válidos.
Propiedades
Una instancia de la clase FacetRefinement tiene las siguientes propiedades:
- name
Nombre de la búsqueda restringida por faceta.
- value
Valor de cadena del refinamiento de la faceta.
- intervalo
rango numérico del filtro de faceta.
Métodos de instancia
Las instancias de la clase FacetRefinement tienen los siguientes métodos:
- ToTokenString()
Convierte este refinamiento en una cadena de tokens que se puede usar de forma segura en HTML. El formato de esta cadena puede cambiar.
-
Valor de resultado
Cadena de token que se puede usar de forma segura en HTML para este refinamiento de faceta.
- FromTokenString()
Este método estático convierte una cadena de token en un objeto FacetRefinement. No almacenes cadenas de tokens entre diferentes versiones de la API, ya que la clave podría ser incompatible.
-
Argumentos
- token_string
Una cadena de token creada por el método ToTokenString o devuelta por un resultado de búsqueda.
Valor de resultado
Objeto FacetRefinement.
Excepciones
- ValueError
Si token_string no es válido.