Convenience Method to create a synonymmap object

sdk/search/search-documents/review/search-documents.api.md

@@ -288,6 +288,9 @@ export interface CreateOrUpdateSynonymMapOptions extends OperationOptions {
 // @public
 export type CreateSkillsetOptions = OperationOptions;
 
+// @public
+export function createSynonymMapFromFile(name: string, filePath: string): SynonymMap;
+
 // @public
 export type CreateSynonymMapOptions = OperationOptions;
 

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

@@ -301,3 +301,4 @@ export {
   SearchIndexerKnowledgeStoreTableProjectionSelector
 } from "./generated/service/models";
 export { AzureKeyCredential } from "@azure/core-auth";
+export { createSynonymMapFromFile } from "./serviceUtils";

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

@@ -77,6 +77,7 @@ import {
   SuggestDocumentsResult as GeneratedSuggestDocumentsResult,
   SearchResult as GeneratedSearchResult
 } from "./generated/data/models";
+import * as fs from "fs";
 
 export function convertSkillsToPublic(skills: SearchIndexerSkillUnion[]): SearchIndexerSkill[] {
   if (!skills) {
@@ -664,3 +665,18 @@ export function getRandomIntegerInclusive(min: number, max: number): number {
   const offset = Math.floor(Math.random() * (max - min + 1));
   return offset + min;
 }
+
+/**
+ * Helper method to create a SynonymMap object.
+ *
+ * @param name - Name of the SynonymMap.
+ * @param filePath - Path of the file that contains the Synonyms (seperated by new lines)
+ * @returns SynonymMap object
+ */
+export function createSynonymMapFromFile(name: string, filePath: string): SynonymMap {
+  const synonyms: string[] = fs.readFileSync(filePath, "utf-8").split("\n");
+  return {
+    name,
+    synonyms
+  };
+}