Knowledge Sources - Create Or Update

Dienst:
Search Service
API-Version:
2026-05-01-preview

Erstellt eine neue Wissensquelle oder aktualisiert eine Wissensquelle, wenn sie bereits vorhanden ist.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
endpoint
 path True

string (uri)

Die Endpunkt-URL des Suchdiensts.
sourceName
 path True

string

Der Name der Wissensquelle.
api-version
 query True

string

minLength: 1

Die API-Version, die für diesen Vorgang verwendet werden soll.

Anforderungsheader

Name Erforderlich Typ Beschreibung
Accept

Accept

Die Überschrift "Annehmen".
If-Match

string

Definiert die If-Match Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server mit diesem Wert übereinstimmt.
If-None-Match

string

Definiert die If-None-Match-Bedingung. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer True

Prefer

Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
x-ms-client-request-id

string (uuid)

Ein undurchsichtiger, global eindeutiger, clientgenerierter Zeichenfolgenbezeichner für die Anforderung.

Anforderungstext

Beim Anforderungstext kann es sich um eines der folgenden Elemente handeln:

Name Beschreibung
AzureBlobKnowledgeSource

Konfiguration für die Azure Blob Storage-Wissensquelle.
FabricDataAgentKnowledgeSource

Konfiguration für Fabric Data Agent-Wissensquelle.
FabricOntologyKnowledgeSource

Konfiguration für Fabric Ontology Wissensquelle.
FileKnowledgeSource

Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt.
IndexedOneLakeKnowledgeSource

Konfiguration für die OneLake-Wissensquelle.
IndexedSharePointKnowledgeSource

Konfiguration für SharePoint-Wissensquelle.
IndexedSqlKnowledgeSource

Konfiguration für indexierte SQL-Wissensquellen.
McpServerKnowledgeSource

Konfiguration für eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird.
RemoteSharePointKnowledgeSource

Konfiguration für Remote-SharePoint-Wissensquelle.
SearchIndexKnowledgeSource

Wissensquelle, die auf einen Suchindex abzielt.
WebKnowledgeSource

Wissensquelle, die auf Webergebnisse abzielt.
WorkIQKnowledgeSource

Konfiguration für WorkIQ Knowledge Source.

AzureBlobKnowledgeSource

Konfiguration für die Azure Blob Storage-Wissensquelle.

Name Erforderlich Typ Beschreibung
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

Der Typ der Wissensquelle.
kind True string:

azureBlob

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.

FabricDataAgentKnowledgeSource

Konfiguration für Fabric Data Agent-Wissensquelle.

Name Erforderlich Typ Beschreibung
fabricDataAgentParameters True

FabricDataAgentKnowledgeSourceParameters

Die Parameter für die Fabric Data Agent-Wissensquelle.
kind True string:

fabricDataAgent

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.

FabricOntologyKnowledgeSource

Konfiguration für Fabric Ontology Wissensquelle.

Name Erforderlich Typ Beschreibung
fabricOntologyParameters True

FabricOntologyKnowledgeSourceParameters

Die Parameter für die Fabric Ontology Wissensquelle.
kind True string:

fabricOntology

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

FileKnowledgeSourceParameters

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.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedOneLakeKnowledgeSourceParameters

Die Parameter für die Wissensquelle.
kind True string:

indexedOneLake

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedSharePointKnowledgeSourceParameters

Die Parameter für die Wissensquelle.
kind True string:

indexedSharePoint

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedSqlKnowledgeSourceParameters

Die Parameter für die SQL-Wissensquelle.
kind True string:

indexedSql

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.

McpServerKnowledgeSource

Konfiguration für eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird.

Name Erforderlich Typ Beschreibung
kind True string:

mcpServer

Der Typ der Wissensquelle.
mcpServerParameters True

McpServerKnowledgeSourceParameters

Die Parameter für die Wissensquelle des MCP-Servers.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.

RemoteSharePointKnowledgeSource

Konfiguration für Remote-SharePoint-Wissensquelle.

Name Erforderlich Typ Beschreibung
kind True string:

remoteSharePoint

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.
remoteSharePointParameters

RemoteSharePointKnowledgeSourceParameters

Die Parameter für die entfernte SharePoint-Wissensquelle.

SearchIndexKnowledgeSource

Wissensquelle, die auf einen Suchindex abzielt.

Name Erforderlich Typ Beschreibung
kind True string:

searchIndex

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
searchIndexParameters True

SearchIndexKnowledgeSourceParameters

Die Parameter für die Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

SearchResourceEncryptionKey

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

WebKnowledgeSourceParameters

Die Parameter für die Web-Wissensquelle.

WorkIQKnowledgeSource

Konfiguration für WorkIQ Knowledge Source.

Name Erforderlich Typ Beschreibung
kind True string:

workIQ

Der Typ der Wissensquelle.
name True

string

Der Name der Wissensquelle.
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.

Antworten

Name Typ Beschreibung
200 OK KnowledgeSource:

Die Anforderung ist erfolgreich.
201 Created KnowledgeSource:

Die Anforderung ist erfolgreich und eine neue Ressource wurde als Ergebnis erstellt.
Other Status Codes

ErrorResponse

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

SearchServiceCreateOrUpdateKnowledgeSource
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent
SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
SearchServiceCreateOrUpdateKnowledgeSourceMcpServer
SearchServiceCreateOrUpdateKnowledgeSourceWeb
SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

SearchServiceCreateOrUpdateKnowledgeSource

Beispielanforderung

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





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig"
  },
  "name": "ks-preview-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>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-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": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}
Statuscode:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-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": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Beispielanforderung

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





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-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>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
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",
    "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": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-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-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}
Statuscode:
201 
{
  "@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",
    "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": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-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-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent

Beispielanforderung

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





{
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  },
  "name": "ks-fabric-agent-test",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "kind": "fabricDataAgent",
  "@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

Statuscode:
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"
  }
}
Statuscode:
201 
{
  "@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"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology

Beispielanforderung

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





{
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  },
  "name": "ks-fabricontology-test",
  "description": "Description of the Fabric Ontology knowledge source.",
  "kind": "fabricOntology",
  "@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

Statuscode:
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"
  }
}
Statuscode:
201 
{
  "@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"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

Beispielanforderung

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





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-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>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
Statuscode:
201 
{
  "@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",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

Beispielanforderung

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





{
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-preview-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>"
    }
  }
}

Beispiel für eine Antwort

Statuscode:
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",
    "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",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}
Statuscode:
201 
{
  "@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",
    "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",
        "rbacScope"
      ],
      "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-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

Beispielanforderung

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





{
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      },
      "kind": "foundryConnection"
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          },
          "kind": "json"
        },
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096
      }
    ]
  },
  "name": "ks-preview-test",
  "description": "Description of the MCP server knowledge source.",
  "kind": "mcpServer",
  "@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

