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

Knowledge Sources - Get

服务:: Search Service

API 版本:: 2026-08-01-preview

检索知识源定义。

GET {endpoint}/knowledgesources('{sourceName}')?api-version=2026-08-01-preview

URI 参数

名称	在	必需	类型	说明
endpoint	path	True	string (uri)	搜索服务的终结点 URL。
sourceName	path	True	string	知识源的名称。
api-version	query	True	string minLength: 1	用于此操作的 API 版本。

请求头

名称	必需	类型	说明
Accept		Accept	接受（Accept）首部。
x-ms-client-request-id		string (uuid)	请求的不透明、全局唯一的客户端生成的字符串标识符。

响应

名称	类型	说明
200 OK	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	请求已成功。
Other Status Codes	ErrorResponse	未预期的错误响应。

安全性

api-key

类型: apiKey
在: header

OAuth2Auth

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

作用域

名称	说明
https://search.azure.com/.default

示例

SearchServiceGetKnowledgeSource

SearchServiceGetKnowledgeSourceAzureBlob

SearchServiceGetKnowledgeSourceFabricDataAgent

SearchServiceGetKnowledgeSourceFabricOntology

SearchServiceGetKnowledgeSourceFile

SearchServiceGetKnowledgeSourceIndexedOneLake

SearchServiceGetKnowledgeSourceIndexedSharePoint

SearchServiceGetKnowledgeSourceIndexedSql

SearchServiceGetKnowledgeSourceMcpServer

SearchServiceGetKnowledgeSourceWeb

SearchServiceGetKnowledgeSourceWorkIQ

SearchServiceGetKnowledgeSource

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceGetKnowledgeSourceAzureBlob

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceFabricDataAgent

示例请求

HTTP

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

SearchServiceGetKnowledgeSourceFabricOntology

示例请求

HTTP

GET https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

SearchServiceGetKnowledgeSourceFile

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "ingestionPermissionOptions": [],
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceGetKnowledgeSourceIndexedOneLake

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "<redacted>",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [],
      "contentExtractionMode": "standard",
      "networkAccessMode": "public",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceIndexedSharePoint

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "public",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceIndexedSql

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "ingestionPermissionOptions": [],
      "contentExtractionMode": "minimal",
      "networkAccessMode": "public",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceMcpServer

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceGetKnowledgeSourceWeb

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

SearchServiceGetKnowledgeSourceWorkIQ

示例请求

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview

示例响应

状态代码:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

定义

