Skillsets - Create Or Update

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

在搜尋服務中建立新的技能集，或更新技能集 （如果已存在）。

PUT {endpoint}/skillsets('{skillsetName}')?api-version=2025-11-01-preview
含選擇性參數: 
PUT {endpoint}/skillsets('{skillsetName}')?api-version=2025-11-01-preview&ignoreResetRequirements={ignoreResetRequirements}&disableCacheReprocessingChangeDetection={disableCacheReprocessingChangeDetection}

URI 參數

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

string (uri)

搜尋服務的端點 URL。
skillsetName
 path True

string

技能集的名稱。
api-version
 query True

string

minLength: 1

用於此作業的 API 版本。
disableCacheReprocessingChangeDetection
 query

boolean

停用快取重新處理變更偵測。
ignoreResetRequirements
 query

boolean

忽略快取重設需求。

要求標頭

名稱 必要 類型 Description
Accept

Accept

接受標頭。
If-Match

string

定義 If-Match 條件。 只有在伺服器上的 ETag 符合此值時，才會執行作業。
If-None-Match

string

定義 If-None-Match 條件。 只有在伺服器上的 ETag 不符合此值時，才會執行作業。
Prefer True

Prefer

針對 HTTP PUT 要求，指示服務在成功時傳回建立/更新的資源。
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

SearchIndexerIndexProjection

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

SearchIndexerKnowledgeStore

對 Azure blob、表格或檔案的額外投影定義，包含豐富的資料。

回應

名稱 類型 Description
200 OK

SearchIndexerSkillset

要求已成功。
201 Created

SearchIndexerSkillset

要求已成功，因此已建立新的資源。
Other Status Codes

ErrorResponse

未預期的錯誤回應。

安全性

api-key

類型: apiKey
位於: header

OAuth2Auth

類型: oauth2
Flow: implicit
授權 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

範圍

名稱 Description
https://search.azure.com/.default

範例

SearchServiceCreateOrUpdateSkillset

範例要求

PUT https://previewexampleservice.search.windows.net/skillsets('tempskillset')?api-version=2025-11-01-preview&ignoreResetRequirements=&disableCacheReprocessingChangeDetection=





{
  "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"
        }
      ]
    },
    {
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      },
      "@odata.type": "#Microsoft.Skills.Util.ContentUnderstandingSkill",
      "name": "contentUnderstandingSKill",
      "context": "/document",
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections2"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images2"
        }
      ]
    }
  ],
  "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"
}

範例回覆

狀態碼:
200 
{
  "@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.\"}}"
          }
        }
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.ContentUnderstandingSkill",
      "name": "contentUnderstandingSKill",
      "context": "/document",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections2"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images2"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    }
  ],
  "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"
  }
}
狀態碼:
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.\"}}"
          }
        }
      }
    },
    {
      "@odata.type": "#Microsoft.Skills.Util.ContentUnderstandingSkill",
      "name": "contentUnderstandingSKill",
      "context": "/document",
      "extractionOptions": [
        "images",
        "locationMetadata"
      ],
      "inputs": [
        {
          "name": "file_data",
          "source": "/document/content",
          "inputs": []
        }
      ],
      "outputs": [
        {
          "name": "text_sections",
          "targetName": "text_sections2"
        },
        {
          "name": "normalized_images",
          "targetName": "normalized_images2"
        }
      ],
      "chunkingProperties": {
        "unit": "characters",
        "maximumLength": 500,
        "overlapLength": 50
      }
    }
  ],
  "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
Accept

接受標頭。
AIServicesAccountIdentity

Azure AI 服務資源的多區域帳號，並附加到技能集。
AIServicesAccountKey

綁定在技能組上的 Azure AI 服務資源的帳號金鑰，用於該資源的子網域。
AzureMachineLearningSkill

AML 技能允許你透過自訂的 Azure Machine Learning（AML）模型來擴展 AI 豐富化。 一旦定型和部署 AML 模型，AML 技能就會將其整合到 AI 擴充中。
AzureOpenAIEmbeddingSkill

