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.
Tetap teratur dengan koleksi
Simpan dan kategorikan konten berdasarkan preferensi Anda.
Class Index mewakili indeks yang memungkinkan dokumen diindeks, dihapus, dan ditelusuri.
Index ditentukan dalam modul google.appengine.api.search.
Pengantar
Class Index menyediakan argumen untuk membuat indeks serta fungsi yang memungkinkan Anda menambahkan, membuat daftar, menelusuri, dan menghapus dokumen (atau koleksi dokumen yang dapat diiterasi) di dalam indeks. Anda membuat indeks menggunakan argumen ke class Index, termasuk nama dan namespace indeks tersebut.
Kode berikut menunjukkan cara memasukkan dokumen ke dalam indeks, lalu menelusurinya untuk menemukan dokumen yang cocok dengan kueri:
# Get the index.index=search.Index(name='index-name')# Create a document.doc=search.Document(doc_id='document-id',fields=[search.TextField(name='subject',value='my first email'),search.HtmlField(name='body',value='<html>some content here</html>')])# Index the document.try:index.put(doc)exceptsearch.PutError,e:result=e.results[0]ifresult.code==search.OperationResult.TRANSIENT_ERROR:# possibly retry indexing result.object_idexceptsearch.Error,e:# possibly log the failure# Query the index.try:results=index.search('subject:first body:here')# Iterate through the search results.forscored_documentinresults:# process the scored_documentexceptsearch.Error,e:# possibly log the failure
Konstruktor
Konstruktor untuk class Index ditentukan sebagai berikut:
Index(name, namespace=None)
Buat instance class Index.
Argumen
name
Nama indeks (lihat properti nama di bawah untuk mengetahui detailnya).
Nama kolom pemetaan skema ke daftar jenis yang didukung. Hanya valid
untuk indeks yang ditampilkan oleh metode
search.get_indexes.
name
Nama indeks, string ASCII yang dapat dibaca manusia yang mengidentifikasi indeks. Tidak boleh berisi karakter spasi kosong dan tidak boleh diawali dengan tanda seru (!).
namespace
Namespace tempat nama indeks ditentukan.
storage_usage
Perkiraan jumlah byte yang digunakan oleh indeks ini. Jumlah tersebut mungkin tidak mencerminkan
hasil perubahan terbaru. Hanya valid
untuk indeks yang ditampilkan oleh metode
search.get_indexes.
storage_limit
Penyimpanan maksimum yang diizinkan untuk indeks ini, dalam satuan byte. Hanya valid
untuk indeks yang ditampilkan oleh metode
search.get_indexes.
Metode Instance
Instance class Index memiliki metode berikut:
put(self, documents, deadline=None)
Jika dokumen yang ditentukan telah dimasukkan ke dalam indeks, dan jika memiliki doc_ids yang sama, dokumen tersebut akan diindeks ulang dengan konten yang diperbarui.
Argumen
documents
Dokumen (atau koleksi dokumen yang dapat diiterasi) untuk diindeks.
deadline
Tenggat waktu panggilan RPC dalam detik.
Nilai hasil
Daftar hasil (PutResult), satu untuk setiap dokumen yang diminta untuk diindeks.
Pengecualian
PutError
Satu atau beberapa dokumen gagal diindeks, atau nomor yang diindeks tidak cocok dengan jumlah yang diminta.
TypeError
Atribut yang tidak diketahui diteruskan.
ValueError
Argumen bukan dokumen atau koleksi dokumen yang dapat diiterasi, atau jumlah dokumen yang lebih besar dari MAXIMUM_DOCUMENTS_PER_PUT_REQUEST.
delete(self, document_ids, deadline=None)
Hapus dokumen dari indeks.
Jika tidak ada dokumen untuk ID dalam daftar, ID tersebut akan diabaikan.
Argumen
document_ids
ID (atau daftar ID) dokumen yang akan dihapus.
deadline
Tenggat waktu panggilan RPC dalam detik.
Pengecualian
DeleteError
Satu atau beberapa dokumen gagal dihapus, atau jumlah yang dihapus tidak cocok dengan jumlah yang diminta.
ValueError
Argumen bukan string atau kumpulan ID dokumen yang valid yang dapat diiterasi, atau jumlah ID dokumen yang lebih besar dari MAXIMUM_DOCUMENTS_PER_PUT_REQUEST.
get(self,doc_id, deadline=None)
Mengambil Dokumen dari indeks menggunakan ID dokumen. Jika dokumen tidak ditemukan, None akan ditampilkan.
Argumen
doc_id
ID dokumen yang akan diambil.
deadline
Tenggat waktu panggilan RPC dalam detik.
Nilai hasil
Objek Dokumen dengan ID yang cocok dengan ID yang disediakan oleh doc_id.
search(query, deadline=None)
Menelusuri indeks untuk menemukan dokumen yang cocok dengan kueri. Kueri dapat berupa string atau objek Kueri.
Misalnya, fragmen kode berikut meminta penelusuran untuk dokumen dengan 'first' muncul dalam subjek dan 'good' terjadi di mana saja, menampilkan maksimal 20 dokumen, memulai penelusuran dari 'cursor token', mengembalikan satu kursor lain untuk respons, mengurutkan berdasarkan subjek dalam urutan menurun, yang menampilkan kolom penulis, subjek, dan ringkasan, serta konten kolom yang dipotong.
results=index.search(# Define the query by using a Query object.query=Query('subject:first good',options=QueryOptions(limit=20,cursor=Cursor(),sort_options=SortOptions(expressions=[SortExpression(expression='subject',default_value='')],limit=1000),returned_fields=['author','subject','summary'],snippeted_fields=['content'])))
Fragmen kode berikut menunjukkan cara menggunakan kursor hasil.
cursor=results.cursorforresultinresults:# process resultresults=index.search(Query('subject:first good',options=QueryOptions(cursor=cursor)))
Fragmen kode berikut menunjukkan cara menggunakan kursor per_result:
[[["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\u003eIndex\u003c/code\u003e class allows for the management of documents within an index, including indexing, deleting, and searching.\u003c/p\u003e\n"],["\u003cp\u003eAsynchronous methods like \u003ccode\u003eput_async\u003c/code\u003e, \u003ccode\u003edelete_async\u003c/code\u003e, \u003ccode\u003eget_async\u003c/code\u003e, \u003ccode\u003esearch_async\u003c/code\u003e, and \u003ccode\u003eget_range_async\u003c/code\u003e are available, returning a future object that can be used to retrieve the result via \u003ccode\u003eget_result()\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003eIndex\u003c/code\u003e constructor takes the index's \u003ccode\u003ename\u003c/code\u003e and an optional \u003ccode\u003enamespace\u003c/code\u003e to create an instance, which can be used to perform methods like \u003ccode\u003eput\u003c/code\u003e, \u003ccode\u003edelete\u003c/code\u003e, \u003ccode\u003eget\u003c/code\u003e, \u003ccode\u003esearch\u003c/code\u003e, and \u003ccode\u003eget_range\u003c/code\u003e.\u003c/p\u003e\n"],["\u003cp\u003eThe \u003ccode\u003esearch\u003c/code\u003e method allows querying the index using a string or a \u003ccode\u003eQuery\u003c/code\u003e object, which can be further customized with a \u003ccode\u003eQueryOptions\u003c/code\u003e to control parameters like limits, cursors, and sort options.\u003c/p\u003e\n"],["\u003cp\u003eThe properties of an \u003ccode\u003eIndex\u003c/code\u003e object include the name, namespace, schema, storage_usage, and storage_limit, while instance methods allow to manage documents, like put a document to the index, deleting an existing one, retrieving a document by it's ID, searching for documents matching a query and retrieving a range of documents by ID.\u003c/p\u003e\n"]]],[],null,["# The Index Class\n\nClass `Index` represents an index allowing documents to be indexed, deleted, and searched.\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`Index` is defined in the `google.appengine.api.search` module.\n| **Note:** There are asynchronous methods corresponding to each instance method: `put_async`, `delete_async`, `get_async`, `search_async`, and `get_range_async`. These are identical to the synchronous methods, except they all return a future. To get the actual result, call `get_result()` on the returned value; that call will block.\n\nIntroduction\n------------\n\nThe `Index` class provides arguments to construct an index as well as functions allowing you to add, list, search, and delete [documents](/appengine/docs/legacy/standard/python/search/documentclass) (or an iterable collection of documents) within the index. You construct an index using arguments to the `Index` class, including the name and namespace of the index.\n\nThe following code shows how to put documents into an index, then search it for documents matching a query: \n\n```python\n# Get the index.\nindex = search.Index(name='index-name')\n\n# Create a document.\ndoc = search.Document(\n doc_id='document-id',\n fields=[search.TextField(name='subject', value='my first email'),\n search.HtmlField(name='body', value='\u003chtml\u003esome content here\u003c/html\u003e')])\n\n# Index the document.\ntry:\n index.put(doc)\nexcept search.PutError, e:\n result = e.results[0]\n if result.code == search.OperationResult.TRANSIENT_ERROR:\n # possibly retry indexing result.object_id\nexcept search.Error, e:\n # possibly log the failure\n\n# Query the index.\ntry:\n results = index.search('subject:first body:here')\n\n # Iterate through the search results.\n for scored_document in results:\n # process the scored_document\n\nexcept search.Error, e:\n # possibly log the failure\n```\n\nConstructor\n-----------\n\nThe constructor for class `Index` is defined as follows:\n\n\nIndex(name, namespace=None)\n\n: Construct an instance of class `Index`.\n\n: Arguments\n\n name\n\n : Index name (see [name property](#Index_name), below, for details).\n\n namespace\n\n : For [multitenant applications](/appengine/docs/legacy/standard/python/multitenancy), the namespace in which index name is defined.\n\n Result value\n\n : A new instance of class `Index`.\n\n \u003cbr /\u003e\n\nProperties\n----------\n\nAn instance of class `Index` has the following properties:\n\nschema\n\n: Schema mapping field names to the list of types supported. Valid only\n for indexes returned by the [search.get_indexes](/appengine/docs/legacy/standard/python/search/functions#get_indexes)\n method.\n\nname\n\n: Index name, a human-readable ASCII string identifying the index. Must contain no whitespace characters and not start with an exclamation point (`!`).\n\nnamespace\n\n: Namespace in which index name is defined.\n\nstorage_usage\n\n: The approximate number of bytes used by this index. The number may not reflect the\n results of recent changes. Valid only\n for indexes returned by the [search.get_indexes](/appengine/docs/legacy/standard/python/search/functions#get_indexes)\n method.\n\nstorage_limit\n\n: The maximum allowable storage for this index, in bytes. Valid only\n for indexes returned by the [search.get_indexes](/appengine/docs/legacy/standard/python/search/functions#get_indexes)\n method.\n\nInstance Methods\n----------------\n\nInstances of class `Index` have the following methods:\n\nput(self, documents, deadline=None)\n\n: If the specified documents have already been put into the index, and if they have the same `doc_ids`, they are reindexed with updated contents.\n\n: Arguments\n\n documents\n\n : Document (or iterable collection of documents) to index.\n\n deadline\n\n : Deadline for RPC call in seconds.\n\n Result value\n\n : List of results (`PutResult`), one for each document requested to be indexed.\n\n Exceptions\n\n PutError\n\n : One or more documents failed to index, or number indexed did not match number requested.\n\n TypeError\n\n : Unknown attribute passed.\n\n ValueError\n\n : Argument not a document or iterable collection of documents, or number of documents larger than `MAXIMUM_DOCUMENTS_PER_PUT_REQUEST`.\n\n\ndelete(self, document_ids, deadline=None)\n\n: Delete documents from index.\n\n If no document exists for an identifier in the list, that identifier is ignored.\n\n: Arguments\n\n document_ids\n\n : Identifier (or list of identifiers) of documents to delete.\n\n deadline\n\n : Deadline for RPC call in seconds.\n\n Exceptions\n\n DeleteError\n\n : One or more documents failed to delete, or number deleted did not match number requested.\n\n ValueError\n\n : Argument not a string or iterable collection of valid document identifiers, or number of document identifiers larger than `MAXIMUM_DOCUMENTS_PER_PUT_REQUEST`.\n\n\nget(self,doc_id, deadline=None)\n\n: Retrieves a [Document](/appengine/docs/legacy/standard/python/search/documentclass) from the index using the document's identifier. If the document is not found, returns `None`.\n\n: Arguments\n\n doc_id\n\n : The identifier of the document to retrieve.\n\n deadline\n\n : Deadline for RPC call in seconds.\n\n Result value\n\n : A [Document](/appengine/docs/legacy/standard/python/search/documentclass) object whose identifier matches the one supplied by doc_id.\n\n\nsearch(query, deadline=None)\n\n: Search the index for documents matching the query. The query may be either a string or a [Query](/appengine/docs/legacy/standard/python/search/queryclass) object.\n\n For example, the following code fragment requests a search for documents where 'first' occurs in subject and 'good' occurs anywhere, returning at most 20 documents, starting the search from 'cursor token', returning another single cursor for the response, sorting by subject in descending order, returning the author, subject, and summary fields as well as a snippeted field content. \n\n ```python\n results = index.search(\n # Define the query by using a Query object.\n query=Query('subject:first good',\n options=QueryOptions(limit=20,\n cursor=Cursor(),\n sort_options=SortOptions(\n expressions=[SortExpression(expression='subject',\n default_value='')],\n limit=1000),\n returned_fields=['author', 'subject', 'summary'],\n snippeted_fields=['content'])))\n ```\n\n The following code fragment shows how to use a results cursor. \n\n ```python\n cursor = results.cursor\n for result in results:\n # process result\n results = index.search(Query('subject:first good',\n options=QueryOptions(cursor=cursor))\n )\n ```\n\n The following code fragment shows how to use a `per_result` cursor: \n\n ```python\n results = index.search(query=Query('subject:first good',\n options=QueryOptions(limit=20,\n cursor=Cursor(per_result=True),\n ...))\n )\n\n cursor = None\n for result in results:\n cursor = result.cursor\n\n results = index.search(\n Query('subject:first good', options=QueryOptions(cursor=cursor))\n )\n ```\n\n: Arguments\n\n query\n\n : The query to match against documents in the index, described in a [Query](/appengine/docs/legacy/standard/python/search/queryclass) object. For more information, please see the [Query Language Overview](/appengine/docs/legacy/standard/python/search#Query_Language_Overview).\n\n deadline\n\n : Deadline for RPC call in seconds.\n\n Result value\n\n : A [SearchResults](/appengine/docs/legacy/standard/python/search/searchresultsclass) object containing a list of documents matched, number returned and number matched by the query.\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\nget_range(self, start_id=None, include_start_object=True, limit=100, ids_only=False, deadline=None)\n\n: Get a range of documents from an index, in `doc_id` order.\n\n: Arguments\n\n start_id\n\n : String containing the document identifier from which to list documents. By default, starts at the first document identifier.\n\n include_start_object\n\n : If `true`, include document specified by `start_id`.\n\n limit\n\n : Maximum number of documents to return.\n\n ids_only\n\n : If `true`, return only document identifiers instead of full documents.\n\n deadline\n\n : Deadline for RPC call in seconds.\n\n Result value\n\n : `A `[GetResponse](/appengine/docs/legacy/standard/python/search/getresponseclass) object containing a list of the retrieved documents, ordered by document identifier.\n\n Exceptions\n\n TypeError\n\n : Unknown attribute passed.\n\n Error\n\n : Some subclass of `Error` occurred while processing request."]]
