Skillsets - Create

服務:
Search Service
API 版本:
2025-08-01-preview

在搜尋服務中建立新的技能集。

POST {endpoint}/skillsets?api-version=2025-08-01-preview

URI 參數

名稱 位於 必要 類型 Description
endpoint
 path True

string

搜尋服務的端點 URL。
api-version
 query True

string

用戶端 API 版本。

要求標頭

名稱 必要 類型 Description
x-ms-client-request-id

string (uuid)

隨請求一起傳送的追蹤 ID，以協助偵錯。

要求本文

名稱 必要 類型 Description
name True

string

技能集的名稱。
skills True SearchIndexerSkill[]:

技能集中的技能清單。
@odata.etag

string

技能組的 ETag。
cognitiveServices CognitiveServicesAccount:

執行技能時要使用的 Azure AI 服務的詳細數據。
description

string

技能組的描述。
encryptionKey

SearchResourceEncryptionKey

您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完全保證沒有人 （甚至 Microsoft） 無法解密您的技能集定義時，此金鑰可用來為您的技能組定義提供額外的待用加密層級。 加密技能組定義之後，它一律會保持加密狀態。 搜尋服務會忽略嘗試將此屬性設定為 Null。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能組合定義將不受影響。 使用客戶管理的金鑰進行加密不適用於免費搜尋服務，且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections

SearchIndexerIndexProjections

對二級搜索索引的額外預測的定義。
knowledgeStore

SearchIndexerKnowledgeStore

定義擴充資料的 Azure Blob、資料表或檔案的其他投影。

回應

名稱 類型 Description
201 Created

SearchIndexerSkillset

技能組合已成功建立。
Other Status Codes

ErrorResponse

錯誤回應。

範例

SearchServiceCreateSkillset

範例要求

POST https://previewexampleservice.search.windows.net/skillsets?api-version=2025-08-01-preview


{
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint"
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "unit": "azureOpenAITokens",
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      },
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode"
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "outputFormat": "text",
      "outputMode": "oneToMany",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      },
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ]
    },
    {
      "apiKey": "<api-key>",
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "extraParametersBehavior": "error",
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}",
            "required": [
              "steps",
              "answer"
            ],
            "additionalProperties": false
          }
        }
      },
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message"
        },
        {
          "name": "userMessage",
          "source": "/document/user_message"
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*"
        },
        {
          "name": "imageDetail",
          "source": "/document/detail"
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ]
    }
  ],
  "cognitiveServices": {
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com",
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset"
  },
  "@odata.etag": "0x1234568AE7E58A1"
}

範例回覆

狀態碼:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "tempskillset",
  "description": "Skillset for extracting entities and more",
  "skills": [
    {
      "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill",
      "name": "skill2",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "countryHint",
          "source": "/document/countryHint",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "languageCode",
          "targetName": "languageCode"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SplitSkill",
      "name": "skill3",
      "textSplitMode": "pages",
      "maximumPageLength": 4000,
      "unit": "azureOpenAITokens",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "textItems",
          "targetName": "pages"
        }
      ],
      "azureOpenAITokenizerParameters": {
        "encoderModelName": "cl100k_base",
        "allowedSpecialTokens": [
          "[START]",
          "[END]"
        ]
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill",
      "name": "skill4",
      "context": "/document/pages/*",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "keyPhrases",
          "targetName": "keyPhrases"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill",
      "name": "skill5",
      "uri": "https://contoso.example.org/",
      "httpMethod": "POST",
      "timeout": "PT5S",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "languageCode",
          "source": "/document/languageCode",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "customresult",
          "targetName": "result"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill",
      "context": "/document",
      "outputMode": "oneToMany",
      "markdownHeaderDepth": "h3",
      "extractionOptions": [],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "markdown_document",
          "targetName": "markdown_document"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill",
      "name": "docIntelligenceLayoutSkill#2",
      "context": "/document",
      "outputMode": "oneToMany",
      "outputFormat": "text",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Custom.ChatCompletionSkill",
      "name": "chatCompletionSkill",
      "context": "/document/normalized_images/*",
      "uri": "https://azs-grok-aoai.openai.azure.com/openai/deployments/azs-grok-gpt-4o/chat/completions",
      "timeout": "PT30S",
      "degreeOfParallelism": 5,
      "apiKey": "<api-key>",
      "extraParametersBehavior": "error",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content",
          "inputs": []
        },
        {
          "name": "systemMessage",
          "source": "/document/system_message",
          "inputs": []
        },
        {
          "name": "userMessage",
          "source": "/document/user_message",
          "inputs": []
        },
        {
          "name": "image",
          "source": "/document/normalized_images/*",
          "inputs": []
        },
        {
          "name": "imageDetail",
          "source": "/document/detail",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "response",
          "targetName": "response"
        }
      ],
      "commonModelParameters": {
        "model": "gpt-4o",
        "frequencyPenalty": 0,
        "presencePenalty": 0,
        "maxTokens": 0,
        "temperature": 0,
        "seed": 0,
        "stop": []
      },
      "extraParameters": {
        "safe_mode": true
      },
      "responseFormat": {
        "type": "jsonSchema",
        "jsonSchemaProperties": {
          "name": "Some Name",
          "description": "Some Description",
          "strict": true,
          "schema": {
            "type": "object",
            "additionalProperties": false,
            "required": [
              "steps",
              "answer"
            ],
            "properties": "{\"steps\": {\"type\": \"array\", \"description\": \"A list of reasoning steps.\", \"items\": {\"type\": \"string\"}}, \"answer\": {\"type\": \"string\", \"description\": \"The final answer.\"}}"
          }
        }
      }
    }
  ],
  "cognitiveServices": {
    "@odata.type": "#Microsoft.Azure.Search.AIServicesByKey",
    "description": "Description of the Azure AI service resource attached to a skillset",
    "key": "myKey",
    "subdomainUrl": "https://mySubdomainName.cognitiveservices.azure.com"
  }
}

定義

名稱 Description
AIServicesAccountIdentity

附加至技能組之 Azure AI 服務資源的多區域帳戶。
AIServicesAccountKey

附加至技能組之 Azure AI 服務資源的帳戶金鑰，可與資源的子網域搭配使用。
AmlSkill

AML 技能可讓您使用自訂 Azure Machine Learning （AML） 模型來擴充 AI 擴充。 一旦 AML 模型經過訓練和部署，AML 技能就會將其整合到 AI 擴充中。
AzureActiveDirectoryApplicationCredentials

針對搜尋服務建立之已註冊應用程式認證，用於對儲存在 Azure 金鑰保存庫中的加密金鑰進行驗證存取。
AzureOpenAIEmbeddingSkill

可讓您使用 Azure OpenAI 資源為指定的文字輸入產生向量內嵌。
AzureOpenAIModelName

將呼叫的 Azure Open AI 模型名稱。
AzureOpenAITokenizerParameters
ChatCompletionCommonModelParameters

聊天完成的通用語言模型參數。 如果省略，則會使用預設值。
ChatCompletionExtraParametersBehavior

指定 Azure AI Foundry 應該如何處理 'extraParameters'。 預設為「錯誤」。
ChatCompletionResponseFormat

決定語言模型的回應應該如何序列化。 預設為「文字」。
ChatCompletionResponseFormatType

指定 LLM 應如何格式化回應。 可能的值：「text」（純字串）、「json_object」（任意JSON）或「json_schema」（遵循提供的結構描述）。
ChatCompletionSchema

定義模型將用來建構其輸出的自訂結構描述的物件。
ChatCompletionSkill

透過 Azure AI Foundry 的聊天完成端點呼叫語言模型的技能。
CognitiveServicesAccountKey

附加至技能組之 Azure AI 服務資源的多區域帳戶金鑰。
ConditionalSkill

一種技能，可讓需要布林運算的案例來決定要指派給輸出的資料。
CustomEntity