允許你使用 Azure OpenAI 資源，為特定文字輸入產生向量嵌入。
AzureOpenAIModelName

將被命名的 Azure Open AI 模型名稱。
AzureOpenAITokenizerParameters

Azure OpenAI Tokenizer parameters.
ChatCompletionCommonModelParameters

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

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

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

指定 LLM 應如何格式化回應。
ChatCompletionSchema

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

JSON 架構回應格式的屬性。
ChatCompletionSkill

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

Azure AI 服務資源的多區域帳號金鑰，該資源綁定在技能組上。
ConditionalSkill

一種技能，可讓需要布爾運算的案例，以判斷要指派給輸出的數據。
ContentUnderstandingSkill

一項利用 Azure AI 內容理解來處理並提取結構化洞察的技能，使內容豐富且可搜尋，提升文件索引與檢索能力。
ContentUnderstandingSkillChunkingProperties

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

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

物件，其中包含找到之相符專案的相關信息，以及相關的元數據。
CustomEntityAlias

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

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

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

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

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

這項技能能透過 Azure AI 服務，從豐富流程中的檔案中擷取內容與版面資訊。
DocumentIntelligenceLayoutSkillChunkingProperties

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

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

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

利用 文字分析 API，從文字中擷取連結實體。
EntityRecognitionSkillLanguage

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

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

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

錯誤詳細數據。
ErrorResponse

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。 （這也遵循 OData 錯誤回應格式。）。
ImageAnalysisSkill

分析影像檔案的技能。 它會根據影像內容擷取一組豐富的視覺功能。
ImageAnalysisSkillLanguage

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

字串，指出要傳回哪些網域特定詳細數據。
IndexProjectionMode

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

技能的輸入欄位對應。
KeyPhraseExtractionSkill

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

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

一種技能，可偵測輸入文字的語言，並報告要求上提交之每份檔的單一語言代碼。 語言代碼會與分數配對，指出分析的信心。
MergeSkill

將兩個或多個字串合併成單一統一字串的技能，選擇性的使用者定義分隔符會分隔每個元件元件元件。
OcrLineEnding

定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。
OcrSkill

從圖像檔擷取文字的技能。
OcrSkillLanguage

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

技能的輸出欄位對應。
PIIDetectionSkill

使用 文字分析 API 可以從輸入文字中提取個人資訊，並提供遮蔽選項。
PIIDetectionSkillMaskingMode

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

針對 HTTP PUT 要求，指示服務在成功時傳回建立/更新的資源。
SearchIndexerDataNoneIdentity

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

指定要使用之數據源的身分識別。
SearchIndexerIndexProjection

對次要搜尋索引進行其他投影的定義。
SearchIndexerIndexProjectionSelector

要儲存在指定搜尋索引中的數據描述。
SearchIndexerIndexProjectionsParameters

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

定義擴充數據之 azure Blob、數據表或檔案的其他投影。
SearchIndexerKnowledgeStoreFileProjectionSelector

投影定義 for store what data in Azure 檔案儲存體.
SearchIndexerKnowledgeStoreObjectProjectionSelector

Projection 定義 for what data to store in Azure Blob.
SearchIndexerKnowledgeStoreParameters

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

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

關於在 Azure Tables 中儲存哪些資料的描述。
SearchIndexerSkillset

技能清單。
SearchResourceEncryptionKey

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

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

利用 文字分析 API，會評估非結構化文字，並為每筆紀錄提供情感標籤（如「負面」、「中立」和「正面」），這些標籤基於服務在句子和文件層級找到的最高信心分數。
ShaperSkill

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

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

一個表示應該使用哪個分詞器的值。
SplitSkillLanguage

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

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

值，表示要執行的分割模式。
TextTranslationSkill

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

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

