La clase FacetRefinement
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La clase FacetRefinement se usa para restringir los resultados de la búsqueda en función de un valor de faceta.
Se recomienda usar la string de token para definir mejor la faceta. Cada FacetResult tendrá un token aceptable en lugar de esta clase. Con el fin de 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 para la clase FacetRefinement se define de la siguiente manera:
clase FacetRefinement(name, value=None, facet_range=None)
Construye una instancia de la clase FacetRefinement.
NOTA: Se debe configurar el valor o facet_range, pero no se deben configurar ambos.
Argumentos
- name
Configura la propiedad del nombre.
- value
Configura la propiedad del valor.
- facet_range
Configura la propiedad de facet_range.
Valor del resultado
Una instancia nueva de la clase FacetRefinement.
Excepciones
- TypeError
Se muestra si cualquiera de los parámetros tiene un tipo no válido, o si se pasa un atributo desconocido.
- ValueError
Se muestra si cualquiera de los parámetros tiene valores no válidos.
Propiedades
Una instancia de la clase FacetRefinement tiene las siguientes propiedades:
- name
El nombre del perfeccionamiento de la faceta.
- value
El valor de string del perfeccionamiento de la faceta.
- rango
El rango numérico de la faceta de refinamiento.
Métodos de instancia
Las instancias de la clase FacetRefinement tienen los siguientes métodos:
- ToTokenString()
Convierte este perfeccionamiento en una string de token segura para usar en HTML. El formato de la string puede variar.
-
Valor del resultado
Una string de token segura para usar en HTML con el fin de realizar este perfeccionamiento de faceta.
- FromTokenString()
Este método estático convierte una string de token en un objeto FacetRefinement. No almacenes strings de token entre diferentes versiones de API porque es posible que la clave no sea compatible.
-
Argumentos
- token_string
Una string de token creada con el método ToTokenString o que se muestra como el resultado de una búsqueda.
Valor del resultado
Un objeto FacetRefinement.
Excepciones
- ValueError
Se muestra si token_string no es válida.
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-09-04 (UTC)
[[["Fácil de comprender","easyToUnderstand","thumb-up"],["Resolvió mi problema","solvedMyProblem","thumb-up"],["Otro","otherUp","thumb-up"]],[["Difícil de entender","hardToUnderstand","thumb-down"],["Información o código de muestra incorrectos","incorrectInformationOrSampleCode","thumb-down"],["Faltan la información o los ejemplos que necesito","missingTheInformationSamplesINeed","thumb-down"],["Problema de traducción","translationIssue","thumb-down"],["Otro","otherDown","thumb-down"]],["Última actualización: 2025-09-04 (UTC)"],[[["\u003cp\u003eThe \u003ccode\u003eFacetRefinement\u003c/code\u003e class is used to refine search results based on a specific facet value.\u003c/p\u003e\n"],["\u003cp\u003eWhile manual \u003ccode\u003eFacetRefinement\u003c/code\u003e is possible, using the token string from \u003ccode\u003eFacetResult\u003c/code\u003e is the recommended approach.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eFacetRefinement\u003c/code\u003e constructor accepts a name, a value, or a \u003ccode\u003efacet_range\u003c/code\u003e, but only one of the value or facet_range can be specified.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e instances have \u003ccode\u003ename\u003c/code\u003e, \u003ccode\u003evalue\u003c/code\u003e, and \u003ccode\u003erange\u003c/code\u003e properties that define the refinement.\u003c/p\u003e\n"],["\u003cp\u003e\u003ccode\u003eFacetRefinement\u003c/code\u003e objects can be converted to token strings using \u003ccode\u003eToTokenString()\u003c/code\u003e and can be created from a token string using the \u003ccode\u003eFromTokenString()\u003c/code\u003e method.\u003c/p\u003e\n"]]],[],null,["# The FacetRefinement Class\n\nClass `FacetRefinement` is used to narrow search results based on a facet value.\n\nThe recommended way to use facet refinement is to use its token string. Each FacetResult will\nhave a token that is acceptable instead of this class. To provide manual FacetRefinement, an\ninstance of this class can be passed to SearchOptions.\n| This API is supported for first-generation runtimes and can be used when [upgrading to corresponding second-generation runtimes](/appengine/docs/standard/\n| python3\n|\n| /services/access). If you are updating to the App Engine Python 3 runtime, refer to the [migration guide](/appengine/migration-center/standard/migrate-to-second-gen/python-differences) to learn about your migration options for legacy bundled services.\n\n`FacetRefinement` is defined in the module `google.appengine.api.search`.\n\nConstructor\n-----------\n\nThe constructor for class `FacetRefinement` is defined as follows:\n\nclass FacetRefinement(name, value=None, facet_range=None)\n\n: Construct an instance of class `FacetRefinement`.\n\n NOTE: Either the value or the facet_range should be set but not both.\n\n:\n\n Arguments\n\n name\n\n : Sets the name property\n\n value\n\n : Sets the value property\n\n facet_range\n\n : Sets the facet_range property\n\n Result value\n\n : A new instance of class `FacetRefinement`.\n\n Exceptions\n\n TypeError\n\n : If any of the parameters have invalid types, or an unknown\n attribute is passed.\n\n ValueError\n\n : If any of the parameters have invalid values.\n\n \u003cbr /\u003e\n\n\u003cbr /\u003e\n\nProperties\n----------\n\nAn instance of class `FacetRefinement` has the following properties:\n\nname\n\n: name of the facet refinement.\n\nvalue\n\n: string value of the facet refinement.\n\nrange\n\n: numeric range of the facet refinement.\n\nInstance Methods\n----------------\n\nInstances of class `FacetRefinement` have the following methods:\n\nToTokenString()\n\n: Converts this refinement to a token string safe to be used in HTML. The format of this string may change.\n\n: Result value\n\n : A token string safe to be used in HTML for this facet refinement.\n\nFromTokenString()\n\n: This static method converts a token string to a FacetRefinement object. Do not store token strings between different versions of API as key could\n be incompatible.\n\n: Arguments\n\n token_string\n\n : A token string created by ToTokenString method or returned\n by a search result.\n\n Result value\n\n : A FacetRefinement object.\n\n Exceptions\n\n ValueError\n\n : If the token_string is invalid."]]
