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

ドキュメント ID。人間が読み取れる形式の ASCII 文字列で、ドキュメントを識別します。空白文字を含めることはできません。また、先頭に感嘆符（!）は使用できません。省略した場合、検索サービスにより ID 文字列が提供されます。

ほとんどの場合、ドキュメント ID を明示的に指定する必要はありません。ただし、独自の ID を指定すると、他のストレージ メカニズム（Blobstore や Google ストレージなど）で検索を実施する際に便利です。たとえば Blobstore の場合、ドキュメント ID を BlobKey に設定して、そのドキュメントを特定の blob に関連付けることができます。

fields

ドキュメントのコンテンツを表す Field オブジェクトの反復可能なコレクション。

language

ドキュメントのフィールド値の記述に使用される言語を表す、2 文字の ISO 693-1 コード。

rank

ドキュメントの rank。検索結果で返される順序を整数で指定します。新しいドキュメントから先に返されます。指定しない場合、rank は 2011 年 1 月 1 日 00:00:00（UTC）以降経過した秒数に設定されます。FieldExpression または SortExpression で rank を使用する場合は、_rank として参照されます。

結果値

Document クラスの新しいインスタンス。

例外

TypeError

パラメータのタイプが無効であるか、不明な属性が渡されました。

ValueError

パラメータの値が無効です。

特性

Document クラスのインスタンスには次のプロパティがあります。

doc_id

ドキュメント ID。人間が読み取れる形式の ASCII 文字列で、ドキュメントを識別します。

fields

ドキュメントのフィールドのリスト。

language

ドキュメントのフィールド値の記述に使用される言語を表す、2 文字の ISO 693-1 コード。

rank

ドキュメントの rank。検索結果で返される順序を整数で指定します。FieldExpression または SortExpression で rank を使用する場合は、_rank として参照されます。また、ソートキーの 1 つとして rank を含む SortExpression を作成する場合、rank の並べ替えは降順でのみ可能です。