@azure/search-documents 12.2.0-alpha.20250424.1 → 12.2.0-alpha.20250501.2

package/README.md

@@ -88,13 +88,13 @@ _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(
@@ -116,14 +116,14 @@ To authenticate in a [National Cloud](https://learn.microsoft.com/azure/active-d
 
 - 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(
@@ -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";
 
-main();
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
+
+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://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://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,71 +356,67 @@ interface Hotel {
   }>;
 }
 
-const client = new SearchClient<Hotel>(
+const searchClient = new SearchClient<Hotel>(
   "<endpoint>",
   "<indexName>",
   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://learn.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);
-  }
-}
+```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>",
@@ -433,61 +424,44 @@ const searchClient = new SearchClient(
   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://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.
 
-```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' }
-  //   ]
-  // }
-}
+```ts snippet:ReadmeSampleSearchWithFacets
+import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
 
-main();
+const searchClient = new SearchClient(
+  "<endpoint>",
+  "<indexName>",
+  new AzureKeyCredential("<apiKey>"),
+);
+
+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.)
@@ -498,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");

package/dist/browser/odata.d.ts

@@ -1,7 +1,9 @@
 /**
  * Escapes an odata filter expression to avoid errors with quoting string literals.
  * Example usage:
- * ```ts
+ * ```ts snippet:ReadmeSampleOdataUsage
+ * import { odata } from "@azure/search-documents";
+ *
  * const baseRateMax = 200;
  * const ratingMin = 4;
  * const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

package/dist/browser/odata.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"odata.d.ts","sourceRoot":"","sources":["../../src/odata.ts"],"names":[],"mappings":"AAyBA;;;;;;;;;;;GAWG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAajF"}
+{"version":3,"file":"odata.d.ts","sourceRoot":"","sources":["../../src/odata.ts"],"names":[],"mappings":"AAyBA;;;;;;;;;;;;;GAaG;AACH,wBAAgB,KAAK,CAAC,OAAO,EAAE,oBAAoB,EAAE,GAAG,MAAM,EAAE,OAAO,EAAE,GAAG,MAAM,CAajF"}

package/dist/browser/odata.js

@@ -20,7 +20,9 @@ function escapeQuotesIfString(input, previous) {
 /**
  * Escapes an odata filter expression to avoid errors with quoting string literals.
  * Example usage:
- * ```ts
+ * ```ts snippet:ReadmeSampleOdataUsage
+ * import { odata } from "@azure/search-documents";
+ *
  * const baseRateMax = 200;
  * const ratingMin = 4;
  * const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;

package/dist/browser/odata.js.map

@@ -1 +1 @@
-{"version":3,"file":"odata.js","sourceRoot":"","sources":["../../src/odata.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc,EAAE,QAAgB;IAC5D,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,0CAA0C;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,IAAI,MAAM,GAAG,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;GAWG;AACH,MAAM,UAAU,KAAK,CAAC,OAA6B,EAAE,GAAG,MAAiB;IACvE,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClD,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nfunction formatNullAndUndefined(input: unknown): string | unknown {\n  if (input === null || input === undefined) {\n    return \"null\";\n  }\n\n  return input;\n}\n\nfunction escapeQuotesIfString(input: unknown, previous: string): string | unknown {\n  let result = input;\n\n  if (typeof input === \"string\") {\n    result = input.replace(/'/g, \"''\");\n    // check if we need to escape this literal\n    if (!previous.trim().endsWith(\"'\")) {\n      result = `'${result}'`;\n    }\n  }\n\n  return result;\n}\n\n/**\n * Escapes an odata filter expression to avoid errors with quoting string literals.\n * Example usage:\n * ```ts\n * const baseRateMax = 200;\n * const ratingMin = 4;\n * const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;\n * ```\n * For more information on supported syntax see: https://learn.microsoft.com/en-us/azure/search/search-query-odata-filter\n * @param strings - Array of strings for the expression\n * @param values - Array of values for the expression\n */\nexport function odata(strings: TemplateStringsArray, ...values: unknown[]): string {\n  const results = [];\n  for (let i = 0; i < strings.length; i++) {\n    results.push(strings[i]);\n    if (i < values.length) {\n      if (values[i] === null || values[i] === undefined) {\n        results.push(formatNullAndUndefined(values[i]));\n      } else {\n        results.push(escapeQuotesIfString(values[i], strings[i]));\n      }\n    }\n  }\n  return results.join(\"\");\n}\n"]}
+{"version":3,"file":"odata.js","sourceRoot":"","sources":["../../src/odata.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,SAAS,sBAAsB,CAAC,KAAc;IAC5C,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;QAC1C,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,oBAAoB,CAAC,KAAc,EAAE,QAAgB;IAC5D,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;QACnC,0CAA0C;QAC1C,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;YACnC,MAAM,GAAG,IAAI,MAAM,GAAG,CAAC;QACzB,CAAC;IACH,CAAC;IAED,OAAO,MAAM,CAAC;AAChB,CAAC;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,KAAK,CAAC,OAA6B,EAAE,GAAG,MAAiB;IACvE,MAAM,OAAO,GAAG,EAAE,CAAC;IACnB,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACxC,OAAO,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC;QACzB,IAAI,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC;YACtB,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,MAAM,CAAC,CAAC,CAAC,KAAK,SAAS,EAAE,CAAC;gBAClD,OAAO,CAAC,IAAI,CAAC,sBAAsB,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAClD,CAAC;iBAAM,CAAC;gBACN,OAAO,CAAC,IAAI,CAAC,oBAAoB,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;YAC5D,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,OAAO,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;AAC1B,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT License.\n\nfunction formatNullAndUndefined(input: unknown): string | unknown {\n  if (input === null || input === undefined) {\n    return \"null\";\n  }\n\n  return input;\n}\n\nfunction escapeQuotesIfString(input: unknown, previous: string): string | unknown {\n  let result = input;\n\n  if (typeof input === \"string\") {\n    result = input.replace(/'/g, \"''\");\n    // check if we need to escape this literal\n    if (!previous.trim().endsWith(\"'\")) {\n      result = `'${result}'`;\n    }\n  }\n\n  return result;\n}\n\n/**\n * Escapes an odata filter expression to avoid errors with quoting string literals.\n * Example usage:\n * ```ts snippet:ReadmeSampleOdataUsage\n * import { odata } from \"@azure/search-documents\";\n *\n * const baseRateMax = 200;\n * const ratingMin = 4;\n * const filter = odata`Rooms/any(room: room/BaseRate lt ${baseRateMax}) and Rating ge ${ratingMin}`;\n * ```\n * For more information on supported syntax see: https://learn.microsoft.com/en-us/azure/search/search-query-odata-filter\n * @param strings - Array of strings for the expression\n * @param values - Array of values for the expression\n */\nexport function odata(strings: TemplateStringsArray, ...values: unknown[]): string {\n  const results = [];\n  for (let i = 0; i < strings.length; i++) {\n    results.push(strings[i]);\n    if (i < values.length) {\n      if (values[i] === null || values[i] === undefined) {\n        results.push(formatNullAndUndefined(values[i]));\n      } else {\n        results.push(escapeQuotesIfString(values[i], strings[i]));\n      }\n    }\n  }\n  return results.join(\"\");\n}\n"]}