允許你使用 Azure AI Services 的 Vision Vectorize API 為特定圖片或文字輸入產生向量嵌入。
VisualFeature

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

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

Accept

列舉型別

接受標頭。

值 Description
application/json;odata.metadata=minimal

AIServicesAccountIdentity

Object

Azure AI 服務資源的多區域帳號，並附加到技能集。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByIdentity

衍生型別的歧視性。
description

string

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

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

string

該子網域/Azure AI Services 端點網址，對應 AI 服務。

AIServicesAccountKey

Object

綁定在技能組上的 Azure AI 服務資源的帳號金鑰，用於該資源的子網域。

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.AIServicesByKey

衍生型別的歧視性。
description

string

附在技能組上的 Azure AI 服務資源描述。
key

string

用於配置附加到技能組的 Azure AI 服務資源的金鑰。
subdomainUrl

string

該子網域/Azure AI Services 端點網址，對應 AI 服務。

AzureMachineLearningSkill

Object

AML 技能允許你透過自訂的 Azure Machine Learning（AML）模型來擴展 AI 豐富化。 一旦定型和部署 AML 模型，AML 技能就會將其整合到 AI 擴充中。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Custom.AmlSkill

衍生型別的歧視性。
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 資源 ID。 格式應該是 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 配置。

AzureOpenAIEmbeddingSkill

Object

允許你使用 Azure OpenAI 資源，為特定文字輸入產生向量嵌入。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

衍生型別的歧視性。
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

TextEmbeddingAda002 模型。
text-embedding-3-large

TextEmbedding3Large 模型。
text-embedding-3-small

TextEmbedding3小型模型。
gpt-4o

Gpt4o 模型。
gpt-4o-mini

Gpt4oMini 型號。
gpt-4.1

GPT41 型號。
gpt-4.1-mini

Gpt41Mini 型號。
gpt-4.1-nano

Gpt41Nano 模型。
gpt-5

GPT5 型號。
gpt-5-mini

Gpt5Mini 型號。
gpt-5-nano

Gpt5Nano 模型。

AzureOpenAITokenizerParameters

Object

Azure OpenAI Tokenizer parameters.

名稱 類型 Description
allowedSpecialTokens

string[]

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

SplitSkillEncoderModelName

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

ChatCompletionCommonModelParameters

Object

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

名稱 類型 預設值 Description
frequencyPenalty

number (double)

0

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

integer (int32)

要產生的最大語彙基元數。
model

string

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

number (double)

0

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

integer (int32)

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

string[]

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

number (double)

0.7

取樣溫度。 預設值為 0.7。

ChatCompletionExtraParametersBehavior

列舉型別

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

值 Description
passThrough

將任何額外的參數直接傳遞至模型。
drop

捨棄所有額外的參數。
error

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

ChatCompletionResponseFormat

Object

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

名稱 類型 預設值 Description
jsonSchemaProperties

ChatCompletionSchemaProperties

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

ChatCompletionResponseFormatType

text

指定 LLM 應如何格式化回應。

ChatCompletionResponseFormatType

列舉型別

指定 LLM 應如何格式化回應。

值 Description
text

純文字回應格式。
jsonObject

任意 JSON 物件回應格式。
jsonSchema

JSON 符合結構的回應格式。

ChatCompletionSchema

Object

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

名稱 類型 預設值 Description
additionalProperties

boolean

False

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

string

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

string[]

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

string

object

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

ChatCompletionSchemaProperties

Object

JSON 架構回應格式的屬性。

名稱 類型 預設值 Description
description

string

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

string

模型會遵循的 json 架構名稱。
schema

ChatCompletionSchema

模式定義。
strict

boolean

True

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

ChatCompletionSkill

Object

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

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

#Microsoft.Skills.Custom.ChatCompletionSkill

衍生型別的歧視性。
apiKey

string

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

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

string

