Skillsets - Create

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

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

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

URI 參數

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

string

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

string

用戶端 API 版本。

要求標頭

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

string (uuid)

隨要求一起傳送的追蹤標識碼，以協助偵錯。

要求本文

名稱 必要 類型 Description
name True

string

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

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

string

技能集的 ETag。
cognitiveServices CognitiveServicesAccount:

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

string

技能集的描述。
encryptionKey

SearchResourceEncryptionKey

您在 Azure Key Vault 中建立的加密金鑰描述。 當您想要完整保證沒有人，甚至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-05-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",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

範例回覆

狀態碼:
201 
{
  "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"
  },
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

定義

名稱 Description
AIServicesAccountIdentity

連結至技能集的 Azure AI 服務資源多重區域帳戶。
AIServicesAccountKey

連結至技能集的 Azure AI 服務資源的帳戶密鑰，要與資源的子域搭配使用。
AmlSkill

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

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

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

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

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

指定 Azure AI Foundry 應如何處理“extraParameters”。 默認為 『error』。
ChatCompletionResponseFormat

確定應如何序列化語言模型的回應。 默認為 『text』。
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

控制 chunk unit 的基數。 默認值為 'characters'
DocumentIntelligenceLayoutSkillExtractionOptions

控制技能從文檔中提取的內容的基數。
DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

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

控制輸出格式的基數。 默認值為 『markdown』。
DocumentIntelligenceLayoutSkillOutputMode

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

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

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

此技能已被取代。 使用 V3。請改為 EntityRecognitionSkill。
EntityRecognitionSkillLanguage

已廢棄。 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

已廢棄。 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

URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
description

string

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

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

string

對應 AI 服務的子域 URL。

AIServicesAccountKey

Object

連結至技能集的 Azure AI 服務資源的帳戶密鑰，要與資源的子域搭配使用。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByKey

URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
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)

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

string

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

InputFieldMappingEntry[]

技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
key

string

（金鑰驗證的必要專案）AML 服務的金鑰。
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 Key Vault 中的加密密鑰進行驗證存取。

名稱 類型 Description
applicationId

string

AAD 應用程式識別碼，已將待用數據加密時要使用的 Azure Key Vault 所需訪問許可權授與。 應用程式標識碼不應與 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)

產生的輸出內嵌應具有的維度數目。 只有文字內嵌-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)

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

string[]

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

number

0.7

取樣溫度。 預設值為 0.7。

ChatCompletionExtraParametersBehavior

列舉型別

指定 Azure AI Foundry 應如何處理“extraParameters”。 默認為 『error』。

值 Description
pass-through
drop

刪除所有額外參數。
error

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

ChatCompletionResponseFormat

Object

確定應如何序列化語言模型的回應。 默認為 『text』。

名稱 類型 預設值 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

架構表示形式類型。 通常是 『object』。 默認值為 『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 如何處理額外參數。 預設值為 『error』。
httpHeaders

object

提出 HTTP 要求所需的標頭。
httpMethod

string

HTTP 要求的方法。
inputs

InputFieldMappingEntry[]

技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
name

string

技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。
responseFormat

ChatCompletionResponseFormat

確定 LLM 應如何格式化其回應。 默認為 『text』 回應類型。
timeout

string (duration)

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

string

Web API 的 URL。

CognitiveServicesAccountKey

Object

連結至技能集的 Azure AI 服務資源多重區域帳戶密鑰。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.CognitiveServicesByKey

URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
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

變更此實體的預設腔調敏感度值。 它可用來變更所有別名的預設值不區分腔調值。
defaultCaseSensitive

boolean

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

integer (int32)

變更此實體的預設模糊編輯距離值。 它可以用來變更所有別名模糊EditDistance 值的預設值。
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 中設定 CaseSensitive，此值將會是預設值。
globalDefaultFuzzyEditDistance

integer (int32)

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

CustomEntity[]

內嵌 CustomEntity 定義。
inputs

InputFieldMappingEntry[]

技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
name

string

技能的名稱，可唯一識別技能集內的技能。 未定義名稱的技能將會在技能數位中指定其以 1 起始索引的預設名稱，前面加上字元 『#』。
outputs

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

CustomEntityLookupSkillLanguage

列舉型別

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

