Semantic Search Code Changes (Azure#14857)

* Semantic Search Code Changes

* Fix Linter

* Fix Formatting

* Marked fields of AnswerResult as required

* Added Code Changes for Knowledge Store

* Code Changes for AnswerResult

Author: sarangan12

sdk/search/search-documents/recordings/node/searchclient/recording_search_with_semantic_ranking.js

@@ -36,6 +36,18 @@ export interface AnalyzeResult {
 // @public
 export type AnalyzeTextOptions = OperationOptions & AnalyzeRequest;
 
+// @public
+export interface AnswerResult {
+    [property: string]: any;
+    readonly highlights?: string | null;
+    readonly key: string;
+    readonly score: number;
+    readonly text: string;
+}
+
+// @public
+export type Answers = string;
+
 // @public
 export type AsciiFoldingTokenFilter = BaseTokenFilter & {
     odatatype: "#Microsoft.Azure.Search.AsciiFoldingTokenFilter";
@@ -163,6 +175,13 @@ export type BM25Similarity = Similarity & {
     b?: number | null;
 };
 
+// @public
+export interface CaptionResult {
+    [property: string]: any;
+    readonly highlights?: string | null;
+    readonly text?: string;
+}
+
 // @public
 export type CharFilter = MappingCharFilter | PatternReplaceCharFilter;
 
@@ -782,6 +801,12 @@ export enum KnownAnalyzerNames {
     ZhHantMicrosoft = "zh-Hant.microsoft"
 }
 
+// @public
+export const enum KnownAnswers {
+    Extractive = "extractive",
+    None = "none"
+}
+
 // @public
 export const enum KnownBlobIndexerDataToExtract {
     AllMetadata = "allMetadata",
@@ -1044,6 +1069,12 @@ export const enum KnownOcrSkillLanguage {
     ZhHant = "zh-Hant"
 }
 
+// @public
+export const enum KnownQueryLanguage {
+    EnUs = "en-us",
+    None = "none"
+}
+
 // @public
 export const enum KnownRegexFlags {
     CanonEq = "CANON_EQ",
@@ -1085,6 +1116,12 @@ export const enum KnownSentimentSkillLanguage {
     Tr = "tr"
 }
 
+// @public
+export const enum KnownSpeller {
+    Lexicon = "lexicon",
+    None = "none"
+}
+
 // @public
 export const enum KnownSplitSkillLanguage {
     Da = "da",
@@ -1494,6 +1531,9 @@ export type PhoneticTokenFilter = BaseTokenFilter & {
     replaceOriginalTokens?: boolean;
 };
 
+// @public
+export type QueryLanguage = string;
+
 // @public
 export type QueryType = "simple" | "full" | "semantic";
 
@@ -1569,6 +1609,7 @@ export interface SearchDocumentsResult<T> extends SearchDocumentsResultBase {
 
 // @public
 export interface SearchDocumentsResultBase {
+    readonly answers?: AnswerResult[] | null;
     readonly count?: number;
     readonly coverage?: number;
     readonly facets?: {
@@ -1709,6 +1750,44 @@ export interface SearchIndexerError {
     readonly statusCode: number;
 }
 
+// @public
+export interface SearchIndexerKnowledgeStore {
+    projections: SearchIndexerKnowledgeStoreProjection[];
+    storageConnectionString: string;
+}
+
+// @public
+export type SearchIndexerKnowledgeStoreBlobProjectionSelector = SearchIndexerKnowledgeStoreProjectionSelector & {
+    storageContainer: string;
+};
+
+// @public
+export type SearchIndexerKnowledgeStoreFileProjectionSelector = SearchIndexerKnowledgeStoreBlobProjectionSelector & {};
+
+// @public
+export type SearchIndexerKnowledgeStoreObjectProjectionSelector = SearchIndexerKnowledgeStoreBlobProjectionSelector & {};
+
+// @public
+export interface SearchIndexerKnowledgeStoreProjection {
+    files?: SearchIndexerKnowledgeStoreFileProjectionSelector[];
+    objects?: SearchIndexerKnowledgeStoreObjectProjectionSelector[];
+    tables?: SearchIndexerKnowledgeStoreTableProjectionSelector[];
+}
+
+// @public
+export interface SearchIndexerKnowledgeStoreProjectionSelector {
+    generatedKeyName?: string;
+    inputs?: InputFieldMappingEntry[];
+    referenceKeyName?: string;
+    source?: string;
+    sourceContext?: string;
+}
+
+// @public
+export type SearchIndexerKnowledgeStoreTableProjectionSelector = SearchIndexerKnowledgeStoreProjectionSelector & {
+    tableName: string;
+};
+
 // @public (undocumented)
 export interface SearchIndexerLimits {
     readonly maxDocumentContentCharactersToExtract?: number;
@@ -1725,6 +1804,7 @@ export interface SearchIndexerSkillset {
     description?: string;
     encryptionKey?: SearchResourceEncryptionKey | null;
     etag?: string;
+    knowledgeStore?: SearchIndexerKnowledgeStore;
     name: string;
     skills: SearchIndexerSkill[];
 }
@@ -1813,6 +1893,7 @@ export type SearchOptions<Fields> = OperationOptions & SearchRequestOptions<Fiel
 
 // @public
 export interface SearchRequest {
+    answers?: Answers;
     facets?: string[];
     filter?: string;
     highlightFields?: string;
@@ -1821,6 +1902,7 @@ export interface SearchRequest {
     includeTotalCount?: boolean;
     minimumCoverage?: number;
     orderBy?: string;
+    queryLanguage?: QueryLanguage;
     queryType?: QueryType;
     scoringParameters?: string[];
     scoringProfile?: string;
@@ -1831,11 +1913,13 @@ export interface SearchRequest {
     select?: string;
     sessionId?: string;
     skip?: number;
+    speller?: Speller;
     top?: number;
 }
 
 // @public
 export interface SearchRequestOptions<Fields> {
+    answers?: Answers;
     facets?: string[];
     filter?: string;
     highlightFields?: string;
@@ -1844,6 +1928,7 @@ export interface SearchRequestOptions<Fields> {
     includeTotalCount?: boolean;
     minimumCoverage?: number;
     orderBy?: string[];
+    queryLanguage?: QueryLanguage;
     queryType?: QueryType;
     scoringParameters?: string[];
     scoringProfile?: string;
@@ -1853,6 +1938,7 @@ export interface SearchRequestOptions<Fields> {
     select?: Fields[];
     sessionId?: string;
     skip?: number;
+    speller?: Speller;
     top?: number;
 }
 
@@ -1868,9 +1954,11 @@ export interface SearchResourceEncryptionKey {
 // @public
 export type SearchResult<T> = {
     readonly score: number;
+    readonly rerankerScore?: number;
     readonly highlights?: {
         [k in keyof T]?: string[];
     };
+    readonly captions?: CaptionResult[] | null;
     document: T;
 };
 
@@ -1902,7 +1990,7 @@ export interface ServiceCounters {
     documentCounter: ResourceCounter;
     indexCounter: ResourceCounter;
     indexerCounter: ResourceCounter;
-    skillsetCounter: ResourceCounter;
+    skillsetCounter?: ResourceCounter;
     storageSizeCounter: ResourceCounter;
     synonymMapCounter: ResourceCounter;
 }
@@ -1972,6 +2060,9 @@ export type SoftDeleteColumnDeletionDetectionPolicy = BaseDataDeletionDetectionP
     softDeleteMarkerValue?: string;
 };
 
+// @public
+export type Speller = string;
+
 // @public
 export type SplitSkill = BaseSearchIndexerSkill & {
     odatatype: "#Microsoft.Skills.Text.SplitSkill";

sdk/search/search-documents/recordings/node/searchclient/recording_search_with_speller.js

@@ -48,7 +48,7 @@ export interface SearchDocumentsResult {
    * The answers query results for the search operation; null if the answers query parameter was not specified or set to 'none'.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  readonly answers?: { [propertyName: string]: AnswerResult[] } | null;
+  readonly answers?: AnswerResult[] | null;
   /**
    * Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response.
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -85,17 +85,17 @@ export interface AnswerResult {
    * The score value represents how relevant the answer is to the the query relative to other answers returned for the query.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  readonly score?: number;
+  readonly score: number;
   /**
    * The key of the document the answer was extracted from.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  readonly key?: string;
+  readonly key: string;
   /**
    * The text passage extracted from the document contents as the answer.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  readonly text?: string;
+  readonly text: string;
   /**
    * Same text passage as in the Text property with highlighted text phrases most relevant to the query.
    * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -174,7 +174,7 @@ export interface SearchResult {
    * Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.
    * NOTE: This property will not be serialized. It can only be populated by the server.
    */
-  readonly captions?: { [propertyName: string]: CaptionResult[] } | null;
+  readonly captions?: CaptionResult[] | null;
 }
 
 /** Captions are the most representative passages from the document relatively to the search query. They are often used as document summary. Captions are only returned for queries of type 'semantic'.. */

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

@@ -82,13 +82,11 @@ export const SearchDocumentsResult: coreHttp.CompositeMapper = {
         readOnly: true,
         nullable: true,
         type: {
-          name: "Dictionary",
-          value: {
+          name: "Sequence",
+          element: {
             type: {
-              name: "Sequence",
-              element: {
-                type: { name: "Composite", className: "AnswerResult" }
-              }
+              name: "Composite",
+              className: "AnswerResult"
             }
           }
         }
@@ -150,20 +148,23 @@ export const AnswerResult: coreHttp.CompositeMapper = {
     modelProperties: {
       score: {
         serializedName: "score",
+        required: true,
         readOnly: true,
         type: {
           name: "Number"
         }
       },
       key: {
         serializedName: "key",
+        required: true,
         readOnly: true,
         type: {
           name: "String"
         }
       },
       text: {
         serializedName: "text",
+        required: true,
         readOnly: true,
         type: {
           name: "String"
@@ -372,13 +373,11 @@ export const SearchResult: coreHttp.CompositeMapper = {
         readOnly: true,
         nullable: true,
         type: {
-          name: "Dictionary",
-          value: {
+          name: "Sequence",
+          element: {
             type: {
-              name: "Sequence",
-              element: {
-                type: { name: "Composite", className: "CaptionResult" }
-              }
+              name: "Composite",
+              className: "CaptionResult"
             }
           }
         }