名称	说明
Accept	接受（Accept）首部。
AIServices	人工智能服务的参数。
AssetStore	用于存储提取的资产（如图片）的资产存储配置。
AzureBlobKnowledgeSource	Azure Blob 存储知识源的配置。
AzureBlobKnowledgeSourceParameters	Azure Blob 存储知识源的参数。
AzureOpenAIModelName	将调用的 Azure Open AI 模型名称。
AzureOpenAIVectorizerParameters	指定用于连接到 Azure OpenAI 资源的参数。
ContentColumnMapping	将SQL列映射到搜索索引字段。
CorsOptions	定义用于控制索引的跨域资源共享（CORS）的选项。
EmbeddingColumnMapping	将SQL列映射到向量场进行嵌入。
EntraAppAuthentication	用于基于联合凭证的认证的客户拥有的 Microsoft Entra 应用注册配置。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorDetail	错误详情
ErrorResponse	所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。
FabricDataAgentKnowledgeSource	Fabric Data Agent 知识源配置。
FabricDataAgentKnowledgeSourceParameters	Fabric Data Agent 知识源参数。
FabricOntologyKnowledgeSource	Fabric 本体配置知识源。
FabricOntologyKnowledgeSourceParameters	Fabric 本体参数知识来源。
FileKnowledgeSource	支持直接文件上传和索引的文件知识源配置。
FileKnowledgeSourceParameters	文件知识来源参数。
FreshnessPolicy	用于新鲜感感知检索的配置。设置好后，新文档在检索过程中排名提升。
IndexedOneLakeKnowledgeSource	OneLake 知识源的配置。
IndexedOneLakeKnowledgeSourceParameters	OneLake 知识源的参数。
IndexedSharePointContainerName	指定要访问的 SharePoint 库。
IndexedSharePointKnowledgeSource	SharePoint 知识源的配置。
IndexedSharePointKnowledgeSourceParameters	SharePoint 知识源的参数。
IndexedSqlKnowledgeSource	索引SQL知识源配置。
IndexedSqlKnowledgeSourceParameters	索引SQL知识源的参数。
IndexingSchedule	表示索引器执行的计划。
KnowledgeBaseAzureOpenAIModel	指定用于执行查询规划的 Azure OpenAI 资源。
KnowledgeBaseModelKind	用于查询规划的 AI 模型。
KnowledgeSourceAzureOpenAIVectorizer	指定用于矢量化查询字符串的 Azure OpenAI 资源。
KnowledgeSourceIngestionParameters	合并知识源的所有常规引入设置。
KnowledgeSourceIngestionPermissionOption	文档内容的权限类型。
KnowledgeSourceKind	知识来源的那种。
KnowledgeSourceNetworkAccessMode	指定知识源摄取的网络访问模式。默认是“公开”。
KnowledgeSourceResultsProcessing	控制知识源的结果是否会被重新排序。
McpServerAuthenticationKind	类似于MCP服务器的认证方式。
McpServerAutoOutputParsing	自动检测输出格式并据此解析。
McpServerFoundryConnectionAuthentication	使用 Azure AI Foundry 连接进行身份验证。
McpServerFoundryConnectionParameters	Foundry 连接认证参数。
McpServerJsonOutputParsing	用配置好的 JSON 参数解析输出为 JSON 文档。
McpServerKnowledgeSource	由MCP（模型上下文协议）服务器支持的知识源配置。
McpServerKnowledgeSourceParameters	MCP服务器知识源的参数。
McpServerNoneOutputParsing	将输出视为一个单一块，无需解析。
McpServerOutputParsingJsonParameters	JSON 输出解析的参数。
McpServerOutputParsingKind	类似于MCP服务器工具的输出解析。
McpServerOutputParsingSplitParameters	分拆输出解析的参数。
McpServerSplitOutputParsing	用配置好的拆分参数将输出拆分成页面。
McpServerStoredHeadersAuthentication	使用存储的HTTP头进行身份验证。
McpServerStoredHeadersParameters	存储头认证参数。
McpServerTool	表示MCP服务器知识源中的单一工具。
RemoteSharePointKnowledgeSource	远程 SharePoint 知识源的配置。
RemoteSharePointKnowledgeSourceParameters	远程 SharePoint 知识源的参数。
SearchIndexerDataNoneIdentity	清除数据源的标识属性。
SearchIndexerDataUserAssignedIdentity	指定要使用的数据源的标识。
SearchIndexFieldReference	搜索索引字段参考。
SearchIndexKnowledgeSource	面向搜索索引的知识源。
SearchIndexKnowledgeSourceBoostKind	这正是搜索索引知识源的提升提示。
SearchIndexKnowledgeSourceFieldValueBoost	一个基于字段值提升文档的提示。
SearchIndexKnowledgeSourceFilterHint	一个提示，用于识别字段和代表值，查询规划器可以在构建过滤器时使用。
SearchIndexKnowledgeSourceMultiWordExpressionBoost	一个基于多词表达式提升文档的提示。
SearchIndexKnowledgeSourceParameters	搜索索引知识源的参数。
SearchIndexKnowledgeSourceQueryHints	指导查询规划的提示，使搜索索引知识源获得有用的筛选和提升。
SearchResourceEncryptionKey	Azure 密钥保管库中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。
SplitSkillLanguage	SplitSkill 支持输入文本的语言代码。
TextSplitMode	一个值，指示要执行的拆分模式。
VectorSearchVectorizerKind	查询时要使用的矢量化方法。
WebKnowledgeSource	面向 Web 结果的知识源。
WebKnowledgeSourceDomain	Web 知识源域的配置。
WebKnowledgeSourceDomains	Web 知识源的域允许/阻止配置。
WebKnowledgeSourceParameters	Web 知识源的参数。
WorkIQKnowledgeSource	WorkIQ知识源的配置。
WorkIQKnowledgeSourceParameters	WorkIQ知识源的参数。

Accept

枚举

接受（Accept）首部。

值	说明
application/json;odata.metadata=minimal

AIServices

对象

人工智能服务的参数。

名称	类型	说明
apiKey	string	用于访问 AI 服务的 API 密钥。
uri	string (uri)	AI 服务终结点的 URI。

AssetStore

对象

用于存储提取的资产（如图片）的资产存储配置。

名称	类型	说明
connectionString	string	资产存储的连接字符串。
containerName	string	资产存储中提取的资产（例如图片）的 blob 容器名称。

AzureBlobKnowledgeSource

对象

