@azure/search-documents 11.3.0-beta.4 → 11.3.0-beta.5

package/types/search-documents.d.ts

@@ -1265,45 +1265,6 @@ export declare interface IndexDocumentsResult {
     readonly results: IndexingResult[];
 }
 
-/** Represents all of the state that defines and dictates the indexer's current execution. */
-export declare interface IndexerCurrentState {
-    /**
-     * The mode the indexer is running in.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly mode?: IndexingMode;
-    /**
-     * Change tracking state used when indexing starts on all documents in the datasource.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly allDocsInitialChangeTrackingState?: string;
-    /**
-     * Change tracking state value when indexing finishes on all documents in the datasource.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly allDocsFinalChangeTrackingState?: string;
-    /**
-     * Change tracking state used when indexing starts on select, reset documents in the datasource.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly resetDocsInitialChangeTrackingState?: string;
-    /**
-     * Change tracking state value when indexing finishes on select, reset documents in the datasource.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly resetDocsFinalChangeTrackingState?: string;
-    /**
-     * The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly resetDocumentKeys?: string[];
-    /**
-     * The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
-     * NOTE: This property will not be serialized. It can only be populated by the server.
-     */
-    readonly resetDatasourceDocumentIds?: string[];
-}
-
 /**
  * Defines values for IndexerExecutionEnvironment. \
  * {@link KnownIndexerExecutionEnvironment} can be used interchangeably with IndexerExecutionEnvironment,
@@ -1330,7 +1291,7 @@ export declare interface IndexerExecutionResult {
      * All of the state that defines and dictates the indexer's current execution.
      * NOTE: This property will not be serialized. It can only be populated by the server.
      */
-    readonly currentState?: IndexerCurrentState;
+    readonly currentState?: IndexerState;
     /**
      * The error message indicating the top-level error, if any.
      * NOTE: This property will not be serialized. It can only be populated by the server.
@@ -1390,6 +1351,45 @@ export declare type IndexerExecutionStatus = "transientFailure" | "success" | "i
  */
 export declare type IndexerExecutionStatusDetail = string;
 
+/** Represents all of the state that defines and dictates the indexer's current execution. */
+export declare interface IndexerState {
+    /**
+     * The mode the indexer is running in.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly mode?: IndexingMode;
+    /**
+     * Change tracking state used when indexing starts on all documents in the datasource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly allDocumentsInitialChangeTrackingState?: string;
+    /**
+     * Change tracking state value when indexing finishes on all documents in the datasource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly allDocumentsFinalChangeTrackingState?: string;
+    /**
+     * Change tracking state used when indexing starts on select, reset documents in the datasource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resetDocumentsInitialChangeTrackingState?: string;
+    /**
+     * Change tracking state value when indexing finishes on select, reset documents in the datasource.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resetDocumentsFinalChangeTrackingState?: string;
+    /**
+     * The list of document keys that have been reset. The document key is the document's unique identifier for the data in the search index. The indexer will prioritize selectively re-ingesting these keys.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resetDocumentKeys?: string[];
+    /**
+     * The list of datasource document ids that have been reset. The datasource document id is the unique identifier for the data in the datasource. The indexer will prioritize selectively re-ingesting these ids.
+     * NOTE: This property will not be serialized. It can only be populated by the server.
+     */
+    readonly resetDatasourceDocumentIds?: string[];
+}
+
 /** Defines values for IndexerStatus. */
 export declare type IndexerStatus = "unknown" | "error" | "running";
 