適用於連接 Azure 函式或其他提供轉換的外部程式碼的自訂技能。 這個值應該是當函式或應用程式註冊到 Azure Active Directory 時所建立的應用程式 ID。 指定時，自定義技能會使用搜尋服務的受控標識碼（系統或使用者指派）和函式或應用程式的存取令牌，使用此值作為建立存取令牌範圍的資源標識符，聯機到函式或應用程式的函式或應用程式。
batchSize

integer (int32)

指出檔數目的所需批次大小。
commonModelParameters

ChatCompletionCommonModelParameters

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

string

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

integer (int32)

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

string

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

應附加至聊天完成呼叫的模型特定參數的開放型別字典。 遵循 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

衍生型別的歧視性。
description

string

附在技能組上的 Azure AI 服務資源描述。
key

string

用於配置附加到技能組的 Azure AI 服務資源的金鑰。

ConditionalSkill

Object

一種技能，可讓需要布爾運算的案例，以判斷要指派給輸出的數據。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.ConditionalSkill

衍生型別的歧視性。
context

string

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

string

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

InputFieldMappingEntry[]

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

string

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

OutputFieldMappingEntry[]

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

ContentUnderstandingSkill

Object

一項利用 Azure AI 內容理解來處理並提取結構化洞察的技能，使內容豐富且可搜尋，提升文件索引與檢索能力。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.ContentUnderstandingSkill

衍生型別的歧視性。
chunkingProperties

ContentUnderstandingSkillChunkingProperties

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

string

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

string

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

ContentUnderstandingSkillExtractionOptions[]

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

InputFieldMappingEntry[]

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

string

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

OutputFieldMappingEntry[]

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

ContentUnderstandingSkillChunkingProperties

Object

控制區塊化內容的基數。

名稱 類型 預設值 Description
maximumLength

integer (int32)

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

integer (int32)

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

characters

characters

區塊的單位。

ContentUnderstandingSkillExtractionOptions

列舉型別

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

值 Description
images

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

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

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

衍生型別的歧視性。
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

Danish
de

德語
en

English
es

西班牙文
fi

Finnish
fr

法語
it

義大利語
ko

朝鮮語
pt

Portuguese

DefaultCognitiveServicesAccount

Object

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

名稱 類型 Description
@odata.type string:

#Microsoft.Azure.Search.DefaultCognitiveServices

衍生型別的歧視性。
description

string

附在技能組上的 Azure AI 服務資源描述。

DocumentExtractionSkill

Object

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

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Util.DocumentExtractionSkill

衍生型別的歧視性。
configuration

技能組態的字典。
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

衍生型別的歧視性。
chunkingProperties

DocumentIntelligenceLayoutSkillChunkingProperties

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

string

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

string

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

DocumentIntelligenceLayoutSkillExtractionOptions[]

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

InputFieldMappingEntry[]

技能的輸入可以是源數據集中的數據行，或上游技能的輸出。
markdownHeaderDepth enum:
  • h1
  • h2
  • h3
  • h4
  • h5
  • h6
h6

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

string

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

控制輸出格式。 預設值為「降價」。
outputMode enum:

oneToMany

oneToMany

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

OutputFieldMappingEntry[]

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

DocumentIntelligenceLayoutSkillChunkingProperties

Object

控制區塊化內容的基數。

名稱 類型 預設值 Description
maximumLength

integer (int32)

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

integer (int32)

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

characters

characters

區塊的單位。

DocumentIntelligenceLayoutSkillExtractionOptions

列舉型別

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

值 Description
images

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

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

EntityCategory

列舉型別

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

值 Description
location

描述實體位置的實體。
organization

描述組織的實體。
person

描述一個人的實體。
quantity

描述數量的實體。
datetime

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

描述 URL 的實體。
email

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

EntityLinkingSkill

Object

利用 文字分析 API，從文字中擷取連結實體。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityLinkingSkill

衍生型別的歧視性。
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[]

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

EntityRecognitionSkillLanguage

列舉型別

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

值 Description
ar

Arabic
cs