package/dist/browser/searchClient.d.ts

@@ -61,26 +61,32 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * Creates an instance of SearchClient.
      *
      * Example usage:
-     * ```ts
-     * const { SearchClient, AzureKeyCredential } = require("@azure/search-documents");
+     * ```ts snippet:ReadmeSampleSearchClient
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
      *
-     * const client = new SearchClient(
+     * const searchClient = new SearchClient(
      *   "<endpoint>",
      *   "<indexName>",
-     *   new AzureKeyCredential("<Admin Key>")
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
      * Optionally, the type of the model can be used to enable strong typing and type hints:
-     * ```ts
+     * ```ts snippet:ReadmeSampleSearchClientWithModel
+     * import { SearchClient, AzureKeyCredential } from "@azure/search-documents";
+     *
      * type TModel = {
      *   keyName: string;
      *   field1?: string | null;
-     *   field2?: { anotherField?: string | null } | null;
+     *   field2?: {
+     *     anotherField?: string | null;
+     *   } | null;
      * };
      *
-     * const client = new SearchClient<TModel>(
-     *   ...
+     * const searchClient = new SearchClient<TModel>(
+     *   "<endpoint>",
+     *   "<indexName>",
+     *   new AzureKeyCredential("<apiKey>"),
      * );
      * ```
      *
@@ -107,31 +113,27 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
      * @param options - Options to the autocomplete operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleAutocomplete
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];
      *
-     * const autocompleteResult = await client.autocomplete(
-     *   "searchText",
-     *   "suggesterName",
-     *   { searchFields }
-     * );
+     * const autocompleteResult = await client.autocomplete("searchText", "suggesterName", {
+     *   searchFields,
+     * });
      * ```
      */
     autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>;
@@ -145,22 +147,20 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * @param searchText - Text to search
      * @param options - Options for the search operation.
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSearchTModel
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;
@@ -180,22 +180,20 @@ export declare class SearchClient<TModel extends object> implements IndexDocumen
      * @param suggesterName - The name of the suggester as specified in the suggesters collection that's part of the index definition.
      * @param options - Options for the suggest operation
      * @example
-     * ```ts
-     * import {
-     *   AzureKeyCredential,
-     *   SearchClient,
-     *   SearchFieldArray,
-     * } from "@azure/search-documents";
+     * ```ts snippet:ReadmeSampleSuggest
+     * import { SearchClient, AzureKeyCredential, SearchFieldArray } from "@azure/search-documents";
      *
      * type TModel = {
      *   key: string;
-     *   azure?: { sdk: string | null } | null;
+     *   azure?: {
+     *     sdk: string | null;
+     *   } | null;
      * };
      *
      * const client = new SearchClient<TModel>(
      *   "endpoint.azure",
      *   "indexName",
-     *   new AzureKeyCredential("key")
+     *   new AzureKeyCredential("key"),
      * );
      *
      * const select = ["azure/sdk"] as const;