쿼리 및 정렬 옵션

쿼리 문자열만 사용하여 search() 메서드를 호출하면 다음과 같은 기본 쿼리 옵션에 따라 결과가 반환됩니다.

• 문서가 내림차순으로 정렬되어 반환됨
• 문서가 한 번에 20개씩 그룹으로 반환됨
• 검색된 문서에 원본 필드가 모두 포함됨

Query 클래스의 인스턴스를 search()에 대한 인수로 사용하여 이러한 옵션을 변경할 수 있습니다.

Query 클래스를 사용하면 한 번에 반환할 문서 개수를 지정할 수 있습니다. 검색된 문서의 콘텐츠를 맞춤설정할 수도 있습니다. 문서 식별자만 요청하거나 문서에 필드 하위 집합만 포함되도록 요청할 수 있습니다. 또한 검색된 문서에서 커스텀 필드를 만들 수도 있습니다. 예를 들면 스니펫(일치하는 문자열 주변의 텍스트를 보여주는 텍스트 필드의 조각), 필드 표현식(문서의 다른 필드에서 파생된 값이 있는 필드)이 있습니다.

쿼리 옵션과 별도로 Query 클래스에는 SortOptions 클래스의 인스턴스도 포함할 수 있습니다. 정렬 옵션을 사용하여 정렬 순서를 변경하고 여러 키를 기준으로 결과를 정렬할 수 있습니다.

Query 클래스를 사용하여 검색

Query 클래스의 인스턴스를 사용하여 검색할 때는 클래스의 인스턴스를 여러 단계로 구성해야 합니다. 일반적인 순서는 다음과 같습니다.

1. 쿼리 문자열을 만듭니다.
2. 필요한 경우 SortOptions를 만듭니다.
3. QueryOptions를 만듭니다.
4. 쿼리 문자열과 QueryOptions(선택사항)를 포함하는 Query 객체를 만듭니다.
5. Query 객체에서 검색 메서드를 호출합니다.

QueryOptions 및 SortOptions 생성자는 다음 예시와 같이 이름이 지정된 인수를 사용합니다.

def query_options():
    index = search.Index('products')
    query_string = "product: piano AND price < 5000"

    # Create sort options to sort on price and brand.
    sort_price = search.SortExpression(
        expression='price',
        direction=search.SortExpression.DESCENDING,
        default_value=0)
    sort_brand = search.SortExpression(
        expression='brand',
        direction=search.SortExpression.DESCENDING,
        default_value="")
    sort_options = search.SortOptions(expressions=[sort_price, sort_brand])

    # Create field expressions to add new fields to the scored documents.
    price_per_note_expression = search.FieldExpression(
        name='price_per_note', expression='price/88')
    ivory_expression = search.FieldExpression(
        name='ivory', expression='snippet("ivory", summary, 120)')

    # Create query options using the sort options and expressions created
    # above.
    query_options = search.QueryOptions(
        limit=25,
        returned_fields=['model', 'price', 'description'],
        returned_expressions=[price_per_note_expression, ivory_expression],
        sort_options=sort_options)

    # Build the Query and run the search
    query = search.Query(query_string=query_string, options=query_options)
    results = index.search(query)
    for scored_document in results:
        print(scored_document)

QueryOptions

다음 속성은 반환되는 결과의 개수와 순서를 제어합니다. 함께 사용할 수 없는 오프셋 및 커서 옵션은 페이지로 나누기를 지원합니다. 이들 옵션은 선택된 문서 중에서 결과에 반환될 문서를 지정합니다.

다음 속성은 결과에 나타나는 문서 필드를 제어합니다.

정렬 옵션

SortOptions 속성은 검색 결과의 순서와 점수를 제어합니다.

여러 키를 기준으로 정렬

여러 개의 정렬 키를 기준으로 검색 결과의 순서를 지정할 수 있습니다. 각 키는 단순한 필드 이름일 수도 있고 여러 필드에서 계산된 값일 수도 있습니다. 정렬 옵션과 관련하여 '표현식'이라는 용어는 여러 가지 의미로 사용됩니다. SortOption 자체에 표현식 속성이 있습니다. 이 속성은 정렬 키에 해당하는 SortExpression 객체의 목록입니다. 마지막으로 각 SortExpression 객체에는 정렬 키 값을 계산하는 방식을 지정하는 표현식 속성이 있습니다. 이 표현식은 다음 섹션의 규칙에 따라 작성됩니다.