Czech
zh-Hans

簡體中文
zh-Hant

繁體中文
da

Danish
nl

荷蘭語
en

English
fi

Finnish
fr

法語
de

德語
el

Greek
hu

Hungarian
it

義大利語
ja

日語
ko

朝鮮語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

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

葡萄牙文 (巴西)
ru

Russian
es

西班牙文
sv

Swedish
tr

Turkish

EntityRecognitionSkillV3

Object

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

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.V3.EntityRecognitionSkill

衍生型別的歧視性。
categories

EntityCategory[]

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

string

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

EntityRecognitionSkillLanguage

值，指出要使用的語言程序代碼。 預設值為 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

附加資訊。
type

string

其他資訊類型。

ErrorDetail

Object

錯誤詳細數據。

名稱 類型 Description
additionalInfo

ErrorAdditionalInfo[]

錯誤附加資訊。
code

string

錯誤碼。
details

ErrorDetail[]

錯誤詳細數據。
message

string

錯誤訊息。
target

string

錯誤目標。

ErrorResponse

Object

所有 Azure Resource Manager API 的常見錯誤回應，用於回傳失敗操作的錯誤細節。 （這也遵循 OData 錯誤回應格式。）。

名稱 類型 Description
error

ErrorDetail

錯誤物件。

ImageAnalysisSkill

Object

分析影像檔案的技能。 它會根據影像內容擷取一組豐富的視覺功能。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Vision.ImageAnalysisSkill

衍生型別的歧視性。
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

Arabic
az

亞塞拜然文
bg

Bulgarian
bs

波士尼亞文 (拉丁)
ca

加泰蘭文
cs

Czech
cy

Welsh
da

Danish
de

德語
el

Greek
en

English
es

西班牙文
et

Estonian
eu

巴斯克文
fi

Finnish
fr

法語
ga

Irish
gl

加利西亞文
he

希伯來文
hi

印地語
hr

Croatian
hu

Hungarian
id

Indonesian
it

義大利語
ja

日語
kk

Kazakh
ko

朝鮮語
lt

Lithuanian
lv

Latvian
mk

Macedonian
ms

馬來文 (馬來西亞)
nb

挪威文 (巴克摩)
nl

荷蘭語
pl

波蘭語
prs

Dari
pt-BR

葡萄牙文 (巴西)
pt

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

葡萄牙文 (葡萄牙)
ro

Romanian
ru

Russian
sk

Slovak
sl

Slovenian
sr-Cyrl

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

塞爾維亞文 (拉丁 RS)
sv

Swedish
th

Thai
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

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

KeyPhraseExtractionSkill

Object

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

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.KeyPhraseExtractionSkill

衍生型別的歧視性。
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

Danish
nl

荷蘭語
en

English
fi

Finnish
fr

法語
de

德語
it

義大利語
ja

日語
ko

朝鮮語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

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

葡萄牙文 (巴西)
ru

Russian
es

西班牙文
sv

Swedish

LanguageDetectionSkill

Object

一種技能，可偵測輸入文字的語言，並報告要求上提交之每份檔的單一語言代碼。 語言代碼會與分數配對，指出分析的信心。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.LanguageDetectionSkill

衍生型別的歧視性。
context

string

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

string

如果國家/地區代碼無法釐清語言，則為語言偵測模型的提示。
description

string

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

InputFieldMappingEntry[]

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

string

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

string

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

OutputFieldMappingEntry[]

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

MergeSkill

Object

將兩個或多個字串合併成單一統一字串的技能，選擇性的使用者定義分隔符會分隔每個元件元件元件。

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

#Microsoft.Skills.Text.MergeSkill

衍生型別的歧視性。
context

string

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

string

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

InputFieldMappingEntry[]

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

string

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

string

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

string

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

OutputFieldMappingEntry[]

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

OcrLineEnding

列舉型別

定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。

值 Description
space

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

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

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

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

OcrSkill

Object