包含找到之相符項目的相關資訊，以及相關中繼資料的物件。
CustomEntityAlias

可用來指定根實體名稱的替代拼字或同義字的複雜物件。
CustomEntityLookupSkill

技能會從自訂的使用者定義的單字和片語清單中尋找文字。
CustomEntityLookupSkillLanguage

CustomEntityLookupSkill 支援輸入文字的語言代碼。
DefaultCognitiveServicesAccount

空白物件，代表技能組的預設 Azure AI 服務資源。
DocumentExtractionSkill

從擴充管線內的檔案擷取內容的技能。
DocumentIntelligenceLayoutSkill

透過 Azure AI 服務從擴充管線內的檔案擷取內容和版面配置資訊的技能。
DocumentIntelligenceLayoutSkillChunkingProperties

控制區塊化內容的基數。
DocumentIntelligenceLayoutSkillChunkingUnit

控制區塊單元的基數。 預設值為「字元」
DocumentIntelligenceLayoutSkillExtractionOptions

控制技能從文件擷取的內容基數。
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

Markdown 輸出中標頭的深度。 預設值為 h6。
DocumentIntelligenceLayoutSkillOutputFormat

控制輸出格式的基數。 預設值為「降價」。
DocumentIntelligenceLayoutSkillOutputMode

控制技能所產生輸出的基數。 預設值為 'oneToMany'。
EntityCategory

指出要傳回哪些實體類別的字串。
EntityLinkingSkill

使用文字分析 API，從文字擷取連結的實體。
EntityRecognitionSkill

此技能已被取代。 使用 V3。EntityRecognitionSkill 的技能。
EntityRecognitionSkillLanguage

Deprecated. EntityRecognitionSkill 支援輸入文字的語言代碼。
EntityRecognitionSkillV3

使用文字分析 API，從文字擷取不同類型的實體。
ErrorAdditionalInfo

資源管理錯誤其他資訊。
ErrorDetail

錯誤詳細數據。
ErrorResponse

錯誤回應
ImageAnalysisSkill

分析影像檔案的技能。 它根據圖像內容提取一組豐富的視覺特徵。
ImageAnalysisSkillLanguage

ImageAnalysisSkill 支援輸入的語言代碼。
ImageDetail

指出要傳回哪些網域特定詳細資料的字串。
IndexProjectionMode

定義索引投影相對於索引子其餘部分的行為。
InputFieldMappingEntry

技能的輸入欄位對應。
JsonSchemaProperties

擴充屬性的開放字典。 如果 'type' == 'json_schema' 則為必要項目
KeyPhraseExtractionSkill

使用文字分析進行關鍵片語擷取的技能。
KeyPhraseExtractionSkillLanguage

KeyPhraseExtractionSkill 支援輸入文字的語言代碼。
LanguageDetectionSkill

一種技能，可偵測輸入文字的語言，並為請求提交的每個文件報告單一語言代碼。 語言代碼與指示分析信賴度的分數配對。
LineEnding

定義要在 OCR 技能識別的文字行之間使用的字元順序。 預設值為「space」。
MergeSkill

將兩個或多個字串合併為單一統一字串的技能，並使用可選的使用者定義分隔符號來分隔每個元件部分。
OcrSkill

從圖像文件中提取文本的技能。
OcrSkillLanguage

OcrSkill 支援輸入的語言代碼。
OutputFieldMappingEntry

技能的輸出欄位對應。
PIIDetectionSkill

使用文字分析 API，從輸入文字擷取個人資訊，並為您提供遮罩它的選項。
PIIDetectionSkillMaskingMode

一個字串，指出要使用的 maskingMode 來遮罩輸入文字中偵測到的個人資訊。
SearchIndexerDataNoneIdentity

清除資料來源的身分識別屬性。
SearchIndexerDataUserAssignedIdentity

指定要使用的資料來源身分識別。
SearchIndexerIndexProjections

定義二級搜尋索引的其他投影。
SearchIndexerIndexProjectionSelector

要儲存在指定搜尋索引中的資料的說明。
SearchIndexerIndexProjectionsParameters

索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
SearchIndexerKnowledgeStore

定義擴充資料的 Azure Blob、資料表或檔案的其他投影。
SearchIndexerKnowledgeStoreFileProjectionSelector

要儲存在 Azure 檔案儲存體中的資料的投影定義。
SearchIndexerKnowledgeStoreObjectProjectionSelector

要儲存在 Azure Blob 中的資料的投影定義。
SearchIndexerKnowledgeStoreParameters

知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
SearchIndexerKnowledgeStoreProjection

各種投影選取器的容器物件。
SearchIndexerKnowledgeStoreTableProjectionSelector

要儲存在 Azure 資料表中的資料描述。
SearchIndexerSkillset

技能清單。
SearchResourceEncryptionKey

Azure Key Vault 中的客戶管理加密金鑰。 您建立和管理的金鑰可用來加密或解密靜態資料，例如索引和同義字對映。
SentimentSkill

此技能已被取代。 使用 V3。SentimentSkill 的
SentimentSkillLanguage

Deprecated. SentimentSkill 支援輸入文字的語言代碼。
SentimentSkillV3

使用文字分析 API，評估非結構化文字，並針對每筆記錄，根據服務在句子和文件層級找到的最高信賴分數，提供情緒標籤 （例如「負面」、「中性」和「正面」）。
ShaperSkill

重塑輸出的技能。 它會建立複雜類型來支援複合欄位 （也稱為多部分欄位）。
SplitSkill

將字串分割成文字區塊的技能。
SplitSkillEncoderModelName

只有在單位設定為 azureOpenAITokens 時才適用。 選項包括“R50k_base”、“P50k_base”、“P50k_edit”和“CL100k_base”。 預設值為 'CL100k_base'。
SplitSkillLanguage

SplitSkill 支援輸入文字的語言代碼。
SplitSkillUnit

指出要使用的單位的值。
TextSplitMode

指出要執行的分割模式的值。
TextTranslationSkill

將文本從一種語言翻譯成另一種語言的技能。
TextTranslationSkillLanguage

TextTranslationSkill 支援輸入文字的語言代碼。
VisionVectorizeSkill

可讓您使用 Azure AI 服務視覺向量化 API 為指定的影像或文字輸入產生向量內嵌。
VisualFeature

指出要傳回哪些視覺功能類型的字串。
WebApiSkill

可呼叫 Web API 端點的技能，可讓您藉由呼叫自訂程式碼來擴充技能集。

AIServicesAccountIdentity

Object

附加至技能組之 Azure AI 服務資源的多區域帳戶。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByIdentity

指定附加至技能組的 Azure AI 服務資源類型的 URI 片段。
description

string

附加至技能組的 Azure AI 服務資源描述。
identity SearchIndexerDataIdentity:

使用者指派的受控識別，用於連線至 AI 服務。 如果未指定，則會使用系統指派的受控識別。 在技能組更新時，如果身分識別未指定，則值會保持不變。 如果設定為 “none”，則會清除此屬性的值。
subdomainUrl

string

對應AI服務的子網域URL。

AIServicesAccountKey

Object

附加至技能組之 Azure AI 服務資源的帳戶金鑰，可與資源的子網域搭配使用。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByKey

指定附加至技能組的 Azure AI 服務資源類型的 URI 片段。
description

string

附加至技能組的 Azure AI 服務資源描述。
key

string

用來佈建附加至技能組的 Azure AI 服務資源的金鑰。
subdomainUrl

string

對應AI服務的子網域URL。

AmlSkill

Object

AML 技能可讓您使用自訂 Azure Machine Learning （AML） 模型來擴充 AI 擴充。 一旦 AML 模型經過訓練和部署，AML 技能就會將其整合到 AI 擴充中。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Custom.AmlSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
degreeOfParallelism

integer (int32)

