[Search] Unskip Tests & Update Tests Recordings (Azure#37213)

### Packages impacted by this PR
@azure/search-documents

### Describe the problem that is addressed by this PR
Update the test suite & recordings. Live pipeline is passing
[here](https://dev.azure.com/azure-sdk/internal/_build/results?buildId=5838855&view=results).
The changes include:
- Creating a separate folder for preview only feature. Any tests outside
this folder should be passing for both stable & preview version.
- Unskip all the tests that are common for both stable and preview
version. Add recordings for those tests.
- Remove usage of `models` property and AOAI client dependency. Update
`KnowledgeRetrievalClient.retrieveKnowledge` test to use `intents` with
`minimal` reasoning effort to remove `models` property

**Known Issues**:
- The only unskipped test suite is the `KnowledgeRetrievalClient` with
AOAI models. We don't have the resource to run this in the live
pipeline, but it can be unskipped to run locally before release.
- `models` is not a required property in the service for `KnowledgeBase`
and JS marks this as required. This is a known issue that will be fixed
for the next preview release. Currently using `as any` to get around
this.

### What are the possible designs available to address the problem? If
there are more than one possible design, why was the one in this PR
chosen?


### Are there test cases added in this PR? _(If not, why?)_


### Provide a list of related PRs _(if any)_


### Command used to generate this PR:**_(Applicable only to SDK release
request PRs)_

### Checklists
- [ ] Added impacted package name to the issue description
- [ ] Does this PR needs any fixes in the SDK Generator?** _(If so,
create an Issue in the
[Autorest/typescript](https://github.com/Azure/autorest.typescript)
repository and link it here)_
- [ ] Added a changelog (if necessary)

Author: minhanh-phan

sdk/search/search-documents/assets.json

@@ -2,5 +2,5 @@
   "AssetsRepo": "Azure/azure-sdk-assets",
   "AssetsRepoPrefixPath": "js",
   "TagPrefix": "js/search/search-documents",
-  "Tag": "js/search/search-documents_37ea47f7d6"
+  "Tag": "js/search/search-documents_4c94109848"
 }

…ic/node/knowledgeRetrievalClient.spec.ts …preview/knowledgeRetrievalClient.spec.tssdk/search/search-documents/test/public/node/knowledgeRetrievalClient.spec.ts renamed to sdk/search/search-documents/test/public/node/preview/knowledgeRetrievalClient.spec.ts sdk/search/search-documents/test/public/node/knowledgeRetrievalClient.spec.ts renamed to sdk/search/search-documents/test/public/node/preview/knowledgeRetrievalClient.spec.ts

@@ -2,34 +2,32 @@
 // Licensed under the MIT License.
 
 import { createTestCredential } from "@azure-tools/test-credential";
-import { Recorder } from "@azure-tools/test-recorder";
+import { env, Recorder } from "@azure-tools/test-recorder";
 import { delay } from "@azure/core-util";
-import type { OpenAIClient } from "@azure/openai";
-import { afterEach, assert, beforeEach, describe, it } from "vitest";
 import type {
-  AzureOpenAIParameters,
-  RemoteSharePointKnowledgeSource,
   SearchClient,
   SearchIndexClient,
   WebKnowledgeSource,
-} from "../../../src/index.js";
-import { KnowledgeRetrievalClient, KnownKnowledgeRetrievalOutputMode } from "../../../src/index.js";
-import { defaultServiceVersion } from "../../../src/serviceUtils.js";
-import type { Hotel } from "../utils/interfaces.js";
-import { createClients } from "../utils/recordedClient.js";
-import { createIndex, createRandomIndexName, populateIndex, WAIT_TIME } from "../utils/setup.js";
-
-// TODO: Remove skip and fix recording issues before enabling these tests in PRs
-// To run these tests locally in 'live' mode, remove the skip modifier
-describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
+  RemoteSharePointKnowledgeSource,
+} from "@azure/search-documents";
+import {
+  KnowledgeRetrievalClient,
+  KnownKnowledgeRetrievalOutputMode,
+} from "@azure/search-documents";
+import { defaultServiceVersion } from "../../../../src/serviceUtils.js";
+import { afterEach, assert, beforeEach, describe, it } from "vitest";
+import type { Hotel } from "../../utils/interfaces.js";
+import { createClients } from "../../utils/recordedClient.js";
+import { createRandomIndexName, createIndex, WAIT_TIME, populateIndex } from "../../utils/setup.js";
+
+describe("Knowledge", { timeout: 20_000 }, () => {
   let recorder: Recorder;
   let searchClient: SearchClient<Hotel>;
   let indexClient: SearchIndexClient;
-  let openAIClient: OpenAIClient;
   let TEST_INDEX_NAME: string;
   let TEST_BASE_NAME: string;
+  let TEST_KS_NAME: string;
   let knowledgeRetrievalClient: KnowledgeRetrievalClient;
-  let chatAzureOpenAIParameters: AzureOpenAIParameters;
 
   beforeEach(async (ctx) => {
     recorder = new Recorder(ctx);
@@ -38,22 +36,21 @@ describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
     ({
       searchClient,
       indexClient,
-      openAIClient,
       knowledgeRetrievalClient,
       indexName: TEST_INDEX_NAME,
       baseName: TEST_BASE_NAME,
-      chatAzureOpenAIParameters,
     } = await createClients<Hotel>(
       defaultServiceVersion,
       recorder,
       TEST_INDEX_NAME,
       TEST_BASE_NAME,
     ));
+    TEST_KS_NAME = `searchindex-ks-${TEST_INDEX_NAME}`;
     await createIndex(indexClient, TEST_INDEX_NAME, defaultServiceVersion);
 
     await indexClient.createKnowledgeSource({
       kind: "searchIndex",
-      name: "searchindex-ks",
+      name: TEST_KS_NAME,
       searchIndexParameters: {
         searchIndexName: TEST_INDEX_NAME,
         searchFields: [{ name: "hotelName" }, { name: "description" }],
@@ -63,22 +60,16 @@ describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
 
     await indexClient.createKnowledgeBase({
       name: TEST_BASE_NAME,
-      models: [
-        {
-          kind: "azureOpenAI",
-          azureOpenAIParameters: chatAzureOpenAIParameters,
-        },
-      ],
-      knowledgeSources: [{ name: "searchindex-ks" }],
-    });
+      knowledgeSources: [{ name: TEST_KS_NAME }],
+    } as any);
 
     await delay(WAIT_TIME);
-    await populateIndex(searchClient, openAIClient);
+    await populateIndex(searchClient);
   });
 
   afterEach(async () => {
     await indexClient.deleteKnowledgeBase(TEST_BASE_NAME);
-    await indexClient.deleteKnowledgeSource("searchindex-ks");
+    await indexClient.deleteKnowledgeSource(TEST_KS_NAME);
     await indexClient.deleteIndex(TEST_INDEX_NAME);
     await delay(WAIT_TIME);
     await recorder?.stop();
@@ -87,19 +78,29 @@ describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
   describe("KnowledgeRetrievalClient", () => {
     it("executes queries", { timeout: 60000 }, async () => {
       const result = await knowledgeRetrievalClient.retrieveKnowledge({
-        messages: [
+        intents: [
           {
-            role: "user",
-            content: [{ type: "text", text: "What is the most luxurious hotel?" }],
+            type: "semantic",
+            search: "What is the most luxurious hotel?",
           },
         ],
+        retrievalReasoningEffort: { kind: "minimal" },
       });
 
       assert.exists(result.activity);
       assert.exists(result.references);
       assert.exists(result.response);
       assert.isTrue(result.response.length > 0);
     });
+  });
+
+  // Unskip and test locally with valid AOAI resource. Cannot enable in the pipeline due to resource constraints.
+  describe.skip("KnowledgeRetrievalClient with models", () => {
+    const chatAzureOpenAIParameters = {
+      deploymentId: env.AZURE_OPENAI_CHAT_DEPLOYMENT_NAME,
+      resourceUrl: env.AZURE_OPENAI_ENDPOINT,
+      modelName: "gpt-4o",
+    };
 
     it("create webKnowledgeSource and query knowledge base", { timeout: 60000 }, async () => {
       const webKnowledgeSource: WebKnowledgeSource = {
@@ -149,10 +150,11 @@ describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
       await indexClient.deleteKnowledgeSource("web-ks");
     });
 
-    it("CRUD  remote sharepoint knowledge source", { timeout: 60000 }, async () => {
+    it("CRUD remote sharepoint knowledge source", { timeout: 60000 }, async () => {
+      const spKsName = `remotesharepoint-ks-${TEST_INDEX_NAME}`;
       const remoteSharePointKnowledgeSource: RemoteSharePointKnowledgeSource = {
         kind: "remoteSharePoint",
-        name: "remotesharepoint-ks",
+        name: spKsName,
         remoteSharePointParameters: {},
       };
 
@@ -169,13 +171,13 @@ describe.skip("KnowledgeRetrievalClient", { timeout: 20_000 }, () => {
             azureOpenAIParameters: chatAzureOpenAIParameters,
           },
         ],
-        knowledgeSources: [{ name: "remotesharepoint-ks" }],
+        knowledgeSources: [{ name: spKsName }],
         outputMode: KnownKnowledgeRetrievalOutputMode.AnswerSynthesis,
       });
 
       await delay(WAIT_TIME);
       await indexClient.deleteKnowledgeBase(`${TEST_BASE_NAME}-remotesharepoint`);
-      await indexClient.deleteKnowledgeSource("remotesharepoint-ks");
+      await indexClient.deleteKnowledgeSource(spKsName);
     });
   });
 });

sdk/search/search-documents/test/public/node/preview/searchClient.spec.ts

@@ -0,0 +1,182 @@
+// Copyright (c) Microsoft Corporation.
+// Licensed under the MIT License.
+
+import { Recorder } from "@azure-tools/test-recorder";
+import { createTestCredential } from "@azure-tools/test-credential";
+import { delay } from "@azure/core-util";
+import { afterEach, assert, beforeEach, describe, it } from "vitest";
+import type { SearchIndex, SearchIndexClient } from "../../../../src/index.js";
+import { KnownQueryLanguage, KnownQuerySpeller, SearchClient } from "../../../../src/index.js";
+import { defaultServiceVersion } from "../../../../src/serviceUtils.js";
+import type { Hotel } from "../../utils/interfaces.js";
+import { createClients } from "../../utils/recordedClient.js";
+import { createIndex, createRandomIndexName, populateIndex, WAIT_TIME } from "../../utils/setup.js";
+
+describe("search scenarios", { timeout: 20_000 }, () => {
+  let recorder: Recorder;
+  let searchClient: SearchClient<Hotel>;
+  let indexClient: SearchIndexClient;
+  let TEST_INDEX_NAME: string;
+  let TEST_BASE_NAME: string;
+  let indexDefinition: SearchIndex;
+
+  beforeEach(async (ctx) => {
+    recorder = new Recorder(ctx);
+    TEST_INDEX_NAME = createRandomIndexName();
+    TEST_BASE_NAME = createRandomIndexName();
+    ({
+      searchClient,
+      indexClient,
+      indexName: TEST_INDEX_NAME,
+      baseName: TEST_BASE_NAME,
+    } = await createClients<Hotel>(
+      defaultServiceVersion,
+      recorder,
+      TEST_INDEX_NAME,
+      TEST_BASE_NAME,
+    ));
+    indexDefinition = await createIndex(indexClient, TEST_INDEX_NAME, defaultServiceVersion);
+    await delay(WAIT_TIME);
+    await populateIndex(searchClient);
+  });
+
+  afterEach(async () => {
+    await indexClient.deleteIndex(TEST_INDEX_NAME);
+    await delay(WAIT_TIME);
+    await recorder?.stop();
+  });
+
+  const baseSemanticOptions = () =>
+    ({
+      queryLanguage: KnownQueryLanguage.EnUs,
+      queryType: "semantic",
+      semanticSearchOptions: {
+        configurationName:
+          indexDefinition.semanticSearch?.configurations?.[0].name ??
+          assert.fail("No semantic configuration in index."),
+      },
+    }) as const;
+
+  it("search with speller (preview)", async () => {
+    const searchResults = await searchClient.search("budjet", {
+      skip: 0,
+      top: 5,
+      includeTotalCount: true,
+      queryLanguage: KnownQueryLanguage.EnUs,
+      speller: KnownQuerySpeller.Lexicon,
+    });
+    assert.equal(searchResults.count, 6);
+  });
+
+  it("search with document debug info", async () => {
+    const baseOptions = baseSemanticOptions();
+    const options = {
+      ...baseOptions,
+      semanticSearchOptions: {
+        ...baseOptions.semanticSearchOptions,
+        errorMode: "fail",
+        debugMode: "semantic",
+      },
+    } as const;
+    const searchResults = await searchClient.search("luxury", options);
+    for await (const result of searchResults.results) {
+      assert.deepEqual(
+        {
+          contentFields: [
+            {
+              name: "description",
+              state: "used",
+            },
+          ],
+          keywordFields: [
+            {
+              name: "tags",
+              state: "used",
+            },
+          ],
+          rerankerInput: {
+            content:
+              "Best hotel in town if you like luxury hotels. They have an amazing infinity pool, a spa, and a really helpful concierge. The location is perfect -- right downtown, close to all the tourist attractions. We highly recommend this hotel.",
+            keywords: "pool\r\nview\r\nwifi\r\nconcierge",
+            title: "Fancy Stay",
+          },
+          titleField: {
+            name: "hotelName",
+            state: "used",
+          },
+        },
+        result.documentDebugInfo?.semantic,
+      );
+    }
+  });
+});
+
+describe("content security (preview)", { timeout: 20_000 }, () => {
+  let recorder: Recorder;
+  let indexClient: SearchIndexClient;
+  let index: SearchIndex;
+
+  beforeEach(async (ctx) => {
+    recorder = new Recorder(ctx);
+    ({ indexClient } = await createClients<Hotel>(defaultServiceVersion, recorder, "", ""));
+    index = {
+      name: "content-security-test",
+      purviewEnabled: true,
+      fields: [
+        {
+          type: "Edm.String",
+          name: "id",
+          key: true,
+        },
+        {
+          name: "sensitivityLabel",
+          type: "Edm.String",
+          filterable: false,
+          sortable: false,
+          facetable: true,
+          sensitivityLabel: true,
+        },
+      ],
+    };
+    await indexClient.createOrUpdateIndex(index);
+    await delay(WAIT_TIME);
+  });
+
+  afterEach(async () => {
+    await indexClient.deleteIndex(index.name);
+    await recorder?.stop();
+  });
+
+  it("verify content security indexes", async () => {
+    const documents = [
+      { id: "1", sensitivityLabel: "87867195-f2b8-4ac2-b0b6-6bb73cb33afc" },
+      { id: "2", sensitivityLabel: "9fbde396-1a24-4c79-8edf-9254a0f35055" },
+      { id: "3", sensitivityLabel: "1a19d03a-48bc-4359-8038-5b5f6d5847c3" },
+      { id: "4", sensitivityLabel: "1a19d03a-48bc-4359-0000-5b5f6d5847c4" },
+    ];
+
+    const searchClient = new SearchClient<{ id: string; sensitivityLabel: string }>(
+      indexClient.endpoint,
+      index.name,
+      createTestCredential(),
+      recorder.configureClientOptions({}),
+    );
+
+    await searchClient.uploadDocuments(documents);
+    await delay(WAIT_TIME);
+
+    // Test that search with invalid authorization token throws an error
+    let errorThrown = false;
+    try {
+      await searchClient.search("*", {
+        xMsQuerySourceAuthorization: "Invalid token",
+        xMsEnableElevatedRead: true,
+      });
+    } catch (ex: any) {
+      errorThrown = true;
+      // Verify it's an auth related error
+      assert.isTrue(ex.message.includes("Invalid header"));
+    }
+    assert.isTrue(errorThrown, "Expected search with invalid header to throw an error");
+  });
+});