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를 제공하지 않으면 검색 서비스에서 ID를 제공합니다.
- 필드
문서의 내용을 나타내는 Field 인스턴스의 반복 가능 항목입니다.
- language
필드 값에 사용된 언어의 두 글자 ISO 639.2 언어 코드입니다.
- sort_scores
정렬 평가 중에 할당된 점수 목록입니다. 각 정렬 차원이 포함됩니다. 양수 점수는 오름차순 정렬에, 음수 점수는 내림차순 정렬에 사용됩니다.
- expressions
요청된 표현식의 결과인 계산된 필드의 목록입니다.
- cursor
문서에 연결된 커서입니다.
- rank
문서 순위는 검색 결과에서 이 문서가 반환되는 순서를 지정하는 데 사용되며, 0 <= rank <= sys.maxint입니다. 지정하지 않으면 2011년 1월 1일 이후 경과된 초 수가 사용됩니다. 문서는 순서 ID 내림차순으로 반환됩니다.
결과 값
ScoredDocument클래스의 새 인스턴스입니다.
예외
- TypeError
매개변수에 잘못된 유형이 있거나 알 수 없는 속성이 전달된 경우 발생합니다.
- ValueError
매개변수에 잘못된 값이 있는 경우 발생합니다.
속성
ScoredDocument 클래스의 인스턴스에는 다음 속성이 있습니다.
- sort_scores
API에서 검색 결과를 정렬하는 동안 할당된 점수의 목록을 반환합니다. 각 정렬 차원이 포함됩니다. 양수 점수는 오름차순 정렬에, 음수 점수는 내림차순 정렬에 사용됩니다.
- expressions
표현식을 평가한 결과인 계산된 필드의 목록입니다. 예를 들어 다음 필드 표현식의 목적은
content필드에서'good story'쿼리와 일치하는 부분을 추출한 HTML 스니펫이 포함된 스니펫 필드를 계산하는 것입니다.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으로 반환됩니다.