（選用）指定時，表示索引子將與您提供的端點平行進行的呼叫數目。 如果您的端點在要求負載過高的情況下失敗，您可以降低此值，或者如果您的端點能夠接受更多要求，而且您想要提高索引子的效能，則可以提高此值。 如果未設定，則會使用預設值 5。 degreeOfParallelism 可以設定為最大值 10，最小值為 1。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
key

string

（密鑰認證所需）反洗錢服務的關鍵。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
region

string

（權杖驗證的選用項目）。 部署 AML 服務的區域。
resourceId

string

（權杖驗證所需）。 AML 服務的 Azure Resource Manager 資源識別碼。 其格式應該為 subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}。
timeout

string (duration)

（選用）指定時，指出進行 API 呼叫的 http 用戶端逾時。
uri

string (uri)

（無需身份驗證或密鑰身份驗證時需要）將傳送 JSON 承載之 AML 服務的評分 URI。 只允許 https URI 配置。

AzureActiveDirectoryApplicationCredentials

Object

針對搜尋服務建立之已註冊應用程式認證，用於對儲存在 Azure 金鑰保存庫中的加密金鑰進行驗證存取。

名稱 類型 Description
applicationId

string

已授與 Azure 金鑰保存庫所需存取權限的 AAD 應用程式識別碼，可在加密待用資料時使用。 應用程式識別碼不應與 AAD 應用程式的物件識別碼混淆。
applicationSecret

string

指定 AAD 應用程式的驗證金鑰。

AzureOpenAIEmbeddingSkill

Object

可讓您使用 Azure OpenAI 資源為指定的文字輸入產生向量內嵌。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

指定技能類型的 URI 片段。
apiKey

string

指定 Azure OpenAI 資源的 API 金鑰。
authIdentity SearchIndexerDataIdentity:

用於輸出連線的使用者指派受控識別。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
deploymentId

string

指定資源上 Azure OpenAI 模型部署的識別碼。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
dimensions

integer (int32)

產生的輸出內嵌應具有的維度數目。 僅在 text-embedding-3 和更新版本中支援。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
modelName

AzureOpenAIModelName

部署在提供的 deploymentId 路徑上的內嵌模型名稱。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
resourceUri

string (uri)

Azure OpenAI 資源的資源 URI。

AzureOpenAIModelName

列舉型別

將呼叫的 Azure Open AI 模型名稱。

值 Description
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAITokenizerParameters

Object
名稱 類型 Description
allowedSpecialTokens

string[]

（選用）只有在單位設定為 azureOpenAITokens 時才適用。 此參數定義記號化程序內允許的特殊記號集合。
encoderModelName

SplitSkillEncoderModelName

只有在單位設定為 azureOpenAITokens 時才適用。 選項包括“R50k_base”、“P50k_base”、“P50k_edit”和“CL100k_base”。 預設值為 'CL100k_base'。

ChatCompletionCommonModelParameters

Object

聊天完成的通用語言模型參數。 如果省略，則會使用預設值。

名稱 類型 預設值 Description
frequencyPenalty

number

0

[-2,2] 範圍內的浮點數，可減少或增加重複標記的可能性。 預設值為 0。
maxTokens

integer (int32)

要產生的權杖數目上限。
model

string

要使用的模型名稱（例如，'gpt-4o' 等）。 如果未指定，預設值為 Null。
presencePenalty

number

0

[-2,2] 範圍內的浮動量，根據新代幣的現有存在對其進行懲罰。 預設值為 0。
seed

integer (int32)

用於控制確定性輸出的隨機種子。 如果省略，則使用隨機化。
stop

string[]

將切斷文字產生的停止序列清單。 預設值為無。
temperature

number

0.7

取樣溫度。 預設值為 0.7。

ChatCompletionExtraParametersBehavior

列舉型別

指定 Azure AI Foundry 應該如何處理 'extraParameters'。 預設為「錯誤」。

值 Description
pass-through
drop

捨棄所有額外的參數。
error

如果存在任何額外的參數，則引發錯誤。

ChatCompletionResponseFormat

Object

決定語言模型的回應應該如何序列化。 預設為「文字」。

名稱 類型 預設值 Description
jsonSchemaProperties

JsonSchemaProperties

擴充屬性的開放字典。 如果 'type' == 'json_schema' 則為必要項目
type

ChatCompletionResponseFormatType

text

指定 LLM 應如何格式化回應。 可能的值：「text」（純字串）、「json_object」（任意JSON）或「json_schema」（遵循提供的結構描述）。

ChatCompletionResponseFormatType

列舉型別

指定 LLM 應如何格式化回應。 可能的值：「text」（純字串）、「json_object」（任意JSON）或「json_schema」（遵循提供的結構描述）。

值 Description
text
jsonObject
jsonSchema

ChatCompletionSchema

Object

定義模型將用來建構其輸出的自訂結構描述的物件。

名稱 類型 預設值 Description
additionalProperties

boolean

False

控制物件是否允許包含 JSON 結構描述中未定義的其他索引鍵/值。 預設值為 false。
properties

string

JSON 格式的字串，定義模型輸出結構描述的屬性和條件約束。
required

string[]

需要成為模型回應一部分的屬性名稱陣列。 結構化輸出必須包含所有屬性。
type

string

object

結構描述表示的類型。 通常是“對象”。 預設值為「物件」。

ChatCompletionSkill

Object

透過 Azure AI Foundry 的聊天完成端點呼叫語言模型的技能。

名稱 類型 預設值 Description
@odata.type string:

#Microsoft.Skills.Custom.ChatCompletionSkill

指定技能類型的 URI 片段。
apiKey

string

用於向模型進行驗證的 API 金鑰。 apiKey 和 authIdentity 無法同時指定。
authIdentity SearchIndexerDataIdentity:

用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引子更新時，如果未指定身分識別，則值會保持不變。 如果設定為 “none”，則會清除此屬性的值。
authResourceId

string

適用於連線到 Azure 函式中外部程式碼的自訂技能，或提供轉換的其他應用程式。 此值應該是向 Azure Active Directory 註冊時針對函式或應用程式建立的應用程式識別碼。 指定時，自訂技能會使用搜尋服務的受控識別碼 （系統或使用者指派） 和函式或應用程式的存取權杖連線到函式或應用程式，並使用此值作為建立存取權杖範圍的資源識別碼。
batchSize

integer (int32)

所需的批次大小，表示文件數目。
commonModelParameters

ChatCompletionCommonModelParameters

客戶可以調整的通用語言模型參數。 如果省略，將應用合理的違約。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
degreeOfParallelism

integer (int32)

如果設定，則可對 Web API 進行的平行呼叫數目。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
extraParameters

object

應附加至聊天完成呼叫的模型特定參數的開放型別字典。 遵循 Azure AI Foundry 的擴充性模式。
extraParametersBehavior

ChatCompletionExtraParametersBehavior

error

Azure AI Foundry 如何處理額外的參數。 預設值為「錯誤」。
httpHeaders

object

發出 http 要求所需的標頭。
httpMethod

string

http 要求的方法。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
responseFormat

ChatCompletionResponseFormat

決定 LLM 應如何格式化其回應。 預設為「文字」回應類型。
timeout

string (duration)

要求所需的逾時。 預設值為 30 秒。
uri

string

Web API 的 URL。

CognitiveServicesAccountKey

Object

附加至技能組之 Azure AI 服務資源的多區域帳戶金鑰。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.CognitiveServicesByKey

指定附加至技能組的 Azure AI 服務資源類型的 URI 片段。
description

string

附加至技能組的 Azure AI 服務資源描述。
key

string

用來佈建附加至技能組的 Azure AI 服務資源的金鑰。

ConditionalSkill

Object

一種技能，可讓需要布林運算的案例來決定要指派給輸出的資料。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.ConditionalSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

CustomEntity

Object

包含找到之相符項目的相關資訊，以及相關中繼資料的物件。

名稱 類型 Description
accentSensitive

boolean

預設為 False。 布林值，表示與實體名稱的比較是否應該對重音敏感。
aliases