SortExpression은 정렬 방향과 문서의 표현식을 계산할 수 없는 경우 사용할 기본 키 값도 정의합니다. 다음은 전체 속성 목록입니다.

다중 값 필드를 기준으로 정렬

특정 유형의 다중 값 필드를 기준으로 정렬할 때는 필드에 할당된 첫 번째 값만 사용됩니다. 예를 들어 DocA와 DocB의 두 문서에 모두 'color'라는 텍스트 필드가 있다고 가정해 보겠습니다. DocA의 'color' 필드에 두 값이(red, blue) 순서대로 할당되어 있고 DocB에 두 값이(green, red) 순서대로 할당되어 있습니다. 텍스트 필드 "color"를 지정하여 정렬을 수행하면 DocA는 "red"값으로, DocB는 '"green"값으로 정렬됩니다. 다른 필드 값은 정렬에 사용되지 않습니다.

정렬 여부 결정

정렬 옵션을 지정하지 않으면 검색 결과가 자동으로 내림차순으로 정렬되어 반환됩니다. 이 경우에는 반환되는 문서 수에 제한이 없습니다. 정렬 옵션을 지정하면 일치하는 모든 문서가 선택된 후에 정렬이 수행됩니다. 정렬의 크기를 제어하는 명시적 속성인 `SortOptions.limit`가 있습니다. 10,000개를 초과하는 문서를 정렬할 수 없으며 기본값은 1,000입니다. 일치하는 문서의 수가 `SortOptions.limit`로 지정된 수보다 많으면 검색에서 해당하는 제한된 개수만 검색, 정렬, 반환합니다. 이때 내림차순으로 표시된 일치하는 모든 문서 목록에서 정렬할 문서가 선택됩니다. 정렬할 수 있는 개수보다 더 많은 수의 일치하는 문서가 쿼리를 통해 선택될 수도 있습니다. 정렬 옵션을 사용하며 일치하는 모든 문서를 검색하는 것이 중요할 경우, 정렬할 수 있는 것보다 더 많은 문서가 쿼리를 통해 반환되지 않도록 해야 합니다.

표현식 쓰기

표현식은 필드 표현식('QueryOptions'에 설정됨) 및 정렬 표현식(SortOptions에 설정됨)을 정의하는 데 사용됩니다. 표현식은 문자열로 작성됩니다.

"price * quantity"
"(men + women)/2"
"min(daily_use, 10) * rate"
"snippet('rose', flower, 120)"

숫자 필드를 포함하는 표현식에는 산술 연산자(+, -, *, /)와 아래에 나열된 기본 제공 숫자 함수를 사용할 수 있습니다. 지리 좌표 필드를 포함하는 표현식은 지리 좌표 및 거리 함수를 사용할 수 있습니다. 텍스트 및 HTML 필드용 표현식에는 스니펫 함수를 사용할 수 있습니다.

표현식에 다음과 같은 특수 용어를 포함할 수도 있습니다.

숫자 함수

FieldExpressions 및 SortExpressions의 숫자 값을 정의하는 표현식에는 다음과 같은 기본 제공 함수를 사용할 수 있습니다. 인수는 숫자, 필드 이름이거나 숫자 및 필드 이름을 사용하는 표현식이어야 합니다.

지리 좌표 함수

지리 좌표 필드를 포함하는 표현식에 다음 함수를 사용할 수 있습니다.

스니펫

스니펫은 쿼리 문자열과 일치하며 주변 텍스트를 포함하는 텍스트 필드의 일부입니다. snippet 함수를 호출하여 스니펫을 만듭니다.

snippet(query, body, [max_chars])

query

필드에서 찾을 텍스트를 지정하는 따옴표가 붙은 쿼리 문자열입니다.

body

텍스트, HTML, Atom 필드의 이름입니다.

max_chars

스니펫에 반환할 최대 문자 수입니다. 이 인수는 선택사항이며, 기본값은 160자입니다(영문 기준).

이 함수는 HTML 문자열을 반환합니다. 이 문자열에는 본문 필드 값의 스니펫이 포함되며, 쿼리와 일치하는 텍스트가 굵게 표시됩니다.