Python 2.7 telah mencapai akhir dukungan
dan akan
dihentikan penggunaannya
pada 31 Januari 2026. Setelah penghentian penggunaan, Anda tidak akan dapat men-deploy aplikasi Python 2.7, meskipun organisasi Anda sebelumnya menggunakan kebijakan organisasi untuk mengaktifkan kembali deployment runtime lama. Aplikasi Python 2.7 yang ada akan terus berjalan dan menerima traffic setelah
tanggal penghentiannya. Sebaiknya Anda
bermigrasi ke versi Python terbaru yang didukung.
Class Dokumen
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Class Document mewakili dokumen yang berisi konten yang dapat ditelusuri.
Document ditentukan dalam modul google.appengine.api.search.
Konstruktor
Konstruktor untuk class Document ditentukan sebagai berikut:
- class Document(doc_id=None, fields=None, language='en', rank=None)
Buat instance class Document.
Contoh berikut menunjukkan cara membuat dokumen yang terdiri dari kumpulan kolom, beberapa teks biasa, dan satu lagi dalam 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')
Argumen
- doc_id
ID dokumen, string ASCII yang dapat dibaca manusia yang mengidentifikasi dokumen. Tidak boleh berisi karakter spasi kosong dan tidak boleh diawali dengan tanda seru (!). Jika dihilangkan, layanan penelusuran akan menyediakan string ID.
Pada umumnya, Anda tidak perlu menyebutkan ID dokumen secara eksplisit. Namun, menentukan ID Anda sendiri berguna untuk menerapkan penelusuran dengan mekanisme penyimpanan lain, seperti Blobstore atau Google Storage. Untuk Blobstore, misalnya, Anda dapat menetapkan ID dokumen ke BlobKey untuk mengaitkan dokumen tersebut dengan blob tertentu.
- kolom
Kumpulan objek Field iterable yang mewakili konten dokumen.
- bahasa
Kode dua huruf ISO 693-1 untuk bahasa yang digunakan untuk menyatakan nilai kolom dokumen.
- peringkat
Peringkat dokumen, bilangan bulat yang menentukan urutan dokumen yang akan ditampilkan dalam hasil penelusuran. Dokumen baru akan ditampilkan terlebih dahulu. Jika tidak ditentukan, peringkat akan ditetapkan ke jumlah detik yang dimulai sejak 1 Januari 2011 00:00:00 UTC.
Perhatikan bahwa saat peringkat digunakan dalam FieldExpression atau SortExpression, peringkat akan dirujuk sebagai _rank.
Nilai hasil
Instance baru dari class Document.
Pengecualian
- TypeError
Parameter memiliki jenis yang tidak valid atau atribut yang tidak diketahui telah diteruskan.
- ValueError
Parameter memiliki nilai yang tidak valid.
Properti
Instance class Document memiliki properti berikut:
- doc_id
ID dokumen, string ASCII yang dapat dibaca manusia yang mengidentifikasi dokumen.
- kolom
Daftar kolom dokumen.
- bahasa
Kode dua huruf ISO 693-1 untuk bahasa yang digunakan untuk menyatakan nilai kolom dokumen.
- peringkat
Peringkat dokumen, bilangan bulat yang menentukan urutan dokumen yang akan ditampilkan dalam hasil penelusuran.
Perhatikan bahwa saat peringkat digunakan dalam FieldExpression atau SortExpression, peringkat akan dirujuk sebagai _rank.
Selain itu, jika Anda membuat SortExpression yang menyertakan peringkat sebagai salah satu kunci pengurutan, peringkat hanya dapat diurutkan dalam
arah MENURUN.
Kecuali dinyatakan lain, konten di halaman ini dilisensikan berdasarkan Lisensi Creative Commons Attribution 4.0, sedangkan contoh kode dilisensikan berdasarkan Lisensi Apache 2.0. Untuk mengetahui informasi selengkapnya, lihat Kebijakan Situs Google Developers. Java adalah merek dagang terdaftar dari Oracle dan/atau afiliasinya.
Terakhir diperbarui pada 2025-08-11 UTC.
[[["Mudah dipahami","easyToUnderstand","thumb-up"],["Memecahkan masalah saya","solvedMyProblem","thumb-up"],["Lainnya","otherUp","thumb-up"]],[["Sulit dipahami","hardToUnderstand","thumb-down"],["Informasi atau kode contoh salah","incorrectInformationOrSampleCode","thumb-down"],["Informasi/contoh yang saya butuhkan tidak ada","missingTheInformationSamplesINeed","thumb-down"],["Masalah terjemahan","translationIssue","thumb-down"],["Lainnya","otherDown","thumb-down"]],["Terakhir diperbarui pada 2025-08-11 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."]]