CustomEntityAlias[]

複雜物件陣列，可用來指定根實體名稱的替代拼字或同義字。
caseSensitive

boolean

預設為 False。 布林值，表示與實體名稱的比較是否應該對字元大小寫敏感。 「Microsoft」 的不區分大小寫的比對範例可能是：microsoft、microSoft、MICROSOFT。
defaultAccentSensitive

boolean

變更此實體的預設重音敏感度值。 它用於更改所有別名的默認值 accentSensitive 值。
defaultCaseSensitive

boolean

變更此實體的預設區分大小寫值。 它用來變更所有別名 caseSensitive 值的預設值。
defaultFuzzyEditDistance

integer (int32)

變更此圖元的預設模糊編輯距離值。 它可用來變更所有別名 fuzzyEditDistance 值的預設值。
description

string

此欄位可用作有關匹配文本的自定義中繼資料的傳遞。 此欄位的值將與技能輸出中其實體的每次匹配一起顯示。
fuzzyEditDistance

integer (int32)

預設為 0。 最大值為 5。 表示仍會與實體名稱相符的可接受不同字元數目。 會傳回任何指定相符專案的最小可能模糊度。 例如，如果編輯距離設定為 3，則「Windows10」仍會符合「Windows」、「Windows10」和「Windows 7」。 當區分大小寫設定為 false 時，大小差異不會計入模糊容錯，但其他方面會計入。
id

string

此欄位可用作有關匹配文本的自定義中繼資料的傳遞。 此欄位的值將與技能輸出中其實體的每次匹配一起顯示。
name

string

最上層實體描述元。 技能輸出中的相符項目將依此名稱分組，並且它應該代表所找到的文字的「標準化」形式。
subtype

string

此欄位可用作有關匹配文本的自定義中繼資料的傳遞。 此欄位的值將與技能輸出中其實體的每次匹配一起顯示。
type

string

此欄位可用作有關匹配文本的自定義中繼資料的傳遞。 此欄位的值將與技能輸出中其實體的每次匹配一起顯示。

CustomEntityAlias

Object

可用來指定根實體名稱的替代拼字或同義字的複雜物件。

名稱 類型 Description
accentSensitive

boolean

判斷別名是否敏感於重音。
caseSensitive

boolean

判斷別名是否區分大小寫。
fuzzyEditDistance

integer (int32)

決定別名的模糊編輯距離。
text

string

別名的文字。

CustomEntityLookupSkill

Object

技能會從自訂的使用者定義的單字和片語清單中尋找文字。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.CustomEntityLookupSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

CustomEntityLookupSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
entitiesDefinitionUri

string

JSON 或 CSV 檔案的路徑，其中包含要比對的所有目標文字。 此實體定義會在索引子執行開始時讀取。 在索引子執行期間，此檔案的任何更新都不會在後續執行之前生效。 此設定必須可透過HTTPS存取。
globalDefaultAccentSensitive

boolean

AccentSensitive 的全球旗幟。 如果未在 CustomEntity 中設定 AccentSensitive，則此值會是預設值。
globalDefaultCaseSensitive

boolean

CaseSensitive 的全域旗標。 如果未在 CustomEntity 中設定 CaseSensity，則此值會是預設值。
globalDefaultFuzzyEditDistance

integer (int32)

FuzzyEditDistance 的全域旗標。 如果未在 CustomEntity 中設定 FuzzyEditDistance，則此值會是預設值。
inlineEntitiesDefinition

CustomEntity[]

內嵌 CustomEntity 定義。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

CustomEntityLookupSkillLanguage

列舉型別

CustomEntityLookupSkill 支援輸入文字的語言代碼。

值 Description
da

丹麥文
de

德語
en

English
es

西班牙文
fi

芬蘭文
fr

法語
it

義大利語
ko

朝鮮語
pt

Portuguese

DefaultCognitiveServicesAccount

Object

空白物件，代表技能組的預設 Azure AI 服務資源。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DefaultCognitiveServices

指定附加至技能組的 Azure AI 服務資源類型的 URI 片段。
description

string

附加至技能組的 Azure AI 服務資源描述。

DocumentExtractionSkill

Object

從擴充管線內的檔案擷取內容的技能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.DocumentExtractionSkill

指定技能類型的 URI 片段。
configuration

object

技能設定的字典。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
dataToExtract

string

要為技能擷取的資料類型。 如果未定義，將設定為 'contentAndMetadata'。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
parsingMode

string

技能的 parsingMode。 如果未定義，將設定為「預設」。

DocumentIntelligenceLayoutSkill

Object

透過 Azure AI 服務從擴充管線內的檔案擷取內容和版面配置資訊的技能。

名稱 類型 預設值 Description
@odata.type string:

#Microsoft.Skills.Util.DocumentIntelligenceLayoutSkill

指定技能類型的 URI 片段。
chunkingProperties

DocumentIntelligenceLayoutSkillChunkingProperties

控制區塊化內容的基數。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
extractionOptions

DocumentIntelligenceLayoutSkillExtractionOptions[]

控制技能從文件擷取的內容基數
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
markdownHeaderDepth

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

h6

Markdown 輸出中標頭的深度。 預設值為 h6。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputFormat

DocumentIntelligenceLayoutSkillOutputFormat

markdown

控制輸出格式的基數。 預設值為「降價」。
outputMode

DocumentIntelligenceLayoutSkillOutputMode

oneToMany

控制技能所產生輸出的基數。 預設值為 'oneToMany'。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

DocumentIntelligenceLayoutSkillChunkingProperties

Object

控制區塊化內容的基數。

名稱 類型 預設值 Description
maximumLength

integer (int32)

區塊長度上限（以字元為單位）。 預設值為 500。
overlapLength

integer (int32)

兩個文字區塊之間提供的重疊長度。 預設值為 0。
unit

DocumentIntelligenceLayoutSkillChunkingUnit

characters

區塊的單位。

DocumentIntelligenceLayoutSkillChunkingUnit

列舉型別

控制區塊單元的基數。 預設值為「字元」

值 Description
characters

依字元指定區塊。

DocumentIntelligenceLayoutSkillExtractionOptions

列舉型別

控制技能從文件擷取的內容基數。

值 Description
images

指定應從文件中擷取影像內容。
locationMetadata

指定應從文件中擷取位置中繼資料。

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

列舉型別

Markdown 輸出中標頭的深度。 預設值為 h6。

值 Description
h1

標頭層級 1。
h2

標頭層級 2。
h3

標頭層級 3。
h4

標頭層級 4。
h5

標頭等級 5。
h6

標頭層級 6。

DocumentIntelligenceLayoutSkillOutputFormat

列舉型別

控制輸出格式的基數。 預設值為「降價」。

值 Description
text

將輸出的格式指定為文字。
markdown

將輸出的格式指定為 markdown。

DocumentIntelligenceLayoutSkillOutputMode

列舉型別

控制技能所產生輸出的基數。 預設值為 'oneToMany'。

值 Description
oneToMany

指定輸出應該剖解析為 'oneToMany'。

EntityCategory

列舉型別

指出要傳回哪些實體類別的字串。

值 Description
location

描述實體位置的實體。
organization

描述組織的實體。
person

描述一個人的實體。
quantity

描述數量的實體。
datetime

描述日期和時間的實體。
url

描述 URL 的實體。
email

描述電子郵件地址的實體。

EntityLinkingSkill

Object

使用文字分析 API，從文字擷取連結的實體。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityLinkingSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

string

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
minimumPrecision

number (double)

minimum: 0
maximum: 1

介於 0 和 1 之間的值，用於僅包含信賴度分數大於指定值的實體。 如果未設定 （預設值），或明確設定為 null，則會包含所有實體。
modelVersion

string

呼叫文字分析服務時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

EntityRecognitionSkill

Object

此技能已被取代。 使用 V3。EntityRecognitionSkill 的技能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.EntityRecognitionSkill