從圖像檔擷取文字的技能。

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

#Microsoft.Skills.Vision.OcrSkill

衍生型別的歧視性。
context

string

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

OcrSkillLanguage

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

string

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

boolean

False

值，表示開啟或未開啟方向偵測。 預設值為 false。
inputs

InputFieldMappingEntry[]

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

OcrLineEnding

定義字元序列，以在 OCR 技能辨識的文字行之間使用。 預設值為 「space」。
name

string

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

OutputFieldMappingEntry[]

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

OcrSkillLanguage

列舉型別

OcrSkill 支援輸入的語言代碼。

值 Description
af

Afrikaans
sq

Albanian
anp

昂加文 (梵文字母)
ar

Arabic
ast

阿斯圖裏亞斯文
awa

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

亞塞拜然文 (拉丁)
bfy

巴哥里文
eu

巴斯克文
be

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

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

白俄羅斯文 (拉丁)
bho

博杰普爾文 - 印地文 (梵文字母)
bi

比斯拉馬文
brx

霍文 (梵文字母)
bs

波士尼亞文 (拉丁)
bra

Brajbha
br

布列塔尼文
bg

Bulgarian
bns

Bundeli
bua

布里亞特文 (斯拉夫)
ca

加泰蘭文
ceb

Cebuano
rab

查姆靈文
ch

查莫羅文
hne

恰蒂斯加爾文 (梵文字母)
zh-Hans

簡體中文
zh-Hant

繁體中文
kw

康沃耳文
co

科西嘉文
crh

克里米亞韃靼文 (拉丁)
hr

Croatian
cs

Czech
da

Danish
prs

Dari
dhi

狄摩文 (梵文字母)
doi

多格拉文 (梵文字母)
nl

荷蘭語
en

English
myv

厄爾茲亞文 (斯拉夫)
et

Estonian
fo

法羅文
fj

斐濟文
fil

Filipino
fi

Finnish
fr

法語
fur

弗魯連
gag

加告茲文 (拉丁)
gl

加利西亞文
de

德語
gil

吉里巴斯文
gon

貢德文 (梵文字母)
el

Greek
kl

格陵蘭文
gvr

古隆文 (梵文字母)
ht

海地克裏奧爾文
hlb

亥比文 (梵文字母)
hni

哈尼文
bgc

哈里亞納文
haw

夏威夷文
hi

印地語
mww

白苗文 (拉丁)
hoc

Ho（梵文）
hu

Hungarian
is

Icelandic
smn

伊納里薩米文
id

Indonesian
ia

人工國際語
iu

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

Irish
it

義大利語
ja

日語
Jns

詹薩里文 (梵文字母)
jv

爪哇文
kea

維德角文
kac

克欽文 (拉丁)
xnr

康格里文 (梵文字母)
krc

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

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

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

卡舒比文
kk-cyrl

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

哈薩克文 (拉丁)
klr

哈林文
kha

卡西文
quc

K'iche'
ko

朝鮮語
kfq

科爾庫文
kpy

科里亞克文
kos

科斯雷文
kum

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

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

庫德文 (拉丁)
kru

庫魯克文 (梵文字母)
ky

吉爾吉斯文 (斯拉夫)
lkt

拉科塔文
la

拉丁文
lt

Lithuanian
dsb

下索布文
smj

魯勒薩米文
lb

Luxembourgish
bfz

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

馬來文 (拉丁)
mt

Maltese
kmj

馬爾托文 (梵文字母)
gv

曼島文
mi

Maori
mr

Marathi
mn

蒙古文 (斯拉夫)
cnr-cyrl

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

蒙特內哥羅文 (拉丁)
nap

那不勒斯文
ne

尼泊爾文
niu

紐埃文
nog

諾蓋文
sme

北薩米文 (拉丁)
nb

挪威文
no

挪威文
oc

奧克西坦文
os

奧塞提文
ps

普什圖文
fa

Persian
pl

波蘭語
pt

