Knowledge Sources - Create
Erstellt eine neue Wissensquelle.
POST {endpoint}/knowledgesources?api-version=2026-10-01
URI-Parameter
| Name | In | Erforderlich | Typ | Beschreibung |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Die Endpunkt-URL des Suchdiensts. |
|
api-version
|
query | True |
string minLength: 1 |
Die API-Version, die für diesen Vorgang verwendet werden soll. |
Anforderungsheader
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung. |
|
| Accept |
Der Accept-Header. |
Anforderungstext
Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:
| Name | Beschreibung |
|---|---|
|
Azure |
Konfiguration für die Azure Blob Storage-Wissensquelle. |
|
File |
Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt. |
|
Indexed |
Konfiguration für die OneLake-Wissensquelle. |
|
Indexed |
Konfiguration für SharePoint-Wissensquelle. |
|
Indexed |
Konfiguration für indexierte SQL-Wissensquellen. |
|
Search |
Wissensquelle, die auf einen Suchindex abzielt. |
|
Web |
Wissensquelle, die auf Webergebnisse abzielt. |
AzureBlobKnowledgeSource
Konfiguration für die Azure Blob Storage-Wissensquelle.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| azureBlobParameters | True |
Der Typ der Wissensquelle. |
|
| kind | True |
string:
azure |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
FileKnowledgeSource
Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| fileParameters | True |
Die Parameter für die Datei-Wissensquelle. |
|
| kind | True |
string:
file |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| corsOptions |
Optionen zur Steuerung des Cross-Origin Resource Sharing (CORS) für die Dateiendpunkte der Datei-Wissensquelle (Hochladen, Listen, Aktualisieren, Löschen). |
||
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
IndexedOneLakeKnowledgeSource
Konfiguration für die OneLake-Wissensquelle.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| indexedOneLakeParameters | True |
Die Parameter für die Wissensquelle. |
|
| kind | True |
string:
indexed |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
IndexedSharePointKnowledgeSource
Konfiguration für SharePoint-Wissensquelle.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| indexedSharePointParameters | True |
Die Parameter für die Wissensquelle. |
|
| kind | True |
string:
indexed |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
IndexedSqlKnowledgeSource
Konfiguration für indexierte SQL-Wissensquellen.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| indexedSqlParameters | True |
Die Parameter für die SQL-Wissensquelle. |
|
| kind | True |
string:
indexed |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
SearchIndexKnowledgeSource
Wissensquelle, die auf einen Suchindex abzielt.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| kind | True |
string:
search |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| searchIndexParameters | True |
Die Parameter für die Wissensquelle. |
|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
WebKnowledgeSource
Wissensquelle, die auf Webergebnisse abzielt.
| Name | Erforderlich | Typ | Beschreibung |
|---|---|---|---|
| kind | True |
string:
web |
Der Typ der Wissensquelle. |
| name | True |
string |
Der Name der Wissensquelle. |
| @odata.etag |
string |
Die ETag der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
|
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
||
| webParameters |
Die Parameter für die Web-Wissensquelle. |
Antworten
| Name | Typ | Beschreibung |
|---|---|---|
| 201 Created | KnowledgeSource: |
Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt. |
| Other Status Codes |
Unerwartete Fehlerantwort. |
Sicherheit
api-key
Typ:
apiKey
In:
header
OAuth2Auth
Typ:
oauth2
Ablauf:
implicit
Autorisierungs-URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Bereiche
| Name | Beschreibung |
|---|---|
| https://search.azure.com/.default |
Beispiele
SearchServiceCreateKnowledgeSource
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the knowledge source.",
"kind": "searchIndex",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "stable-test",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'"
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "stable-test",
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
]
}
}
SearchServiceCreateKnowledgeSourceAzureBlob
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the knowledge source.",
"kind": "azureBlob",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"isADLSGen2": false,
"ingestionParameters": {
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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,
"contentExtractionMode": "standard",
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceCreateKnowledgeSourceFile
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the File knowledge source.",
"kind": "file",
"fileParameters": {
"ingestionParameters": {
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "file",
"description": "Description of the File knowledge source.",
"fileParameters": {
"ingestionParameters": {
"contentExtractionMode": "standard",
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"index": "ks-stable-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
SearchServiceCreateKnowledgeSourceIndexedOneLake
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the OneLake knowledge source.",
"kind": "indexedOneLake",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedOneLake",
"description": "Description of the OneLake knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"disableImageVerbalization": false,
"contentExtractionMode": "standard",
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateKnowledgeSourceIndexedSharePoint
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the SharePoint knowledge source.",
"kind": "indexedSharePoint",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSharePointParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "defaultSiteLibrary",
"query": "*.docx OR *.pdf",
"ingestionParameters": {
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"userIds",
"groupIds"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSharePoint",
"description": "Description of the SharePoint knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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",
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateKnowledgeSourceIndexedSql
Beispielanforderung
POST https://typespecstableexampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the SQL knowledge source.",
"kind": "indexedSql",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"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": {
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"contentExtractionMode": "minimal"
}
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSql",
"description": "Description of the SQL knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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": {
"contentExtractionMode": "minimal",
"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": "api-key",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
}
}
}
}
SearchServiceCreateKnowledgeSourceWeb
Beispielanforderung
POST https://exampleservice.search.windows.net/knowledgesources?api-version=2026-10-01
{
"webParameters": {
"domains": {
"allowedDomains": [
{
"address": "example.com",
"includeSubpages": true
},
{
"address": "another-example.com"
}
],
"blockedDomains": [
{
"address": "blocked.com"
},
{
"address": "spam.com",
"includeSubpages": true
}
]
},
"language": "en",
"market": "en-US",
"count": 10,
"freshness": "Week"
},
"name": "ks-example-index",
"description": "Description of the knowledge source.",
"kind": "web",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Beispiel für eine Antwort
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-example-index",
"kind": "web",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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
}
]
},
"language": "en",
"market": "en-US",
"count": 10,
"freshness": "Week"
}
}
Definitionen
| Name | Beschreibung |
|---|---|
| Accept |
Der Accept-Header. |
| AIServices |
Parameter für KI-Dienste. |
|
Azure |
Konfiguration für die Azure Blob Storage-Wissensquelle. |
|
Azure |
Parameter für die Azure Blob Storage-Wissensquelle. |
|
Azure |
Der Name des Azure Open AI-Modells, der aufgerufen wird. |
|
Azure |
Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an. |
|
Content |
Bildet eine SQL-Spalte einem Suchindexfeld zu. |
|
Cors |
Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index. |
|
Embedding |
Mappt eine SQL-Spalte auf ein Vektorfeld zur Einbettung. |
|
Error |
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung. |
|
Error |
Die Fehlerdetails. |
|
Error |
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.) |
|
File |
Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt. |
|
File |
Parameter für Datei-Wissensquelle. |
|
Indexed |
Konfiguration für die OneLake-Wissensquelle. |
|
Indexed |
Parameter für die OneLake-Wissensquelle. |
|
Indexed |
Gibt an, auf welche SharePoint-Bibliotheken zugegriffen werden soll. |
|
Indexed |
Konfiguration für SharePoint-Wissensquelle. |
|
Indexed |
Parameter für die SharePoint-Wissensquelle. |
|
Indexed |
Konfiguration für indexierte SQL-Wissensquellen. |
|
Indexed |
Parameter für indexierte SQL-Wissensquellen. |
|
Indexing |
Stellt einen Zeitplan für die Indizierungsausführung dar. |
|
Knowledge |
Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird. |
|
Knowledge |
Das KI-Modell, das für die Abfrageplanung verwendet werden soll. |
|
Knowledge |
Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird. |
|
Knowledge |
Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen. |
|
Knowledge |
Berechtigungstypen, die zusammen mit Dokumenteninhalten aufgenommen werden. |
|
Knowledge |
Die Art der Wissensquelle. |
|
Knowledge |
Spezifiziert den Netzwerkzugriffsmodus für die Erfassung von Wissensquellen. Standardmäßig ist 'öffentlich'. |
|
Search |
Löscht die Identitätseigenschaft einer Datenquelle. |
|
Search |
Gibt die Identität für eine zu verwendende Datenquelle an. |
|
Search |
Feldreferenz für einen Suchindex. |
|
Search |
Wissensquelle, die auf einen Suchindex abzielt. |
|
Search |
Parameter für die Wissensquelle für den Suchindex. |
|
Search |
Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen. |
|
Vector |
Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll. |
|
Web |
Wissensquelle, die auf Webergebnisse abzielt. |
|
Web |
Konfiguration für die Web-Wissensquellendomäne. |
|
Web |
Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren. |
|
Web |
Parameter für die Web-Wissensquelle. |
Accept
Der Accept-Header.
| Wert | Beschreibung |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Parameter für KI-Dienste.
| Name | Typ | Beschreibung |
|---|---|---|
| apiKey |
string |
Der API-Schlüssel für den Zugriff auf KI-Dienste. |
| uri |
string (uri) |
Der URI des AI Services-Endpunkts. |
AzureBlobKnowledgeSource
Konfiguration für die Azure Blob Storage-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| azureBlobParameters |
Der Typ der Wissensquelle. |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| kind |
string:
azure |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
AzureBlobKnowledgeSourceParameters
Parameter für die Azure Blob Storage-Wissensquelle.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| connectionString |
string |
Schlüsselbasierte Verbindungszeichenfolge oder das ResourceId-Format, wenn eine verwaltete Identität verwendet wird. |
|
| containerName |
string |
Der Name des BLOB-Speichercontainers. |
|
| createdResources |
object |
Ressourcen, die von der Wissensquelle erstellt wurden. |
|
| folderPath |
string |
Optionaler Ordnerpfad innerhalb des Containers. |
|
| ingestionParameters |
Konsolidiert alle allgemeinen Erfassungseinstellungen. |
||
| isADLSGen2 |
boolean |
False |
Legen Sie diesen Wert auf true fest, wenn eine Verbindung mit einem ADLS Gen2-Speicherkonto hergestellt wird. Die Standardeinstellung ist "false". |
AzureOpenAIModelName
Der Name des Azure Open AI-Modells, der aufgerufen wird.
| Wert | Beschreibung |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 Modell. |
| text-embedding-3-large |
TextEmbedding3Großes Modell. |
| text-embedding-3-small |
TextEmbedding3Kleines Modell. |
| gpt-5-mini |
Gpt5Mini-Modell. |
| gpt-5-nano |
Gpt5Nano-Modell. |
| gpt-5.4 |
Gpt54-Modell. |
| gpt-5.4-mini |
Gpt54Mini Modell. |
| gpt-5.4-nano |
Gpt54Nano-Modell. |
| gpt-5.5 |
Gpt55-Modell. |
| gpt-5.6-sol |
Gpt56Sol-Modell. |
| gpt-5.6-terra |
Gpt56Terra Modell. |
| gpt-5.6-luna |
Gpt56Luna Modell. |
AzureOpenAIVectorizerParameters
Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.
| Name | Typ | Beschreibung |
|---|---|---|
| apiKey |
string |
API-Schlüssel der angegebenen Azure OpenAI-Ressource. |
| authIdentity | SearchIndexerDataIdentity: |
Die vom Benutzer zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. |
| deploymentId |
string |
ID der Azure OpenAI-Modellbereitstellung für die angegebene Ressource. |
| modelName |
Der Name des Einbettungsmodells, das im bereitgestellten deploymentId-Pfad bereitgestellt wird. |
|
| resourceUri |
string (uri) |
Der Ressourcen-URI der Azure OpenAI-Ressource. |
ContentColumnMapping
Bildet eine SQL-Spalte einem Suchindexfeld zu.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Name des Zielindexfeldes. |
| searchFieldType |
string |
Azure KI-Suche field type (z.B. Edm.String, Edm.Int32). |
| sourceField |
string |
SQL-Spaltenname. |
CorsOptions
Definiert Optionen zum Steuern der cross-Origin Resource Sharing (CORS) für einen Index.
| Name | Typ | Beschreibung |
|---|---|---|
| allowedOrigins |
string[] |
Die Liste der Ursprünge, von denen aus JavaScript-Code Zugriff auf Ihren Index erhält. Kann eine Liste von Hosts in der Form {protocol}://{fully-qualified-domain-name}[:{port#}] oder ein einzelnes '*' enthalten, um alle Ursprünge zuzulassen (nicht empfohlen). |
| maxAgeInSeconds |
integer (int64) |
Die Dauer, für die Browser CORS-Preflight-Antworten zwischenspeichern sollen. Der Standardwert ist 5 Minuten. |
EmbeddingColumnMapping
Mappt eine SQL-Spalte auf ein Vektorfeld zur Einbettung.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Name des Zielvektorfeldes im Suchindex. |
| sourceField |
string |
SQL-Spalte wird als Eingabe für die Einbettungsgenerierung verwendet. |
ErrorAdditionalInfo
Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
| Name | Typ | Beschreibung |
|---|---|---|
| info |
Zusätzliche Informationen. |
|
| type |
string |
Typ der Zusatzinformationen. |
ErrorDetail
Die Fehlerdetails.
| Name | Typ | Beschreibung |
|---|---|---|
| additionalInfo |
Die Zusatzinformationen zum Fehler. |
|
| code |
string |
Der Fehlercode. |
| details |
Die Fehlerdetails. |
|
| message |
string |
Die Fehlermeldung. |
| target |
string |
Der Fehlerzielwert. |
ErrorResponse
Häufige Fehlerantwort für alle Azure Resource Manager-APIs, um Fehlerdetails für fehlgeschlagene Vorgänge zurückzugeben. (Dies folgt auch dem OData-Fehlerantwortformat.)
| Name | Typ | Beschreibung |
|---|---|---|
| error |
Das Fehlerobjekt. |
FileKnowledgeSource
Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| corsOptions |
Optionen zur Steuerung des Cross-Origin Resource Sharing (CORS) für die Dateiendpunkte der Datei-Wissensquelle (Hochladen, Listen, Aktualisieren, Löschen). |
|
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| fileParameters |
Die Parameter für die Datei-Wissensquelle. |
|
| kind |
string:
file |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
FileKnowledgeSourceParameters
Parameter für Datei-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| createdResources |
object |
Ressourcen, die von der Datei-Wissensquelle erstellt werden. |
| ingestionParameters |
Konsolidiert alle allgemeinen Eingabeeinstellungen für die Datei-Wissensquelle, einschließlich des Inhaltsextraktionsmodus und eines optionalen EmbeddingModel. |
IndexedOneLakeKnowledgeSource
Konfiguration für die OneLake-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| indexedOneLakeParameters |
Die Parameter für die Wissensquelle. |
|
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
IndexedOneLakeKnowledgeSourceParameters
Parameter für die OneLake-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| createdResources |
object |
Ressourcen, die von der Wissensquelle erstellt wurden. |
| fabricWorkspaceId |
string |
OneLake-Arbeitsbereichs-ID. |
| ingestionParameters |
Konsolidiert alle allgemeinen Erfassungseinstellungen. |
|
| lakehouseId |
string |
Gibt an, auf welches OneLake-Seehaus zugegriffen werden soll. |
| targetPath |
string |
Optionaler OneLakehouse-Ordner oder Verknüpfung zum Filtern von OneLake-Inhalten. |
IndexedSharePointContainerName
Gibt an, auf welche SharePoint-Bibliotheken zugegriffen werden soll.
| Wert | Beschreibung |
|---|---|
| defaultSiteLibrary |
Indizieren Sie Inhalte aus der Standarddokumentbibliothek der Website. |
| allSiteLibraries |
Indizieren Sie Inhalte aus jeder Dokumentbibliothek auf der Website. |
| useQuery |
Verwenden Sie eine Abfrage, um SharePoint-Inhalte zu filtern. |
| allSiteLists |
Indexieren Sie Inhalte aus jeder Liste auf der Website. |
| allSitePages |
Indexieren Sie Inhalte von jeder Seite auf der Website. |
| allSiteContent |
Inhalte aus allen unterstützten Bibliotheken, Listen und Seiten auf der Website indexieren. |
IndexedSharePointKnowledgeSource
Konfiguration für SharePoint-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| indexedSharePointParameters |
Die Parameter für die Wissensquelle. |
|
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
IndexedSharePointKnowledgeSourceParameters
Parameter für die SharePoint-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| connectionString |
string |
SharePoint-Verbindungszeichenfolge mit dem Format: SharePointOnlineEndpoint=[URL der SharePoint-Website]; ApplicationId=[Azure AD-App-ID]; ApplicationSecret=[Geheimer Clientschlüssel für Azure AD-Apps]; TenantId=[Mandanten-ID der SharePoint-Website] |
| containerName |
Gibt an, auf welche SharePoint-Bibliotheken zugegriffen werden soll. |
|
| createdResources |
object |
Ressourcen, die von der Wissensquelle erstellt wurden. |
| ingestionParameters |
Konsolidiert alle allgemeinen Erfassungseinstellungen. |
|
| query |
string |
Optionale Abfrage zum Filtern von SharePoint-Inhalten. |
IndexedSqlKnowledgeSource
Konfiguration für indexierte SQL-Wissensquellen.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| indexedSqlParameters |
Die Parameter für die SQL-Wissensquelle. |
|
| kind |
string:
indexed |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
IndexedSqlKnowledgeSourceParameters
Parameter für indexierte SQL-Wissensquellen.
| Name | Typ | Beschreibung |
|---|---|---|
| connectionString |
string |
Die Verbindungszeichenfolge für die Azure SQL-Datenbank oder SQL Managed Instance. |
| contentColumns |
Optionale Spaltenzuordnungen für Inhaltsfelder. Wenn sie weggelassen werden, werden alle Spalten automatisch entdeckt. |
|
| createdResources |
object |
Ressourcen, die von der Wissensquelle erstellt wurden. |
| embeddingColumns |
Optionale Spaltenabbildungen zum Einbetten von Vektorfeldern. Wenn sie weggelassen werden, werden keine Vektorfelder erzeugt. |
|
| highWaterMarkColumnName |
string |
Optionaler Spaltenname zur Erkennung von Veränderungen bei hohen Wassermarken. Falls vorhanden, verwenden Sie HighWaterMarkChangeDetectionPolicy. |
| ingestionParameters |
Konsolidiert alle allgemeinen Aufnahmeeinstellungen, einschließlich Einbettung von Modell, Schema und Identität. |
|
| tableOrView |
string |
Der Name der Tabelle oder Ansicht zum Indexieren. Kann schema-qualifiziert sein (z. B. 'dbo. MyTable'). |
IndexingSchedule
Stellt einen Zeitplan für die Indizierungsausführung dar.
| Name | Typ | Beschreibung |
|---|---|---|
| interval |
string (duration) |
Das Zeitintervall zwischen den Indexerausführungen. |
| startTime |
string (date-time) |
Der Zeitpunkt, zu dem die Ausführung eines Indexers gestartet werden soll. |
KnowledgeBaseAzureOpenAIModel
Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI-Parameter. |
|
| kind |
string:
azure |
Das KI-Modell, das für die Abfrageplanung verwendet werden soll. |
KnowledgeBaseModelKind
Das KI-Modell, das für die Abfrageplanung verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| azureOpenAI |
Verwenden Sie Azure Open AI-Modelle für die Abfrageplanung. |
KnowledgeSourceAzureOpenAIVectorizer
Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.
| Name | Typ | Beschreibung |
|---|---|---|
| azureOpenAIParameters |
Enthält die Parameter, die für die Vektorisierung der Azure OpenAI-Einbettung spezifisch sind. |
|
| kind |
string:
azure |
Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird. |
KnowledgeSourceIngestionParameters
Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen.
| Name | Typ | Standardwert | Beschreibung |
|---|---|---|---|
| aiServices |
Optionale AI Services-Konfiguration für die Inhaltsverarbeitung. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Optionales Chat-Vervollständigungsmodell für die Verbalisierung von Bildern oder die Extraktion von Kontexten. |
|
| contentExtractionMode |
enum:
|
minimal |
Optionaler Modus zur Extraktion von Inhalten. Der Standardwert ist 'minimal'. |
| disableImageVerbalization |
boolean |
False |
Gibt an, ob die Bildverbalisierung deaktiviert werden soll. Die Standardeinstellung ist "false". |
| embeddingModel | KnowledgeSourceVectorizer: |
Optionale Vektorisiererkonfiguration zum Vektorisieren von Inhalten. |
|
| identity | SearchIndexerDataIdentity: |
Eine explizite Identität, die für diese Wissensquelle verwendet werden soll. |
|
| ingestionPermissionOptions |
Optionale Liste von Berechtigungstypen, die zusammen mit dem Dokumentinhalt aufgenommen werden sollen. Wenn angegeben, werden die Indexerberechtigungsoptionen für die Datenquelle festgelegt. |
||
| ingestionSchedule |
Optionaler Zeitplan für die Datenerfassung. |
||
| networkAccessMode | public |
Optionaler Netzwerkzugriffsmodus zur Aufnahme. Auf 'privat' gestellt, um die Eingabe in einer privaten Ausführungsumgebung durchzuführen, die Datenquellen und Abhängigkeiten über ein privates Netzwerk erreichen kann. Standardmäßig ist 'öffentlich'. Dies ist eine Erstellungszeit-Einstellung und kann nach der Erstellung der Wissensquelle nicht mehr geändert werden. |
KnowledgeSourceIngestionPermissionOption
Berechtigungstypen, die zusammen mit Dokumenteninhalten aufgenommen werden.
| Wert | Beschreibung |
|---|---|
| userIds |
Erfassen Sie explizite Benutzerkennungen zusammen mit Dokumentinhalten. |
| groupIds |
Erfassen Sie Gruppenkennungen zusammen mit Dokumentinhalten. |
| rbacScope |
Erfassen Sie RBAC-Bereichsinformationen zusammen mit Dokumentinhalten. |
KnowledgeSourceKind
Die Art der Wissensquelle.
| Wert | Beschreibung |
|---|---|
| searchIndex |
Eine Wissensquelle, die Daten aus einem Suchindex liest. |
| azureBlob |
Eine Wissensquelle, die Daten aus Azure Blob Storage liest und in einem Suchindex erfasst. |
| indexedSharePoint |
Eine Wissensquelle, die Daten von indexiertem SharePoint liest. |
| indexedOneLake |
Eine Wissensquelle, die Daten von indexierten OneLake ausliest. |
| indexedSql |
Eine Wissensquelle, die Daten aus der Azure SQL-Datenbank oder der SQL Managed Instance in einen Search Index abruft und aufnimmt. |
| web |
Eine Wissensquelle, die Daten aus dem Web liest. |
| file |
Eine Wissensquelle, die das direkte Uploaden und Indexieren von Dateien unterstützt. |
KnowledgeSourceNetworkAccessMode
Spezifiziert den Netzwerkzugriffsmodus für die Erfassung von Wissensquellen. Standardmäßig ist 'öffentlich'.
| Wert | Beschreibung |
|---|---|
| public |
Die Aufnahme läuft in der standardisierten, öffentlich erreichbaren Ausführungsumgebung. Dies ist die Standardoption. |
| private |
Die Eingabe läuft in einer privaten Ausführungsumgebung, sodass Datenquellen und Abhängigkeiten über ein privates Netzwerk (privater Endpunkt / geteilte private Verbindung) erreicht werden können. |
SearchIndexerDataNoneIdentity
Löscht die Identitätseigenschaft einer Datenquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ein URI-Fragment, das den Typ der Identität angibt. |
SearchIndexerDataUserAssignedIdentity
Gibt die Identität für eine zu verwendende Datenquelle an.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ein URI-Fragment, das den Typ der Identität angibt. |
| federatedIdentityClientId |
string |
Multi-Tenant User-Assigned Managed Identity Support: Die Client-ID der Multi-Tentant-App, die so konfiguriert wurde, dass sie mit der vom Benutzer zugewiesenen verwalteten Identität föderiert. |
| userAssignedIdentity |
string |
Die vollqualifizierte Azure-Ressourcen-ID einer vom Benutzer zugewiesenen verwalteten Identität in der Regel im Format "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", die dem Suchdienst zugewiesen werden sollen. |
SearchIndexFieldReference
Feldreferenz für einen Suchindex.
| Name | Typ | Beschreibung |
|---|---|---|
| name |
string |
Der Name des Felds. |
SearchIndexKnowledgeSource
Wissensquelle, die auf einen Suchindex abzielt.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| kind |
string:
search |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
| searchIndexParameters |
Die Parameter für die Wissensquelle. |
SearchIndexKnowledgeSourceParameters
Parameter für die Wissensquelle für den Suchindex.
| Name | Typ | Beschreibung |
|---|---|---|
| baseFilter |
string |
Eine Standard-Filterbedingung, die beim Abruf auf den Index angewendet wird (z. B. 'State eq VA'). Kann zur Abfragezeit über Knowledge Source Laufzeitparameter überschrieben werden. |
| searchFields |
Wird verwendet, um einzuschränken, welche Felder im Suchindex durchsucht werden sollen. |
|
| searchIndexName |
string |
Der Name des Suchindexes. |
| semanticConfigurationName |
string |
Wird verwendet, um eine andere semantische Konfiguration für den Zielsuchindex als die Standardkonfiguration anzugeben. |
| sourceDataFields |
Wird verwendet, um zusätzliche Felder für referenzierte Quelldaten anzufordern. |
SearchResourceEncryptionKey
Ein vom Kunden verwalteter Verschlüsselungsschlüssel im Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.
| Name | Typ | Beschreibung |
|---|---|---|
| accessCredentials.applicationId |
string |
Eine AAD-Anwendungs-ID, die die erforderlichen Zugriffsberechtigungen für den Azure Key Vault erteilt hat, die beim Verschlüsseln Ihrer ruhenden Daten verwendet werden sollen. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden. |
| accessCredentials.applicationSecret |
string |
Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung. |
| identity | SearchIndexerDataIdentity: |
Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn diese Eigenschaft nicht angegeben ist und die Eigenschaft für Zugriffsanmeldeinformationen null ist, wird die vom System zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität nicht angegeben ist, bleibt die Aktualisierung der Ressource unverändert. Wenn "none" angegeben wird, wird der Wert dieser Eigenschaft gelöscht. |
| keyVaultKeyName |
string |
Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. |
| keyVaultKeyVersion |
string |
Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. |
| keyVaultUri |
string |
Der URI Ihres Azure Key Vault, auch als DNS-Name bezeichnet, der den Schlüssel enthält, der zum Verschlüsseln Ihrer ruhenden Daten verwendet werden soll. Ein Beispiel-URI kann |
VectorSearchVectorizerKind
Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll.
| Wert | Beschreibung |
|---|---|
| azureOpenAI |
Generieren Sie Einbettungen mithilfe einer Azure OpenAI-Ressource zur Abfragezeit. |
| customWebApi |
Generieren Sie Einbettungen mithilfe eines benutzerdefinierten Webendpunkts zur Abfragezeit. |
| aiServicesVision |
Generieren Sie Einbettungen für ein Bild oder eine Texteingabe zur Abfragezeit mithilfe der Azure AI Services Vision Vectorize-API. |
| aml |
Generieren Sie Einbettungen mithilfe eines Azure Machine Learning-Endpunkts, der zur Abfragezeit über den Azure AI Foundry -Modellkatalog bereitgestellt wird. |
WebKnowledgeSource
Wissensquelle, die auf Webergebnisse abzielt.
| Name | Typ | Beschreibung |
|---|---|---|
| @odata.etag |
string |
Die ETag der Wissensquelle. |
| description |
string |
Optionale benutzerdefinierte Beschreibung. |
| encryptionKey |
Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel dient dazu, eine zusätzliche Ebene der Verschlüsselung im Ruhezustand für die Definition Ihrer Wissensquelle bereitzustellen, wenn Sie die volle Gewissheit wünschen, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Sobald Sie Ihre Definition Ihrer Wissensquelle verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Du kannst diese Eigenschaft nach Bedarf ändern, wenn du deinen Verschlüsselungsschlüssel drehen möchtest; Deine Definition der Wissensquelle bleibt unverändert. Verschlüsselung mit vom Kunden verwalteten Schlüsseln steht nicht für kostenlose Suchdienste zur Verfügung und ist nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden. |
|
| kind |
string:
web |
Der Typ der Wissensquelle. |
| name |
string |
Der Name der Wissensquelle. |
| webParameters |
Die Parameter für die Web-Wissensquelle. |
WebKnowledgeSourceDomain
Konfiguration für die Web-Wissensquellendomäne.
| Name | Typ | Beschreibung |
|---|---|---|
| address |
string |
Die Adresse der Domain. |
| includeSubpages |
boolean |
Ob Unterseiten aus dieser Domain eingebunden werden sollen oder nicht. |
WebKnowledgeSourceDomains
Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren.
| Name | Typ | Beschreibung |
|---|---|---|
| allowedDomains |
Domains, die für Webergebnisse erlaubt sind. |
|
| blockedDomains |
Domains, die aus Webergebnissen blockiert sind. |
WebKnowledgeSourceParameters
Parameter für die Web-Wissensquelle.
| Name | Typ | Beschreibung |
|---|---|---|
| count |
integer (int32) |
Die Standardanzahl der Webergebnisse, die zurückgegeben werden sollen. Kann zur Abfragezeit über Knowledge Source Laufzeitparameter überschrieben werden. |
| domains |
Konfiguration des Zulassens/Blockierens von Domänen für Webergebnisse. |
|
| freshness |
string |
Der Standard-Frischefilter für Web-Ergebnisse. Kann zur Abfragezeit über Knowledge Source Laufzeitparameter überschrieben werden. |
| language |
string |
Die Standardsprache für Webergebnisse. Kann zur Abfragezeit über Knowledge Source Laufzeitparameter überschrieben werden. |
| market |
string |
Der Standardmarkt für Webergebnisse. Kann zur Abfragezeit über Knowledge Source Laufzeitparameter überschrieben werden. |