指定技能類型的 URI 片段。
categories

EntityCategory[]

應擷取的實體類別清單。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

EntityRecognitionSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
includeTypelessEntities

boolean

決定是否包含已知但不符合預先定義類型的實體。 如果未設定此組態 （預設值）、設定為 null 或設定為 false，則不會顯示不符合其中一個預先定義類型的實體。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
minimumPrecision

number (double)

介於 0 和 1 之間的值，用於僅包含信賴度分數大於指定值的實體。 如果未設定 （預設值），或明確設定為 null，則會包含所有實體。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

EntityRecognitionSkillLanguage

列舉型別

Deprecated. EntityRecognitionSkill 支援輸入文字的語言代碼。

值 Description
ar

阿拉伯文
cs

捷克語
zh-Hans

Chinese-Simplified
zh-Hant

Chinese-Traditional
da

丹麥文
nl

荷蘭文
en

English
fi

芬蘭文
fr

法語
de

德語
el

希臘文
hu

匈牙利文
it

義大利語
ja

日語
ko

朝鮮語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

葡萄牙文 (葡萄牙)
pt-BR

葡萄牙文 (巴西)
ru

Russian
es

西班牙文
sv

瑞典文
tr

Turkish

EntityRecognitionSkillV3

Object

使用文字分析 API，從文字擷取不同類型的實體。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityRecognitionSkill

指定技能類型的 URI 片段。
categories

string[]

應擷取的實體類別清單。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

string

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
minimumPrecision

number (double)

minimum: 0
maximum: 1

介於 0 和 1 之間的值，用於僅包含信賴度分數大於指定值的實體。 如果未設定 （預設值），或明確設定為 null，則會包含所有實體。
modelVersion

string

呼叫文字分析 API 時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

ErrorAdditionalInfo

Object

資源管理錯誤其他資訊。

名稱 類型 Description
info

object

其他資訊。
type

string

其他信息類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤其他資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細資料。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

錯誤回應

名稱 類型 Description
error

ErrorDetail

error 物件。

ImageAnalysisSkill

Object

分析影像檔案的技能。 它根據圖像內容提取一組豐富的視覺特徵。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Vision.ImageAnalysisSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

ImageAnalysisSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
details

ImageDetail[]

指出要傳回哪些網域特定詳細資料的字串。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
visualFeatures

VisualFeature[]

視覺功能清單。

ImageAnalysisSkillLanguage

列舉型別

ImageAnalysisSkill 支援輸入的語言代碼。

值 Description
ar

阿拉伯文
az

亞塞拜然文
bg

保加利亞文
bs

波斯尼亞拉丁語
ca

加泰蘭文
cs

捷克語
cy

威爾斯文
da

丹麥文
de

德語
el

希臘文
en

English
es

西班牙文
et

愛沙尼亞文
eu

巴斯克文
fi

芬蘭文
fr

法語
ga

愛爾蘭文
gl

加利西亞文
he

希伯來文
hi

印地語
hr

克羅埃西亞文
hu

匈牙利文
id

Indonesian
it

義大利語
ja

日語
kk

哈薩克文
ko

朝鮮語
lt

立陶宛文
lv

拉脫維亞文
mk

馬其頓文
ms

馬來西亞馬來語
nb

挪威文 (巴克摩)
nl

荷蘭文
pl

波蘭語
prs

達利文
pt-BR

Portuguese-Brazil
pt

Portuguese-Portugal
pt-PT

Portuguese-Portugal
ro

羅馬尼亞文
ru

Russian
sk

斯洛伐克文
sl

斯洛維尼亞文
sr-Cyrl

塞爾維亞語 - 西里爾字母 RS
sr-Latn

塞爾維亞語 - 拉丁語 RS
sv

瑞典文
th

泰文
tr

Turkish
uk

烏克蘭文
vi

Vietnamese
zh

簡體中文
zh-Hans

簡體中文
zh-Hant

繁體中文

ImageDetail

列舉型別

指出要傳回哪些網域特定詳細資料的字串。

值 Description
celebrities

細節公認為名人。
landmarks

細節被認為是地標。

IndexProjectionMode

列舉型別

定義索引投影相對於索引子其餘部分的行為。

值 Description
skipIndexingParentDocuments

來源檔將會略過寫入索引子的目標索引。
includeIndexingParentDocuments

來源文件將會寫入索引子的目標索引。 這是預設模式。

InputFieldMappingEntry

Object

技能的輸入欄位對應。

名稱 類型 Description
inputs

InputFieldMappingEntry[]

建立複雜類型時使用的遞迴輸入。
name

string

輸入的名稱。
source

string

輸入的來源。
sourceContext

string

用於選取遞迴輸入的來源內容。

JsonSchemaProperties

Object

擴充屬性的開放字典。 如果 'type' == 'json_schema' 則為必要項目

名稱 類型 預設值 Description
description

string

模型將遵循的 json 結構描述。
name

string

模型將遵循的json結構描述名稱
schema

ChatCompletionSchema

定義模型將用來建構其輸出的自訂結構描述的物件。
strict

boolean

True

模型的回應是否應該使用結構化輸出。 預設值為 true

KeyPhraseExtractionSkill

Object

使用文字分析進行關鍵片語擷取的技能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.KeyPhraseExtractionSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

KeyPhraseExtractionSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
maxKeyPhraseCount

integer (int32)

一個數字，表示要傳回多少個關鍵詞組。 如果不存在，將傳回所有已識別的關鍵詞組。
modelVersion

string

呼叫文字分析服務時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

KeyPhraseExtractionSkillLanguage

列舉型別

KeyPhraseExtractionSkill 支援輸入文字的語言代碼。

值 Description
da

丹麥文
nl

荷蘭文
en

English
fi

芬蘭文
fr

法語
de

德語
it

義大利語
ja

日語
ko

朝鮮語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

葡萄牙文 (葡萄牙)
pt-BR

葡萄牙文 (巴西)
ru

Russian
es

西班牙文
sv

瑞典文

LanguageDetectionSkill

Object

一種技能，可偵測輸入文字的語言，並為請求提交的每個文件報告單一語言代碼。 語言代碼與指示分析信賴度的分數配對。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.LanguageDetectionSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultCountryHint

string

國家/地區代碼，如果語言偵測模型無法消除語言歧義，則可用作語言偵測模型的提示。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
modelVersion

string

呼叫文字分析服務時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

LineEnding

列舉型別

定義要在 OCR 技能識別的文字行之間使用的字元順序。 預設值為「space」。

值 Description
space

行以單一空格字元分隔。
carriageReturn

行會以回車 （'\r'） 字元分隔。
lineFeed

行由單一換行 （'\n'） 字元分隔。
carriageReturnLineFeed

行會以回車符和換行 （'\r\n'） 字元分隔。

MergeSkill

Object

將兩個或多個字串合併為單一統一字串的技能，並使用可選的使用者定義分隔符號來分隔每個元件部分。

名稱 類型 預設值 Description
@odata.type string:

#Microsoft.Skills.Text.MergeSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
insertPostTag

string

標籤表示合併文字的結尾。 依預設，標籤是空白空間。
insertPreTag

string

標籤表示合併文字的開頭。 依預設，標籤是空白空間。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

OcrSkill

Object

從圖像文件中提取文本的技能。

名稱 類型 預設值 Description
@odata.type string:

#Microsoft.Skills.Vision.OcrSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

OcrSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
detectOrientation

boolean

False

指示開啟或不開啟方向偵測的值。 預設值為 false。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
lineEnding

LineEnding

定義要在 OCR 技能識別的文字行之間使用的字元順序。 預設值為「space」。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

OcrSkillLanguage

列舉型別

OcrSkill 支援輸入的語言代碼。

值 Description
af

南非荷蘭文
sq

阿爾巴尼亞文
anp

安吉卡（梵城）
ar

阿拉伯文
ast

阿斯圖里亞斯
awa

