你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

models 包

参考

类

AnalyzeResult	针对文本测试分析器的结果。必须填充所有必需的参数才能发送到 Azure。
AnalyzeTextOptions	指定用于将文本拆分为标记的一些文本和分析组件。必须填充所有必需的参数才能发送到 Azure。
AnalyzedTokenInfo	有关分析器返回的令牌的信息。变量仅由服务器填充，在发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
AsciiFoldingTokenFilter	将“基本拉丁语”Unicode) 块 (的前 127 个 ASCII 字符中的字母、数字和符号 Unicode 字符转换为其 ASCII 等效项（如果存在此类等效项）。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
BM25SimilarityAlgorithm
CharFilter	字符筛选器的基类型。你可能想要直接使用子类，而不是此类。已知的子类包括：MappingCharFilter、PatternReplaceCharFilter 必须填充所有必需的参数才能发送到 Azure。
CjkBigramTokenFilter	形成从标准 tokenizer 生成的 CJK 术语的 bigram。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
ClassicSimilarityAlgorithm
ClassicTokenizer	适用于处理大多数欧洲语言文档的基于语法的 tokenizer。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
CognitiveServicesAccount	描述附加到技能组的任何 Azure AI 服务资源的基类型。你可能想要直接使用子类，而不是此类。已知子类为：CognitiveServicesAccountKey、DefaultCognitiveServicesAccount 必须填充所有必需的参数才能发送到 Azure。
CognitiveServicesAccountKey	使用附加到技能组的密钥预配的 Azure AI 服务资源。必须填充所有必需的参数才能发送到 Azure。
CommonGramTokenFilter	在编制索引时为经常出现的词条构造二元语法。此外，仍将为单个词条编制索引并叠加二元语法。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
ConditionalSkill	一种技能，使需要布尔运算来确定要分配给输出的数据的方案。必须填充所有必需的参数才能发送到 Azure。
CorsOptions	定义用于控制索引 (CORS) 跨域资源共享的选项。必须填充所有必需的参数才能发送到 Azure。
CustomAnalyzer	允许你控制将文本转换为可索引/可搜索令牌的过程。它是用户定义的配置，由单个预定义的 tokenizer 和一个或多个筛选器组成。 tokenizer 负责将文本分解为令牌，以及用于修改 tokenizer 发出的令牌的筛选器。必须填充所有必需的参数才能发送到 Azure。
CustomEntity	一个对象，其中包含有关找到的匹配项和相关元数据的信息。必须填充所有必需的参数才能发送到 Azure。
CustomEntityAlias	一个复杂对象，可用于指定根实体名称的替代拼写或同义词。必须填充所有必需的参数才能发送到 Azure。
CustomEntityLookupSkill	技能从用户定义的自定义字词和短语列表中查找文本。必须填充所有必需的参数才能发送到 Azure。
DataChangeDetectionPolicy	数据更改检测策略的基类型。你可能想要直接使用子类，而不是此类。已知子类为：HighWaterMarkChangeDetectionPolicy、SqlIntegratedChangeTrackingPolicy 必须填充所有必需的参数才能发送到 Azure。
DataDeletionDetectionPolicy	数据删除检测策略的基类型。你可能想要直接使用子类，而不是此类。已知子类为：SoftDeleteColumnDeletionDetectionPolicy 必须填充所有必需的参数才能发送到 Azure。
DefaultCognitiveServicesAccount	一个空对象，表示技能组的默认 Azure AI 服务资源。必须填充所有必需的参数才能发送到 Azure。
DictionaryDecompounderTokenFilter	分解在许多日耳曼语系中找到的复合词。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
DistanceScoringFunction	定义一个函数，该函数根据与地理位置的距离提高分数。必须填充所有必需的参数才能发送到 Azure。
DistanceScoringParameters	为距离评分函数提供参数值。必须填充所有必需的参数才能发送到 Azure。
DocumentExtractionSkill	一种技能，用于从扩充管道中的文件中提取内容。必须填充所有必需的参数才能发送到 Azure。
EdgeNGramTokenFilter	从输入令牌的正面或背面开始，生成给定大小 (s) 的 n 元。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
EdgeNGramTokenizer	将来自边缘的输入标记化为给定大小 (s) 的 n 克。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
ElisionTokenFilter	删除省音。例如，“l'avion” (平面) 将转换为“avion” (平面) 。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
EntityLinkingSkill	使用文本分析 API 从文本中提取链接实体。必须填充所有必需的参数才能发送到 Azure。
EntityRecognitionSkill	使用文本分析 API 从文本中提取不同类型的实体。必须填充所有必需的参数才能发送到 Azure。
ExhaustiveKnnAlgorithmConfiguration	包含特定于查询期间使用的详尽 KNN 算法的配置选项，该算法将在整个向量索引中执行暴力搜索。必须填充所有必需的参数才能发送到 Azure。
ExhaustiveKnnParameters	包含特定于详尽 KNN 算法的参数。
FieldMapping	定义数据源中的字段与索引中目标字段之间的映射。必须填充所有必需的参数才能发送到 Azure。
FieldMappingFunction	表示一个函数，该函数在编制索引之前转换数据源中的值。必须填充所有必需的参数才能发送到 Azure。
FreshnessScoringFunction	定义一个函数，该函数根据日期时间字段的值提高分数。必须填充所有必需的参数才能发送到 Azure。
FreshnessScoringParameters	为新鲜度评分函数提供参数值。必须填充所有必需的参数才能发送到 Azure。
GetIndexStatisticsResult	给定索引的统计信息。统计信息是定期收集的，不保证始终是最新的。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
HighWaterMarkChangeDetectionPolicy	定义一个数据更改检测策略，该策略根据高使用标记列的值捕获更改。必须填充所有必需的参数才能发送到 Azure。
HnswAlgorithmConfiguration	包含特定于索引编制和查询期间使用的 HNSW 近似近邻算法的配置选项。 HNSW 算法在搜索速度和准确性之间提供可调整的权衡。必须填充所有必需的参数才能发送到 Azure。
HnswParameters	包含特定于 HNSW 算法的参数。
ImageAnalysisSkill	分析图像文件的技能。它基于图像内容提取一组丰富的视觉特征。必须填充所有必需的参数才能发送到 Azure。
IndexerExecutionResult	表示单个索引器执行的结果。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
IndexingParameters	表示索引器执行的参数。
IndexingParametersConfiguration	索引器特定配置属性的字典。每个名称都是特定属性的名称。每个值必须是基元类型。
IndexingSchedule	表示索引器执行的计划。必须填充所有必需的参数才能发送到 Azure。
InputFieldMappingEntry	技能的输入字段映射。必须填充所有必需的参数才能发送到 Azure。
KeepTokenFilter	标记筛选器，仅保留包含指定单词列表中的文本的标记。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
KeyPhraseExtractionSkill	使用文本分析提取关键短语的技能。必须填充所有必需的参数才能发送到 Azure。
KeywordMarkerTokenFilter	将词条标记为关键字。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
KeywordTokenizer
LanguageDetectionSkill	一种技能，用于检测输入文本的语言，并为请求中提交的每个文档报告单个语言代码。语言代码与指示分析置信度分数配对。必须填充所有必需的参数才能发送到 Azure。
LengthTokenFilter	删除太长或太短的字词。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
LexicalAnalyzer	分析器的基类型。你可能想要使用子类，而不是直接使用此类。已知子类包括：CustomAnalyzer、PatternAnalyzer、LuceneStandardAnalyzer、StopAnalyzer 必须填充所有必需的参数才能发送到 Azure。
LexicalTokenizer	tokenizer 的基类型。你可能想要使用子类，而不是直接使用此类。已知子类包括：ClassicTokenizer、EdgeNGramTokenizer、KeywordTokenizer、KeywordTokenizerV2、MicrosoftLanguageStemmingTokenizer、MicrosoftLanguageTokenizer、NGramTokenizer、PathHierarchyTokenizerV2、PatternTokenizer、LuceneStandardTokenizer、LuceneStandardTokenizerV2、UaxUrlEmailTokenizer 必须填充所有必需的参数才能发送到 Azure。
LimitTokenFilter	编制索引时限制标记数量。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
LuceneStandardAnalyzer	标准 Apache Lucene 分析器;由标准 tokenizer、小写筛选器和停止筛选器组成。必须填充所有必需的参数才能发送到 Azure。
LuceneStandardTokenizer	按照 Unicode 文本分段规则划分文本。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
MagnitudeScoringFunction	定义一个函数，该函数根据数值字段的大小提升分数。必须填充所有必需的参数才能发送到 Azure。
MagnitudeScoringParameters	为数量级评分函数提供参数值。必须填充所有必需的参数才能发送到 Azure。
MappingCharFilter	一个字符筛选器，它应用使用映射选项定义的映射。匹配具有贪婪性（给定点的最长模式匹配获胜）。允许替换为空字符串。此字符筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
MergeSkill	一种技能，用于将两个或多个字符串合并为单个统一字符串，并使用可选的用户定义的分隔符分隔每个组件部分。必须填充所有必需的参数才能发送到 Azure。
MicrosoftLanguageStemmingTokenizer	使用特定于语言的规则划分文本，并将各字词缩减为其原形。必须填充所有必需的参数才能发送到 Azure。
MicrosoftLanguageTokenizer	使用特定于语言的规则划分文本。必须填充所有必需的参数才能发送到 Azure。
NGramTokenFilter	生成给定大小的 n 元语法。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
NGramTokenizer	将输入标记为给定大小的 n 元语法。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
OcrSkill	一种从图像文件中提取文本的技能。必须填充所有必需的参数才能发送到 Azure。
OutputFieldMappingEntry	技能的输出字段映射。必须填充所有必需的参数才能发送到 Azure。
PIIDetectionSkill	使用文本分析 API 从输入文本中提取个人信息，并提供屏蔽选项。必须填充所有必需的参数才能发送到 Azure。
PathHierarchyTokenizer
PatternAnalyzer	通过正则表达式灵活地将文本分隔为多个字词。此分析器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
PatternCaptureTokenFilter	使用 Java 正则表达式发出多个令牌 - 一个或多个模式中的每个捕获组一个令牌。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
PatternReplaceCharFilter	替换输入字符串中的字符的字符筛选器。它使用正则表达式来标识要保留的字符序列，并使用替换模式来标识要替换的字符。例如，给定输入文本“aa bb aa bb”、模式“ (aa) s+ (bb) ”和替换“$1#$2”，结果将是“aa#bb aa#bb”。此字符筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
PatternReplaceTokenFilter	替换输入字符串中的字符的字符筛选器。它使用正则表达式来标识要保留的字符序列，并使用替换模式来标识要替换的字符。例如，给定输入文本“aa bb aa bb”、模式“ (aa) s+ (bb) ”和替换“$1#$2”，结果将是“aa#bb aa#bb”。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
PatternTokenizer	使用正则表达式模式匹配来构造不同标记的 Tokenizer。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
PhoneticTokenFilter	为拼音匹配项创建标记。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
ScoringFunction	可在排名期间修改文档分数的函数的基类型。你可能想要使用子类，而不是直接使用此类。已知子类包括：DistanceScoringFunction、FreshnessScoringFunction、MagnitudeScoringFunction、TagScoringFunction 必须填充所有必需的参数才能发送到 Azure。
ScoringProfile	定义影响搜索查询中评分的搜索索引的参数。必须填充所有必需的参数才能发送到 Azure。
SearchField	表示索引定义中的字段，该字段描述字段的名称、数据类型和搜索行为。必须填充所有必需的参数才能发送到 Azure。
SearchIndex	表示搜索索引定义，该定义描述索引的字段和搜索行为。必须填充所有必需的参数才能发送到 Azure。
SearchIndexer	表示索引器。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerDataContainer	表示有关实体 (的信息，例如将编制索引的Azure SQL表或 CosmosDB 集合) 。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerDataSourceConnection	表示可用于配置索引器的数据源连接定义。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerError	表示项级别或文档级别索引错误。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerKnowledgeStore	定义扩充数据的 Azure Blob、表或文件的其他投影。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerKnowledgeStoreBlobProjectionSelector	用于在具体选择器之间共享属性的抽象类。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerKnowledgeStoreFileProjectionSelector	要存储在 Azure 文件存储中的数据的投影定义。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerKnowledgeStoreObjectProjectionSelector	要存储在 Azure Blob 中的数据的投影定义。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerKnowledgeStoreProjection	各种投影选择器的容器对象。
SearchIndexerKnowledgeStoreProjectionSelector	用于在具体选择器之间共享属性的抽象类。
SearchIndexerKnowledgeStoreTableProjectionSelector	说明要在 Azure 表中存储哪些数据。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerLimits	SearchIndexerLimits。变量仅由服务器填充，发送请求时将被忽略。
SearchIndexerSkill	技能的基类型。你可能想要使用子类，而不是直接使用此类。已知子类为：WebApiSkill、 CustomEntityLookupSkill、EntityRecognitionSkill、KeyPhraseExtractionSkill、LanguageDetectionSkill、MergeSkill、PIIDetectionSkill、SentimentSkill、SplitSkill、TextTranslationSkill、EntityLinkingSkill、EntityRecognitionSkillV3、SentimentSkillV3、ConditionalSkill、DocumentExtractionSkill、ShaperSkill、ImageAnalysisSkill、OcrSkill 必须填充所有必需的参数才能发送到 Azure。
SearchIndexerSkillset	技能列表。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerStatus	表示索引器的当前状态和执行历史记录。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
SearchIndexerWarning	表示项级警告。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
SearchResourceEncryptionKey	Azure 密钥保管库中客户管理的加密密钥。创建和管理的密钥可用于加密或解密Azure 认知搜索中的静态数据，例如索引和同义词映射。必须填充所有必需的参数才能发送到 Azure。
SearchSuggester
SemanticConfiguration	定义要在语义功能上下文中使用的特定配置。必须填充所有必需的参数才能发送到 Azure。
SemanticField	用作语义配置的一部分的字段。必须填充所有必需的参数才能发送到 Azure。
SemanticPrioritizedFields	描述用于语义排名、标题、突出显示和答案的标题、内容和关键字字段。
SemanticSearch	定义影响语义功能的搜索索引的参数。
SentimentSkill	V1：文本分析正负情绪分析，评分为 0 到 1 范围内的浮点值。 V3：使用文本分析 API 评估非结构化文本，并根据服务在句子和文档级别找到的最高置信度分数，提供情绪标签 (，例如“负面”、“中性”和“积极”) 。必须填充所有必需的参数才能发送到 Azure。
ShaperSkill	用于重塑输出的技能。它创建一个复杂类型以支持复合字段 (也称为多部分字段) 。必须填充所有必需的参数才能发送到 Azure。
ShingleTokenFilter	创建标记组合作为单个标记。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
SimilarityAlgorithm
SnowballTokenFilter	使用 Snowball 生成的词干分析器对单词进行词干的筛选器。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
SoftDeleteColumnDeletionDetectionPolicy	定义实现软删除策略的数据删除检测策略。它根据指定的“软删除”列的值确定是否应删除项。必须填充所有必需的参数才能发送到 Azure。
SplitSkill	将字符串拆分为文本块的技能。必须填充所有必需的参数才能发送到 Azure。
SqlIntegratedChangeTrackingPolicy	定义使用 Azure SQL 数据库的集成更改跟踪功能捕获更改的数据更改检测策略。必须填充所有必需的参数才能发送到 Azure。
StemmerOverrideTokenFilter	提供使用基于自定义字典的词干分解替代其他词干筛选的功能。任何字典词干术语都将标记为关键字，以便它们不会在链中通过词干分析器进行词干分解。必须放在任何词干分解筛选器之前。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
StemmerTokenFilter	特定于语言的词干筛选。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
StopAnalyzer	将文本除以非字母;应用小写和非字标记筛选器。此分析器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
StopwordsTokenFilter	从标记流中删除非索引字。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
SuggestOptions	参数组。
SynonymMap	表示同义词映射定义。变量仅由服务器填充，发送请求时将被忽略。必须填充所有必需的参数才能发送到 Azure。
SynonymTokenFilter	匹配令牌流中的单字或多字同义词。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
TagScoringFunction	定义一个函数，该函数使用与给定标记列表匹配的字符串值提升文档分数。必须填充所有必需的参数才能发送到 Azure。
TagScoringParameters	为标记评分函数提供参数值。必须填充所有必需的参数才能发送到 Azure。
TextTranslationSkill	将文本从一种语言翻译成另一种语言的技能。必须填充所有必需的参数才能发送到 Azure。
TextWeights	定义索引字段的权重，匹配项应提高搜索查询中的评分。必须填充所有必需的参数才能发送到 Azure。
TokenFilter	标记筛选器的基类型。你可能想要使用子类，而不是直接使用此类。已知子类包括：AsciiFoldingTokenFilter、CjkBigramTokenFilter、CommonGramTokenFilter、DictionaryDecompounderTokenFilter、EdgeNGramTokenFilter、EdgeNGramTokenFilterV2、ElisionTokenFilter、 KeepTokenFilter、KeywordMarkerTokenFilter、LengthTokenFilter、LimitTokenFilter、NGramTokenFilter、NGramTokenFilterV2、PatternCaptureTokenFilter、PatternReplaceTokenFilter、PhoneticTokenFilter、ShingleTokenFilter、SnowballTokenFilter、StemmerOverrideTokenFilter、StemmerTokenFilter、StopwordsTokenFilter、SynonymTokenFilter、TruncateTokenFilter、UniqueTokenFilter、WordDelimiterTokenFilter 必须填充所有必需的参数才能发送到 Azure。
TruncateTokenFilter	将字词截断为特定长度。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
UaxUrlEmailTokenizer	将 URL 和电子邮件标记为一个标记。此 tokenizer 是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
UniqueTokenFilter	筛选出与前一个标记具有相同文本的标记。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。
VectorSearch	包含与矢量搜索相关的配置选项。
VectorSearchAlgorithmConfiguration	包含特定于索引编制或查询期间使用的算法的配置选项。你可能想要使用子类，而不是直接使用此类。已知子类包括：ExhaustiveKnnAlgorithmConfiguration、HnswAlgorithmConfiguration 必须填充所有必需的参数才能发送到 Azure。
VectorSearchProfile	定义要用于矢量搜索的配置组合。必须填充所有必需的参数才能发送到 Azure。
WebApiSkill	一种可以调用 Web API 终结点的技能，使你能够通过调用自定义代码来扩展技能集。必须填充所有必需的参数才能发送到 Azure。
WordDelimiterTokenFilter	将字词拆分为子字，并对子字组执行可选转换。此令牌筛选器是使用 Apache Lucene 实现的。必须填充所有必需的参数才能发送到 Azure。

枚举

BlobIndexerDataToExtract	指定要从 Azure Blob 存储中提取的数据，并在将“imageAction”设置为“none”以外的值时，告知索引器从图像内容中提取哪些数据。这适用于 .PDF 或其他应用程序中的嵌入图像内容，或者 Azure blob 中的图像文件（例如 .jpg 和 .png）。
BlobIndexerImageAction	确定如何处理 Azure Blob 存储中的嵌入图像和图像文件。将“imageAction”配置设置为“none”以外的任何值都需要将技能组附加到该索引器。
BlobIndexerParsingMode	表示用于从 Azure Blob 数据源编制索引分析模式。
CharFilterName	定义搜索引擎支持的所有字符筛选器的名称。
CustomEntityLookupSkillLanguage	CustomEntityLookupSkill 支持的输入文本的语言代码。
EdgeNGramTokenFilterSide	指定应从中生成 n-gram 的输入的哪一端。
EntityCategory	一个字符串，指示要返回的实体类别。
EntityRecognitionSkillLanguage	EntityRecognitionSkill 支持的输入文本的语言代码。
EntityRecognitionSkillVersion	指定要使用的实体识别技能版本。
ImageAnalysisSkillLanguage	ImageAnalysisSkill 支持输入的语言代码。
ImageDetail	一个字符串，指示要返回哪些特定于域的详细信息。
IndexerExecutionStatus	表示单个索引器执行的状态。
IndexerStatus	表示总体的索引器状态。
KeyPhraseExtractionSkillLanguage	KeyPhraseExtractionSkill 支持的输入文本的语言代码。
LexicalAnalyzerName	定义搜索引擎支持的所有文本分析器的名称。
LexicalTokenizerName	定义搜索引擎支持的所有 tokenizer 的名称。
MicrosoftStemmingTokenizerLanguage	列出 Microsoft 语言词干分析 tokenizer 支持的语言。
MicrosoftTokenizerLanguage	列出 Microsoft 语言 tokenizer 支持的语言。
OcrSkillLanguage	OcrSkill 输入支持的语言代码。
PIIDetectionSkillMaskingMode	一个字符串，指示用于屏蔽输入文本中检测到的个人信息的 maskingMode。
PhoneticEncoder	标识要与 PhoneticTokenFilter 一起使用的拼音编码器的类型。
RegexFlags	定义可以组合在一起以控制模式分析器和模式标记器中使用正则表达式的方式的标志。
ScoringFunctionAggregation	定义用于合并评分配置文件中所有评分函数的结果的聚合函数。
ScoringFunctionInterpolation	定义用于跨一系列文档内插分数提升的函数。
SearchIndexerDataSourceType	定义数据源的类型。
SentimentSkillLanguage	SentimentSkill 支持的输入文本的语言代码。
SentimentSkillVersion	指定要使用的情绪技能版本。
SnowballTokenFilterLanguage	用于 Snowball 标记筛选器的语言。
SplitSkillLanguage	SplitSkill 支持的输入文本的语言代码。
StemmerTokenFilterLanguage	用于词干分析器标记筛选器的语言。
StopwordsList	标识特定于语言的非索引字的预定义列表。
TextSplitMode	一个值，该值指示要执行的拆分模式。
TextTranslationSkillLanguage	TextTranslationSkill 支持的输入文本的语言代码。
TokenCharacterKind	表示标记筛选器可以对其操作的字符类。
TokenFilterName	定义搜索引擎支持的所有令牌筛选器的名称。
VectorSearchAlgorithmKind	用于索引和查询的算法。
VectorSearchAlgorithmMetric	用于矢量比较的相似性指标。
VisualFeature	指示要返回的视觉特征类型的字符串。

函数

ComplexField

为 Azure 搜索索引配置复杂或复杂集合字段

ComplexField(**kw: Any) -> SearchField

仅限关键字的参数

名称	说明
name	str 必需。字段的名称，该名称在索引字段或父字段的 fields 集合中必须是唯一的。
collection	bool 此复杂字段是否为集合 (默认值 False)
fields	list[<xref:search_service_client.models.Field>] 子字段列表

SearchableField

为 Azure 搜索索引配置可搜索文本字段

SearchableField(**kw: Any) -> SearchField

仅限关键字的参数

名称	说明
name	str 必需。字段的名称，该名称在索引字段或父字段的 fields 集合中必须是唯一的。
collection	bool 此搜索字段是否为集合 (默认 False)
key	bool 一个值，该值指示字段是否唯一标识索引中的文档。必须选择每个索引中的一个顶级字段作为键字段，并且该字段的类型必须为 SearchFieldDataType.String。关键字段可用于直接查找文档以及更新或删除特定文档。默认值为 False
hidden	bool 一个值，该值指示是否可以在搜索结果中返回该字段。如果要使用字段 (例如边距) 作为筛选器、排序或评分机制，但不希望字段对最终用户可见，则可以启用此选项。对于键字段，此属性必须为 False。可以在现有字段上更改此属性。启用此属性不会导致索引存储要求的任何增加。默认值为 False。
searchable	bool 一个值，该值指示字段是否可全文搜索。这意味着它会在索引期间受到分词之类的分析。如果将某个可搜索字段设置为“sunny day”之类的值，在内部它将拆分为单独的标记“sunny”和“day”。这实现了对这些词的全文搜素。注意：可搜索字段会占用索引中的额外空间，因为Azure 认知搜索将存储字段值的其他标记化版本，以便进行全文搜索。如果要节省索引中的空间，并且不需要字段包含在搜索中，请将“可搜索”设置为 false。默认值为 True。
filterable	bool 一个值，该值指示是否启用在$filter查询中引用的字段。 filterable 与可搜索字符串的处理方式不同。可筛选的字段不会进行断字，因此比较仅用于精确匹配。例如，如果将此类字段 f 设置为“sunny day”，$filter=f eq 'sunny' 将找不到匹配项，但$filter=f eq 'sunny day' 将找到匹配项。默认值为 False。
sortable	bool 一个值，该值指示是否允许在$orderby表达式中引用字段。默认情况下，Azure 认知搜索按分数对结果进行排序，但在许多情况下，用户需要按文档中的字段进行排序。默认值为 False。
facetable	bool 一个值，该值指示是否允许在分面查询中引用字段。通常用于搜索结果的呈现，包括按类别 (的命中计数，例如，搜索数码相机并查看按品牌、按百万像素、按价格等) 命中数。默认值为 False。
analyzer_name	str 或 <xref:azure.search.documents.indexes.models.AnalyzerName> 要用于字段的分析器的名称。此选项不能与 searchAnalyzer 或 indexAnalyzer 一起设置。选择分析器后，无法为字段更改它。可能的值包括：“ar.microsoft”、“ar.lucene”、“hy.lucene”、 'bn.microsoft'， 'eu.lucene'， 'bg.microsoft'， 'bg.lucene'， 'ca.microsoft'， 'ca.lucene'， 'zh- Hans.microsoft'， 'zh-Hans.lucene'， 'zh-Hant.microsoft'， 'zh-Hant.lucene'， 'hr.microsoft'， 'cs.microsoft'， 'da.microsoft'， 'da.lucene'， 'nl.microsoft'， 'nl.lucene'， 'en.microsoft'， 'en.lucene'， 'et.microsoft'， 'fi.microsoft'， 'fi.lucene'， 'fr.microsoft'， 'fr.lucene'， 'gl.lucene'， 'de.microsoft'， 'de.lucene'，el.microsoft'， 'el.lucene'， 'gu.microsoft'， 'he.microsoft'， 'hi.microsoft'， 'hi.lucene'， 'hu.microsoft'， 'hu.lucene'， 'is.microsoft'， 'id.microsoft'， 'id.lucene'， 'ga.lucene'， 'it.microsoft'， 'it.lucene'， 'ja.lucene'， 'ko.microsoft'， 'ko.lucene'， 'lv.microsoft'， 'lv.lucene'， 'lt.microsoft'， 'ml.microsoft'， 'ms.microsoft'， 'mr.microsoft'， 'nb.microsoft'， 'no.lucene'， 'fa.lucene'， 'pl.microsoft'， 'pl.lucene'， 'pt-BR.microsoft'， 'pt-BR.lucene'， 'pt-PT.microsoft“、”pt-PT.lucene“、”pa.microsoft“、”ro.microsoft“、”ro.lucene“、”ru.microsoft“、”ru.lucene“、”sr-cyrillic.microsoft“、”sr-latin.microsoft“、”sk.microsoft“、”sl.microsoft“、”sl.microsoft“、”es.microsoft“、 'es.lucene'， 'sv.microsoft'， 'sv.lucene'， 'ta.microsoft'， 'te.microsoft'， 'th.microsoft'， 'th.lucene'， 'tr.microsoft'， 'tr.lucene'， 'uk.microsoft'， 'your.microsoft'， 'vi.microsoft'， 'standard.lucene'， 'standardasciifolding.lucene'， '关键字 (keyword) '， 'pattern'， 'simple'， 'stop'， 'whitespace'。
search_analyzer_name	str 或 <xref:azure.search.documents.indexes.models.AnalyzerName> 搜索时用于字段的分析器的名称。它必须与 indexAnalyzer 一起设置，并且不能与分析器选项一起设置。此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用分析器属性。此分析器无法在现有字段上更新。可能的值包括：“ar.microsoft”、“ar.lucene”、“hy.lucene”、 'bn.microsoft'， 'eu.lucene'， 'bg.microsoft'， 'bg.lucene'， 'ca.microsoft'， 'ca.lucene'， 'zh-Hans.microsoft'， 'zh-Hans.lucene'， 'zh- Hant.microsoft'， 'zh-Hant.lucene'， 'hr.microsoft'， 'cs.microsoft'， 'da.microsoft'， 'da.lucene'， 'nl.microsoft'， 'nl.lucene'， 'en.microsoft'， 'en.lucene'， 'et.microsoft'， 'fi.microsoft'， 'fi.lucene'， 'fr.microsoft'， 'fr.lucene'， 'gl.lucene'， 'de.microsoft'， 'de.lucene'，el.microsoft“、”el.lucene“、”gu.microsoft“、”he.microsoft“、”hi.microsoft“、”hi.lucene“、”hu.microsoft“、”hu.lucene“、”is.microsoft“、”id.microsoft“、”id.lucene“、”ga.lucene“、”it.microsoft“、”it.lucene“、”ja.lucene“、”ja.lucene“、”kn.microsoft“、 'ko.microsoft'， 'ko.lucene'， 'lv.microsoft'， 'lv.lucene'， 'lt.microsoft'， 'ml.microsoft'， 'ms.microsoft'， 'mr.microsoft'， 'nb.microsoft'， 'no.lucene'， 'fa.lucene'， 'pl.microsoft'， 'pl.lucene'， 'pt-BR.microsoft'， 'pt-BR.lucene'， 'pt-PT.microsoft“、”pt-PT.lucene“、”pa.microsoft“、”ro.microsoft“、”ro.lucene“、”ru.microsoft“、”ru.lucene“、”sr-cyrillic.microsoft“、”sr-latin.microsoft“、”sk.microsoft“、”sl.microsoft“、”es.microsoft“、 ”es.lucene“、”sv.microsoft“、”sv.lucene“、”ta.microsoft“、”te.microsoft“、”th.microsoft“、”th.lucene“、”tr.microsoft“、”tr.lucene“、”uk.microsoft“、”your.microsoft“、”vi.microsoft“、”standard.lucene“、”standardasciifolding.lucene“、”关键字 (keyword) '， 'pattern'， 'simple'， 'stop'， 'whitespace'。
index_analyzer_name	str 或 <xref:azure.search.documents.indexes.models.AnalyzerName> 在为字段编制索引时使用的分析器的名称。它必须与 searchAnalyzer 一起设置，并且不能与分析器选项一起设置。此属性不能设置为语言分析器的名称;如果需要语言分析器，请改用分析器属性。选择分析器后，无法为字段更改它。可能的值包括：“ar.microsoft”、“ar.lucene”、“hy.lucene”、 'bn.microsoft'， 'eu.lucene'， 'bg.microsoft'， 'bg.lucene'， 'ca.microsoft'， 'ca.lucene'， 'zh-Hans.microsoft'， 'zh-Hans.lucene'， 'zh-Hant.microsoft'， 'zh-Hant.lucene'， 'hr.microsoft'， 'cs.microsoft'， 'da.microsoft'， 'da.lucene'， 'nl.microsoft'， 'nl.lucene'， 'en.microsoft'， 'en.lucene'， 'et.microsoft'， 'fi.microsoft'， 'fi.lucene'， 'fr.microsoft'， 'fr.lucene'， 'gl.lucene'， 'de.microsoft'， 'de.lucene'，el.microsoft“、”el.lucene“、”gu.microsoft“、”he.microsoft“、”hi.microsoft“、”hi.lucene“、”hu.microsoft“、”hu.lucene“、”is.microsoft“、”id.microsoft“、”id.lucene“、”ga.lucene“、”it.microsoft“、”it.lucene“、”ja.lucene“、”ja.lucene“、”kn.microsoft“、 'ko.microsoft'， 'ko.lucene'， 'lv.microsoft'， 'lv.lucene'， 'lt.microsoft'， 'ml.microsoft'， 'ms.microsoft'， 'mr.microsoft'， 'nb.microsoft'， 'no.lucene'， 'fa.lucene'， 'pl.microsoft'， 'pl.lucene'， 'pt-BR.microsoft'， 'pt-BR.lucene'， 'pt-PT.microsoft“、”pt-PT.lucene“、”pa.microsoft“、”ro.microsoft“、”ro.lucene“、”ru.microsoft“、”ru.lucene“、”sr-cyrillic.microsoft“、”sr-latin.microsoft“、”sk.microsoft“、”sl.microsoft“、”es.microsoft“、 ”es.lucene“、”sv.microsoft“、”sv.lucene“、”ta.microsoft“、”te.microsoft“、”th.microsoft“、”th.lucene“、”tr.microsoft“、”tr.lucene“、”uk.microsoft“、”your.microsoft“、”vi.microsoft“、”standard.lucene“、”standardasciifolding.lucene“、”关键字 (keyword) '， 'pattern'， 'simple'， 'stop'， 'whitespace'。
synonym_map_names	list[str] 要与此字段关联的同义词名称列表。目前，每个字段仅支持一个同义词映射。为字段分配同义词映射可确保在查询时使用同义词映射中的规则扩展面向该字段的查询词。可以在现有字段上更改此属性。

SimpleField

为 Azure 搜索索引配置简单字段

SimpleField(**kw: Any) -> SearchField

仅限关键字的参数

名称	说明
name	str 必需。字段的名称，该名称在索引或父字段的 fields 集合中必须是唯一的。
type	必需。字段的数据类型。可能的值包括：Azure.search.documents.SearchFieldDataType.DateTimeOffset、SearchFieldDataType.GeographyPoint、SearchFieldDataType.Int64、SearchFieldDataType.Double、SearchFieldDataType.Boolean、SearchFieldDataType.DateTimeOffset、SearchFieldDataType.GeographyPoint、 SearchFieldDataType.ComplexType。 :p aramtype 类型：str
key	bool 一个值，该值指示字段是否唯一标识索引中的文档。必须选择每个索引中的一个顶级字段作为键字段，并且该字段的类型必须为 SearchFieldDataType.String。关键字段可用于直接查找文档以及更新或删除特定文档。默认值为 False
hidden	bool 一个值，该值指示字段是否可以在搜索结果中返回。如果要使用字段 (例如边距) 作为筛选器、排序或评分机制，但不希望字段对最终用户可见，则可以启用此选项。对于键字段，此属性必须为 False。可以在现有字段上更改此属性。启用此属性不会导致索引存储要求的任何增加。默认值为 False。
filterable	bool 一个值，该值指示是否允许在$filter查询中引用字段。 filterable 与可搜索字符串的处理方式不同。可筛选的 SearchFieldDataType.String 或集合 (SearchFieldDataType.String) 类型的字段不会进行断字，因此比较仅用于完全匹配。例如，如果将此类字段 f 设置为“sunny day”，$filter=f eq“sunny”将找不到匹配项，但$filter=f eq“sunny day”将找到匹配项。对于复杂字段，此属性必须为 null。默认值为 False
sortable	bool 一个值，该值指示是否启用要在$orderby表达式中引用的字段。默认情况下，Azure 认知搜索按分数对结果进行排序，但在许多情况下，用户需要按文档中的字段进行排序。仅当简单字段是单值字段， (它在父文档) 的范围内具有单个值时，才能对其进行排序。简单集合字段不可排序，因为它们是多值字段。复杂集合的简单子字段也是多值字段，因此无法排序。无论是直接父字段还是上级字段（即复杂集合），都是如此。默认值为 False。
facetable	bool 一个值，该值指示是否允许在分面查询中引用字段。通常用于搜索结果的演示文稿，包括按类别 (例如，搜索数码相机并查看按品牌、百万像素、按价格等) 命中次数。 SearchFieldDataType.GeographyPoint 或集合 (SearchFieldDataType.GeographyPoint) 的字段不可识别。默认值为 False。

通过

models 包

类

枚举

函数

ComplexField

仅限关键字的参数

SearchableField

仅限关键字的参数

SimpleField

仅限关键字的参数

其他资源