La clase Document
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La clase Document representa un documento con contenido que se puede buscar.
Document se define en el módulo google.appengine.api.search.
Constructor
El constructor para la clase Document se define de la manera siguiente:
- class Document(doc_id=None, fields=None, language='en', rank=None)
Construye una instancia de la clase Document.
En el siguiente ejemplo, se muestra cómo crear un documento que consiste en un conjunto de campos, algunos de texto sin formato y uno en formato HTML:
from google.appengine.api import search
search.Document(
doc_id='documentId',
fields=[search.TextField(name='subject', value='going for dinner'),
search.HtmlField(name='body', value='<html>I found a place.</html>'),
search.TextField(name='signature', value='brzydka pogoda', language='pl')],
language='en')
Argumentos
- doc_id
El identificador de documento, una string ASCII en formato legible que identifica el documento. No debe contener caracteres de espacio en blanco y no debe comenzar con un signo de exclamación (!). Si se omite, el servicio de búsqueda proporcionará una string de identificador.
En la mayoría de los casos, no necesitas especificar el identificador de documento de manera explícita. No obstante, especificar tu propio identificador resulta útil para implementar la búsqueda con otros mecanismos de almacenamiento, como Blobstore o Google Storage. En el caso de Blobstore, por ejemplo, puedes establecer el identificador de documento en la BlobKey a fin de asociar ese documento con un BLOB específico.
- fields
Una colección iterable de objetos Field que representa el contenido del documento.
- language
Un código ISO 693-1 de dos letras para el lenguaje en el que se expresan los valores de campo del documento.
- rank
La clasificación de un documento, un número entero que especifica el orden en el que se mostrará en los resultados de la búsqueda. Los documentos más nuevos se muestran primero. Si no se especifica, la clasificación se establecerá en el número de segundos desde el 1 de enero de 2011 a las 00:00:00 UTC.
Ten en cuenta que, cuando se usa la clasificación en las clases FieldExpression o SortExpression, se hace referencia a ella como _rank.
Valor del resultado
Una instancia nueva de la clase Document.
Excepciones
- TypeError
Un parámetro tiene un tipo no válido, o se pasó un atributo desconocido.
- ValueError
Un parámetro tiene un valor no válido.
Propiedades
Una instancia de la clase Document tiene las siguientes propiedades:
- doc_id
El identificador de documento, una string ASCII en formato legible que identifica el documento.
- fields
La lista de los campos del documento.
- language
El código ISO 693-1 de dos letras para el lenguaje en el que se expresan los valores de campo del documento.
- rank
La clasificación de un documento, un número entero que especifica el orden en el que se mostrará en los resultados de la búsqueda.
Ten en cuenta que, cuando se usa la clasificación en las clases FieldExpression o SortExpression, se hace referencia a ella como _rank.
Además, si creas una clase SortExpression que incluye la clasificación como una de las claves de orden, la clasificación solo se puede ordenar en dirección DESCENDENTE.
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\u003eDocument\u003c/code\u003e class represents a searchable document and is defined within the \u003ccode\u003egoogle.appengine.api.search\u003c/code\u003e module.\u003c/p\u003e\n"],["\u003cp\u003eYou can construct a \u003ccode\u003eDocument\u003c/code\u003e instance by specifying a \u003ccode\u003edoc_id\u003c/code\u003e, an iterable collection of \u003ccode\u003eField\u003c/code\u003e objects, the language of the document, and an optional rank for search result ordering.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003edoc_id\u003c/code\u003e is a unique identifier for the document, and if not provided, the search service will automatically assign one.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003erank\u003c/code\u003e property determines the document's order in search results, with newer documents returned first, and if not specified, defaults to seconds since January 1, 2011.\u003c/p\u003e\n"],["\u003cp\u003eThe document language can be defined by the use of a two-letter \u003ca href=\"https://iso639-3.sil.org/\"\u003eISO 693-1\u003c/a\u003e code.\u003c/p\u003e\n"]]],[],null,["# The Document Class\n\nClass `Document` represents a document containing searchable content.\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`Document` is defined in the module `google.appengine.api.search`.\n\nConstructor\n-----------\n\nThe constructor for class `Document` is defined as follows:\n\nclass Document(doc_id=None, fields=None, language='en', rank=None)\n\n: Construct an instance of class `Document`.\n\n The following example shows how to create a document consisting of a set of fields, some plain text and one in HTML: \n\n ```python\n from google.appengine.api import search\n\n search.Document(\n doc_id='documentId',\n fields=[search.TextField(name='subject', value='going for dinner'),\n search.HtmlField(name='body', value='\u003chtml\u003eI found a place.\u003c/html\u003e'),\n search.TextField(name='signature', value='brzydka pogoda', language='pl')],\n language='en')\n ```\n\n \u003cbr /\u003e\n\n:\n\n Arguments\n\n doc_id\n\n : The *document identifier,* a human-readable ASCII string identifying the document. Must contain no whitespace characters and not start with an exclamation point (`!`). If omitted, the search service will provide an identifier string.\n\n\n In most cases, you do not need to specify the document identifier explicitly. Specifying your own identifier is useful, however, for implementing search with other storage mechanisms, such as Blobstore or Google Storage. In the case of Blobstore, for example, you can set the document identifier to the [BlobKey](/appengine/docs/legacy/standard/python/refdocs/google.appengine.ext.blobstore.blobstore#google.appengine.ext.blobstore.blobstore.BlobKey) in order to associate that document with a specific blob.\n\n fields\n\n : An iterable collection of `Field` objects representing the content of the document.\n\n language\n\n : A two-letter [ISO 693-1](https://iso639-3.sil.org/) code for the language in which the document's field values are expressed.\n\n rank\n\n : The document's *rank,* an integer specifying the order in which it will be returned in search results. Newer documents are returned first. If not specified the rank will be set to the number of seconds since 1 January 2011 00:00:00 UTC.\n Note that when rank is used in a FieldExpression or SortExpression it is referenced as `_rank`.\n\n Result value\n\n : A new instance of class `Document`.\n\n Exceptions\n\n TypeError\n\n : A parameter has an invalid type or an unknown attribute was passed.\n\n ValueError\n\n : A parameter has an invalid value.\n\n \u003cbr /\u003e\n\n\u003cbr /\u003e\n\nProperties\n----------\n\nAn instance of class `Document` has the following properties:\n\ndoc_id\n\n: The document identifier, a human-readable ASCII string identifying the document.\n\nfields\n\n: A list of the document's [fields](/appengine/docs/legacy/standard/python/search/fieldclasses).\n\nlanguage\n\n: The two-letter [ISO 693-1](https://iso639-3.sil.org/) code for the language in which the document's field values are expressed.\n\nrank\n\n: The document's rank, an integer specifying the order in which it will be returned in search results.\n Note that when rank is used in a FieldExpression or SortExpression it is referenced as `_rank`.\n Also, if you create a SortExpression that includes rank as one of the sort keys, rank can only be sorted in\n the DESCENDING direction."]]