值 Description
da

丹麥文
de

德語
en

英語
es

西班牙文
fi

芬蘭文
fr

法語
it

義大利語
ko

朝鮮語
pt

葡萄牙語

DefaultCognitiveServicesAccount

Object

空的 物件，表示技能集的預設 Azure AI 服務資源。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DefaultCognitiveServices

URI 片段，指定連結至技能集的 Azure AI 服務資源類型。
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。 如果未定義，則會設定為 『default』。

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

控制輸出格式的基數。 默認值為 『markdown』。
outputMode

DocumentIntelligenceLayoutSkillOutputMode

oneToMany

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

OutputFieldMappingEntry[]

技能的輸出是搜尋索引中的字段，或是另一個技能可作為輸入的值。

DocumentIntelligenceLayoutSkillChunkingProperties

Object

控制用於分塊內容的基數。

名稱 類型 預設值 Description
maximumLength

integer (int32)

最大塊長度（以字元為單位）。 預設值為 500。
overlapLength

integer (int32)

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

DocumentIntelligenceLayoutSkillChunkingUnit

characters

塊的單位。

DocumentIntelligenceLayoutSkillChunkingUnit

列舉型別

控制 chunk unit 的基數。 默認值為 'characters'

值 Description
characters

按字元指定塊。

DocumentIntelligenceLayoutSkillExtractionOptions

列舉型別

控制技能從文檔中提取的內容的基數。

值 Description
images

指定應從文件中提取圖像內容。
locationMetadata

指定應從文件中提取位置元數據。

DocumentIntelligenceLayoutSkillMarkdownHeaderDepth

列舉型別

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

值 Description
h1

標頭層級 1。
h2

標頭層級 2。
h3

標頭層級 3。
h4

標頭層級 4。
h5

標頭層級 5。
h6

標頭層級 6。

DocumentIntelligenceLayoutSkillOutputFormat

列舉型別

控制輸出格式的基數。 默認值為 『markdown』。

值 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

列舉型別

已廢棄。 EntityRecognitionSkill 支援輸入文字的語言代碼。

值 Description
ar

阿拉伯文
cs

捷克
zh-Hans

簡體中文
zh-Hant

繁體中文
da

丹麥文
nl

荷蘭語
en

英語
fi

芬蘭文
fr

法語
de

德語
el

希臘語
hu

匈牙利語
it

義大利語
ja

日語
ko

朝鮮語
no

挪威文（博克瑪律）
pl

波蘭語
pt-PT

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

葡萄牙文（巴西）
ru

俄語
es

西班牙文
sv

瑞典文
tr

土耳其文

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

英語
es

西班牙文
et

愛沙尼亞語
eu

巴斯克文
fi

芬蘭文
fr

法語
ga

愛爾蘭語
gl

加利西亞文
he

希伯來文
hi

印地語
hr

克羅埃西亞語
hu

匈牙利語
id

印尼文
it

義大利語
ja

日語
kk

哈薩克語
ko

朝鮮語
lt

立陶宛語
lv

拉脫維亞語
mk

馬其頓語
ms

馬來文 (馬來西亞)
nb

挪威文（博克马尔）
nl

荷蘭語
pl

波蘭語
prs

達里
pt-BR

葡萄牙文-巴西
pt

葡萄牙文-葡萄牙
pt-PT

葡萄牙文-葡萄牙
ro

羅馬尼亞
ru

俄語
sk

斯洛伐克語
sl

斯洛維尼亞文
sr-Cyrl

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

塞爾維亞文 (拉丁 RS)
sv

瑞典文
th

泰語
tr

土耳其文
uk

烏克蘭文
vi

越南文
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

英語
fi

芬蘭文
fr

法語
de

德語
it

義大利語
ja

日語
ko

朝鮮語
no

挪威文（博克瑪律）
pl

波蘭語
pt-PT

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

葡萄牙文（巴西）
ru

俄語
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

阿瓦德文 - 印度文 (梵文字母)
az

亞塞拜然文 (拉丁)
bfy

巴哥里文
eu

巴斯克文
be

白俄羅斯文（斯拉夫文和拉丁文）
be-cyrl

白俄羅斯文 (斯拉夫)
be-latn

白俄羅斯文 (拉丁)
bho