Awadhi-Hindi（梵文）
az

亞塞拜然語（拉丁語）
bfy

巴格利
eu

巴斯克文
be

白俄羅斯語（西里爾文和拉丁文）
be-cyrl

白俄羅斯語（西里爾文）
be-latn

白俄羅斯語（拉丁語）
bho

Bhojpuri-Hindi（梵文）
bi

比斯拉馬
brx

博多（梵城）
bs

波斯尼亞拉丁語
bra

布拉吉巴
br

布列塔尼
bg

保加利亞文
bns

本德利
bua

布里亞特（西里爾文）
ca

加泰蘭文
ceb

宿霧語
rab

查姆林
ch

查莫羅
hne

恰蒂斯加爾語（梵城）
zh-Hans

簡體中文
zh-Hant

繁體中文
kw

康沃爾
co

科西嘉島
crh

克里米亞韃靼語（拉丁語）
hr

克羅埃西亞文
cs

捷克語
da

丹麥文
prs

達利文
dhi

迪馬爾（梵城）
doi

多格里語（梵城）
nl

荷蘭文
en

English
myv

Erzya（西里爾文）
et

愛沙尼亞文
fo

法羅群島
fj

斐濟文
fil

菲律賓文
fi

芬蘭文
fr

法語
fur

弗魯連
gag

加告茲語（拉丁文）
gl

加利西亞文
de

德語
gil

吉爾伯特語
gon

貢迪（梵城）
el

希臘文
kl

格陵蘭語
gvr

古隆（梵文）
ht

海地克里奧爾文
hlb

哈爾比（梵文）
hni

哈尼
bgc

哈里揚維語
haw

夏威夷人
hi

印地語
mww

苗族道（拉丁語）
hoc

Ho（梵文）
hu

匈牙利文
is

Icelandic
smn

稻荷薩米
id

Indonesian
ia

國際語言
iu

伊努克提圖語（拉丁字母）
ga

愛爾蘭文
it

義大利語
ja

日語
Jns

Jaunsari（梵城）
jv

爪哇文
kea

卡布維迪亞努
kac

克欽語（拉丁語）
xnr

Kangri（梵木）
krc

Karachay-Balkar
kaa-cyrl

Kara-Kalpak （西里爾文）
kaa

Kara-Kalpak （拉丁文）
csb

卡舒比安
kk-cyrl

哈薩克語（西里爾文）
kk-latn

哈薩克語（拉丁文）
klr

卡林
kha

卡西
quc

K'iche'
ko

朝鮮語
kfq

科爾庫
kpy

科里亞克
kos

科斯雷安
kum

庫梅克語（西里爾文）
ku-arab

庫爾德語（阿拉伯語）
ku-latn

庫爾德語（拉丁語）
kru

庫魯克（梵文）
ky

吉爾吉斯語（西里爾字母）
lkt

拉科塔
la

拉丁文
lt

立陶宛文
dsb

下索布語
smj

盧勒薩米
lb

盧森堡文
bfz

Mahasu Pahari（梵城）
ms

馬來語（拉丁語）
mt

馬爾他文
kmj

馬爾托（梵城）
gv

馬恩島
mi

毛利文
mr

馬拉地文
mn

蒙古文 (斯拉夫)
cnr-cyrl

黑山（西里爾字母）
cnr-latn

黑山語（拉丁語）
nap

那不勒斯
ne

尼泊爾文
niu

紐埃
nog

諾蓋伊
sme

北薩米語（拉丁語）
nb

挪威文
no

挪威文
oc

奧克西唐語
os

奧塞蒂克
ps

普什圖文
fa

波斯文
pl

波蘭語
pt

Portuguese
pa

旁遮普語（阿拉伯語）
ksh

里普亞里安
ro

羅馬尼亞文
rm

羅曼什語
ru

Russian
sck

薩德里（梵文）
sm

薩摩亞語（拉丁語）
sa

梵文（梵文）
sat

桑塔利（梵城）
sco

蘇格蘭人
gd

蘇格蘭蓋爾文
sr

塞爾維亞文 (拉丁)
sr-Cyrl

塞爾維亞文 (斯拉夫)
sr-Latn

塞爾維亞文 (拉丁)
xsr

夏爾巴人（梵城）
srx

西爾毛里（梵木）
sms

斯科爾特薩米人
sk

斯洛伐克文
sl

斯洛維尼亞文
so

索馬里語（阿拉伯語）
sma

南薩米語
es

西班牙文
sw

斯瓦希里語（拉丁語）
sv

瑞典文
tg

塔吉克文 (斯拉夫)
tt

韃靼語（拉丁語）
tet

德頓
thf

唐米
to

東加文
tr

Turkish
tk

土庫曼語（拉丁語）
tyv

圖瓦語
hsb

上索布文
ur

烏都文
ug

維吾爾語（阿拉伯語）
uz-arab

烏茲別克語（阿拉伯語）
uz-cyrl

烏茲別克語（西里爾文）
uz

烏茲別克文 (拉丁)
vo

沃拉普克
wae

瓦爾瑟
cy

威爾斯文
fy

西弗里斯蘭語
yua

猶加敦馬雅文
za

莊
zu

祖魯語
unk

未知（全部）

OutputFieldMappingEntry

Object

技能的輸出欄位對應。

名稱 類型 Description
name

string

技能所定義的輸出名稱。
targetName

string

輸出的目標名稱。 它是選用的，預設為名稱。

PIIDetectionSkill

Object

使用文字分析 API，從輸入文字擷取個人資訊，並為您提供遮罩它的選項。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.PIIDetectionSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

string

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
domain

string

如果指定，則會將 PII 網域設定為僅包含實體類別的子集。 可能的值包括：「phi」、「none」。 預設值為「無」。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
maskingCharacter

string

maxLength: 1

如果 maskingMode 參數設定為取代，則用來遮罩文字的字元。 預設值為 '*'。
maskingMode

PIIDetectionSkillMaskingMode

提供各種方式來遮罩輸入文字中偵測到的個人資訊的參數。 預設值為「無」。
minimumPrecision

number (double)

minimum: 0
maximum: 1

介於 0 和 1 之間的值，用於僅包含信賴度分數大於指定值的實體。 如果未設定 （預設值），或明確設定為 null，則會包含所有實體。
modelVersion

string

呼叫文字分析服務時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
piiCategories

string[]

應擷取和遮罩的 PII 實體類別清單。

PIIDetectionSkillMaskingMode

列舉型別

一個字串，指出要使用的 maskingMode 來遮罩輸入文字中偵測到的個人資訊。

值 Description
none

不會發生遮罩，且不會傳回 maskedText 輸出。
replace

將偵測到的實體取代為 maskingCharacter 參數中指定的字元。 字元將重複到偵測到的實體的長度，以便位移量將正確對應於輸入文字和輸出 maskedText。

SearchIndexerDataNoneIdentity

Object

清除資料來源的身分識別屬性。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

指定身分類型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

Object

指定要使用的資料來源身分識別。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

指定身分類型的 URI 片段。
userAssignedIdentity

string

使用者指派受控識別的完整 Azure 資源識別碼，通常採用「/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId」格式，應該已指派給搜尋服務。

SearchIndexerIndexProjections

Object

定義二級搜尋索引的其他投影。

名稱 類型 Description
parameters

SearchIndexerIndexProjectionsParameters

索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
selectors

SearchIndexerIndexProjectionSelector[]

要對次要搜尋索引執行的投影清單。

SearchIndexerIndexProjectionSelector

Object

要儲存在指定搜尋索引中的資料的說明。

名稱 類型 Description
mappings

InputFieldMappingEntry[]

投影的對應，或哪個來源應該對應至目標索引中的哪個欄位。
parentKeyFieldName

string

搜尋索引中要將父文件索引鍵值對應至的欄位名稱。 必須是可篩選的字串欄位，而不是索引鍵欄位。
sourceContext

string

