Skip to content

Commit 308182d

Browse files
authored
[Search] Fix snippets for KnowledgeRetrievalClient (#36134)
1 parent ed8f865 commit 308182d

File tree

2 files changed

+10
-21
lines changed

2 files changed

+10
-21
lines changed

sdk/search/search-documents/src/knowledgeRetrievalClient.ts

Lines changed: 2 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -79,32 +79,13 @@ export class KnowledgeRetrievalClient {
7979
* ```ts snippet:ReadmeSampleKnowledgeRetrievalClient
8080
* import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents";
8181
*
82-
* const searchClient = new KnowledgeRetrievalClient(
82+
* const knowledgeRetrievalClient = new KnowledgeRetrievalClient(
8383
* "<endpoint>",
8484
* "<agentName>",
8585
* new AzureKeyCredential("<apiKey>"),
8686
* );
8787
* ```
88-
*
89-
* Optionally, the type of the model can be used to enable strong typing and type hints:
90-
* ```ts snippet:ReadmeSampleKnowledgeRetrievalClientWithModel
91-
* import { KnowledgeRetrievalClient, AzureKeyCredential } from "@azure/search-documents";
92-
*
93-
* type TModel = {
94-
* keyName: string;
95-
* field1?: string | null;
96-
* field2?: {
97-
* anotherField?: string | null;
98-
* } | null;
99-
* };
100-
*
101-
* const searchClient = new KnowledgeRetrievalClient<TModel>(
102-
* "<endpoint>",
103-
* "<agentName>",
104-
* new AzureKeyCredential("<apiKey>"),
105-
* );
106-
* ```
107-
*
88+
10889
* @param endpoint - The endpoint of the search service
10990
* @param agentName - The name of the knowledge agent
11091
* @param credential - Used to authenticate requests to the service.

sdk/search/search-documents/test/snippets.spec.ts

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import { setLogLevel } from "@azure/logger";
55
import { describe, it } from "vitest";
66
import {
77
AzureKeyCredential,
8+
KnowledgeRetrievalClient,
89
KnownSearchAudience,
910
odata,
1011
SearchClient,
@@ -373,6 +374,13 @@ describe("snippets", () => {
373374
it("ReadmeSampleSearchIndexerClient", async () => {
374375
const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
375376
});
377+
it("ReadmeSampleKnowledgeRetrievalClient", async () => {
378+
const knowledgeRetrievalClient = new KnowledgeRetrievalClient(
379+
"<endpoint>",
380+
"<agentName>",
381+
new AzureKeyCredential("<apiKey>"),
382+
);
383+
});
376384

377385
it("SetLogLevel", () => {
378386
setLogLevel("info");

0 commit comments

Comments
 (0)