Document 類別

Document 類別代表的是包含可搜尋內容的文件。

Document 是在 google.appengine.api.search 模組中定義。

建構函式

Document 類別的建構函式定義如下:

class Document(doc_id=None, fields=None, language='en', rank=None)

這會建構 Document 類別的執行個體。

以下範例顯示如何建立包含一組欄位的文件,這些欄位有些為純文字內容,有一個為 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')

引數

doc_id

「文件識別碼」,為使用者可判讀的 ASCII 字串,用於識別文件。文件識別碼不得包含任何空白字元且開頭不得為驚嘆號 (!)。如果省略,則會由搜尋服務提供識別碼字串。

在大部分情況下,您無須明確指定文件識別碼,但在實作其他儲存機制 (例如 Blobstore 或 Google Storage) 的搜尋功能時,指定自訂識別碼會很實用。以 Blobstore 為例,您可以將文件 ID 設為 BlobKey,建立該文件與特定 blob 的關聯。

fields

Field 物件的可疊代集合,代表文件的內容。

language

雙字母格式的 ISO 693-1 語言編碼,用於表示文件欄位值使用的語言。

rank

文件的「排名」,以整數表示,用於指定在搜尋結果中的傳回順序。較新的文件會較先傳回。如未指定,rank 將設為從世界標準時間 2011 年 1 月 1 日 00:00:00 開始算起的秒數。請注意,在 FieldExpression 或 SortExpression 中使用 rank 時,會以 _rank 表示。

結果值

Document 類別的新執行個體。

例外狀況

TypeError

參數有無效的類型,或傳送了未知的屬性。

ValueError

參數含有無效的值。

屬性

Document 類別的執行個體具有下列屬性:

doc_id

「文件識別碼」,為使用者可判讀的 ASCII 字串,用於識別文件。

fields

文件的欄位清單。

language

雙字母格式的 ISO 693-1 語言編碼,用於表示文件欄位值使用的語言。

rank

文件的排名,以整數表示,用於指定在搜尋結果中的傳回順序。請注意,在 FieldExpression 或 SortExpression 中使用 rank 時,會以 _rank 表示。此外,如果您建立的 SortExpression 將 rank 納入排序索引鍵,則 rank 僅能以「遞減」方向排序。

本頁內容對您是否有任何幫助?請提供意見:

傳送您對下列選項的寶貴意見...

這個網頁
Python 2 適用的 App Engine 標準環境