Azure Blob 存储知识源的配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
azureBlobParameters	AzureBlobKnowledgeSourceParameters	知识源的类型。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: azureBlob	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

AzureBlobKnowledgeSourceParameters

对象

Azure Blob 存储知识源的参数。

名称	类型	默认值	说明
connectionString	string		基于密钥的连接字符串或 ResourceId 格式（如果使用托管标识）。
containerName	string		Blob 存储容器的名称。
createdResources	object		由知识源创建的资源。
folderPath	string		容器内的可选文件夹路径。
ingestionParameters	KnowledgeSourceIngestionParameters		合并所有常规引入设置。
isADLSGen2	boolean	False	如果连接到 ADLS Gen2 存储帐户，请设置为 true。默认值为 false。
queryHints	SearchIndexKnowledgeSourceQueryHints		指导查询规划的默认提示，为该索引支持的知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。

AzureOpenAIModelName

枚举

将调用的 Azure Open AI 模型名称。

值	说明
text-embedding-ada-002	TextEmbeddingAda002 模型。
text-embedding-3-large	TextEmbedding3大型模型。
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模型。
gpt-5.1	GPT51型号。
gpt-5.2	GPT52型号。
gpt-5.4	GPT54型号。
gpt-5.4-mini	GPT54Mini型号。
gpt-5.4-nano	Gpt54Nano型号。
gpt-5.5	GPT55型号。
gpt-5.6-sol	GPT56Sol模型。
gpt-5.6-terra	Gpt56Terra型号。
gpt-5.6-luna	Gpt56Luna型号。

AzureOpenAIVectorizerParameters

对象

指定用于连接到 Azure OpenAI 资源的参数。

名称	类型	说明
apiKey	string	指定的 Azure OpenAI 资源的 API 密钥。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	用于出站连接的用户分配的托管标识。
deploymentId	string	指定资源上的 Azure OpenAI 模型部署的 ID。
modelName	AzureOpenAIModelName	在提供的 deploymentId 路径中部署的嵌入模型的名称。
resourceUri	string (uri)	Azure OpenAI 资源的资源 URI。

ContentColumnMapping

对象

将SQL列映射到搜索索引字段。

名称	类型	说明
name	string	目标索引字段名称。
searchFieldType	string	Azure AI 搜索字段类型（例如 Edm.String， Edm.Int32）。
sourceField	string	SQL列名。

CorsOptions

对象

定义用于控制索引的跨域资源共享（CORS）的选项。

名称	类型	说明
allowedOrigins	string[]	JavaScript 代码将被授予对索引访问权限的来源列表。可以包含 {protocol}：//{fully-qualified-domain-name}[：{port#}] 形式的主机列表，或单个“*”以允许所有源（不推荐）。
maxAgeInSeconds	integer (int64)	浏览器应缓存 CORS 预检响应的持续时间。默认为 5 分钟。

EmbeddingColumnMapping

对象

将SQL列映射到向量场进行嵌入。

名称	类型	说明
name	string	搜索索引中的目标向量场名称。
sourceField	string	SQL列作为嵌入生成的输入。

EntraAppAuthentication

对象

用于基于联合凭证的认证的客户拥有的 Microsoft Entra 应用注册配置。

名称	类型	说明
applicationId	string (uuid)	客户拥有的Entra应用注册的应用（客户端）ID。
federatedCredentialId	string (uuid)	在应用注册时配置的联合凭证ID，使搜索服务能够以应用身份认证，而无需存储客户端秘密。
tenantId	string (uuid)	应用注册时的租户ID。当应用注册与搜索服务不同的租户时，必须注册。如果省略，则使用搜索服务的租户。

ErrorAdditionalInfo

对象

资源管理错误附加信息。

名称	类型	说明
info		附加信息。
type	string	其他信息类型。

ErrorDetail

对象

错误详情

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误的附加信息。
code	string	错误代码。
details	ErrorDetail[]	错误详情。
message	string	错误消息。
target	string	错误的目标。

ErrorResponse

对象

所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式）。

名称	类型	说明
error	ErrorDetail	错误对象。

FabricDataAgentKnowledgeSource

对象

Fabric Data Agent 知识源配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Fabric Data Agent 知识源的参数。
kind	string: fabricDataAgent	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

FabricDataAgentKnowledgeSourceParameters

对象

Fabric Data Agent 知识源参数。

名称	类型	说明
dataAgentId	string	指定访问哪个 Fabric 数据代理。
workspaceId	string	Fabric工作区ID。

FabricOntologyKnowledgeSource

对象