Portuguese
pa

旁遮普文 (阿拉伯文)
ksh

利普里安文
ro

Romanian
rm

羅曼斯文
ru

Russian
sck

薩德里文 (梵文字母)
sm

薩摩亞文 (拉丁)
sa

梵文（梵文）
sat

桑塔利（梵城）
sco

蘇格蘭文
gd

蘇格蘭蓋爾文
sr

塞爾維亞文（拉丁文）
sr-Cyrl

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

塞爾維亞文（拉丁文）
xsr

夏爾巴文 (梵文字母)
srx

西爾毛利文 (梵文字母)
sms

斯科特薩米文
sk

Slovak
sl

Slovenian
so

索馬利文 (阿拉伯)
sma

南薩米文
es

西班牙文
sw

史瓦希里文 (拉丁)
sv

Swedish
tg

塔吉克文 (西里爾)
tt

韃靼文 (拉丁)
tet

德頓文
thf

塔米文
to

東加文
tr

Turkish
tk

土庫曼文 (拉丁)
tyv

圖瓦文
hsb

上索布文
ur

Urdu
ug

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

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

烏茲別克文 (斯拉夫)
uz

烏茲別克文 (拉丁)
vo

沃拉普克文
wae

瓦瑟文
cy

Welsh
fy

西弗里西亞文
yua

猶加敦馬雅文
za

壯文
zu

袓魯文
unk

未知（全部）

OutputFieldMappingEntry

Object

技能的輸出欄位對應。

名稱 類型 Description
name

string

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

string

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

PIIDetectionSkill

Object

使用 文字分析 API 可以從輸入文字中提取個人資訊，並提供遮蔽選項。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.PIIDetectionSkill

衍生型別的歧視性。
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。

Prefer

列舉型別

針對 HTTP PUT 要求，指示服務在成功時傳回建立/更新的資源。

值 Description
return=representation

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 資源 ID，通常格式為「/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId」，這些本應該被分配給搜尋服務。

SearchIndexerIndexProjection

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

投影定義 for store what data in Azure 檔案儲存體.

名稱 類型 Description
generatedKeyName

string

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

InputFieldMappingEntry[]

複雜投影的巢狀輸入。
referenceKeyName

string

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

string

將資料來源設為專案。
sourceContext

string

複雜投影的來源內容。
storageContainer

string

Blob 容器，以儲存投影。

SearchIndexerKnowledgeStoreObjectProjectionSelector

Object

Projection 定義 for what data to store in 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 Table storage。

SearchIndexerKnowledgeStoreTableProjectionSelector

Object

關於在 Azure Tables 中儲存哪些資料的描述。

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

SearchIndexerIndexProjection

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

SearchIndexerKnowledgeStore

對 Azure blob、表格或檔案的額外投影定義，包含豐富的資料。
name

string

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

技能集中的技能清單。

SearchResourceEncryptionKey

Object

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

名稱 類型 Description
accessCredentials.applicationId

string

一個 AAD 應用程式 ID，該 ID 被授予 Azure Key Vault 所需的存取權限，用於加密靜態資料。 應用程式標識碼不應與 AAD 應用程式的物件標識元混淆。
accessCredentials.applicationSecret

string

指定 AAD 應用程式的驗證金鑰。
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。

SentimentSkillLanguage

列舉型別

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

值 Description
da

Danish
nl

荷蘭語
en

English
fi

Finnish
fr

法語
de

德語
el

Greek
it

義大利語
no

挪威語（博克馬爾）
pl

波蘭語
pt-PT

葡萄牙文 (葡萄牙)
ru

Russian
es

西班牙文
sv

Swedish
tr

Turkish

SentimentSkillV3

Object

利用 文字分析 API，會評估非結構化文字，並為每筆紀錄提供情感標籤（如「負面」、「中立」和「正面」），這些標籤基於服務在句子和文件層級找到的最高信心分數。

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