Statuscode:
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",
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}
Statuscode:
201 
{
  "@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",
        "inclusionMode": "reranked",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

Beispielanforderung

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





{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-preview-test",
  "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

Statuscode:
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",
    "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
        }
      ]
    }
  }
}
Statuscode:
201 
{
  "@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",
    "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
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

Beispielanforderung

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-workiq-test')?api-version=2026-05-01-preview





{
  "name": "ks-workiq-test",
  "description": "Description of the WorkIQ knowledge source.",
  "kind": "workIQ",
  "@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

Statuscode:
200 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-workiq-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}
Statuscode:
201 
{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-workiq-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Definitionen

Name Beschreibung
Accept

Die Überschrift "Annehmen".
AIServices

Parameter für KI-Dienste.
AssetStore

Konfiguration für einen Asset-Store, der zur Speicherung extrahierter Assets wie Bilder verwendet wird.
AzureBlobKnowledgeSource

Konfiguration für die Azure Blob Storage-Wissensquelle.
AzureBlobKnowledgeSourceParameters

Parameter für die Azure Blob Storage-Wissensquelle.
AzureOpenAIModelName

Der Name des Azure Open AI-Modells, der aufgerufen wird.
AzureOpenAIVectorizerParameters

Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.
ContentColumnMapping

Bildet eine SQL-Spalte einem Suchindexfeld zu.
EmbeddingColumnMapping

Mappt eine SQL-Spalte auf ein Vektorfeld zur Einbettung.
ErrorAdditionalInfo

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.
ErrorDetail

Die Fehlerdetails.
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.)
FabricDataAgentKnowledgeSource

Konfiguration für Fabric Data Agent-Wissensquelle.
FabricDataAgentKnowledgeSourceParameters

Parameter für Fabric Data Agent-Wissensquelle.
FabricOntologyKnowledgeSource

Konfiguration für Fabric Ontology Wissensquelle.
FabricOntologyKnowledgeSourceParameters

Parameter für Fabric Ontology Wissensquellen.
FileKnowledgeSource

Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt.
FileKnowledgeSourceParameters

Parameter für Datei-Wissensquelle.
FreshnessPolicy

Konfiguration für frischebewusste Abrufe. Wenn sie eingestellt sind, erhalten neuere Dokumente beim Abruf einen Ranking-Boost.
IndexedOneLakeKnowledgeSource

Konfiguration für die OneLake-Wissensquelle.
IndexedOneLakeKnowledgeSourceParameters

Parameter für die OneLake-Wissensquelle.
IndexedSharePointContainerName

Gibt an, auf welche SharePoint-Bibliotheken zugegriffen werden soll.
IndexedSharePointKnowledgeSource

Konfiguration für SharePoint-Wissensquelle.
IndexedSharePointKnowledgeSourceParameters

Parameter für die SharePoint-Wissensquelle.
IndexedSqlKnowledgeSource

Konfiguration für indexierte SQL-Wissensquellen.
IndexedSqlKnowledgeSourceParameters

Parameter für indexierte SQL-Wissensquellen.
IndexingSchedule

Stellt einen Zeitplan für die Indizierungsausführung dar.
KnowledgeBaseAzureOpenAIModel

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.
KnowledgeBaseModelKind

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.
KnowledgeSourceAzureOpenAIVectorizer

Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.
KnowledgeSourceIngestionParameters

Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen.
KnowledgeSourceIngestionPermissionOption

Berechtigungstypen, die zusammen mit Dokumenteninhalten aufgenommen werden.
KnowledgeSourceKind

Die Art der Wissensquelle.
McpServerAuthenticationKind

Die Art der Authentifizierung für einen MCP-Server.
McpServerAutoOutputParsing

Automatisch das Ausgabeformat erkennen und entsprechend parsen.
McpServerFoundryConnectionAuthentication

Authentifizierung über eine Azure AI Foundry -Verbindung.
McpServerFoundryConnectionParameters

Parameter für die Foundry-Verbindungsauthentifizierung.
McpServerJsonOutputParsing

Parse die Ausgabe als JSON-Dokument mit den konfigurierten JSON-Parametern.
McpServerKnowledgeSource

Konfiguration für eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird.
McpServerKnowledgeSourceParameters

Parameter für eine Wissensquelle eines MCP-Servers.
McpServerNoneOutputParsing

Behandle die Ausgabe als einen einzelnen Block ohne Parsing.
McpServerOutputParsingJsonParameters

Parameter für JSON-Ausgabeparsing.
McpServerOutputParsingKind

Die Art von Output-Parsing für ein MCP-Server-Tool.
McpServerOutputParsingSplitParameters

Parameter für geteilte Ausgabe-Parsing.
McpServerSplitOutputParsing

Teile die Ausgabe mit den konfigurierten Split-Parametern in Seiten auf.
McpServerStoredHeadersAuthentication

Authentifizierung mit gespeicherten HTTP-Headern.
McpServerStoredHeadersParameters

Parameter für die Authentifizierung gespeicherter Header.
McpServerTool

Stellt ein einzelnes Werkzeug innerhalb einer Wissensquelle des MCP-Servers dar.
McpServerToolInclusionMode

Kontrolliert, wie die analysierten MCP-Werkzeugergebnisse in das Endergebnisset integriert werden.
Prefer

Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.
RemoteSharePointKnowledgeSource

Konfiguration für Remote-SharePoint-Wissensquelle.
RemoteSharePointKnowledgeSourceParameters

Parameter für die Remote-SharePoint-Wissensquelle.
SearchIndexerDataNoneIdentity

Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataUserAssignedIdentity

Gibt die Identität für eine zu verwendende Datenquelle an.
SearchIndexFieldReference

Feldreferenz für einen Suchindex.
SearchIndexKnowledgeSource

Wissensquelle, die auf einen Suchindex abzielt.
SearchIndexKnowledgeSourceParameters

Parameter für die Wissensquelle für den Suchindex.
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.
SplitSkillLanguage

Die Sprachcodes, die von SplitSkill für Eingabetext unterstützt werden.
TextSplitMode

Ein Wert, der angibt, welcher Geteilte Modus ausgeführt werden soll.
VectorSearchVectorizerKind

Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll.
WebKnowledgeSource

Wissensquelle, die auf Webergebnisse abzielt.
WebKnowledgeSourceDomain

Konfiguration für die Web-Wissensquellendomäne.
WebKnowledgeSourceDomains

Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren.
WebKnowledgeSourceParameters

Parameter für die Web-Wissensquelle.
WorkIQKnowledgeSource

Konfiguration für WorkIQ Knowledge Source.

Accept

Enumeration

Die Überschrift "Annehmen".

Wert Beschreibung
application/json;odata.metadata=minimal

AIServices

Objekt

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.

AssetStore

Objekt

Konfiguration für einen Asset-Store, der zur Speicherung extrahierter Assets wie Bilder verwendet wird.

Name Typ Beschreibung
connectionString

string

Die Verbindungszeichenfolge für den Asset Store.
containerName

string

Der Name des Blob-Containers im Asset-Store, in dem extrahierte Assets (zum Beispiel Images) gespeichert werden.

AzureBlobKnowledgeSource

Objekt

Konfiguration für die Azure Blob Storage-Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
azureBlobParameters

AzureBlobKnowledgeSourceParameters

Der Typ der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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:

azureBlob

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

AzureBlobKnowledgeSourceParameters

Objekt

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

KnowledgeSourceIngestionParameters

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

Enumeration

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-4o

Gpt4o Modell.
gpt-4o-mini

Gpt4oMini-Modell.
gpt-4.1

Gpt41-Modell.
gpt-4.1-mini

Gpt41Mini Modell.
gpt-4.1-nano

Gpt41Nano-Modell.
gpt-5

Gpt5-Modell.
gpt-5-mini

Gpt5Mini-Modell.
gpt-5-nano

Gpt5Nano-Modell.
gpt-5.1

Gpt51 Modell.
gpt-5.2

Gpt52 Modell.
gpt-5.4

Gpt54-Modell.
gpt-5.4-mini

Gpt54Mini Modell.
gpt-5.4-nano

Gpt54Nano-Modell.
gpt-5.5

Gpt55-Modell.

AzureOpenAIVectorizerParameters

Objekt

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

AzureOpenAIModelName

Der Name des Einbettungsmodells, das im bereitgestellten deploymentId-Pfad bereitgestellt wird.
resourceUri

string (uri)

Der Ressourcen-URI der Azure OpenAI-Ressource.

ContentColumnMapping

Objekt

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.

EmbeddingColumnMapping

Objekt

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

Objekt

Zusätzliche Informationen zum Fehler bei der Ressourcenverwaltung.

Name Typ Beschreibung
info

Zusätzliche Informationen.
type

string

Typ der Zusatzinformationen.

ErrorDetail

Objekt

Die Fehlerdetails.

Name Typ Beschreibung
additionalInfo

ErrorAdditionalInfo[]

Die Zusatzinformationen zum Fehler.
code

string

Der Fehlercode.
details

ErrorDetail[]

Die Fehlerdetails.
message

string

Die Fehlermeldung.
target

string

Der Fehlerzielwert.

ErrorResponse

Objekt

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

ErrorDetail

Das Fehlerobjekt.

FabricDataAgentKnowledgeSource

Objekt

Konfiguration für Fabric Data Agent-Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.
fabricDataAgentParameters

FabricDataAgentKnowledgeSourceParameters

Die Parameter für die Fabric Data Agent-Wissensquelle.
kind string:

fabricDataAgent

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

FabricDataAgentKnowledgeSourceParameters

Objekt

Parameter für Fabric Data Agent-Wissensquelle.

Name Typ Beschreibung
dataAgentId

string

Spezifiziert, auf welchen Fabric Data Agent zugegriffen werden soll.
workspaceId

string

Fabric-Arbeitsplatz-ID.

FabricOntologyKnowledgeSource

Objekt

Konfiguration für Fabric Ontology Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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.
fabricOntologyParameters

FabricOntologyKnowledgeSourceParameters

Die Parameter für die Fabric Ontology Wissensquelle.
kind string:

fabricOntology

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

FabricOntologyKnowledgeSourceParameters

Objekt

Parameter für Fabric Ontology Wissensquellen.

Name Typ Beschreibung
ontologyId

string

Die ID der Ontologie, die aus dem Fabric-Arbeitsbereich verwendet werden soll.
workspaceId

string

Die Fabric-Arbeitsbereichs-ID, die die Ontologie enthält.

FileKnowledgeSource

Objekt

Konfiguration für Datei-Wissensquell, die direkte Datei-Upload und -Indexierung unterstützt.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

FileKnowledgeSourceParameters

Die Parameter für die Datei-Wissensquelle.
kind string:

file

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

FileKnowledgeSourceParameters

Objekt

Parameter für Datei-Wissensquelle.

Name Typ Beschreibung
createdResources

object

Ressourcen, die von der Datei-Wissensquelle erstellt werden.
ingestionParameters

KnowledgeSourceIngestionParameters

Konsolidiert alle allgemeinen Eingabeeinstellungen für die Datei-Wissensquelle, einschließlich des Inhaltsextraktionsmodus und eines optionalen EmbeddingModel.

FreshnessPolicy

Objekt

Konfiguration für frischebewusste Abrufe. Wenn sie eingestellt sind, erhalten neuere Dokumente beim Abruf einen Ranking-Boost.

Name Typ Beschreibung
boostingDuration

string

ISO 8601-Dauer für das Frischesteigerungsfenster (z. B. 'P90D' für 90 Tage). Dokumente, die jünger als diese Dauer sind, erhalten während der Abruf einen Ranking-Boost.

IndexedOneLakeKnowledgeSource

Objekt

Konfiguration für die OneLake-Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedOneLakeKnowledgeSourceParameters

Die Parameter für die Wissensquelle.
kind string:

indexedOneLake

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

IndexedOneLakeKnowledgeSourceParameters

Objekt

Parameter für die OneLake-Wissensquelle.

Name Typ Beschreibung
createdResources

object

Ressourcen, die von der Wissensquelle erstellt wurden.
fabricWorkspaceId

string

OneLake-Arbeitsbereichs-ID.
ingestionParameters

KnowledgeSourceIngestionParameters

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

Enumeration

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.

IndexedSharePointKnowledgeSource

Objekt

Konfiguration für SharePoint-Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedSharePointKnowledgeSourceParameters

Die Parameter für die Wissensquelle.
kind string:

indexedSharePoint

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

IndexedSharePointKnowledgeSourceParameters

Objekt

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

IndexedSharePointContainerName

Gibt an, auf welche SharePoint-Bibliotheken zugegriffen werden soll.
createdResources

object

Ressourcen, die von der Wissensquelle erstellt wurden.
ingestionParameters

KnowledgeSourceIngestionParameters

Konsolidiert alle allgemeinen Erfassungseinstellungen.
query

string

Optionale Abfrage zum Filtern von SharePoint-Inhalten.

IndexedSqlKnowledgeSource

Objekt

Konfiguration für indexierte SQL-Wissensquellen.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

IndexedSqlKnowledgeSourceParameters

Die Parameter für die SQL-Wissensquelle.
kind string:

indexedSql

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.

IndexedSqlKnowledgeSourceParameters

Objekt

Parameter für indexierte SQL-Wissensquellen.

Name Typ Beschreibung
connectionString

string

Die Verbindungszeichenfolge für die Azure SQL-Datenbank oder SQL Managed Instance.
contentColumns

ContentColumnMapping[]

Optionale Spaltenzuordnungen für Inhaltsfelder. Wenn sie weggelassen werden, werden alle Spalten automatisch entdeckt.
createdResources

object

Ressourcen, die von der Wissensquelle erstellt wurden.
embeddingColumns

EmbeddingColumnMapping[]

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

KnowledgeSourceIngestionParameters

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

Objekt

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

Objekt

Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.

Name Typ Beschreibung
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI parameters.
kind string:

azureOpenAI

Das KI-Modell, das für die Abfrageplanung verwendet werden soll.

KnowledgeBaseModelKind

Enumeration

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

Objekt

Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.

Name Typ Beschreibung
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Enthält die Parameter, die für die Vektorisierung der Azure OpenAI-Einbettung spezifisch sind.
kind string:

azureOpenAI

Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird.

KnowledgeSourceIngestionParameters

Objekt

Konsolidiert alle allgemeinen Erfassungseinstellungen für Wissensquellen.

Name Typ Standardwert Beschreibung
aiServices

AIServices

Optionale AI Services-Konfiguration für die Inhaltsverarbeitung.
assetStore

AssetStore

Optionale Asset-Store-Konfiguration zum Speichern extrahierter Assets wie Bilder.
chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

Optionales Chat-Vervollständigungsmodell für die Verbalisierung von Bildern oder die Extraktion von Kontexten.
contentExtractionMode enum:
  • minimal
  • standard
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:

KnowledgeSourceAzureOpenAIVectorizer

Optionale Vektorisiererkonfiguration zum Vektorisieren von Inhalten.
freshnessPolicy

FreshnessPolicy

Optionale Aktualisierungsrichtlinie zur voreingenommenen Abruf zugunsten neuerer Dokumente.
identity SearchIndexerDataIdentity:

Eine explizite Identität, die für diese Wissensquelle verwendet werden soll.
ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

Optionale Liste von Berechtigungstypen, die zusammen mit dem Dokumentinhalt aufgenommen werden sollen. Wenn angegeben, werden die Indexerberechtigungsoptionen für die Datenquelle festgelegt.
ingestionSchedule

IndexingSchedule

Optionaler Zeitplan für die Datenerfassung.

KnowledgeSourceIngestionPermissionOption

Enumeration

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.
sensitivityLabels

Führen Sie Microsoft Purview-Sensitivitätsetiketten zusammen mit Dokumentinhalten ein.

KnowledgeSourceKind

Enumeration

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.
remoteSharePoint

Eine Wissensquelle, die Daten von entferntem SharePoint liest.
workIQ

Eine Wissensquelle, die Daten aus dem Arbeits-IQ liest
file

Eine Wissensquelle, die das direkte Uploaden und Indexieren von Dateien unterstützt.
mcpServer

Eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird.
fabricDataAgent

Eine Wissensquelle, die Daten von einem Fabric Data Agent abruft.
fabricOntology

Eine Wissensquelle, die Daten aus Microsoft Fabric Ontology-Ontologien abruft.

McpServerAuthenticationKind

Enumeration

Die Art der Authentifizierung für einen MCP-Server.

Wert Beschreibung
foundryConnection

Authentifizieren Sie sich über eine Azure AI Foundry -Verbindung.
storedHeaders

Authentifiziere dich mit gespeicherten HTTP-Headern.

McpServerAutoOutputParsing

Objekt

Automatisch das Ausgabeformat erkennen und entsprechend parsen.

Name Typ Beschreibung
kind string:

auto

Die Art von Output-Parsing, die man anwenden sollte.

McpServerFoundryConnectionAuthentication

Objekt

Authentifizierung über eine Azure AI Foundry -Verbindung.

Name Typ Beschreibung
foundryConnectionParameters

McpServerFoundryConnectionParameters

Parameter für die Foundry-Verbindungsauthentifizierung.
kind string:

foundryConnection

Die Art der Authentifizierung, die man verwenden sollte.

McpServerFoundryConnectionParameters

Objekt

Parameter für die Foundry-Verbindungsauthentifizierung.

Name Typ Beschreibung
connectionId

string

Die Azure AI Foundry -Verbindungskennung.

McpServerJsonOutputParsing

Objekt

Parse die Ausgabe als JSON-Dokument mit den konfigurierten JSON-Parametern.

Name Typ Beschreibung
jsonParameters

McpServerOutputParsingJsonParameters

Parameter für JSON-Ausgabeparsing. Erforderlich, wenn Freundlichkeit 'json' ist.
kind string:

json

Die Art von Output-Parsing, die man anwenden sollte.

McpServerKnowledgeSource

Objekt

Konfiguration für eine Wissensquelle, die von einem MCP-Server (Model Context Protocol) unterstützt wird.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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:

mcpServer

Der Typ der Wissensquelle.
mcpServerParameters

McpServerKnowledgeSourceParameters

Die Parameter für die Wissensquelle des MCP-Servers.
name

string

Der Name der Wissensquelle.

McpServerKnowledgeSourceParameters

Objekt

Parameter für eine Wissensquelle eines MCP-Servers.

Name Typ Beschreibung
authentication McpServerAuthentication:

Die Authentifizierungskonfiguration für den MCP-Server.
serverURL

string

Die URL des MCP-Server-Endpunkts.
tools

McpServerTool[]

Die Liste der Werkzeuge, die auf dem MCP-Server aufgerufen werden können.

McpServerNoneOutputParsing

Objekt

Behandle die Ausgabe als einen einzelnen Block ohne Parsing.

Name Typ Beschreibung
kind string:

none

Die Art von Output-Parsing, die man anwenden sollte.

McpServerOutputParsingJsonParameters

Objekt

Parameter für JSON-Ausgabeparsing.

Name Typ Beschreibung
documentsPath

string

Der JSON-Pfad zum Array der Dokumente im Tool-Output.
includeContext

boolean

Ob der umgebende Kontext aus der JSON-Ausgabe zusammen mit extrahierten Dokumenten aufgenommen werden soll.

McpServerOutputParsingKind

Enumeration

Die Art von Output-Parsing für ein MCP-Server-Tool.

Wert Beschreibung
auto

Automatisch das Ausgabeformat erkennen und entsprechend parsen.
json

Parse die Ausgabe als JSON-Dokument mit den konfigurierten JSON-Parametern.
split

Teile die Ausgabe mit den konfigurierten Split-Parametern in Seiten auf.
none

Behandle die Ausgabe als einen einzelnen Block ohne Parsing.

McpServerOutputParsingSplitParameters

Objekt

Parameter für geteilte Ausgabe-Parsing.

Name Typ Beschreibung
defaultLanguageCode

SplitSkillLanguage

Ein Wert, der angibt, welcher Sprachcode verwendet werden soll. Der Standardwert ist en.
maximumPageLength

integer (int32)

Die maximale Anzahl an Zeichen pro Seite.
maximumPagesToTake

integer (int32)

Die maximale Anzahl an Seiten, die aus dem Output genommen werden muss.
pageOverlapLength

integer (int32)

Die Anzahl der Zeichen, die sich zwischen den Seiten überschneiden.
textSplitMode

TextSplitMode

Der Textsplit-Modus ist zu verwenden.

McpServerSplitOutputParsing

Objekt

Teile die Ausgabe mit den konfigurierten Split-Parametern in Seiten auf.

Name Typ Beschreibung
kind string:

split

Die Art von Output-Parsing, die man anwenden sollte.
splitParameters

McpServerOutputParsingSplitParameters

Parameter für geteilte Ausgabe-Parsing.

McpServerStoredHeadersAuthentication

Objekt

Authentifizierung mit gespeicherten HTTP-Headern.

Name Typ Beschreibung
kind string:

storedHeaders

Die Art der Authentifizierung, die man verwenden sollte.
storedHeadersParameters

McpServerStoredHeadersParameters

Parameter für die Authentifizierung gespeicherter Header.

McpServerStoredHeadersParameters

Objekt

Parameter für die Authentifizierung gespeicherter Header.

Name Typ Beschreibung
headers

object

Die gespeicherten HTTP-Header, die in MCP-Serveranfragen aufgenommen werden.

McpServerTool

Objekt

Stellt ein einzelnes Werkzeug innerhalb einer Wissensquelle des MCP-Servers dar.

Name Typ Beschreibung
inclusionMode

McpServerToolInclusionMode

Kontrolliert, wie die geparsten Ergebnisse dieses Werkzeugs in den Endergebnissatz integriert werden. Standardmäßig wird auf 'reranked' gesetzt, wenn nicht angegeben.
maxOutputTokens

integer (int32)

Optionales Post-Parsing-Token-Limit für die Ausgabe dieses Tools. Muss größer als 0 sein, wenn angegeben.
name

string

Der Name des zu aufrufenden MCP-Tools.
outputParsing McpServerOutputParsing:

Optionale Konfiguration zum Parsen der Ausgabe des Werkzeugs.

McpServerToolInclusionMode

Enumeration

Kontrolliert, wie die analysierten MCP-Werkzeugergebnisse in das Endergebnisset integriert werden.

Wert Beschreibung
reranked

Tool-Ergebnisse durchlaufen die Reranking- und Aggregationspipeline zusammen mit Ergebnissen aus anderen Wissensquellen. Dies ist das Standardverhalten.
always

Tool-Ergebnisse umgehen die Neubewertung und sind immer im Agentenkontext enthalten.

Prefer

Enumeration

Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Wert Beschreibung
return=representation

RemoteSharePointKnowledgeSource

Objekt

Konfiguration für Remote-SharePoint-Wissensquelle.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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:

remoteSharePoint

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.
remoteSharePointParameters

RemoteSharePointKnowledgeSourceParameters

Die Parameter für die entfernte SharePoint-Wissensquelle.

RemoteSharePointKnowledgeSourceParameters

Objekt

Parameter für die Remote-SharePoint-Wissensquelle.

Name Typ Beschreibung
containerTypeId

string

Container-ID für SharePoint Embedded-Verbindung. Wenn dieser Wert null ist, wird SharePoint Online verwendet.
filterExpression

string

KQL-Ausdruck (Keyword Query Language) mit abfragbaren SharePoint-Eigenschaften und -Attributen, um den Abruf vor der Ausführung der Abfrage zu begrenzen.
resourceMetadata

string[]

Eine Liste der Metadatenfelder, die für jedes Element in der Antwort zurückgegeben werden sollen. Nur abrufbare Metadateneigenschaften können in diese Liste aufgenommen werden. Standardmäßig werden keine Metadaten zurückgegeben.

SearchIndexerDataNoneIdentity

Objekt

Löscht die Identitätseigenschaft einer Datenquelle.

Name Typ Beschreibung
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Ein URI-Fragment, das den Typ der Identität angibt.

SearchIndexerDataUserAssignedIdentity

Objekt

Gibt die Identität für eine zu verwendende Datenquelle an.

Name Typ Beschreibung
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

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

Objekt

Feldreferenz für einen Suchindex.

Name Typ Beschreibung
name

string

Der Name des Felds.

SearchIndexKnowledgeSource

Objekt

Wissensquelle, die auf einen Suchindex abzielt.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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:

searchIndex

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.
searchIndexParameters

SearchIndexKnowledgeSourceParameters

Die Parameter für die Wissensquelle.

SearchIndexKnowledgeSourceParameters

Objekt

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

SearchIndexFieldReference[]

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

SearchIndexFieldReference[]

Wird verwendet, um zusätzliche Felder für referenzierte Quelldaten anzufordern.

SearchResourceEncryptionKey

Objekt

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 Standardwert 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.
isServiceLevelKey

boolean

False

Ein optionaler Wert, der angibt, ob dieser Schlüssel ein Service-Level-Schlüssel ist. Die Standardeinstellung ist "false".
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 https://my-keyvault-name.vault.azure.netsein.

SplitSkillLanguage

Enumeration

Die Sprachcodes, die von SplitSkill für Eingabetext unterstützt werden.

Wert Beschreibung
am

Amharic
bs

Bosnian
cs

Tschechisch
da

Dänisch
de

German
en

English
es

Spanish
et

Estonian
fi

Finnisch
fr

French
he

Hebräisch
hi

Hindi
hr

Croatian
hu

Hungarian
id

Indonesian
is

Icelandic
it

Italian
ja

Japanese
ko

Korean
lv

Latvian
nb

Norwegisch
nl

Holländisch
pl

Polnisch
pt

Portugiesisch (Portugal)
pt-br

Portugiesisch (Brasilien)
ru

Russian
sk

Slovak
sl

Slovenian
sr

Serbisch
sv

Schwedisch
tr

Türkisch
ur

Urdu
zh

Chinesisch (vereinfacht)

TextSplitMode

Enumeration

Ein Wert, der angibt, welcher Geteilte Modus ausgeführt werden soll.

Wert Beschreibung
pages

Teilen Sie den Text in einzelne Seiten auf.
sentences

Teilen Sie den Text in einzelne Sätze.

VectorSearchVectorizerKind

Enumeration

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

Objekt

Wissensquelle, die auf Webergebnisse abzielt.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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

WebKnowledgeSourceParameters

Die Parameter für die Web-Wissensquelle.

WebKnowledgeSourceDomain

Objekt

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

Objekt

Konfiguration der Domäne für Web-Wissensquelle zulassen/blockieren.

Name Typ Beschreibung
allowedDomains

WebKnowledgeSourceDomain[]

Domains, die für Webergebnisse erlaubt sind.
blockedDomains

WebKnowledgeSourceDomain[]

Domains, die aus Webergebnissen blockiert sind.

WebKnowledgeSourceParameters

Objekt

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

WebKnowledgeSourceDomains

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.

WorkIQKnowledgeSource

Objekt

Konfiguration für WorkIQ Knowledge Source.

Name Typ Beschreibung
@odata.etag

string

Die ETag der Wissensquelle.
description

string

Optionale benutzerdefinierte Beschreibung.
encryptionKey

SearchResourceEncryptionKey

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:

workIQ

Der Typ der Wissensquelle.
name

string

Der Name der Wissensquelle.