Fabric 本体配置知识源。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Fabric 本体知识源的参数。
kind	string: fabricOntology	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

FabricOntologyKnowledgeSourceParameters

对象

Fabric 本体参数知识来源。

名称	类型	说明
ontologyId	string	用于 Fabric 工作区的本体 ID。
workspaceId	string	包含本体的 Fabric 工作空间 ID。

FileKnowledgeSource

对象

支持直接文件上传和索引的文件知识源配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
corsOptions	CorsOptions	控制文件知识源文件端点（上传、列表、更新、删除）的跨原点资源共享（CORS）选项。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
fileParameters	FileKnowledgeSourceParameters	文件知识源的参数。
kind	string: file	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

FileKnowledgeSourceParameters

对象

文件知识来源参数。

名称	类型	说明
createdResources	object	由文件知识源创建的资源。
ingestionParameters	KnowledgeSourceIngestionParameters	整合文件知识源的所有通用摄取设置，包括内容提取模式和可选的嵌入模型。
queryHints	SearchIndexKnowledgeSourceQueryHints	指导查询规划的默认提示，为该索引支持的知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。

FreshnessPolicy

对象

用于新鲜感感知检索的配置。设置好后，新文档在检索过程中排名提升。

名称	类型	说明
boostingDuration	string	ISO 8601标准的保鲜期持续时间（例如“P90D”为90天）。超过此期限的新文档在检索过程中获得排名提升。

IndexedOneLakeKnowledgeSource

对象

OneLake 知识源的配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	知识源的参数。
kind	string: indexedOneLake	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

IndexedOneLakeKnowledgeSourceParameters

对象

OneLake 知识源的参数。

名称	类型	说明
createdResources	object	由知识源创建的资源。
fabricWorkspaceId	string	OneLake 工作区 ID。
ingestionParameters	KnowledgeSourceIngestionParameters	合并所有常规引入设置。
lakehouseId	string	指定要访问的 OneLake 湖屋。
queryHints	SearchIndexKnowledgeSourceQueryHints	指导查询规划的默认提示，为该索引支持的知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。
targetPath	string	用于筛选 OneLake 内容的可选 OneLakehouse 文件夹或快捷方式。

IndexedSharePointContainerName

枚举

指定要访问的 SharePoint 库。

值	说明
defaultSiteLibrary	为网站默认文档库中的内容编制索引。
allSiteLibraries	为网站中每个文档库的内容编制索引。
useQuery	使用查询来筛选SharePoint内容。

IndexedSharePointKnowledgeSource

对象

SharePoint 知识源的配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	知识源的参数。
kind	string: indexedSharePoint	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

IndexedSharePointKnowledgeSourceParameters

对象

SharePoint 知识源的参数。

名称	类型	说明
connectionString	string	格式为：SharePointOnlineEndpoint=[SharePoint 网站 URL];ApplicationId=[Azure AD 应用 ID];ApplicationSecret=[Azure AD 应用客户端密码];TenantId=[SharePoint 网站租户 ID]
containerName	IndexedSharePointContainerName	指定要访问的 SharePoint 库。
createdResources	object	由知识源创建的资源。
ingestionParameters	KnowledgeSourceIngestionParameters	合并所有常规引入设置。
query	string	用于筛选 SharePoint 内容的可选查询。
queryHints	SearchIndexKnowledgeSourceQueryHints	指导查询规划的默认提示，为该索引支持的知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。

IndexedSqlKnowledgeSource

对象

索引SQL知识源配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	SQL知识源的参数。
kind	string: indexedSql	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

IndexedSqlKnowledgeSourceParameters

对象

索引SQL知识源的参数。

名称	类型	说明
connectionString	string	Azure SQL 数据库或 SQL 托管实例的连接字符串。
contentColumns	ContentColumnMapping[]	内容字段可选的列映射。如果省略，所有列都会自动发现。
createdResources	object	由知识源创建的资源。
embeddingColumns	EmbeddingColumnMapping[]	可选的列映射用于嵌入向量场。如果省略，则不会生成向量场。
highWaterMarkColumnName	string	可选列名用于高水位标记变化检测。如提供，使用HighWaterMarkChangeDetectionPolicy。
ingestionParameters	KnowledgeSourceIngestionParameters	整合所有通用摄取设置，包括嵌入模型、调度和身份。
queryHints	SearchIndexKnowledgeSourceQueryHints	指导查询规划的默认提示，为该索引支持的知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。
tableOrView	string	索引的表格或视图名称。可以是schema限定的（例如，'dbo.我的桌子“）。

