Azure AI Search의 간단한 검색 쿼리 예제
Azure AI 검색에서 simple 쿼리 구문은 전체 텍스트 검색에 대한 기본 쿼리 파서를 호출합니다. 파서는 속도가 빠르며 전체 텍스트 검색, 필터링된 패싯 검색 및 접두사 검색을 포함한 일반적인 시나리오를 처리합니다. 이 문서에서는 예제를 사용하여 검색 문서(REST API) 요청의 simple 구문 사용을 보여 줍니다.
참고 항목
대체 쿼리 구문은 유사 항목 및 와일드카드 검색과 같은 더 복잡한 쿼리 구조를 지원하는 Lucene입니다. 자세한 내용은 전체 Lucene 검색 구문의 예를 참조 하세요 .
호텔 샘플 인덱스
다음 쿼리는 빠른 시작: Azure Portal에서 검색 인덱스 만들기의 지침에 따라 만들 수 있는 hotels-sample-index를 기반으로 합니다.
예제 쿼리는 REST API 및 POST 요청을 사용하여 설명됩니다. REST 클라이언트에서 붙여넣고 실행할 수 있습니다. 또는 Azure Portal에서 검색 탐색기의 JSON 보기를 사용합니다. JSON 보기에서는 이 문서에 표시된 쿼리 예제를 붙여넣을 수 있습니다.
요청 헤더의 값은 다음과 같아야 합니다.
| 키 | 값 |
|---|---|
| 콘텐츠-형식 | application/json |
| api-key | <your-search-service-api-key>, 쿼리 또는 관리자 키 중 하나 |
URI 매개 변수는 다음 예제와 유사하게 인덱스 이름, docs 컬렉션, 검색 명령 및 API 버전을 포함하는 검색 서비스 엔드포인트를 포함해야 합니다.
https://{{service-name}}.search.windows.net/indexes/hotels-sample-index/docs/search?api-version=2024-07-01
요청 본문은 유효한 JSON으로 구성되어야 합니다.
{
"search": "*",
"queryType": "simple",
"select": "HotelId, HotelName, Category, Tags, Description",
"count": true
}
search*로 설정은 null 또는 빈 검색에 해당하는 지정되지 않은 쿼리입니다. 특별히 유용한 것은 아니지만 할 수 있는 것 중 가장 간단한 검색이며, 모든 값을 사용하여 인덱스에서 조회 가능 필드를 모두 표시합니다.queryType기본값은 단순으로 설정되며 생략할 수 있지만 이 문서의 쿼리 예제가 간단한 구문으로 표현된다는 점을 강조하기 위해 포함됩니다.select쉼표로 구분된 필드 목록으로 설정하면 검색 결과 컨텍스트에서 유용한 필드만 포함하여 검색 결과 컴퍼지션에 사용됩니다.count는 검색 조건과 일치하는 문서 수를 반환합니다. 빈 검색 문자열에서 개수는 인덱스의 모든 문서입니다(hotels-sample-index의 경우 50개).
예제 1: 전체 텍스트 검색
전체 텍스트 검색은 부울 연산자가 있거나 없는 임의의 독립 실행형 용어 또는 따옴표로 묶인 구일 수 있습니다.
POST /indexes/hotel-samples-index/docs/search?api-version=2024-07-01
{
"search": "pool spa +airport",
"searchMode": "any",
"queryType": "simple",
"select": "HotelId, HotelName, Category, Description",
"count": true
}
중요한 용어나 구로 구성된 키워드 검색을 사용하는 것이 가장 좋습니다. 문자열 필드는 인덱싱 및 쿼리하는 동안 텍스트 분석을 수행하고, 다음과 같은 중요하지 않은 단어를 삭제합니다. 인덱스에서 쿼리 문자열이 토큰화되는 방식을 보려면 텍스트 분석 호출의 문자열을 인덱스에 전달합니다.
매개 변수는 searchMode 정밀도 및 회수를 제어합니다. 더 많은 회수를 원하는 경우 쿼리 문자열의 일부가 일치하는 경우 결과를 반환하는 기본값 을 사용합니다 . 문자열의 모든 부분을 일치시켜야 하는 정밀도를 선호하는 경우 모두로 변경 searchMode 합니다. searchMode에서 결과를 변경하는 방법을 확인하려면 앞의 쿼리를 두 가지 방법으로 모두 시도하세요.
풀 스파 +공항 쿼리에 대한 응답은 다음 예제와 유사해야 합니다.
"@odata.count": 4,
"value": [
{
"@search.score": 6.090657,
"HotelId": "12",
"HotelName": "Winter Panorama Resort",
"Description": "Plenty of great skiing, outdoor ice skating, sleigh rides, tubing and snow biking. Yoga, group exercise classes and outdoor hockey are available year-round, plus numerous options for shopping as well as great spa services. Newly-renovated with large rooms, free 24-hr airport shuttle & a new restaurant. Rooms/suites offer mini-fridges & 49-inch HDTVs.",
"Category": "Resort and Spa"
},
{
"@search.score": 4.314683,
"HotelId": "21",
"HotelName": "Good Business Hotel",
"Description": "1 Mile from the airport. Free WiFi, Outdoor Pool, Complimentary Airport Shuttle, 6 miles from Lake Lanier & 10 miles from downtown. Our business center includes printers, a copy machine, fax, and a work area.",
"Category": "Suite"
},
{
"@search.score": 3.575948,
"HotelId": "27",
"HotelName": "Starlight Suites",
"Description": "Complimentary Airport Shuttle & WiFi. Book Now and save - Spacious All Suite Hotel, Indoor Outdoor Pool, Fitness Center, Florida Green certified, Complimentary Coffee, HDTV",
"Category": "Suite"
},
{
"@search.score": 2.6926985,
"HotelId": "25",
"HotelName": "Waterfront Scottish Inn",
"Description": "Newly Redesigned Rooms & airport shuttle. Minutes from the airport, enjoy lakeside amenities, a resort-style pool & stylish new guestrooms with Internet TVs.",
"Category": "Suite"
}
]
응답에서 검색 점수를 확인해 보세요. 이는 일치 항목의 관련성 점수입니다. 기본적으로 검색 서비스는 이 점수를 기준으로 상위 50개의 일치 항목을 반환합니다.
1.0의 균일한 점수는 검색이 전체 텍스트 검색이 아니거나 조건이 제공되지 않았기 때문에 순위가 없을 때 발생합니다. 예를 들어 빈 검색(search=*)에서는 행이 임의의 순서로 반환됩니다. 실제 조건을 포함하는 경우 검색 점수가 의미 있는 값으로 바뀌는 것을 볼 수 있습니다.
예제 2: ID별 조회
검색 결과가 반환된 후 논리적인 다음 단계는 문서에서 더 많은 필드를 포함하는 세부 정보 페이지를 제공하는 것입니다. 이 예제에서는 문서 ID를 전달하여 문서 가져오기를 사용하여 단일 문서를 반환하는 방법을 보여줍니다.
GET /indexes/hotels-sample-index/docs/41?api-version=2024-07-01
모든 문서에는 고유 식별자가 있습니다. 포털을 사용하는 경우 인덱스 탭에서 인덱스를 선택한 다음, 필드 정의를 살펴봐서 키가 되는 필드를 확인합니다. REST API에서 GET 인덱스 호출은 응답 본문의 인덱스 정의를 반환합니다.
이전 쿼리에 대한 응답은 키가 41인 문서로 구성됩니다. 인덱스 정의에서 검색 가능한 것으로 표시된 모든 필드는 검색 결과에서 반환되고 앱에서 렌더링될 수 있습니다.
{
"HotelId": "41",
"HotelName": "Windy Ocean Motel",
"Description": "Oceanfront hotel overlooking the beach features rooms with a private balcony and 2 indoor and outdoor pools. Inspired by the natural beauty of the island, each room includes an original painting of local scenes by the owner. Rooms include a mini fridge, Keurig coffee maker, and flatscreen TV. Various shops and art entertainment are on the boardwalk, just steps away.",
"Description_fr": "Cet hôtel en bord de mer donnant sur la plage propose des chambres dotées d'un balcon privé et de 2 piscines intérieure et extérieure. Inspiré par la beauté naturelle de l'île, chaque chambre comprend une peinture originale de scènes locales par le propriétaire. Les chambres comprennent un mini-réfrigérateur, une cafetière Keurig et une télévision à écran plat. Divers magasins et divertissements artistiques se trouvent sur la promenade, à quelques pas.",
"Category": "Suite",
"Tags": [
"pool",
"air conditioning",
"bar"
],
"ParkingIncluded": true,
"LastRenovationDate": "2021-05-10T00:00:00Z",
"Rating": 3.5,
"Location": {
"type": "Point",
"coordinates": [
-157.846817,
21.295841
],
"crs": {
"type": "name",
"properties": {
"name": "EPSG:4326"
}
}
},
"Address": {
"StreetAddress": "1450 Ala Moana Blvd 2238 Ala Moana Ctr",
"City": "Honolulu",
"StateProvince": "HI",
"PostalCode": "96814",
"Country": "USA"
}
}
예제 3: 텍스트 필터링
필터 구문은 자체적으로 또는 search와 함께 사용할 수 있는 OData 식입니다. 동일한 요청 filter 에서 함께 사용하는 경우 먼저 전체 인덱스로 적용된 다음 search 필터의 결과에 대해 수행됩니다. 따라서 필터는 검색 쿼리가 처리해야 하는 일련의 문서를 감소시키기 때문에 쿼리 성능을 개선하는 데 유용한 기술일 수 있습니다.
인덱스 정의에서 filterable로 표시된 모든 필드에서 필터를 정의할 수 있습니다. 호텔 샘플 인덱스의 경우 필터링 가능한 필드에는 범주, 태그, ParkingIncluded, 등급 및 대부분의 주소 필드가 포함됩니다.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "art tours",
"queryType": "simple",
"filter": "Category eq 'Boutique'",
"searchFields": "HotelName,Description,Category",
"select": "HotelId,HotelName,Description,Category",
"count": true
}
이전 쿼리에 대한 응답은 부티크로 분류된 호텔로만 범위가 지정되며, 여기에는 예술 또는 투어라는 용어가 포함됩니다. 이 경우 하나의 일치 항목만 있습니다.
"value": [
{
"@search.score": 1.2814453,
"HotelId": "2",
"HotelName": "Old Century Hotel",
"Description": "The hotel is situated in a nineteenth century plaza, which has been expanded and renovated to the highest architectural standards to create a modern, functional and first-class hotel in which art and unique historical elements coexist with the most modern comforts. The hotel also regularly hosts events like wine tastings, beer dinners, and live music.",
"Category": "Boutique"
}
]
예제 4: 필터 함수
필터 식에는 search.ismatch 및 search.ismatchscoring 함수가 포함될 수 있으므로 필터 내에서 검색 쿼리를 작성할 수 있습니다. 이 필터 식은 무료에 대한 와일드카드를 사용하여 무료 WiFi, 무료 주차 등을 포함한 편의 시설을 선택합니다.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "",
"filter": "search.ismatch('free*', 'Tags', 'full', 'any')",
"select": "HotelName, Tags, Description",
"count": true
}
이전 쿼리에 대한 응답은 무료 편의 시설을 제공하는 27개 호텔과 일치합니다. 검색 점수는 결과 전체에서 균일 한 1 입니다. 이는 검색 식이 null이거나 비어 있기 때문입니다. 이로 인해 축자 필터는 일치하지만 전체 텍스트 검색은 없습니다. 관련성 점수는 전체 텍스트 검색에서만 반환됩니다. search 없이 필터를 사용하는 경우 검색 순위를 제어할 수 있도록 정렬 가능한 필드가 충분한지 확인합니다.
"@odata.count": 27,
"value": [
{
"@search.score": 1,
"HotelName": "Country Residence Hotel",
"Description": "All of the suites feature full-sized kitchens stocked with cookware, separate living and sleeping areas and sofa beds. Some of the larger rooms have fireplaces and patios or balconies. Experience real country hospitality in the heart of bustling Nashville. The most vibrant music scene in the world is just outside your front door.",
"Tags": [
"laundry service",
"restaurant",
"free parking"
]
},
{
"@search.score": 1,
"HotelName": "Downtown Mix Hotel",
"Description": "Mix and mingle in the heart of the city. Shop and dine, mix and mingle in the heart of downtown, where fab lake views unite with a cheeky design.",
"Tags": [
"air conditioning",
"laundry service",
"free wifi"
]
},
{
"@search.score": 1,
"HotelName": "Starlight Suites",
"Description": "Complimentary Airport Shuttle & WiFi. Book Now and save - Spacious All Suite Hotel, Indoor Outdoor Pool, Fitness Center, Florida Green certified, Complimentary Coffee, HDTV",
"Tags": [
"pool",
"coffee in lobby",
"free wifi"
]
},
. . .
예제 5: 범위 필터
범위 필터링은 모든 데이터 형식에 대한 필터 식을 통해 지원됩니다. 다음 예제에서는 숫자 및 문자열 범위를 보여 줍니다. 데이터 형식은 범위 필터에서 중요하며, 숫자 데이터가 숫자 필드에 있고 문자열 데이터가 문자열 필드에 있으면 가장 잘 작동합니다. 숫자 문자열을 비교할 수 없으므로 문자열 필드의 숫자 데이터가 범위에 적합하지 않습니다.
다음 쿼리는 숫자 범위입니다. hotels-sample-index에서 필터링 가능한 유일한 숫자 필드는 .입니다 Rating.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "*",
"filter": "Rating ge 2 and Rating lt 4",
"select": "HotelId, HotelName, Rating",
"orderby": "Rating desc",
"count": true
}
이 쿼리에 대한 응답은 간결하게 트리밍된 다음 예제와 유사해야 합니다.
"@odata.count": 27,
"value": [
{
"@search.score": 1,
"HotelId": "22",
"HotelName": "Lion's Den Inn",
"Rating": 3.9
},
{
"@search.score": 1,
"HotelId": "25",
"HotelName": "Waterfront Scottish Inn",
"Rating": 3.8
},
{
"@search.score": 1,
"HotelId": "2",
"HotelName": "Old Century Hotel",
"Rating": 3.6
},
...
다음 쿼리는 문자열 필드(Address/StateProvince)에 대한 범위 필터입니다.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "*",
"filter": "Address/StateProvince ge 'A*' and Address/StateProvince lt 'D*'",
"select": "HotelId, HotelName, Address/StateProvince",
"count": true
}
이 쿼리에 대한 응답은 간결하게 트리밍된 다음 예제와 유사해야 합니다. 이 예제에서는 필드가 인덱스 정의에서 정렬 StateProvince 가능한 특성이 아니므로 정렬 기준으로 정렬할 수 없습니다.
{
"@odata.count": 9,
"value": [
{
"@search.score": 1,
"HotelId": "39",
"HotelName": "White Mountain Lodge & Suites",
"Address": {
"StateProvince": "CO"
}
},
{
"@search.score": 1,
"HotelId": "9",
"HotelName": "Smile Up Hotel",
"Address": {
"StateProvince": "CA "
}
},
{
"@search.score": 1,
"HotelId": "7",
"HotelName": "Roach Motel",
"Address": {
"StateProvince": "CA "
}
},
{
"@search.score": 1,
"HotelId": "34",
"HotelName": "Lakefront Captain Inn",
"Address": {
"StateProvince": "CT"
}
},
{
"@search.score": 1,
"HotelId": "37",
"HotelName": "Campus Commander Hotel",
"Address": {
"StateProvince": "CA "
}
},
. . .
예제 6: 지리 공간 검색
hotels-sample-index에는 위도 및 경도 좌표가 있는 위치 필드가 포함됩니다. 이 예제에서는 시작 지점의 원주 내에서 사용자가 지정하는 임의의 거리(킬로미터 단위)에 문서를 필터링하는 geo.distance 함수를 사용합니다. 쿼리(10)에서 마지막 값을 조정하여 쿼리 노출 영역을 줄이거나 확장할 수 있습니다.
POST /indexes/v/docs/search?api-version=2024-07-01
{
"search": "*",
"filter": "geo.distance(Location, geography'POINT(-122.335114 47.612839)') le 10",
"select": "HotelId, HotelName, Address/City, Address/StateProvince",
"count": true
}
이 쿼리에 대한 응답은 제공된 좌표에서 10km 거리에 있는 모든 호텔을 반환합니다.
{
"@odata.count": 3,
"value": [
{
"@search.score": 1,
"HotelId": "45",
"HotelName": "Happy Lake Resort & Restaurant",
"Address": {
"City": "Seattle",
"StateProvince": "WA"
}
},
{
"@search.score": 1,
"HotelId": "24",
"HotelName": "Uptown Chic Hotel",
"Address": {
"City": "Seattle",
"StateProvince": "WA"
}
},
{
"@search.score": 1,
"HotelId": "16",
"HotelName": "Double Sanctuary Resort",
"Address": {
"City": "Seattle",
"StateProvince": "WA"
}
}
]
}
예제 7: searchMode를 사용한 부울
단순 구문은 AND, OR 및 NOT 쿼리 논리를 지원하기 위해 문자(+, -, |)의 형태로 부울 연산자를 지원합니다. 부울 검색은 몇 가지 주목할 만한 예외를 제외하고 예상대로 작동합니다.
부울 검색에서 정밀도 및 재현율에 영향을 주는 메커니즘으로 매개 변수를 추가하는 searchMode 것이 좋습니다. 유효한 값으로는 "searchMode": "any" 회수 선호(조건을 충족하는 문서가 일치하는 것으로 간주됨) 및 "searchMode": "all" 정밀도 선호(모든 조건은 문서에서 일치해야 합니다)가 포함됩니다.
부울 검색의 컨텍스트에서는 여러 연산자를 사용하여 쿼리를 누적하고 좁은 결과 대신 광범위하게 사용하는 경우 기본 "searchMode": "any"를 사용하면 혼란스러울 수 있습니다. 결과가 특정 용어나 구를 포함하지 않는 모든 문서를 포함하는 NOT에서는 특히 그렇습니다.
다음 예제에서 이에 대해 설명합니다. 쿼리는 공조 구를 제외하는 레스토랑에서 일치 항목을 찾습니다. searchMode(모두)를 사용하여 다음 쿼리를 실행하면 43개의 문서가 반환됩니다. 여기에는 식당이라는 용어가 포함된 문서와 *공조라는 문구가 없는 모든 문서가 반환됩니다.
부울 연산자(-)와 구 공조 사이에 공백이 없습니다. 따옴표는 이스케이프됩니다(\").
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "restaurant -\"air conditioning\"",
"searchMode": "any",
"searchFields": "Tags",
"select": "HotelId, HotelName, Tags",
"count": true
}
조건에 누적 효과를 적용하도록 "searchMode": "all" 변경하면 레스토랑이라는 용어가 포함된 문서로 구성된 더 작은 결과 집합(7개의 일치)을 반환하고 구 공조를 포함하는 문서를 뺀 값이 반환됩니다.
이제 이 쿼리에 대한 응답은 간결하게 트리밍된 다음 예제와 유사하게 표시됩니다.
{
"@odata.count": 14,
"value": [
{
"@search.score": 3.1383743,
"HotelId": "18",
"HotelName": "Ocean Water Resort & Spa",
"Tags": [
"view",
"pool",
"restaurant"
]
},
{
"@search.score": 2.028083,
"HotelId": "22",
"HotelName": "Lion's Den Inn",
"Tags": [
"laundry service",
"free wifi",
"restaurant"
]
},
{
"@search.score": 2.028083,
"HotelId": "34",
"HotelName": "Lakefront Captain Inn",
"Tags": [
"restaurant",
"laundry service",
"coffee in lobby"
]
},
...
예제 8: 페이징 결과
이전 예제에서는 결과에 포함되는 필드를 결정하는 select, 정렬 순서 및 모든 일치 항목의 수를 포함시키는 방법을 비롯한 검색 결과 컴퍼지션에 영향을 주는 매개 변수에 대해 알아보았습니다. 이 예제는 지정된 페이지에 표시되는 결과의 수를 일괄 처리할 수 있도록 하는 페이징 매개 변수 형식의 연속적인 검색 결과 컴퍼지션입니다.
기본적으로 검색 서비스는 상위 50개의 일치 항목을 반환합니다. 각 페이지의 일치 항목 수를 제어하려면 top을 사용하여 일괄 처리의 크기를 정의한 다음, skip을 사용하여 후속 일괄 처리를 선택합니다.
다음 예제에서는 정렬된 결과에 대한 Rating 페이징의 효과를 더 쉽게 볼 수 있으므로 필드에 필터 및 정렬 순서를 사용합니다(등급은 필터링 가능하고 정렬 가능). 일반 전체 검색 쿼리에서 상위 일치 항목은 @search.score로 순위를 지정하고 페이징합니다.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "*",
"filter": "Rating gt 4",
"select": "HotelName, Rating",
"orderby": "Rating desc",
"top": 5,
"count": true
}
쿼리는 일치하는 21개의 문서를 찾지만 지정했기 top때문에 응답은 상위 5개의 일치 항목만 반환하며, 등급은 4.9에서 시작하여 Lakeside B 및 B에서 4.7로 끝납니다.
다음 5개를 얻으려면 첫 번째 일괄 처리를 건너뜁니다.
POST /indexes/hotels-sample-index/docs/search?api-version=2024-07-01
{
"search": "*",
"filter": "Rating gt 4",
"select": "HotelName, Rating",
"orderby": "Rating desc",
"top": 5,
"skip": 5,
"count": true
}
두 번째 일괄 처리에 대한 응답은 처음 5경기를 건너뛰고, 풀리 인 모텔부터 시작하여 다음 5경기를 반환합니다. 더 많은 일괄 처리를 top 계속하려면 새 요청마다 5개씩 증 skip 분합니다(skip=5, skip=10, skip=15 등).
{
"@odata.count": 21,
"value": [
{
"@search.score": 1,
"HotelName": "Head Wind Resort",
"Rating": 4.7
},
{
"@search.score": 1,
"HotelName": "Sublime Palace Hotel",
"Rating": 4.6
},
{
"@search.score": 1,
"HotelName": "City Skyline Antiquity Hotel",
"Rating": 4.5
},
{
"@search.score": 1,
"HotelName": "Nordick's Valley Motel",
"Rating": 4.5
},
{
"@search.score": 1,
"HotelName": "Winter Panorama Resort",
"Rating": 4.5
}
]
}
관련 콘텐츠
이제 기본 쿼리 구문으로 몇 가지 연습을 마쳤으니 코드에서 쿼리를 지정해 보세요. 다음 링크에서는 Azure SDK를 사용하여 검색 쿼리를 설정하는 방법을 설명합니다.
더 많은 구문 참조, 쿼리 아키텍처 및 예는 다음 링크에서 찾을 수 있습니다.