投影的來源內容。 代表文件將分割成多個子文件的基數。
targetIndexName

string

要投影到的搜尋索引名稱。 必須具有已設定「關鍵字」分析器的索引鍵欄位。

SearchIndexerIndexProjectionsParameters

Object

索引投影特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。

名稱 類型 Description
projectionMode

IndexProjectionMode

定義索引投影相對於索引子其餘部分的行為。

SearchIndexerKnowledgeStore

Object

定義擴充資料的 Azure Blob、資料表或檔案的其他投影。

名稱 類型 Description
identity SearchIndexerDataIdentity:

使用者指派的受控識別，用於撰寫知識存放區投影時連線至 Azure 儲存體。 如果連接字串指出身分識別 （ResourceId） 且未指定，則會使用系統指派的受控識別。 在索引子更新時，如果未指定身分識別，則值會保持不變。 如果設定為 “none”，則會清除此屬性的值。
parameters

SearchIndexerKnowledgeStoreParameters

知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。
projections

SearchIndexerKnowledgeStoreProjection[]

索引期間要執行的其他投影清單。
storageConnectionString

string

儲存體帳戶投影的連接字串將會儲存在其中。

SearchIndexerKnowledgeStoreFileProjectionSelector

Object

要儲存在 Azure 檔案儲存體中的資料的投影定義。

名稱 類型 Description
generatedKeyName

string

要儲存投影的產生金鑰名稱。
inputs

InputFieldMappingEntry[]

複雜投影的巢狀輸入。
referenceKeyName

string

不同投影的參考鍵名稱。
source

string

將資料來源設為專案。
sourceContext

string

複雜投影的來源內容。
storageContainer

string

Blob 容器，以儲存投影。

SearchIndexerKnowledgeStoreObjectProjectionSelector

Object

要儲存在 Azure Blob 中的資料的投影定義。

名稱 類型 Description
generatedKeyName

string

要儲存投影的產生金鑰名稱。
inputs

InputFieldMappingEntry[]

複雜投影的巢狀輸入。
referenceKeyName

string

不同投影的參考鍵名稱。
source

string

將資料來源設為專案。
sourceContext

string

複雜投影的來源內容。
storageContainer

string

Blob 容器，以儲存投影。

SearchIndexerKnowledgeStoreParameters

Object

知識存放區特定組態屬性的字典。 每個名稱都是特定屬性的名稱。 每個值都必須是基本類型。

名稱 類型 預設值 Description
synthesizeGeneratedKeyName

boolean

False

如果尚未存在，投影是否應該合成產生的索引鍵名稱。

SearchIndexerKnowledgeStoreProjection

Object

各種投影選取器的容器物件。

名稱 類型 Description
files

SearchIndexerKnowledgeStoreFileProjectionSelector[]

投影至 Azure 檔案儲存體。
objects

SearchIndexerKnowledgeStoreObjectProjectionSelector[]

投影至 Azure Blob 儲存體。
tables

SearchIndexerKnowledgeStoreTableProjectionSelector[]

Azure 資料表儲存體的投影。

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

要儲存在 Azure 資料表中的資料描述。

名稱 類型 Description
generatedKeyName

string

要儲存投影的產生金鑰名稱。
inputs

InputFieldMappingEntry[]

複雜投影的巢狀輸入。
referenceKeyName

string

不同投影的參考鍵名稱。
source

string

將資料來源設為專案。
sourceContext

string

複雜投影的來源內容。
tableName

string

要儲存投影資料的 Azure 資料表名稱。

SearchIndexerSkillset

Object

技能清單。

名稱 類型 Description
@odata.etag

string

技能組的 ETag。
cognitiveServices CognitiveServicesAccount:

執行技能時要使用的 Azure AI 服務的詳細數據。
description

string

技能組的描述。
encryptionKey

SearchResourceEncryptionKey

您在 Azure 金鑰保存庫中建立的加密金鑰描述。 當您想要完全保證沒有人 （甚至 Microsoft） 無法解密您的技能集定義時，此金鑰可用來為您的技能組定義提供額外的待用加密層級。 加密技能組定義之後，它一律會保持加密狀態。 搜尋服務會忽略嘗試將此屬性設定為 Null。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能組合定義將不受影響。 使用客戶管理的金鑰進行加密不適用於免費搜尋服務，且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections

SearchIndexerIndexProjections

對二級搜索索引的額外預測的定義。
knowledgeStore

SearchIndexerKnowledgeStore

定義擴充資料的 Azure Blob、資料表或檔案的其他投影。
name

string

技能集的名稱。
skills SearchIndexerSkill[]:

技能集中的技能清單。

SearchResourceEncryptionKey

Object

Azure Key Vault 中的客戶管理加密金鑰。 您建立和管理的金鑰可用來加密或解密靜態資料，例如索引和同義字對映。

名稱 類型 Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

用來存取 Azure 金鑰保存庫的選擇性 Azure Active Directory 認證。 如果改用受控識別，則不需要。
identity SearchIndexerDataIdentity:

用於此加密金鑰的明確受控識別。 如果未指定且存取認證屬性為 Null，則會使用系統指派的受控識別。 更新資源時，如果未指定明確身分識別，則會保持不變。 如果指定 “none” ，則會清除此屬性的值。
keyVaultKeyName

string

要用來加密待用資料的 Azure 金鑰保存庫名稱。
keyVaultKeyVersion

string

要用來加密待用資料的 Azure 金鑰版本。
keyVaultUri

string

Azure 金鑰保存庫的 URI，也稱為 DNS 名稱，其中包含要用來加密待用資料的金鑰。 範例 URI 可能是 https://my-keyvault-name.vault.azure.net。

SentimentSkill

Object

此技能已被取代。 使用 V3。SentimentSkill 的

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.SentimentSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

SentimentSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

SentimentSkillLanguage

列舉型別

Deprecated. SentimentSkill 支援輸入文字的語言代碼。

值 Description
da

丹麥文
nl

荷蘭文
en

English
fi

芬蘭文
fr

法語
de

德語
el

希臘文
it

義大利語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

葡萄牙文 (葡萄牙)
ru

Russian
es

西班牙文
sv

瑞典文
tr

Turkish

SentimentSkillV3

Object

使用文字分析 API，評估非結構化文字，並針對每筆記錄，根據服務在句子和文件層級找到的最高信賴分數，提供情緒標籤 （例如「負面」、「中性」和「正面」）。

名稱 類型 預設值 Description
@odata.type string:

#Microsoft.Skills.Text.V3.SentimentSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

string

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
includeOpinionMining

boolean

False

如果設定為 true，技能輸出將包含來自文字分析的資訊，以進行意見採礦，也就是文字中的目標 （名詞或動詞） 及其相關聯的評定 （形容詞） 。 預設值為 false。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
modelVersion

string

呼叫文字分析服務時要使用的模型版本。 未指定時，它將預設為最新的可用。 除非絕對必要，否則建議您不要指定此值。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

ShaperSkill

Object

重塑輸出的技能。 它會建立複雜類型來支援複合欄位 （也稱為多部分欄位）。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.ShaperSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

SplitSkill

Object

將字串分割成文字區塊的技能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.SplitSkill

指定技能類型的 URI 片段。
azureOpenAITokenizerParameters

AzureOpenAITokenizerParameters

只有在單位設定為 azureOpenAITokens 時才適用。 如果指定，splitSkill 會在執行權杖化時使用這些參數。 參數是有效的 'encoderModelName' 和選擇性的 'allowedSpecialTokens' 屬性。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultLanguageCode

SplitSkillLanguage

指出要使用的語言程式碼的值。 預設值為 en。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
maximumPageLength

integer (int32)

所需的頁面長度上限。 預設值為 10000。
maximumPagesToTake

integer (int32)

僅適用於 textSplitMode 設定為 'pages' 時。 如果指定，SplitSkill 將在處理第一個「maximumPagesToTake」頁面後停止分割，以便在每個文件只需要幾個初始頁面時提高效能。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
pageOverlapLength