IndexingSchedule

对象

表示索引器执行的计划。

名称	类型	说明
interval	string (duration)	索引器执行之间的时间间隔。
startTime	string (date-time)	索引器应开始运行的时间。

KnowledgeBaseAzureOpenAIModel

对象

指定用于执行查询规划的 Azure OpenAI 资源。

名称	类型	说明
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI 参数。
kind	string: azureOpenAI	用于查询规划的 AI 模型。

KnowledgeBaseModelKind

枚举

用于查询规划的 AI 模型。

值	说明
azureOpenAI	使用 Azure Open AI 模型进行查询规划。

KnowledgeSourceAzureOpenAIVectorizer

对象

指定用于矢量化查询字符串的 Azure OpenAI 资源。

名称	类型	说明
azureOpenAIParameters	AzureOpenAIVectorizerParameters	包含特定于 Azure OpenAI 嵌入矢量化的参数。
kind	string: azureOpenAI	配置为用于向量搜索的矢量化方法的名称。

KnowledgeSourceIngestionParameters

对象

合并知识源的所有常规引入设置。

名称	类型	默认值	说明
aiServices	AIServices		用于内容处理的可选 AI 服务配置。
assetStore	AssetStore		可选的资源存储配置用于存储提取的资源，如图片。
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		用于图像语言化或上下文提取的可选聊天完成模型。
contentExtractionMode	enum: minimal standard	minimal	可选的内容提取模式。默认值为“最小值”。
disableImageVerbalization	boolean	False	指示是否应禁用图像语言化。默认值为 false。
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		用于矢量化内容的可选矢量化器配置。
freshnessPolicy	FreshnessPolicy		可选的新鲜度政策，用于偏向更新文档检索。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		用于此知识源的显式标识。
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		可与文档内容一起摄取的权限类型的可选列表。如果指定，它将设置数据源的索引器权限选项。
ingestionSchedule	IndexingSchedule		数据摄取的可选计划。
networkAccessMode	KnowledgeSourceNetworkAccessMode	public	可选的网络访问模式用于摄取。设置为“私密”以便在私有执行环境中运行摄取，能够通过私有网络访问数据源和依赖。默认是“公开”。这是一个创建时间设置，知识源创建后无法更改。

KnowledgeSourceIngestionPermissionOption

枚举

文档内容的权限类型。

值	说明
userIds	引入显式用户标识符以及文档内容。
groupIds	将组标识符与文档内容一起摄取。
rbacScope	将 RBAC 范围信息与文档内容一起引入。
sensitivityLabels	在文档内容中同时获取 Microsoft Purview 敏感度标签。

KnowledgeSourceKind

枚举

知识来源的那种。

值	说明
searchIndex	从搜索索引中读取数据的知识源。
azureBlob	用于读取数据并将其从 Azure Blob 存储引入搜索索引的知识源。
indexedSharePoint	一个读取索引 SharePoint 数据的知识源。
indexedOneLake	一个读取索引 OneLake 数据的知识源。
indexedSql	一个知识源，可以从Azure SQL 数据库或SQL 托管实例获取数据到搜索索引。
web	一个从网络读取数据的知识源。
remoteSharePoint	一个读取远程SharePoint数据的知识源。
workIQ	一个读取工作智商数据的知识源
file	一个支持直接文件上传和索引的知识源。
mcpServer	一个由MCP（模型上下文协议）服务器支持的知识源。
fabricDataAgent	一个从Fabric数据代理获取数据的知识源。
fabricOntology	一个从Microsoft Fabric本体中提取数据的知识源。

KnowledgeSourceNetworkAccessMode

枚举

指定知识源摄取的网络访问模式。默认是“公开”。

值	说明
public	摄取运行在标准的、公开可访问的执行环境中。这是默认值。
private	摄取运行在私有执行环境中，因此可以通过私有网络（私有端点/共享私有链路）访问数据源和依赖。

KnowledgeSourceResultsProcessing

枚举

控制知识源的结果是否会被重新排序。

值	说明
rerank	这些知识源的成果会经过重新排序流程。这是默认行为。
none	该知识源的结果绕过重新排序，保持其底层顺序。

McpServerAuthenticationKind

枚举

类似于MCP服务器的认证方式。

值	说明
foundryConnection	使用Azure AI Foundry连接进行身份验证。
storedHeaders	使用存储的HTTP头进行认证。

McpServerAutoOutputParsing

对象

自动检测输出格式并据此解析。

名称	类型	说明
kind	string: auto	应该应用的输出解析方式。

