Skip to content

Commit 5504092

Browse files
HeidiSteenHeidiSteen
committed
updated python and intro to use new query string
1 parent b8f424e commit 5504092

File tree

2 files changed

+168
-93
lines changed

2 files changed

+168
-93
lines changed

‎articles/search/includes/quickstarts/semantic-ranker-intro.md

Lines changed: 87 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ In this quickstart, you learn about the index and query modifications that invok
1111

1212
In Azure AI Search, [semantic ranking](../../semantic-search-overview.md) is query-side functionality that uses machine reading comprehension from Microsoft to rescore search results, promoting the most semantically relevant matches to the top of the list. Depending on the content and the query, semantic ranking can [significantly improve search relevance](https://techcommunity.microsoft.com/t5/azure-ai-services-blog/azure-cognitive-search-outperforming-vector-search-with-hybrid/ba-p/3929167) with minimal developer effort. Semantic ranking is also required for [agentic retrieval (preview)](../../search-agentic-retrieval-concept.md).
1313

14-
You can add a semantic configuration to an existing index with no rebuild requirement. Semantic ranking is most effective on content that's informational or descriptive.
14+
You can add a semantic configuration to an existing index with no rebuild requirement. Semantic ranking is most effective on text that's informational or descriptive.
1515

1616
In this quickstart:
1717

@@ -63,67 +63,92 @@ This quickstart assumes an existing index, modified to include a semantic config
6363

6464
:::image type="content" source="../../media/search-get-started-semantic/no-semantic-configuration.png" alt-text="Screenshot of an empty semantic configuration page in the Azure portal.":::
6565

66-
1. To verify the index is operational, run a query. In **Search explorer**, enter this search string "good trails for running or biking and outdoor activities" so that you can view the response *before* semantic ranking is applied. Your response should be similar to the following example, as scored by the default BM25 L1 ranker for full text search. For readability, the example selects just the "HotelName" and "Description" fields.
67-
68-
```json
69-
"@odata.count": 11,
70-
"value": [
71-
{
72-
"@search.score": 3.5593667,
73-
"HotelName": "Winter Panorama Resort",
74-
"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."
75-
},
76-
{
77-
"@search.score": 3.0720026,
78-
"HotelName": "Good Business Hotel",
79-
"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."
80-
},
81-
{
82-
"@search.score": 2.2779887,
83-
"HotelName": "Trails End Motel",
84-
"Description": "Only 8 miles from Downtown. On-site bar/restaurant, Free hot breakfast buffet, Free wireless internet, All non-smoking hotel. Only 15 miles from airport."
85-
},
86-
{
87-
"@search.score": 1.7617674,
88-
"HotelName": "Royal Cottage Resort",
89-
"Description": "Your home away from home. Brand new fully equipped premium rooms, fast WiFi, full kitchen, washer & dryer, fitness center. Inner courtyard includes water features and outdoor seating. All units include fireplaces and small outdoor balconies. Pets accepted."
90-
},
91-
{
92-
"@search.score": 1.5327098,
93-
"HotelName": "City Center Summer Wind Resort",
94-
"Description": "Eco-friendly from our gardens to table, with a rooftop serenity pool and outdoor seating to take in the sunset. Just steps away from the Convention Center. Located in the heart of downtown with modern rooms with stunning city views, 24-7 dining options, free WiFi and easy valet parking."
95-
},
96-
{
97-
"@search.score": 1.5104222,
98-
"HotelName": "Foot Happy Suites",
99-
"Description": "Downtown in the heart of the business district. Close to everything. Leave your car behind and walk to the park, shopping, and restaurants. Or grab one of our bikes and take your explorations a little further."
100-
},
101-
{
102-
"@search.score": 1.4453387,
103-
"HotelName": "Economy Universe Motel",
104-
"Description": "Local, family-run hotel in bustling downtown Redmond. We are a pet-friendly establishment, near expansive Marymoor park, haven to pet owners, joggers, and sports enthusiasts. Close to the highway and just a short drive away from major cities."
105-
},
106-
{
107-
"@search.score": 1.3732712,
108-
"HotelName": "Starlight Suites",
109-
"Description": "Complimentary Airport Shuttle & WiFi. Book Now and save - Spacious All Suite Hotel, Indoor Outdoor Pool, Fitness Center, Florida Green certified, Complimentary Coffee, HDTV"
110-
},
111-
{
112-
"@search.score": 1.2054883,
113-
"HotelName": "Happy Lake Resort & Restaurant",
114-
"Description": "The largest year-round resort in the area offering more of everything for your vacation – at the best value! What can you enjoy while at the resort, aside from the mile-long sandy beaches of the lake? Check out our activities sure to excite both young and young-at-heart guests. We have it all, including being named “Property of the Year” and a “Top Ten Resort” by top publications."
115-
},
116-
{
117-
"@search.score": 1.161385,
118-
"HotelName": "White Mountain Lodge & Suites",
119-
"Description": "Live amongst the trees in the heart of the forest. Hike along our extensive trail system. Visit the Natural Hot Springs, or enjoy our signature hot stone massage in the Cathedral of Firs. Relax in the meditation gardens, or join new friends around the communal firepit. Weekend evening entertainment on the patio features special guest musicians or poetry readings."
120-
},
121-
{
122-
"@search.score": 0.8955848,
123-
"HotelName": "Windy Ocean Motel",
124-
"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."
125-
}
126-
]
66+
1. To verify the index is operational, run a query. In **Search explorer**, enter this search string *"walking distance to live music"* so that you can view the response *before* semantic ranking is applied. Your response should be similar to the following example, as scored by the default BM25 L1 ranker for full text search. For readability, the example selects just the "HotelName" "HotelId", and "Description" fields.
67+
68+
This query is a keyword search. The matches contain verbatim matches on the query terms (walking, distance, live, music) or a linguistic variant (walk, living).
69+
70+
```json
71+
"@odata.count": 13,
72+
"value": [
73+
{
74+
"@search.score": 5.5153193,
75+
"HotelId": "2",
76+
"HotelName": "Old Century Hotel",
77+
"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."
78+
},
79+
{
80+
"@search.score": 5.074317,
81+
"HotelId": "24",
82+
"HotelName": "Uptown Chic Hotel",
83+
"Description": "Chic hotel near the city. High-rise hotel in downtown, within walking distance to theaters, art galleries, restaurants and shops. Visit Seattle Art Museum by day, and then head over to Benaroya Hall to catch the evening's concert performance."
84+
},
85+
{
86+
"@search.score": 4.8959594,
87+
"HotelId": "4",
88+
"HotelName": "Sublime Palace Hotel",
89+
"Description": "Sublime Cliff Hotel is located in the heart of the historic center of Sublime in an extremely vibrant and lively area within short walking distance to the sites and landmarks of the city and is surrounded by the extraordinary beauty of churches, buildings, shops and monuments. Sublime Cliff is part of a lovingly restored 19th century resort, updated for every modern convenience."
90+
},
91+
{
92+
"@search.score": 2.5966604,
93+
"HotelId": "35",
94+
"HotelName": "Bellevue Suites",
95+
"Description": "Comfortable city living in the very center of downtown Bellevue. Newly reimagined, this hotel features apartment-style suites with sleeping, living and work spaces. Located across the street from the Light Rail to downtown. Free shuttle to the airport."
96+
},
97+
{
98+
"@search.score": 2.566386,
99+
"HotelId": "47",
100+
"HotelName": "Country Comfort Inn",
101+
"Description": "Situated conveniently at the north end of the village, the inn is just a short walk from the lake, offering reasonable rates and all the comforts home inlcuding living room suites and functional kitchens. Pets are welcome."
102+
},
103+
{
104+
"@search.score": 2.2405157,
105+
"HotelId": "9",
106+
"HotelName": "Smile Up Hotel",
107+
"Description": "Experience the fresh, modern downtown. Enjoy updated rooms, bold style & prime location. Don't miss our weekend live music series featuring who's new/next on the scene."
108+
},
109+
{
110+
"@search.score": 2.1737604,
111+
"HotelId": "8",
112+
"HotelName": "Foot Happy Suites",
113+
"Description": "Downtown in the heart of the business district. Close to everything. Leave your car behind and walk to the park, shopping, and restaurants. Or grab one of our bikes and take your explorations a little further."
114+
},
115+
{
116+
"@search.score": 2.0364518,
117+
"HotelId": "31",
118+
"HotelName": "Country Residence Hotel",
119+
"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."
120+
},
121+
{
122+
"@search.score": 1.7595702,
123+
"HotelId": "49",
124+
"HotelName": "Swirling Currents Hotel",
125+
"Description": "Spacious rooms, glamorous suites and residences, rooftop pool, walking access to shopping, dining, entertainment and the city center. Each room comes equipped with a microwave, a coffee maker and a minifridge. In-room entertainment includes complimentary W-Fi and flat-screen TVs. "
126+
},
127+
{
128+
"@search.score": 1.5502293,
129+
"HotelId": "15",
130+
"HotelName": "By the Market Hotel",
131+
"Description": "Book now and Save up to 30%. Central location. Walking distance from the Empire State Building & Times Square, in the Chelsea neighborhood. Brand new rooms. Impeccable service."
132+
},
133+
{
134+
"@search.score": 1.3302404,
135+
"HotelId": "42",
136+
"HotelName": "Rock Bottom Resort & Campground",
137+
"Description": "Rock Bottom is nestled on 20 unspoiled acres on a private cove of Rock Bottom Lake. We feature both lodging and campground accommodations to suit just about every taste. Even though we are out of the traffic of the city, getting there is only a short drive away."
138+
},
139+
{
140+
"@search.score": 0.9050383,
141+
"HotelId": "38",
142+
"HotelName": "Lakeside B & B",
143+
"Description": "Nature is Home on the beach. Explore the shore by day, and then come home to our shared living space to relax around a stone fireplace, sip something warm, and explore the library by night. Save up to 30 percent. Valid Now through the end of the year. Restrictions and blackouts may apply."
144+
},
145+
{
146+
"@search.score": 0.7334347,
147+
"HotelId": "39",
148+
"HotelName": "White Mountain Lodge & Suites",
149+
"Description": "Live amongst the trees in the heart of the forest. Hike along our extensive trail system. Visit the Natural Hot Springs, or enjoy our signature hot stone massage in the Cathedral of Firs. Relax in the meditation gardens, or join new friends around the communal firepit. Weekend evening entertainment on the patio features special guest musicians or poetry readings."
150+
}
151+
]
127152
```
128153

129154
Later, you can try this query again after semantic ranking is configured to see how the response changes.

0 commit comments

Comments
 (0)