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의 경우 BlobKey를 문서 식별자로 설정하면 특정 blob을 문서와 연결할 수 있습니다.

fields

문서의 내용을 나타내는 반복 가능한 Field 객체의 집합입니다.

language

문서의 필드 값을 표현한 언어로 쓰인 두 자로 된 ISO 693-1 코드입니다.

rank

문서의 순위로, 검색결과로 반환되는 순서를 지정하는 정수입니다. 최신 문서가 먼저 반환됩니다. 지정하지 않으면 순위는 2011년 1월 1일 00:00:00 UTC 이후의 초 수로 설정됩니다. 참고로 순위가 FieldExpression 또는 SortExpression에서 사용되는 경우 _rank로 표시됩니다.

결과 값

Document 클래스의 새 인스턴스입니다.

예외

TypeError

매개변수가 잘못된 유형이거나 알 수 없는 속성이 전달되었습니다.

ValueError

매개변수의 값이 잘못되었습니다.

속성

Document 클래스의 인스턴스에는 다음 속성이 있습니다.

doc_id

문서를 식별하는 문서 식별자로서 사람이 읽을 수 있는 ASCII 문자열입니다.

fields

문서의 필드 목록입니다.

language

문서의 필드 값을 표현한 언어로 쓰인 두 자로 된 ISO 693-1 코드입니다.

rank

문서의 순위로, 검색결과로 반환되는 순서를 지정하는 정수입니다. 참고로 순위가 FieldExpression 또는 SortExpression에서 사용되는 경우 _rank로 표시됩니다. 또한 정렬 키 중 하나로 순위가 포함된 SortExpression을 만드는 경우 순위는 내림차순으로만 정렬됩니다.