McpServerFoundryConnectionAuthentication

对象

使用 Azure AI Foundry 连接进行身份验证。

名称	类型	说明
foundryConnectionParameters	McpServerFoundryConnectionParameters	Foundry 连接认证参数。
kind	string: foundryConnection	应该使用的认证类型。

McpServerFoundryConnectionParameters

对象

Foundry 连接认证参数。

名称	类型	说明
connectionId	string	Azure AI Foundry 连接标识符。

McpServerJsonOutputParsing

对象

用配置好的 JSON 参数解析输出为 JSON 文档。

名称	类型	说明
jsonParameters	McpServerOutputParsingJsonParameters	JSON 输出解析的参数。当类型为“json”时，必须使用。
kind	string: json	应该应用的输出解析方式。

McpServerKnowledgeSource

对象

由MCP（模型上下文协议）服务器支持的知识源配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: mcpServer	知识源的类型。
mcpServerParameters	McpServerKnowledgeSourceParameters	MCP服务器知识源的参数。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

McpServerKnowledgeSourceParameters

对象

MCP服务器知识源的参数。

名称	类型	说明
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	MCP服务器的认证配置。
serverURL	string	MCP服务器端点的URL。
tools	McpServerTool[]	在MCP服务器上调用的工具列表。

McpServerNoneOutputParsing

对象

将输出视为一个单一块，无需解析。

名称	类型	说明
kind	string: none	应该应用的输出解析方式。

McpServerOutputParsingJsonParameters

对象

JSON 输出解析的参数。

名称	类型	说明
documentsPath	string	工具输出中文档数组的JSON路径。
includeContext	boolean	是否要在提取的文档中包含JSON输出中的相关上下文。

McpServerOutputParsingKind

枚举

类似于MCP服务器工具的输出解析。

值	说明
auto	自动检测输出格式并据此解析。
json	用配置好的 JSON 参数解析输出为 JSON 文档。
split	用配置好的拆分参数将输出拆分成页面。
none	将输出视为一个单一块，无需解析。

McpServerOutputParsingSplitParameters

对象

分拆输出解析的参数。

名称	类型	说明
defaultLanguageCode	SplitSkillLanguage	一个值，该值指示要使用的语言代码。默认值为 `en`。
maximumPageLength	integer (int32)	每页字符数上限。
maximumPagesToTake	integer (int32)	从输出中取的最大页数。
pageOverlapLength	integer (int32)	页面之间重叠的字符数量。
textSplitMode	TextSplitMode	使用文本分拆模式。

McpServerSplitOutputParsing

对象

用配置好的拆分参数将输出拆分成页面。

名称	类型	说明
kind	string: split	应该应用的输出解析方式。
splitParameters	McpServerOutputParsingSplitParameters	分拆输出解析的参数。

McpServerStoredHeadersAuthentication

对象

使用存储的HTTP头进行身份验证。

名称	类型	说明
kind	string: storedHeaders	应该使用的认证类型。
storedHeadersParameters	McpServerStoredHeadersParameters	存储头认证参数。

McpServerStoredHeadersParameters

对象

存储头认证参数。

名称	类型	说明
headers	object	存储的HTTP头部要包含在MCP服务器请求中。

McpServerTool

对象

表示MCP服务器知识源中的单一工具。

名称	类型	说明
maxOutputTokens	integer (int32)	该工具输出的解析后标记上限为可选。指定时必须大于0。
name	string	要调用的 MCP 工具的名称。
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	可选配置用于解析工具输出。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该工具解析结果是否会被重新排序。未指定时默认为“重新排序”。

RemoteSharePointKnowledgeSource

对象

远程 SharePoint 知识源的配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: remoteSharePoint	知识源的类型。
name	string	知识源的名称。
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	远程SharePoint知识源的参数。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。

RemoteSharePointKnowledgeSourceParameters

对象

远程 SharePoint 知识源的参数。

名称	类型	说明
containerTypeId	string	SharePoint Embedded 连接的容器 ID。当此值为 null 时，它将使用 SharePoint Online。
filterExpression	string	关键字查询语言（KQL）表达式，其中包含可查询的 SharePoint 属性和属性，用于在查询运行之前限定检索范围。
resourceMetadata	string[]	要为响应中的每个项目返回的元数据字段列表。此列表只能包含可检索的元数据属性。默认情况下，不返回任何元数据。

SearchIndexerDataNoneIdentity

对象

清除数据源的标识属性。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	指定身份类型的 URI 片段。

SearchIndexerDataUserAssignedIdentity

