ScoredDocument 類別

ScoredDocument 類別代表的是搜尋傳回的計分文件。您無法直接建構這個類別；這個類別是 Index.search() 傳回的結果。

ScoredDocument 應在 google.appengine.api.search 模組中定義。

建構函式

MatchScorer 類別的建構函式定義如下：

class ScoredDocument(doc_id=None, fields=None, language='en', sort_scores=None, expressions=None, cursor=None, rank=None)

代表搜尋傳回的計分文件。

引數

doc_id

用於識別文件且可列印的 ASCII 顯示字串。開頭不得為「!」，且 ID 中不得包含空格。如未提供 ID，則會由搜尋服務提供。

欄位

可疊代的 Field 執行個體，代表文件的內容。

language

雙字母格式的 ISO 639.2 語言編碼，代表欄位值使用的語言。

sort_scores

排序評估期間指派的得分清單。每個排序依據都會包含在內。正值的得分用於遞增排序；負值的得分用於遞減排序。

運算式

要求運算式結果的運算欄位清單。

cursor

與文件相關聯的游標。

rank

文件排名可用於指定此文件在搜尋結果中傳回的順序，其中 0 <= rank <= sys.maxint。如未指定，則會使用從 2011 年 1 月 1 日算起的秒數。系統會依照 ID 的遞減順序傳回文件。

結果值

ScoredDocument 類別的新例項。

例外狀況

TypeError

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

ValueError

參數含有無效的值。

屬性

ScoredDocument 類別的執行個體具有下列屬性：

sort_scores

傳回 API 為搜尋結果排序時指派的得分清單。每個排序依據都會包含在內。正值的得分用於遞增排序，而負值的得分用於遞減排序。

運算式

運算式計算結果的運算欄位清單。舉例來說，下列欄位運算式會運算包含 HTML 程式碼片段的程式碼片段欄位，而 HTML 程式碼片段是從 content 欄位中查詢 'good story' 的相符內容中擷取而來：

FieldExpression(name='snippet', 'snippet("good story", content)')

在這個查詢下，API 會傳回下列 ScoredDocument.expression：

HtmlField(name='snippet', value='that was a good story to finish')

cursor

與結果相關聯的游標，用來作為傳回下一組搜尋結果的起點。這個屬性在 Index.cursor_type 設為 Index.RESULT_CURSOR 時才會傳回。如果不是此設定，此屬性會傳回 None。