@azure/search-documents 12.2.0-beta.2 → 12.2.0

package/LICENSE

@@ -1,6 +1,6 @@
-The MIT License (MIT)
+Copyright (c) Microsoft Corporation.
 
-Copyright (c) 2020 Microsoft
+MIT License
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal
@@ -12,7 +12,7 @@ furnished to do so, subject to the following conditions:
 The above copyright notice and this permission notice shall be included in all
 copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

package/README.md

@@ -1,6 +1,6 @@
 # Azure AI Search client library for JavaScript
 
-[Azure AI Search](https://docs.microsoft.com/azure/search/) (formerly known as "Azure Cognitive Search") is an AI-powered information retrieval platform that helps developers build rich search experiences and generative AI apps that combine large language models with enterprise data.
+[Azure AI Search](https://learn.microsoft.com/azure/search/) (formerly known as "Azure Cognitive Search") is an AI-powered information retrieval platform that helps developers build rich search experiences and generative AI apps that combine large language models with enterprise data.
 
 The Azure AI Search service is well suited for the following application scenarios:
 
@@ -33,9 +33,9 @@ Key links:
 
 - [Source code](https://github.com/Azure/azure-sdk-for-js/blob/main/sdk/search/search-documents/)
 - [Package (NPM)](https://www.npmjs.com/package/@azure/search-documents)
-- [API reference documentation](https://docs.microsoft.com/javascript/api/@azure/search-documents)
-- [REST API documentation](https://docs.microsoft.com/rest/api/searchservice/)
-- [Product documentation](https://docs.microsoft.com/azure/search/)
+- [API reference documentation](https://learn.microsoft.com/javascript/api/@azure/search-documents)
+- [REST API documentation](https://learn.microsoft.com/rest/api/searchservice/)
+- [Product documentation](https://learn.microsoft.com/azure/search/)
 - [Samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/search/search-documents/samples)
 
 ## Getting started
@@ -64,7 +64,7 @@ To create a new search service, you can use the [Azure portal][create_search_ser
 az search service create --name <mysearch> --resource-group <mysearch-rg> --sku free --location westus
 ```
 
-See [choosing a pricing tier](https://docs.microsoft.com/azure/search/search-sku-tier) for more information about available options.
+See [choosing a pricing tier](https://learn.microsoft.com/azure/search/search-sku-tier) for more information about available options.
 
 ### Authenticate the client
 
@@ -74,7 +74,7 @@ To interact with the search service, you'll need to create an instance of the ap
 
 An API key can be an easier approach to start with because it doesn't require pre-existing role assignments.
 
-You can get the **endpoint** and an **API key** from the search service in the [Azure portal](https://portal.azure.com/). Please refer the [documentation](https://docs.microsoft.com/azure/search/search-security-api-keys) for instructions on how to get an API key.
+You can get the **endpoint** and an **API key** from the search service in the [Azure portal](https://portal.azure.com/). Please refer the [documentation](https://learn.microsoft.com/azure/search/search-security-api-keys) for instructions on how to get an API key.
 
 Alternatively, you can use the following [Azure CLI](https://learn.microsoft.com/cli/azure/) command to retrieve the API key from the search service:
 
@@ -88,19 +88,19 @@ _Note: The example Azure CLI snippet above retrieves an admin key so it's easier
 
 Once you have an api-key, you can use it as follows:
 
-```js
-const {
+```ts snippet:ReadmeSampleCreateClient_APIKey
+import {
   SearchClient,
+  AzureKeyCredential,
   SearchIndexClient,
   SearchIndexerClient,
-  AzureKeyCredential,
-} = require("@azure/search-documents");
+} from "@azure/search-documents";
 
 // To query and manipulate documents
 const searchClient = new SearchClient(
   "<endpoint>",
   "<indexName>",
-  new AzureKeyCredential("<apiKey>")
+  new AzureKeyCredential("<apiKey>"),
 );
 
 // To manage indexes and synonymmaps
@@ -112,18 +112,18 @@ const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredenti
 
 ### Authenticate in a National Cloud
 
-To authenticate in a [National Cloud](https://docs.microsoft.com/azure/active-directory/develop/authentication-national-cloud), you will need to make the following additions to your client configuration:
+To authenticate in a [National Cloud](https://learn.microsoft.com/azure/active-directory/develop/authentication-national-cloud), you will need to make the following additions to your client configuration:
 
 - Set the `Audience` in `SearchClientOptions`
 
-```js
-const {
+```ts snippet:ReadmeSampleCreateClient_NationalCloud
+import {
   SearchClient,
-  SearchIndexClient,
-  SearchIndexerClient,
   AzureKeyCredential,
   KnownSearchAudience,
-} = require("@azure/search-documents");
+  SearchIndexClient,
+  SearchIndexerClient,
+} from "@azure/search-documents";
 
 // To query and manipulate documents
 const searchClient = new SearchClient(
@@ -132,7 +132,7 @@ const searchClient = new SearchClient(
   new AzureKeyCredential("<apiKey>"),
   {
     audience: KnownSearchAudience.AzureChina,
-  }
+  },
 );
 
 // To manage indexes and synonymmaps
@@ -153,24 +153,24 @@ exposes operations on these resources through three main client types.
 
 - `SearchClient` helps with:
 
-  - [Searching](https://docs.microsoft.com/azure/search/search-lucene-query-architecture)
+  - [Searching](https://learn.microsoft.com/azure/search/search-lucene-query-architecture)
     your indexed documents using [vector queries](https://learn.microsoft.com/azure/search/vector-search-how-to-query),
     [keyword queries](https://learn.microsoft.com/azure/search/search-query-create)
     and [hybrid queries](https://learn.microsoft.com/azure/search/hybrid-search-how-to-query)
   - [Vector query filters](https://learn.microsoft.com/azure/search/vector-search-filters) and [Text query filters](https://learn.microsoft.com/azure/search/search-filters)
   - [Semantic ranking](https://learn.microsoft.com/azure/search/semantic-how-to-query-request) and [scoring profiles](https://learn.microsoft.com/azure/search/index-add-scoring-profiles) for boosting relevance
-  - [Autocompleting](https://docs.microsoft.com/rest/api/searchservice/autocomplete) partially typed search terms based on documents in the index
-  - [Suggesting](https://docs.microsoft.com/rest/api/searchservice/suggestions) the most likely matching text in documents as a user types
-  - [Adding, Updating or Deleting Documents](https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents) documents from an index
+  - [Autocompleting](https://learn.microsoft.com/rest/api/searchservice/autocomplete) partially typed search terms based on documents in the index
+  - [Suggesting](https://learn.microsoft.com/rest/api/searchservice/suggestions) the most likely matching text in documents as a user types
+  - [Adding, Updating or Deleting Documents](https://learn.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents) documents from an index
 
 - `SearchIndexClient` allows you to:
 
-  - [Create, delete, update, or configure a search index](https://docs.microsoft.com/rest/api/searchservice/index-operations)
-  - [Declare custom synonym maps to expand or rewrite queries](https://docs.microsoft.com/rest/api/searchservice/synonym-map-operations)
+  - [Create, delete, update, or configure a search index](https://learn.microsoft.com/rest/api/searchservice/index-operations)
+  - [Declare custom synonym maps to expand or rewrite queries](https://learn.microsoft.com/rest/api/searchservice/synonym-map-operations)
 
 - `SearchIndexerClient` allows you to:
-  - [Start indexers to automatically crawl data sources](https://docs.microsoft.com/rest/api/searchservice/indexer-operations)
-  - [Define AI powered Skillsets to transform and enrich your data](https://docs.microsoft.com/rest/api/searchservice/skillset-operations)
+  - [Start indexers to automatically crawl data sources](https://learn.microsoft.com/rest/api/searchservice/indexer-operations)
+  - [Define AI powered Skillsets to transform and enrich your data](https://learn.microsoft.com/rest/api/searchservice/skillset-operations)
 
 **Note**: These clients cannot function in the browser because the APIs it calls do not have support for Cross-Origin Resource Sharing (CORS).
 
@@ -182,11 +182,11 @@ An item stored inside a search index. The shape of this document is described in
 
 ### Pagination
 
-Typically you will only wish to [show a subset of search results](https://docs.microsoft.com/azure/search/search-pagination-page-layout#total-hits-and-page-counts) to a user at one time. To support this, you can use the `top`, `skip` and `includeTotalCount` parameters to provide a paged experience on top of search results.
+Typically you will only wish to [show a subset of search results](https://learn.microsoft.com/azure/search/search-pagination-page-layout#total-hits-and-page-counts) to a user at one time. To support this, you can use the `top`, `skip` and `includeTotalCount` parameters to provide a paged experience on top of search results.
 
 ### Document field encoding
 
-[Supported data types](https://docs.microsoft.com/rest/api/searchservice/Supported-data-types) in an index are mapped to JSON types in API requests/responses. The JS client library keeps these mostly the same, with some exceptions:
+[Supported data types](https://learn.microsoft.com/rest/api/searchservice/Supported-data-types) in an index are mapped to JSON types in API requests/responses. The JS client library keeps these mostly the same, with some exceptions:
 
 - `Edm.DateTimeOffset` is converted to a JS `Date`.
 - `Edm.GeographyPoint` is converted to a `GeographyPoint` type exported by the client library.
@@ -208,142 +208,137 @@ The following examples demonstrate the basics - please [check out our samples](h
 
 ### Create an Index
 
-```js
-const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents");
+```ts snippet:ReadmeSampleCreateIndex
+import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
 
-const client = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
-
-async function main() {
-  const result = await client.createIndex({
-    name: "example-index",
-    fields: [
-      {
-        type: "Edm.String",
-        name: "id",
-        key: true,
-      },
-      {
-        type: "Edm.Double",
-        name: "awesomenessLevel",
-        sortable: true,
-        filterable: true,
-        facetable: true,
-      },
-      {
-        type: "Edm.String",
-        name: "description",
-        searchable: true,
-      },
-      {
-        type: "Edm.ComplexType",
-        name: "details",
-        fields: [
-          {
-            type: "Collection(Edm.String)",
-            name: "tags",
-            searchable: true,
-          },
-        ],
-      },
-      {
-        type: "Edm.Int32",
-        name: "hiddenWeight",
-        hidden: true,
-      },
-    ],
-  });
+const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
 
-  console.log(result);
-}
+const result = await indexClient.createIndex({
+  name: "example-index",
+  fields: [
+    {
+      type: "Edm.String",
+      name: "id",
+      key: true,
+    },
+    {
+      type: "Edm.Double",
+      name: "awesomenessLevel",
+      sortable: true,
+      filterable: true,
+      facetable: true,
+    },
+    {
+      type: "Edm.String",
+      name: "description",
+      searchable: true,
+    },
+    {
+      type: "Edm.ComplexType",
+      name: "details",
+      fields: [
+        {
+          type: "Collection(Edm.String)",
+          name: "tags",
+          searchable: true,
+        },
+      ],
+    },
+    {
+      type: "Edm.Int32",
+      name: "hiddenWeight",
+      hidden: true,
+    },
+  ],
+});
 
-main();
+console.log(`Index created with name ${result.name}`);
 ```
 
 ### Retrieve a specific document from an index
 
 A specific document can be retrieved by its primary key value:
 
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+```ts snippet:ReadmeSampleGetDocument
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
-
-async function main() {
-  const result = await client.getDocument("1234");
-  console.log(result);
-}
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-main();
+const result = await searchClient.getDocument("1234");
 ```
 
 ### Adding documents into an index
 
 You can upload multiple documents into index inside a batch:
 
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
-
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
-
-async function main() {
-  const uploadResult = await client.uploadDocuments([
-    // JSON objects matching the shape of the client's index
-    {},
-    {},
-    {},
-  ]);
-  for (const result of uploadResult.results) {
-    console.log(`Uploaded ${result.key}; succeeded? ${result.succeeded}`);
-  }
-}
+```ts snippet:ReadmeSampleUploadDocuments
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-main();
+const uploadResult = await searchClient.uploadDocuments([
+  // JSON objects matching the shape of the client's index
+  {},
+  {},
+  {},
+]);
+for (const result of uploadResult.results) {
+  console.log(`Uploaded ${result.key}; succeeded? ${result.succeeded}`);
+}
 ```
 
 ### Perform a search on documents
 
-To list all results of a particular query, you can use `search` with a search string that uses [simple query syntax](https://docs.microsoft.com/azure/search/query-simple-syntax):
+To list all results of a particular query, you can use `search` with a search string that uses [simple query syntax](https://learn.microsoft.com/azure/search/query-simple-syntax):
 
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+```ts snippet:ReadmeSampleSearch
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-async function main() {
-  const searchResults = await client.search("wifi -luxury");
-  for await (const result of searchResults.results) {
-    console.log(result);
-  }
+const searchResults = await searchClient.search("wifi -luxury");
+for await (const result of searchResults.results) {
+  console.log(result);
 }
-
-main();
 ```
 
-For a more advanced search that uses [Lucene syntax](https://docs.microsoft.com/azure/search/query-lucene-syntax), specify `queryType` to be `full`:
+For a more advanced search that uses [Lucene syntax](https://learn.microsoft.com/azure/search/query-lucene-syntax), specify `queryType` to be `full`:
 
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+```ts snippet:ReadmeSampleSearchLucene
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-async function main() {
-  const searchResults = await client.search('Category:budget AND "recently renovated"^3', {
-    queryType: "full",
-    searchMode: "all",
-  });
-  for await (const result of searchResults.results) {
-    console.log(result);
-  }
+const searchResults = await searchClient.search('Category:budget AND "recently renovated"^3', {
+  queryType: "full",
+  searchMode: "all",
+});
+for await (const result of searchResults.results) {
+  console.log(result);
 }
-
-main();
 ```
 
 #### Querying with TypeScript
 
 In TypeScript, `SearchClient` takes a generic parameter that is the model shape of your index documents. This allows you to perform strongly typed lookup of fields returned in results. TypeScript is also able to check for fields returned when specifying a `select` parameter.
 
-```ts
+```ts snippet:ReadmeSampleSearchWithTypes
 import { SearchClient, AzureKeyCredential, SelectFields } from "@azure/search-documents";
 
 // An example schema for documents in the index
@@ -361,131 +356,112 @@ interface Hotel {
   }>;
 }
 
-const client = new SearchClient<Hotel>(
+const searchClient = new SearchClient<Hotel>(
   "<endpoint>",
   "<indexName>",
-  new AzureKeyCredential("<apiKey>")
+  new AzureKeyCredential("<apiKey>"),
 );
 
-async function main() {
-  const searchResults = await client.search("wifi -luxury", {
-    // Only fields in Hotel can be added to this array.
-    // TS will complain if one is misspelled.
-    select: ["hotelId", "hotelName", "rooms/beds"],
-  });
-
-  // These are other ways to declare the correct type for `select`.
-  const select = ["hotelId", "hotelName", "rooms/beds"] as const;
-  // This declaration lets you opt out of narrowing the TypeScript type of your documents,
-  // though the AI Search service will still only return these fields.
-  const selectWide: SelectFields<Hotel>[] = ["hotelId", "hotelName", "rooms/beds"];
-  // This is an invalid declaration. Passing this to `select` will result in a compiler error
-  // unless you opt out of including the model in the client constructor.
-  const selectInvalid = ["hotelId", "hotelName", "rooms/beds"];
-
-  for await (const result of searchResults.results) {
-    // result.document has hotelId, hotelName, and rating.
-    // Trying to access result.document.description would emit a TS error.
-    console.log(result.document.hotelName);
-  }
-}
+const searchResults = await searchClient.search("wifi -luxury", {
+  // Only fields in Hotel can be added to this array.
+  // TS will complain if one is misspelled.
+  select: ["hotelId", "hotelName", "rooms/beds"],
+});
 
-main();
+// These are other ways to declare the correct type for `select`.
+const select = ["hotelId", "hotelName", "rooms/beds"] as const;
+// This declaration lets you opt out of narrowing the TypeScript type of your documents,
+// though the AI Search service will still only return these fields.
+const selectWide: SelectFields<Hotel>[] = ["hotelId", "hotelName", "rooms/beds"];
+// This is an invalid declaration. Passing this to `select` will result in a compiler error
+// unless you opt out of including the model in the client constructor.
+const selectInvalid = ["hotelId", "hotelName", "rooms/beds"];
+
+for await (const result of searchResults.results) {
+  // result.document has hotelId, hotelName, and rating.
+  // Trying to access result.document.description would emit a TS error.
+  console.log(result.document.hotelName);
+}
 ```
 
 #### Querying with OData filters
 
-Using the `filter` query parameter allows you to query an index using the syntax of an [OData \$filter expression](https://docs.microsoft.com/azure/search/search-query-odata-filter).
-
-```js
-const { SearchClient, AzureKeyCredential, odata } = require("@azure/search-documents");
-
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
-
-async function main() {
-  const baseRateMax = 200;
-  const ratingMin = 4;
-  const searchResults = await client.search("WiFi", {
-    filter: odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`,
-    orderBy: ["Rating desc"],
-    select: ["hotelId", "hotelName", "Rating"],
-  });
-  for await (const result of searchResults.results) {
-    // Each result will have "HotelId", "HotelName", and "Rating"
-    // in addition to the standard search result property "score"
-    console.log(result);
-  }
-}
+Using the `filter` query parameter allows you to query an index using the syntax of an [OData \$filter expression](https://learn.microsoft.com/azure/search/search-query-odata-filter).
+
+```ts snippet:ReadmeSampleSearchWithOData
+import { SearchClient, AzureKeyCredential, odata } from "@azure/search-documents";
+
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-main();
+const baseRateMax = 200;
+const ratingMin = 4;
+const searchResults = await searchClient.search("WiFi", {
+  filter: odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`,
+  orderBy: ["Rating desc"],
+  select: ["hotelId", "hotelName", "Rating"],
+});
+for await (const result of searchResults.results) {
+  // Each result will have "HotelId", "HotelName", and "Rating"
+  // in addition to the standard search result property "score"
+  console.log(result);
+}
 ```
 
 #### Querying with vectors
 
 Text embeddings can be queried using the `vector` search parameter. See [Query vectors](https://learn.microsoft.com/azure/search/vector-search-how-to-query) and [Filter vector queries](https://learn.microsoft.com/azure/search/vector-search-filters) for more information.
 
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+```ts snippet:ReadmeSampleSearchWithVector
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
 const searchClient = new SearchClient(
   "<endpoint>",
   "<indexName>",
-  new AzureKeyCredential("<apiKey>")
+  new AzureKeyCredential("<apiKey>"),
 );
 
-async function main() {
-  const queryVector = [/*...*/];
-  const searchResults = await searchClient.search("*", {
-    vectorSearchOptions: {
-      queries: [
-        {
-          kind: "vector",
-          vector: queryVector,
-          fields: ["descriptionVector"],
-          kNearestNeighborsCount: 3,
-        },
-      ],
-    },
-  });
-  for await (const result of searchResults.results) {
-    // These results are the nearest neighbors to the query vector
-    console.log(result);
-  }
+const queryVector: number[] = [
+  // Embedding of the query "What are the most luxurious hotels?"
+];
+const searchResults = await searchClient.search("*", {
+  vectorSearchOptions: {
+    queries: [
+      {
+        kind: "vector",
+        vector: queryVector,
+        fields: ["descriptionVector"],
+        kNearestNeighborsCount: 3,
+      },
+    ],
+  },
+});
+for await (const result of searchResults.results) {
+  // These results are the nearest neighbors to the query vector
+  console.log(result);
 }
-
-main();
 ```
 
 #### Querying with facets
 
-[Facets](https://docs.microsoft.com/azure/search/search-filters-facets) are used to help a user of your application refine a search along pre-configured dimensions. [Facet syntax](https://docs.microsoft.com/rest/api/searchservice/search-documents#facetstring-zero-or-more) provides the options to sort and bucket facet values.
-
-```js
-const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
-
-const client = new SearchClient("<endpoint>", "<indexName>", new AzureKeyCredential("<apiKey>"));
-
-async function main() {
-  const searchResults = await client.search("WiFi", {
-    facets: ["category,count:3,sort:count", "rooms/baseRate,interval:100"],
-  });
-  console.log(searchResults.facets);
-  // Output will look like:
-  // {
-  //   'rooms/baseRate': [
-  //     { count: 16, value: 0 },
-  //     { count: 17, value: 100 },
-  //     { count: 17, value: 200 }
-  //   ],
-  //   category: [
-  //     { count: 5, value: 'Budget' },
-  //     { count: 5, value: 'Luxury' },
-  //     { count: 5, value: 'Resort and Spa' }
-  //   ]
-  // }
-}
+[Facets](https://learn.microsoft.com/azure/search/search-filters-facets) are used to help a user of your application refine a search along pre-configured dimensions. [Facet syntax](https://learn.microsoft.com/rest/api/searchservice/search-documents#facetstring-zero-or-more) provides the options to sort and bucket facet values.
+
+```ts snippet:ReadmeSampleSearchWithFacets
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
 
-main();
+const searchResults = await searchClient.search("WiFi", {
+  facets: ["category,count:3,sort:count", "rooms/baseRate,interval:100"],
+});
+console.log(searchResults.facets);
 ```
 
 When retrieving results, a `facets` property will be available that will indicate the number of results that fall into each facet bucket. This can be used to drive refinement (e.g. issuing a follow-up search that filters on the `Rating` being greater than or equal to 3 and less than 4.)
@@ -496,7 +472,7 @@ When retrieving results, a `facets` property will be available that will indicat
 
 Enabling logging can help uncover useful information about failures. In order to see a log of HTTP requests and responses, set the `AZURE_LOG_LEVEL` environment variable to `info`. Alternatively, logging can be enabled at runtime by calling `setLogLevel` in the `@azure/logger`:
 
-```javascript
+```ts snippet:SetLogLevel
 import { setLogLevel } from "@azure/logger";
 
 setLogLevel("info");
@@ -507,7 +483,7 @@ For more detailed instructions on how to enable logs, you can look at the [@azur
 ## Next steps
 
 - [Go further with search-documents and our samples](https://github.com/Azure/azure-sdk-for-js/tree/main/sdk/search/search-documents/samples)
-- [Read more about the Azure AI Search service](https://docs.microsoft.com/azure/search/search-what-is-azure-search)
+- [Read more about the Azure AI Search service](https://learn.microsoft.com/azure/search/search-what-is-azure-search)
 
 ## Contributing
 
@@ -521,16 +497,16 @@ This project has adopted the [Microsoft Open Source Code of Conduct][coc]. For m
 
 - [Microsoft Azure SDK for JavaScript](https://github.com/Azure/azure-sdk-for-js)
 
-![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-js%2Fsdk%2Fsearch%2Fsearch%2FREADME.png)
 
-[azure_cli]: https://docs.microsoft.com/cli/azure
+
+[azure_cli]: https://learn.microsoft.com/cli/azure
 [azure_sub]: https://azure.microsoft.com/free/
-[search_resource]: https://docs.microsoft.com/azure/search/search-create-service-portal
+[search_resource]: https://learn.microsoft.com/azure/search/search-create-service-portal
 [azure_portal]: https://portal.azure.com
-[cognitive_auth]: https://docs.microsoft.com/azure/cognitive-services/authentication
-[create_search_service_docs]: https://docs.microsoft.com/azure/search/search-create-service-portal
-[create_search_service_ps]: https://docs.microsoft.com/azure/search/search-manage-powershell#create-or-delete-a-service
-[create_search_service_cli]: https://docs.microsoft.com/cli/azure/search/service?view=azure-cli-latest#az-search-service-create
+[cognitive_auth]: https://learn.microsoft.com/azure/cognitive-services/authentication
+[create_search_service_docs]: https://learn.microsoft.com/azure/search/search-create-service-portal
+[create_search_service_ps]: https://learn.microsoft.com/azure/search/search-manage-powershell#create-or-delete-a-service
+[create_search_service_cli]: https://learn.microsoft.com/cli/azure/search/service?view=azure-cli-latest#az-search-service-create
 [cla]: https://cla.microsoft.com
 [coc]: https://opensource.microsoft.com/codeofconduct/
 [coc_faq]: https://opensource.microsoft.com/codeofconduct/faq/

package/dist/browser/base64-browser.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64-browser.d.mts","sourceRoot":"","sources":["../../src/base64-browser.mts"],"names":[],"mappings":"AAGA;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5C;AAED;;;GAGG;AACH,wBAAgB,MAAM,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,CAE5C"}

package/dist/browser/base64-browser.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"base64-browser.mjs","sourceRoot":"","sources":["../../src/base64-browser.mts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,MAAM,CAAC,KAAa;IAClC,OAAO,IAAI,CAAC,KAAK,CAAC,CAAC;AACrB,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\n/**\n * Encodes a string in base64 format.\n * @param value - The string to encode.\n */\nexport function encode(value: string): string {\n  return btoa(value);\n}\n\n/**\n * Decodes a base64 string into a regular string.\n * @param value - The base64 string to decode.\n */\nexport function decode(value: string): string {\n  return atob(value);\n}\n"]}