integer (int32)

僅適用於 textSplitMode 設定為 'pages' 時。 如果指定，則第 n+1 個區塊將從第 n 個區塊結尾開始以此字元/記號數開始。
textSplitMode

TextSplitMode

指出要執行的分割模式的值。
unit

SplitSkillUnit

只有在 textSplitMode 設定為 pages 時才適用。 有兩個可能的值。 值的選擇將決定長度（maximumPageLength 和 pageOverlapLength）測量。 預設值為「字元」，這表示長度將按字元來衡量。

SplitSkillEncoderModelName

列舉型別

只有在單位設定為 azureOpenAITokens 時才適用。 選項包括“R50k_base”、“P50k_base”、“P50k_edit”和“CL100k_base”。 預設值為 'CL100k_base'。

值 Description
r50k_base

指用 50,000 個標記詞彙訓練的基礎模型，常用於一般自然語言處理任務。
p50k_base

具有 50,000 個權杖詞彙的基礎模型，針對基於提示的任務進行了優化。
p50k_edit

與 p50k_base 類似，但經過微調，可編輯或改寫具有 50,000 個標記詞彙的任務。
cl100k_base

具有 100,000 個權杖詞彙的基本模型。

SplitSkillLanguage

列舉型別

SplitSkill 支援輸入文字的語言代碼。

值 Description
am

阿姆哈拉文
bs

波士尼亞文
cs

捷克語
da

丹麥文
de

德語
en

English
es

西班牙文
et

愛沙尼亞文
fi

芬蘭文
fr

法語
he

希伯來文
hi

印地語
hr

克羅埃西亞文
hu

匈牙利文
id

Indonesian
is

Icelandic
it

義大利語
ja

日語
ko

朝鮮語
lv

拉脫維亞文
nb

挪威文
nl

荷蘭文
pl

波蘭語
pt

葡萄牙文 (葡萄牙)
pt-br

葡萄牙文 (巴西)
ru

Russian
sk

斯洛伐克文
sl

斯洛維尼亞文
sr

塞爾維亞文
sv

瑞典文
tr

Turkish
ur

烏都文
zh

中文 (簡體)

SplitSkillUnit

列舉型別

指出要使用的單位的值。

值 Description
characters

長度將按字符測量。
azureOpenAITokens

長度將由 tiktoken 庫中的 AzureOpenAI 分詞器測量。

TextSplitMode

列舉型別

指出要執行的分割模式的值。

值 Description
pages

將文字分割成個別頁面。
sentences

將文本拆分為單獨的句子。

TextTranslationSkill

Object

將文本從一種語言翻譯成另一種語言的技能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.TranslationSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
defaultFromLanguageCode

TextTranslationSkillLanguage

對於未明確指定寄件者語言的文件，要從中翻譯文件的語言代碼。
defaultToLanguageCode

TextTranslationSkillLanguage

對於未明確指定至語言的文件，要將文件翻譯成的語言代碼。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
suggestedFrom

TextTranslationSkillLanguage

當未提供 fromLanguageCode 輸入或 defaultFromLanguageCode 參數，且自動語言偵測失敗時，要從中翻譯文件的語言代碼。 預設值為 en。

TextTranslationSkillLanguage

列舉型別

TextTranslationSkill 支援輸入文字的語言代碼。

值 Description
af

南非荷蘭文
ar

阿拉伯文
bn

孟加拉文
bs

波士尼亞文 (拉丁)
bg

保加利亞文
yue

粵語 (繁體中文)
ca

加泰蘭文
zh-Hans

簡體中文
zh-Hant

繁體中文
hr

克羅埃西亞文
cs

捷克語
da

丹麥文
nl

荷蘭文
en

English
et

愛沙尼亞文
fj

斐濟文
fil

菲律賓文
fi

芬蘭文
fr

法語
de

德語
el

希臘文
ht

海地克里奧爾文
he

希伯來文
hi

印地語
mww

白苗文
hu

匈牙利文
is

Icelandic
id

Indonesian
it

義大利語
ja

日語
sw

史瓦希里文
tlh

克林貢文
tlh-Latn

克林貢語（拉丁文字）
tlh-Piqd

克林貢語（克林貢文字）
ko

朝鮮語
lv

拉脫維亞文
lt

立陶宛文
mg

馬達加斯加文
ms

馬來文
mt

馬爾他文
nb

挪威文
fa

波斯文
pl

波蘭語
pt

Portuguese
pt-br

葡萄牙文 (巴西)
pt-PT

葡萄牙文 (葡萄牙)
otq

克雷塔羅歐多蜜文
ro

羅馬尼亞文
ru

Russian
sm

薩摩亞文
sr-Cyrl

塞爾維亞文 (斯拉夫)
sr-Latn

塞爾維亞文 (拉丁)
sk

斯洛伐克文
sl

斯洛維尼亞文
es

西班牙文
sv

瑞典文
ty

大溪地文
ta

坦米爾文
te

泰盧固文
th

泰文
to

東加文
tr

Turkish
uk

烏克蘭文
ur

烏都文
vi

Vietnamese
cy

威爾斯文
yua

猶加敦馬雅文
ga

愛爾蘭文
kn

坎那達文
mi

毛利文
ml

馬來亞拉姆文
pa

旁遮普文

VisionVectorizeSkill

Object

可讓您使用 Azure AI 服務視覺向量化 API 為指定的影像或文字輸入產生向量內嵌。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Vision.VectorizeSkill

指定技能類型的 URI 片段。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
modelVersion

string

呼叫 AI 服務視覺服務時要使用的模型版本。 未指定時，它將預設為最新的可用。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。

VisualFeature

列舉型別

指出要傳回哪些視覺功能類型的字串。

值 Description
adult

被視為成年人的視覺特徵。
brands

視覺特徵被公認為商業品牌。
categories

類別。
description

Description.
faces

視覺特徵被識別為人臉。
objects

視覺特徵被識別為物件。
tags

標籤。

WebApiSkill

Object

可呼叫 Web API 端點的技能，可讓您藉由呼叫自訂程式碼來擴充技能集。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Custom.WebApiSkill

指定技能類型的 URI 片段。
authIdentity SearchIndexerDataIdentity:

用於輸出連線的使用者指派受控識別。 如果提供 authResourceId 且未指定，則會使用系統指派的受控識別。 在索引子更新時，如果未指定身分識別，則值會保持不變。 如果設定為 “none”，則會清除此屬性的值。
authResourceId

string

適用於連線到 Azure 函式中外部程式碼的自訂技能，或提供轉換的其他應用程式。 此值應該是向 Azure Active Directory 註冊時針對函式或應用程式建立的應用程式識別碼。 指定時，自訂技能會使用搜尋服務的受控識別碼 （系統或使用者指派） 和函式或應用程式的存取權杖連線到函式或應用程式，並使用此值作為建立存取權杖範圍的資源識別碼。
batchSize

integer (int32)

所需的批次大小，表示文件數目。
context

string

代表作業發生的層級，例如文件根目錄或文件內容 （例如，/document 或 /document/content）。 預設值為 /document。
degreeOfParallelism

integer (int32)

如果設定，則可對 Web API 進行的平行呼叫數目。
description

string

技能的描述，描述技能的輸入、輸出和使用方式。
httpHeaders

object

發出 http 要求所需的標頭。
httpMethod

string

http 要求的方法。
inputs

InputFieldMappingEntry[]

技能的輸入可以是來源資料集中的資料行，也可以是上游技能的輸出。
name

string

在技能集中唯一識別技能的技能名稱。 未定義名稱的技能將在技能陣列中獲得其從 1 開始的索引的預設名稱，並以字元「#」為前綴。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的欄位，或可作為另一個技能輸入使用的值。
timeout

string (duration)

要求所需的逾時。 預設值為 30 秒。
uri

string

Web API 的 URL。