博杰普爾文 - 印地文 (梵文字母)
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

英語
myv

厄爾茲亞文 (斯拉夫)
et

愛沙尼亞語
fo

法羅語
fj

斐濟語
fil

菲律賓語
fi

芬蘭文
fr

法語
fur

弗魯利安
gag

加告茲文 (拉丁)
gl

加利西亞文
de

德語
gil

吉里巴斯文
gon

貢德文 (梵文字母)
el

希臘語
kl

格陵蘭文
gvr

古隆文 (梵文字母)
ht

海地克里奧爾語
hlb

亥比文 (梵文字母)
hni

哈尼文
bgc

哈里亞納文
haw

夏威夷人
hi

印地語
mww

白苗文 (拉丁)
hoc

何（德瓦納吉里）
hu

匈牙利語
is

冰島語
smn

伊納里薩米
id

印尼文
ia

人工國際語
iu

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

愛爾蘭語
it

義大利語
ja

日語
Jns

詹薩里文 (梵文字母)
jv

爪哇語
kea

維德角文
kac

克欽文 (拉丁)
xnr

康格里文 (梵文字母)
krc

卡拉恰伊巴爾卡爾文
kaa-cyrl

卡拉卡爾帕克文 (斯拉夫)
kaa

卡拉卡爾帕克文 (拉丁)
csb

卡舒比文
kk-cyrl

哈薩克文 (斯拉夫)
kk-latn

哈薩克文 (拉丁)
klr

哈林文
kha

卡西文
quc

基切
ko

朝鮮語
kfq

科爾庫文
kpy

科里亞克文
kos

科斯雷文
kum

庫梅克文 (斯拉夫)
ku-arab

庫德文 (阿拉伯文)
ku-latn

庫德文 (拉丁)
kru

庫魯克文 (梵文字母)
ky

吉爾吉斯文 (斯拉夫)
lkt

拉科他州
la

拉丁語
lt

立陶宛語
dsb

低地索布語
smj

魯勒薩米文
lb

盧森堡文
bfz

馬哈蘇帕哈里文 (梵文字母)
ms

馬來文 (拉丁)
mt

馬爾他語
kmj

馬爾托文 (梵文字母)
gv

曼島文
mi

毛利語
mr

馬拉地語
mn

蒙古文（西里爾字母）
cnr-cyrl

蒙特內哥羅文 (斯拉夫)
cnr-latn

蒙特內哥羅文 (拉丁)
nap

那不勒斯文
ne

尼泊爾語
niu

紐埃文
nog

諾蓋文
sme

北薩米文 (拉丁)
nb

挪威文
no

挪威文
oc

奧克西坦文
os

奧塞提文
ps

普什圖語
fa

波斯語
pl

波蘭語
pt

葡萄牙語
pa

旁遮普文 (阿拉伯文)
ksh

利普里安文
ro

羅馬尼亞
rm

羅曼斯文
ru

俄語
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

土耳其文
tk

土庫曼文 (拉丁)
tyv

圖瓦文
hsb

上索布語
ur

烏爾都語
ug

維吾爾文 (阿拉伯)
uz-arab

烏茲別克文 (阿拉伯文)
uz-cyrl

烏茲別克文 (斯拉夫)
uz

烏茲別克文（拉丁）
vo

沃拉普克文
wae

Walser （瓦爾瑟）
cy

威爾士語
fy

西部弗里西亞語
yua

猶加敦馬雅文
za

壯文
zu

祖魯語
unk

未知（全部）

OutputFieldMappingEntry

Object

技能的輸出欄位對應。

名稱 類型 Description
name

string

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

string

輸出的目標名稱。 這是選擇性的，預設為 name。

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』。 預設值為 『none』。
inputs

InputFieldMappingEntry[]

技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
maskingCharacter

string

maxLength: 1

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

PIIDetectionSkillMaskingMode

參數，提供各種方式來遮罩輸入文字中偵測到的個人資訊。 預設值為 『none』。
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-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

