Catatan: Python 2.7 telah mencapai akhir dukungan pada 31 Januari 2024. Aplikasi Python 2.7 Anda yang sudah ada akan terus berjalan dan menerima traffic. Namun, App Engine mungkin memblokir deployment ulang aplikasi yang menggunakan runtime setelah akhir tanggal dukungannya. Sebaiknya migrasikan ke Python versi terbaru yang didukung.

Class Dokumen

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.