对象

指定要使用的数据源的标识。

名称	类型	说明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	指定身份类型的 URI 片段。
federatedIdentityClientId	string	多租户 User-Assigned 托管身份支持：已配置为与用户分配的托管身份联合的多门户应用的客户端ID。
userAssignedIdentity	string	用户分配的托管标识的完全限定的 Azure 资源 ID 通常以“/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentity/myId”的形式分配给搜索服务。

SearchIndexFieldReference

对象

搜索索引字段参考。

名称	类型	说明
name	string	字段的名称。

SearchIndexKnowledgeSource

对象

面向搜索索引的知识源。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: searchIndex	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。
searchIndexParameters	SearchIndexKnowledgeSourceParameters	知识源的参数。

SearchIndexKnowledgeSourceBoostKind

枚举

这正是搜索索引知识源的提升提示。

值	说明
fieldValue	根据字段值提升文档。
multiWordExpression	基于多词表达式提升文档。

SearchIndexKnowledgeSourceFieldValueBoost

对象

一个基于字段值提升文档的提示。

名称	类型	说明
boost	number (double)	文档评分的乘数。必须是不等于 1.0 的正数。
boostInstructions	string	自然语言说明，说明何时以及如何应用加成。
field	string minLength: 1	搜索索引字段的名称。
fieldValues	string[]	场的代表性值。
kind	string: fieldValue	那种提升提示。

SearchIndexKnowledgeSourceFilterHint

对象

一个提示，用于识别字段和代表值，查询规划器可以在构建过滤器时使用。

名称	类型	说明
field	string minLength: 1	可筛选的搜索索引字段名称。
fieldValues	string[]	场的代表性值。
filterInstructions	string	自然语言说明，解释何时以及如何在场上过滤。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

对象

一个基于多词表达式提升文档的提示。

名称	类型	说明
boost	number (double)	文档评分的乘数。必须是不等于 1.0 的正数。
boostInstructions	string	自然语言说明，说明何时以及如何应用加成。
fieldValues	string[]	提升的代表性值。
kind	string: multiWordExpression	那种提升提示。

SearchIndexKnowledgeSourceParameters

对象

搜索索引知识源的参数。

名称	类型	说明
baseFilter	string	索引在检索时应用默认的过滤条件（例如，“状态等式 VA”）。可以通过知识源运行时参数在查询时被覆盖。
queryHints	SearchIndexKnowledgeSourceQueryHints	指导查询规划的默认提示，为该搜索索引知识源提供有用的筛选和提升。请求时查询提示取代了这些默认值，成为一个完整的对象。
searchFields	SearchIndexFieldReference[]	用于限制在搜索索引上搜索的字段。
searchIndexName	string	搜索索引的名称。
semanticConfigurationName	string	用于在目标搜索索引上指定默认语义配置以外的其他语义配置。
sourceDataFields	SearchIndexFieldReference[]	用于请求引用源数据的其他字段。

SearchIndexKnowledgeSourceQueryHints

对象

指导查询规划的提示，使搜索索引知识源获得有用的筛选和提升。

名称	类型	说明
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	提升提示，识别查询规划器可用来影响文档排名的条件。
filters	SearchIndexKnowledgeSourceFilterHint[]	筛选提示，识别字段和代表性值，查询规划器在构建筛选时可以使用。

SearchResourceEncryptionKey

对象

Azure 密钥保管库中的客户管理的加密密钥。创建和管理的密钥可用于加密或解密静态数据，例如索引和同义词映射。

名称	类型	默认值	说明
accessCredentials.applicationId	string		向 AAD 应用程序 ID 授予对静态数据加密时要使用的 Azure 密钥保管库所需的访问权限。应用程序 ID 不应与 AAD 应用程序的对象 ID 混淆。
accessCredentials.applicationSecret	string		指定的 AAD 应用程序的身份验证密钥。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		用于此加密密钥的显式托管标识。如果未指定并且访问凭据属性为 null，则使用系统分配的托管标识。更新资源时，如果未指定显式标识，则保持不变。如果指定了“none”，则清除此属性的值。
isServiceLevelKey	boolean	False	一个可选值，表示该键是否为服务级键。默认值为 false。
keyVaultKeyName	string		用于加密静态数据的 Azure 密钥保管库密钥的名称。
keyVaultKeyVersion	string		用于加密静态数据的 Azure 密钥保管库密钥的版本。
keyVaultUri	string		Azure 密钥保管库的 URI（也称为 DNS 名称），其中包含用于加密静态数据的密钥。示例 URI 可能是 `https://my-keyvault-name.vault.azure.net`。