要投影的搜尋索引名稱。 必須具有已設定 『keyword』 分析器的索引鍵欄位。

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 Key Vault 中建立的加密金鑰描述。 當您想要完整保證沒有人，甚至Microsoft，都可以解密技能集定義時，此密鑰可用來為您的技能集定義提供額外的待用加密層級。 加密技能集定義之後，一律會保持加密狀態。 搜尋服務會忽略將此屬性設定為 null 的嘗試。 如果您想要輪替加密金鑰，您可以視需要變更此屬性;您的技能集定義不會受到影響。 使用客戶管理的金鑰加密不適用於免費搜尋服務，而且僅適用於 2019 年 1 月 1 日或之後建立的付費服務。
indexProjections

SearchIndexerIndexProjections

對次要搜尋索引的其他投影定義。
knowledgeStore

SearchIndexerKnowledgeStore

對 Azure Blob、數據表或檔案定義擴充數據的其他投影。
name

string

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

技能集中的技能清單。

SearchResourceEncryptionKey

Object

Azure Key Vault 中客戶管理的加密密鑰。 您建立和管理的金鑰可用來加密或解密待用數據，例如索引和同義字對應。

名稱 類型 Description
accessCredentials

AzureActiveDirectoryApplicationCredentials

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

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

string

要用來加密待用數據的 Azure Key Vault 金鑰名稱。
keyVaultKeyVersion

string

要用來加密待用數據的 Azure Key Vault 金鑰版本。
keyVaultUri

string

Azure Key Vault 的 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

列舉型別

已廢棄。 SentimentSkill 支援輸入文字的語言代碼。

值 Description
da

丹麥文
nl

荷蘭語
en

英語
fi

芬蘭文
fr

法語
de

德語
el

希臘語
it

義大利語
no

挪威文（博克瑪律）
pl

波蘭語
pt-PT

葡萄牙文 (葡萄牙)
ru

俄語
es

西班牙文
sv

瑞典文
tr

土耳其文

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 設定為頁面時才適用。 有兩個可能的值。 值的選擇將決定長度 （maximumPageLength 和 pageOverlapLength） 測量。 默認值為 'characters'，這表示長度會以字元來測量。

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

英語
es

西班牙文
et

愛沙尼亞語
fi

芬蘭文
fr

法語
he

希伯來文
hi

印地語
hr

克羅埃西亞語
hu

匈牙利語
id

印尼文
is

冰島語
it

義大利語
ja

日語
ko

朝鮮語
lv

拉脫維亞語
nb

挪威文
nl

荷蘭語
pl

波蘭語
pt

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

葡萄牙文（巴西）
ru

俄語
sk

斯洛伐克語
sl

斯洛維尼亞文
sr

塞爾維亞文
sv

瑞典文
tr

土耳其文
ur

烏爾都語
zh

中文（簡體）

SplitSkillUnit

列舉型別

值，表示要使用的單位。

值 Description
characters

長度會以字元來測量。
azureOpenAITokens

長度將由來自 tiktoken 連結庫的 AzureOpenAI Tokenizer 來測量。

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

英語
et

愛沙尼亞語
fj

斐濟語
fil

菲律賓語
fi

芬蘭文
fr

法語
de

德語
el

希臘語
ht

海地克里奧爾語
he

希伯來文
hi

印地語
mww

白苗文
hu

匈牙利語
is

冰島語
id

印尼文
it

義大利語
ja

日語
sw

史瓦希里文
tlh

克林貢文
tlh-Latn

克林貢 （拉丁劇本）
tlh-Piqd

克林貢 （克林貢腳本）
ko

朝鮮語
lv

拉脫維亞語
lt

立陶宛語
mg

馬達加斯加文
ms

馬來語
mt

馬爾他語
nb

挪威文
fa

波斯語
pl

波蘭語
pt

葡萄牙語
pt-br

葡萄牙文（巴西）
pt-PT

葡萄牙文 (葡萄牙)
otq

奎雷塔洛歐多米文
ro

羅馬尼亞
ru

俄語
sm

薩摩亞文
sr-Cyrl

塞爾維亞文 (西里爾字母)
sr-Latn

塞爾維亞文（拉丁文）
sk

斯洛伐克語
sl

斯洛維尼亞文
es

西班牙文
sv

瑞典文
ty

大溪地文
ta

泰米爾語
te

泰盧固語
th

泰語
to

東加的
tr

土耳其文
uk

烏克蘭文
ur

烏爾都語
vi

越南文
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

描述
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。