@@ -2499,8 +2499,148 @@ export declare enum KnownQueryCaptionType {
 export declare enum KnownQueryLanguage {
     /** Query language not specified. */
     None = "none",
-    /** English */
-    EnUs = "en-us"
+    /** Query language value for English (United States). */
+    EnUs = "en-us",
+    /** Query language value for English (Great Britain). */
+    EnGb = "en-gb",
+    /** Query language value for English (India). */
+    EnIn = "en-in",
+    /** Query language value for English (Canada). */
+    EnCa = "en-ca",
+    /** Query language value for English (Australia). */
+    EnAu = "en-au",
+    /** Query language value for French (France). */
+    FrFr = "fr-fr",
+    /** Query language value for French (Canada). */
+    FrCa = "fr-ca",
+    /** Query language value for German (Germany). */
+    DeDe = "de-de",
+    /** Query language value for Spanish (Spain). */
+    EsEs = "es-es",
+    /** Query language value for Spanish (Mexico). */
+    EsMx = "es-mx",
+    /** Query language value for Chinese (China). */
+    ZhCn = "zh-cn",
+    /** Query language value for Chinese (Taiwan). */
+    ZhTw = "zh-tw",
+    /** Query language value for Portuguese (Brazil). */
+    PtBr = "pt-br",
+    /** Query language value for Portuguese (Portugal). */
+    PtPt = "pt-pt",
+    /** Query language value for Italian (Italy). */
+    ItIt = "it-it",
+    /** Query language value for Japanese (Japan). */
+    JaJp = "ja-jp",
+    /** Query language value for Korean (Korea). */
+    KoKr = "ko-kr",
+    /** Query language value for Russian (Russia). */
+    RuRu = "ru-ru",
+    /** Query language value for Czech (Czech Republic). */
+    CsCz = "cs-cz",
+    /** Query language value for Dutch (Belgium). */
+    NlBe = "nl-be",
+    /** Query language value for Dutch (Netherlands). */
+    NlNl = "nl-nl",
+    /** Query language value for Hungarian (Hungary). */
+    HuHu = "hu-hu",
+    /** Query language value for Polish (Poland). */
+    PlPl = "pl-pl",
+    /** Query language value for Swedish (Sweden). */
+    SvSe = "sv-se",
+    /** Query language value for Turkish (Turkey). */
+    TrTr = "tr-tr",
+    /** Query language value for Hindi (India). */
+    HiIn = "hi-in",
+    /** Query language value for Arabic (Saudi Arabia). */
+    ArSa = "ar-sa",
+    /** Query language value for Arabic (Egypt). */
+    ArEg = "ar-eg",
+    /** Query language value for Arabic (Morocco). */
+    ArMa = "ar-ma",
+    /** Query language value for Arabic (Kuwait). */
+    ArKw = "ar-kw",
+    /** Query language value for Arabic (Jordan). */
+    ArJo = "ar-jo",
+    /** Query language value for Danish (Denmark). */
+    DaDk = "da-dk",
+    /** Query language value for Norwegian (Normway). */
+    NoNo = "no-no",
+    /** Query language value for Bulgarian (Bulgary). */
+    BgBg = "bg-bg",
+    /** Query language value for Croatian (Croatia). */
+    HrHr = "hr-hr",
+    /** Query language value for Croatian (Bosnia and Herzegovina). */
+    HrBa = "hr-ba",
+    /** Query language value for Malay (Malaysia). */
+    MsMy = "ms-my",
+    /** Query language value for Malay (Brunei Darussalam). */
+    MsBn = "ms-bn",
+    /** Query language value for Slovenian (Slovenia). */
+    SlSl = "sl-sl",
+    /** Query language value for Tamil (India). */
+    TaIn = "ta-in",
+    /** Query language value for Vietnamese (Viet Nam). */
+    ViVn = "vi-vn",
+    /** Query language value for Greek (Greece). */
+    ElGr = "el-gr",
+    /** Query language value for Romanian (Romania). */
+    RoRo = "ro-ro",
+    /** Query language value for Icelandic (Iceland). */
+    IsIs = "is-is",
+    /** Query language value for Indonesian (Indonesia). */
+    IdId = "id-id",
+    /** Query language value for Thai (Thailand). */
+    ThTh = "th-th",
+    /** Query language value for Lithuanian (Lithuania). */
+    LtLt = "lt-lt",
+    /** Query language value for Ukrainian (Ukraine). */
+    UkUa = "uk-ua",
+    /** Query language value for Latvian (Latvia). */
+    LvLv = "lv-lv",
+    /** Query language value for Estonian (Estonia). */
+    EtEe = "et-ee",
+    /** Query language value for Catalan (Spain). */
+    CaEs = "ca-es",
+    /** Query language value for Finnish (Finland). */
+    FiFi = "fi-fi",
+    /** Query language value for Serbian (Bosnia and Herzegovina). */
+    SrBa = "sr-ba",
+    /** Query language value for Serbian (Montenegro). */
+    SrMe = "sr-me",
+    /** Query language value for Serbian (Serbia). */
+    SrRs = "sr-rs",
+    /** Query language value for Slovak (Slovakia). */
+    SkSk = "sk-sk",
+    /** Query language value for Norwegian (Norway). */
+    NbNo = "nb-no",
+    /** Query language value for Armenian (Armenia). */
+    HyAm = "hy-am",
+    /** Query language value for Bengali (India). */
+    BnIn = "bn-in",
+    /** Query language value for Basque (Spain). */
+    EuEs = "eu-es",
+    /** Query language value for Galician (Spain). */
+    GlEs = "gl-es",
+    /** Query language value for Gujarati (India). */
+    GuIn = "gu-in",
+    /** Query language value for Hebrew (Israel). */
+    HeIl = "he-il",
+    /** Query language value for Irish (Ireland). */
+    GaIe = "ga-ie",
+    /** Query language value for Kannada (India). */
+    KnIn = "kn-in",
+    /** Query language value for Malayalam (India). */
+    MlIn = "ml-in",
+    /** Query language value for Marathi (India). */
+    MrIn = "mr-in",
+    /** Query language value for Persian (U.A.E.). */
+    FaAe = "fa-ae",
+    /** Query language value for Punjabi (India). */
+    PaIn = "pa-in",
+    /** Query language value for Telugu (India). */
+    TeIn = "te-in",
+    /** Query language value for Urdu (Pakistan). */
+    UrPk = "ur-pk"
 }
 
 /** Known values of {@link QuerySpellerType} that the service accepts. */
@@ -3687,6 +3827,16 @@ export declare type PIIDetectionSkill = BaseSearchIndexerSkill & {
  */
 export declare type PIIDetectionSkillMaskingMode = string;
 
+/** Describes the title, content, and keywords fields to be used for semantic ranking, captions, highlights, and answers. */
+export declare interface PrioritizedFields {
+    /** Defines the title field to be used for semantic ranking, captions, highlights, and answers. If you don't have a title field in your index, leave this blank. */
+    titleField?: SemanticField;
+    /** Defines the content fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain text in natural language form. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
+    prioritizedContentFields?: SemanticField[];
+    /** Defines the keyword fields to be used for semantic ranking, captions, highlights, and answers. For the best result, the selected fields should contain a list of keywords. The order of the fields in the array represents their priority. Fields with lower priority may get truncated if the content is long. */
+    prioritizedKeywordsFields?: SemanticField[];
+}
+
 /**
  * Defines values for QueryAnswerType. \
  * {@link KnownQueryAnswerType} can be used interchangeably with QueryAnswerType,
@@ -3713,7 +3863,77 @@ export declare type QueryCaptionType = string;
  *  this enum contains the known values that the service supports.
  * ### Known values supported by the service
  * **none**: Query language not specified. \
- * **en-us**: English
+ * **en-us**: Query language value for English (United States). \
+ * **en-gb**: Query language value for English (Great Britain). \
+ * **en-in**: Query language value for English (India). \
+ * **en-ca**: Query language value for English (Canada). \
+ * **en-au**: Query language value for English (Australia). \
+ * **fr-fr**: Query language value for French (France). \
+ * **fr-ca**: Query language value for French (Canada). \
+ * **de-de**: Query language value for German (Germany). \
+ * **es-es**: Query language value for Spanish (Spain). \
+ * **es-mx**: Query language value for Spanish (Mexico). \
+ * **zh-cn**: Query language value for Chinese (China). \
+ * **zh-tw**: Query language value for Chinese (Taiwan). \
+ * **pt-br**: Query language value for Portuguese (Brazil). \
+ * **pt-pt**: Query language value for Portuguese (Portugal). \
+ * **it-it**: Query language value for Italian (Italy). \
+ * **ja-jp**: Query language value for Japanese (Japan). \
+ * **ko-kr**: Query language value for Korean (Korea). \
+ * **ru-ru**: Query language value for Russian (Russia). \
+ * **cs-cz**: Query language value for Czech (Czech Republic). \
+ * **nl-be**: Query language value for Dutch (Belgium). \
+ * **nl-nl**: Query language value for Dutch (Netherlands). \
+ * **hu-hu**: Query language value for Hungarian (Hungary). \
+ * **pl-pl**: Query language value for Polish (Poland). \
+ * **sv-se**: Query language value for Swedish (Sweden). \
+ * **tr-tr**: Query language value for Turkish (Turkey). \
+ * **hi-in**: Query language value for Hindi (India). \
+ * **ar-sa**: Query language value for Arabic (Saudi Arabia). \
+ * **ar-eg**: Query language value for Arabic (Egypt). \
+ * **ar-ma**: Query language value for Arabic (Morocco). \
+ * **ar-kw**: Query language value for Arabic (Kuwait). \
+ * **ar-jo**: Query language value for Arabic (Jordan). \
+ * **da-dk**: Query language value for Danish (Denmark). \
+ * **no-no**: Query language value for Norwegian (Normway). \
+ * **bg-bg**: Query language value for Bulgarian (Bulgary). \
+ * **hr-hr**: Query language value for Croatian (Croatia). \
+ * **hr-ba**: Query language value for Croatian (Bosnia and Herzegovina). \
+ * **ms-my**: Query language value for Malay (Malaysia). \
+ * **ms-bn**: Query language value for Malay (Brunei Darussalam). \
+ * **sl-sl**: Query language value for Slovenian (Slovenia). \
+ * **ta-in**: Query language value for Tamil (India). \
+ * **vi-vn**: Query language value for Vietnamese (Viet Nam). \
+ * **el-gr**: Query language value for Greek (Greece). \
+ * **ro-ro**: Query language value for Romanian (Romania). \
+ * **is-is**: Query language value for Icelandic (Iceland). \
+ * **id-id**: Query language value for Indonesian (Indonesia). \
+ * **th-th**: Query language value for Thai (Thailand). \
+ * **lt-lt**: Query language value for Lithuanian (Lithuania). \
+ * **uk-ua**: Query language value for Ukrainian (Ukraine). \
+ * **lv-lv**: Query language value for Latvian (Latvia). \
+ * **et-ee**: Query language value for Estonian (Estonia). \
+ * **ca-es**: Query language value for Catalan (Spain). \
+ * **fi-fi**: Query language value for Finnish (Finland). \
+ * **sr-ba**: Query language value for Serbian (Bosnia and Herzegovina). \
+ * **sr-me**: Query language value for Serbian (Montenegro). \
+ * **sr-rs**: Query language value for Serbian (Serbia). \
+ * **sk-sk**: Query language value for Slovak (Slovakia). \
+ * **nb-no**: Query language value for Norwegian (Norway). \
+ * **hy-am**: Query language value for Armenian (Armenia). \
+ * **bn-in**: Query language value for Bengali (India). \
+ * **eu-es**: Query language value for Basque (Spain). \
+ * **gl-es**: Query language value for Galician (Spain). \
+ * **gu-in**: Query language value for Gujarati (India). \
+ * **he-il**: Query language value for Hebrew (Israel). \
+ * **ga-ie**: Query language value for Irish (Ireland). \
+ * **kn-in**: Query language value for Kannada (India). \
+ * **ml-in**: Query language value for Malayalam (India). \
+ * **mr-in**: Query language value for Marathi (India). \
+ * **fa-ae**: Query language value for Persian (U.A.E.). \
+ * **pa-in**: Query language value for Punjabi (India). \
+ * **te-in**: Query language value for Telugu (India). \
+ * **ur-pk**: Query language value for Urdu (Pakistan).
  */
 export declare type QueryLanguage = string;
 
@@ -3749,7 +3969,7 @@ export declare type RegexFlags = string;
 /**
  * Options for reset docs operation.
  */
-export declare interface ResetDocsOptions extends OperationOptions {
+export declare interface ResetDocumentsOptions extends OperationOptions {
     /** document keys to be reset */
     documentKeys?: string[];
     /** datasource document identifiers to be reset */
@@ -3766,7 +3986,10 @@ export declare type ResetIndexerOptions = OperationOptions;
 /**
  * Options for reset skills operation.
  */
-export declare type ResetSkillsOptions = OperationOptions;
+export declare interface ResetSkillsOptions extends OperationOptions {
+    /** the names of skills to be reset. */
+    skillNames?: string[];
+}
 
 /** Represents a resource's usage and quota. */
 export declare interface ResourceCounter {
@@ -4103,6 +4326,10 @@ export declare interface SearchIndex {
      * be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.
      */
     similarity?: SimilarityAlgorithm;
+    /**
+     * Defines parameters for a search index that influence semantic capabilities.
+     */
+    semanticSettings?: SemanticSettings;
     /**
      * The ETag of the index.
      */
@@ -4490,14 +4717,14 @@ export declare class SearchIndexerClient {
      * @param indexerName - The name of the indexer to reset documents for.
      * @param options - Additional optional arguments.
      */
-    resetDocs(indexerName: string, options?: ResetDocsOptions): Promise<void>;
+    resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>;
     /**
      * Reset an existing skillset in a search service.
      * @param skillsetName - The name of the skillset to reset.
      * @param skillNames - The names of skills to reset.
      * @param options - The options parameters.
      */
-    resetSkills(skillsetName: string, skillNames: string[], options?: ResetSkillsOptions): Promise<void>;
+    resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>;
 }
 
 /**
@@ -5148,6 +5375,11 @@ export declare interface SearchRequest {
      * the results.
      */
     scoringProfile?: string;
+    /**
+     * The name of a semantic configuration that will be used when processing documents for queries of
+     * type semantic.
+     */
+    semanticConfiguration?: string;
     /**
      * A full-text search query expression; Use "*" or omit this parameter to match all documents.
      */
@@ -5435,6 +5667,25 @@ export declare interface SearchSuggester {
     sourceFields: string[];
 }
 
+/** Defines a specific configuration to be used in the context of semantic capabilities. */
+export declare interface SemanticConfiguration {
+    /** The name of the semantic configuration. */
+    name: string;
+    /** Describes the title, content, and keyword fields to be used for semantic ranking, captions, highlights, and answers. At least one of the three sub properties (titleField, prioritizedKeywordsFields and prioritizedContentFields) need to be set. */
+    prioritizedFields: PrioritizedFields;
+}
+
+/** A field that is used as part of the semantic configuration. */
+export declare interface SemanticField {
+    name?: string;
+}
+
+/** Defines parameters for a search index that influence semantic capabilities. */
+export declare interface SemanticSettings {
+    /** The semantic configurations for the index. */
+    configurations?: SemanticConfiguration[];
+}
+
 /** Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1. */
 export declare type SentimentSkill = BaseSearchIndexerSkill & {
     /** Polymorphic discriminator, which specifies the different types this object can be */