SplitSkillLanguage

枚举

SplitSkill 支持输入文本的语言代码。

值	说明
am	阿姆哈拉语
bs	波斯尼亚语
cs	捷克语
da	丹麦语
de	German
en	English
es	Spanish
et	爱沙尼亚语
fi	芬兰语
fr	French
he	希伯来语
hi	印地语
hr	克罗地亚语
hu	匈牙利语
id	印度尼西亚语
is	Icelandic
it	Italian
ja	日语
ko	Korean
lv	拉脱维亚语
nb	挪威语
nl	荷兰语
pl	波兰语
pt	葡萄牙语（葡萄牙）
pt-br	葡萄牙语（巴西）
ru	俄语
sk	斯洛伐克语
sl	斯洛文尼亚语
sr	塞尔维亚语
sv	瑞典语
tr	土耳其语
ur	乌都语
zh	中文(简体)

TextSplitMode

枚举

一个值，指示要执行的拆分模式。

值	说明
pages	将文本拆分为单个页面。
sentences	将文本拆分为单个句子。

VectorSearchVectorizerKind

枚举

查询时要使用的矢量化方法。

值	说明
azureOpenAI	在查询时使用 Azure OpenAI 资源生成嵌入内容。
customWebApi	在查询时使用自定义 Web 终结点生成嵌入内容。
aiServicesVision	使用 Azure AI 服务视觉矢量化 API 在查询时为图像或文本输入生成嵌入。
aml	在查询时使用通过 Azure AI Foundry 模型目录部署的 Azure 机器学习终结点生成嵌入。

WebKnowledgeSource

对象

面向 Web 结果的知识源。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: web	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。
webParameters	WebKnowledgeSourceParameters	Web 知识源的参数。

WebKnowledgeSourceDomain

对象

Web 知识源域的配置。

名称	类型	说明
address	string	域的地址。
includeSubpages	boolean	是否包含来自此域的子页面。

WebKnowledgeSourceDomains

对象

Web 知识源的域允许/阻止配置。

名称	类型	说明
allowedDomains	WebKnowledgeSourceDomain[]	允许用于网页结果的域名。
blockedDomains	WebKnowledgeSourceDomain[]	被网络搜索结果屏蔽的域名。

WebKnowledgeSourceParameters

对象

Web 知识源的参数。

名称	类型	说明
count	integer (int32)	返回的默认网络结果数量。可以通过知识源运行时参数在查询时被覆盖。
domains	WebKnowledgeSourceDomains	Web 结果的域允许/阻止配置。
freshness	string	网页结果的默认新鲜度过滤器。可以通过知识源运行时参数在查询时被覆盖。
language	string	网页搜索结果的默认语言。可以通过知识源运行时参数在查询时被覆盖。
market	string	网络结果的默认市场。可以通过知识源运行时参数在查询时被覆盖。

WorkIQKnowledgeSource

对象

WorkIQ知识源的配置。

名称	类型	说明
@odata.etag	string	知识源的ETag。
description	string	可选的用户定义描述。
encryptionKey	SearchResourceEncryptionKey	描述在 Azure 密钥保管库中创建的加密密钥。当你想完全确保没有人，甚至不包括Microsoft，能解密知识源定义时，这个密钥用于为知识源定义提供额外的静止加密层。一旦你加密了知识源定义，它就会一直保持加密状态。搜索服务将忽略将此属性设置为 null 的尝试。如果你想旋转加密密钥，可以根据需要更改该属性;你的知识源定义将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于在 2019 年 1 月 1 日或之后创建的付费服务。
kind	string: workIQ	知识源的类型。
name	string	知识源的名称。
resultsProcessing	KnowledgeSourceResultsProcessing	控制该知识源的结果在纳入最终结果集前是否会被重新排序。未指定时默认为“重新排序”。
workIQParameters	WorkIQKnowledgeSourceParameters	WorkIQ知识源的参数，包括用于认证的客户拥有的Entra应用配置。

WorkIQKnowledgeSourceParameters

对象

WorkIQ知识源的参数。

名称	类型	说明
entraAppAuthentication	EntraAppAuthentication	客户拥有的 Microsoft Entra 应用注册配置，用于 Work IQ API 的身份验证。客户注册一个租户拥有的Entra应用，授予其WorkIQAgent.Ask授权权限，并配置联邦凭证，使Azure AI 搜索能够以该应用身份认证，而无需存储客户端秘密。