#Microsoft.Skills.Text.V3.SentimentSkill

衍生型別的歧視性。
context

string

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

SentimentSkillLanguage

值，指出要使用的語言程序代碼。 預設值為 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

衍生型別的歧視性。
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

衍生型別的歧視性。
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

列舉型別

一個表示應該使用哪個分詞器的值。

值 Description
r50k_base

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

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

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

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

SplitSkillLanguage

列舉型別

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

值 Description
am

Amharic
bs

Bosnian
cs

Czech
da

Danish
de

德語
en

English
es

西班牙文
et

Estonian
fi

Finnish
fr

法語
he

希伯來文
hi

印地語
hr

Croatian
hu

Hungarian
id

Indonesian
is

Icelandic
it

義大利語
ja

日語
ko

朝鮮語
lv

Latvian
nb

挪威文
nl

荷蘭語
pl

波蘭語
pt

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

葡萄牙文 (巴西)
ru

Russian
sk

Slovak
sl

Slovenian
sr

塞爾維亞文
sv

Swedish
tr

Turkish
ur

Urdu
zh

中文（簡體）

SplitSkillUnit

列舉型別

指出要使用的單位的值。

值 Description
characters

長度將按字符測量。
azureOpenAITokens

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

TextSplitMode

列舉型別

值，表示要執行的分割模式。

值 Description
pages

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

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

TextTranslationSkill

Object

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

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Text.TranslationSkill

衍生型別的歧視性。
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

Afrikaans
ar

Arabic
bn

班格拉
bs

波士尼亞文 (拉丁)
bg

Bulgarian
yue

粵語 (繁體中文)
ca

加泰蘭文
zh-Hans

簡體中文
zh-Hant

繁體中文
hr

Croatian
cs

Czech
da

Danish
nl

荷蘭語
en

English
et

Estonian
fj

斐濟文
fil

Filipino
fi

Finnish
fr

法語
de

德語
el

Greek
ht

海地克裏奧爾文
he

希伯來文
hi

印地語
mww

白苗文
hu

Hungarian
is

Icelandic
id

Indonesian
it

義大利語
ja

日語
sw

Kiswahili
tlh

克林貢文
tlh-Latn

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

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

朝鮮語
lv

Latvian
lt

Lithuanian
mg

馬達加斯加文
ms

Malay
mt

Maltese
nb

挪威文
fa

Persian
pl

波蘭語
pt

Portuguese
pt-br

葡萄牙文 (巴西)
pt-PT

葡萄牙文 (葡萄牙)
otq

奎雷塔洛歐多米文
ro

Romanian
ru

Russian
sm

薩摩亞文
sr-Cyrl

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

塞爾維亞文（拉丁文）
sk

Slovak
sl

Slovenian
es

西班牙文
sv

Swedish
ty

大溪地文
ta

Tamil
te

Telugu
th

Thai
to

東加文
tr

Turkish
uk

烏克蘭文
ur

Urdu
vi

Vietnamese
cy

Welsh
yua

猶加敦馬雅文
ga

Irish
kn

Kannada
mi

Maori
ml

Malayalam
pa

Punjabi

VisionVectorizeSkill

Object

允許你使用 Azure AI Services 的 Vision Vectorize API 為特定圖片或文字輸入產生向量嵌入。

名稱 類型 Description
@odata.type string:

#Microsoft.Skills.Vision.VectorizeSkill

衍生型別的歧視性。
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

衍生型別的歧視性。
authIdentity SearchIndexerDataIdentity:

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

string

適用於連接 Azure 函式或其他提供轉換的外部程式碼的自訂技能。 這個值應該是當函式或應用程式註冊到 Azure Active Directory 時所建立的應用程式 ID。 指定時，自定義技能會使用搜尋服務的受控標識碼（系統或使用者指派）和函式或應用程式的存取令牌，使用此值作為建立存取令牌範圍的資源標識符，聯機到函式或應用程式的函式或應用程式。
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。