Knowledge Sources - Create Or Update

Dienst:: Search Service

API-Version:: 2025-08-01-preview

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

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
endpoint	path	True	string	Die Endpunkt-URL des Suchdiensts.
sourceName	path	True	string	Der Name der Wissensquelle, die erstellt oder aktualisiert werden soll.
api-version	query	True	string	Version der Client-API.

Anforderungsheader

Name	Erforderlich	Typ	Beschreibung
x-ms-client-request-id		string (uuid)	Die Nachverfolgungs-ID, die mit der Anforderung gesendet wird, um das Debuggen zu unterstützen.
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 Bedingung Wenn-None-Match. Der Vorgang wird nur ausgeführt, wenn das ETag auf dem Server nicht mit diesem Wert übereinstimmt.
Prefer	True	string	Weist den Dienst bei HTTP PUT-Anforderungen an, die erstellte/aktualisierte Ressource bei Erfolg zurückzugeben.

Anforderungstext

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

Name	Beschreibung
AzureBlobKnowledgeSource	Konfiguration für die Azure Blob Storage-Wissensquelle.
SearchIndexKnowledgeSource	Wissensquelle, die auf einen Suchindex abzielt.

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	Das ETag des Agenten.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Agent-Definition bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Agentendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Agentendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.

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	Das ETag des Agenten.
description		string	Optionale benutzerdefinierte Beschreibung.
encryptionKey		SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Agent-Definition bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Agentendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Agentendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, die am oder nach dem 1. Januar 2019 erstellt wurden.

Antworten

Name	Typ	Beschreibung
200 OK	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
201 Created	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
Other Status Codes	ErrorResponse	Fehlerantwort.

Beispiele

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSource

Beispielanforderung

HTTP

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





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataSelect": "description,category"
  },
  "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",
    "sourceDataSelect": "description,category"
  }
}

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",
    "sourceDataSelect": "description,category"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

Beispielanforderung

HTTP

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





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

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",
    "disableImageVerbalization": false,
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "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"
    }
  }
}

Definitionen

Name	Beschreibung
AIFoundryModelCatalogName	Der Name des Einbettungsmodells aus dem Azure AI Foundry-Katalog, das aufgerufen wird.
AIServicesVisionParameters	Gibt die AI Services Vision-Parameter für die Vektorisierung einer Abfrage, eines Bildes oder eines Textes an.
AIServicesVisionVectorizer	Gibt die AI Services Vision-Parameter für die Vektorisierung einer Abfrage, eines Bildes oder eines Textes an.
AMLParameters	Gibt die Eigenschaften für die Verbindung mit einem AML-Vektorisierer an.
AMLVectorizer	Gibt einen Azure Machine Learning-Endpunkt an, der über den Azure AI Foundry-Modellkatalog zum Generieren der Vektoreinbettung einer Abfragezeichenfolge bereitgestellt wird.
AzureActiveDirectoryApplicationCredentials	Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.
AzureBlobKnowledgeSource	Konfiguration für die Azure Blob Storage-Wissensquelle.
AzureBlobKnowledgeSourceParameters	Parameter für die Azure Blob Storage-Wissensquelle.
AzureOpenAIEmbeddingSkill	Ermöglicht das Generieren einer Vektoreinbettung für eine bestimmte Texteingabe mithilfe der Azure OpenAI-Ressource.
AzureOpenAIModelName	Der Name des Azure Open AI-Modells, der aufgerufen wird.
AzureOpenAIParameters	Gibt die Parameter für die Verbindung mit der Azure OpenAI-Ressource an.
AzureOpenAIVectorizer	Gibt die Azure OpenAI-Ressource an, die zum Vektorisieren einer Abfragezeichenfolge verwendet wird.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
IndexingSchedule	Stellt einen Zeitplan für die Indexerausführung dar.
InputFieldMappingEntry	Zuordnung von Eingabefeldern für einen Skill.
KnowledgeAgentAzureOpenAIModel	Gibt die Azure OpenAI-Ressource an, die für die Abfrageplanung verwendet wird.
KnowledgeAgentModelKind	Das KI-Modell, das für die Abfrageplanung verwendet werden soll.
KnowledgeSourceKind	Die Art der Wissensquelle.
OutputFieldMappingEntry	Ausgabefeldzuordnung für einen Skill.
SearchIndexerDataNoneIdentity	Löscht die Identitätseigenschaft einer Datenquelle.
SearchIndexerDataUserAssignedIdentity	Gibt die Identität an, die von einer Datenquelle verwendet werden soll.
SearchIndexKnowledgeSource	Wissensquelle, die auf einen Suchindex abzielt.
SearchIndexKnowledgeSourceParameters	Parameter für die Wissensquelle für den Suchindex.
SearchResourceEncryptionKey	Ein kundenseitig verwalteter Verschlüsselungsschlüssel in 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.
VectorSearchVectorizerKind	Die Vektorisierungsmethode, die während der Abfragezeit verwendet werden soll.
WebApiParameters	Gibt die Eigenschaften für die Verbindung mit einem benutzerdefinierten Vektorisierer an.
WebApiVectorizer	Gibt einen benutzerdefinierten Vektorisierer zum Generieren der Vektoreinbettung einer Abfragezeichenfolge an. Die Integration eines externen Vektorisierers erfolgt über die benutzerdefinierte Web-API-Schnittstelle eines Skillsets.

AIFoundryModelCatalogName

Enumeration

Der Name des Einbettungsmodells aus dem Azure AI Foundry-Katalog, das aufgerufen wird.

Wert	Beschreibung
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english
Cohere-embed-v3-multilingual
Cohere-embed-v4	Cohere Embed v4-Modell zum Generieren von Einbettungen aus Text und Bildern.

AIServicesVisionParameters

Objekt

Gibt die AI Services Vision-Parameter für die Vektorisierung einer Abfrage, eines Bildes oder eines Textes an.

Name	Typ	Beschreibung
apiKey	string	API-Schlüssel der angegebenen AI Services-Ressource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId angegeben und nicht angegeben wird, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn bei Aktualisierungen des Indexes die Identität nicht angegeben ist, bleibt der Wert unverändert. Wenn der Wert auf "none" festgelegt ist, wird der Wert dieser Eigenschaft gelöscht.
modelVersion	string	Die Version des Modells, die beim Aufrufen des AI Services Vision-Diensts verwendet werden soll. Wenn nicht angegeben, wird standardmäßig die neueste verfügbare Version verwendet.
resourceUri	string (uri)	Der Ressourcen-URI der AI Services-Ressource.

AIServicesVisionVectorizer

Objekt

Gibt die AI Services Vision-Parameter für die Vektorisierung einer Abfrage, eines Bildes oder eines Textes an.

Name	Typ	Beschreibung
aiServicesVisionParameters	AIServicesVisionParameters	Enthält die Parameter, die für die Vektorisierung der Einbettung von AI Services Vision spezifisch sind.
kind	string: aiServicesVision	Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird.
name	string	Der Name, der dieser bestimmten Vektorisierungsmethode zugeordnet werden soll.

AMLParameters

Objekt

Gibt die Eigenschaften für die Verbindung mit einem AML-Vektorisierer an.

Name	Typ	Beschreibung
key	string	(Erforderlich für die Schlüsselauthentifizierung) Der Schlüssel für den AML-Dienst.
modelName	AIFoundryModelCatalogName	Der Name des Einbettungsmodells aus dem Azure AI Foundry-Katalog, das am angegebenen Endpunkt bereitgestellt wird.
region	string	(Optional für die Tokenauthentifizierung). Die Region, in der der AML-Dienst bereitgestellt wird.
resourceId	string	(Erforderlich für die Tokenauthentifizierung). Die Azure Resource Manager-Ressourcen-ID des AML-Diensts. Er sollte das Format subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name} haben.
timeout	string (duration)	(Fakultativ) Wenn angegeben, gibt es die Zeitüberschreitung für den HTTP-Client, der den API-Aufruf ausführt.
uri	string (uri)	(Erforderlich für keine Authentifizierung oder Schlüsselauthentifizierung) Der Bewertungs-URI des AML-Diensts, an den die JSON-Nutzlast gesendet wird. Nur das https-URI-Schema ist zulässig.

AMLVectorizer

Objekt

Gibt einen Azure Machine Learning-Endpunkt an, der über den Azure AI Foundry-Modellkatalog zum Generieren der Vektoreinbettung einer Abfragezeichenfolge bereitgestellt wird.

Name	Typ	Beschreibung
amlParameters	AMLParameters	Gibt die Eigenschaften des AML-Vektorisierers an.
kind	string: aml	Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird.
name	string	Der Name, der dieser bestimmten Vektorisierungsmethode zugeordnet werden soll.

AzureActiveDirectoryApplicationCredentials

Objekt

Anmeldeinformationen einer registrierten Anwendung, die für Ihren Suchdienst erstellt wurde und für den authentifizierten Zugriff auf die in Azure Key Vault gespeicherten Verschlüsselungsschlüssel verwendet wird.

Name	Typ	Beschreibung
applicationId	string	Eine AAD-Anwendungs-ID, der die erforderlichen Zugriffsberechtigungen für Azure Key Vault erteilt wurden, die beim Verschlüsseln ruhender Daten verwendet werden soll. Die Anwendungs-ID sollte nicht mit der Objekt-ID für Ihre AAD-Anwendung verwechselt werden.
applicationSecret	string	Der Authentifizierungsschlüssel der angegebenen AAD-Anwendung.

AzureBlobKnowledgeSource

Objekt

Konfiguration für die Azure Blob Storage-Wissensquelle.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag des Agenten.
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 wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Agent-Definition bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Agentendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Agentendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, 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	Beschreibung
chatCompletionModel	KnowledgeAgentModel: KnowledgeAgentAzureOpenAIModel	Optionales Chat-Vervollständigungsmodell für die Verbalisierung von Bildern oder die Extraktion von Kontexten.
connectionString	string	Schlüsselbasierte Verbindungszeichenfolge oder das ResourceId-Format, wenn eine verwaltete Identität verwendet wird.
containerName	string	Der Name des Blob Storage-Containers.
createdResources	object	Ressourcen, die von der Wissensquelle erstellt wurden.
disableImageVerbalization	boolean	Gibt an, ob die Bildverbalisierung deaktiviert werden soll.
embeddingModel	VectorSearchVectorizer: AIServicesVisionVectorizer AMLVectorizer AzureOpenAIVectorizer WebApiVectorizer	Optionale Vektorisiererkonfiguration zum Vektorisieren von Inhalten.
folderPath	string	Optionaler Ordnerpfad innerhalb des Containers.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite Identität, die für diese Wissensquelle verwendet werden soll.
ingestionSchedule	IndexingSchedule	Optionaler Zeitplan für die Datenerfassung.

AzureOpenAIEmbeddingSkill

Objekt

Ermöglicht das Generieren einer Vektoreinbettung für eine bestimmte Texteingabe mithilfe der Azure OpenAI-Ressource.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Ein URI-Fragment, das den Typ des Skills angibt.
apiKey	string	API-Schlüssel der angegebenen Azure OpenAI-Ressource.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird.
context	string	Stellt die Ebene dar, auf der Vorgänge ausgeführt werden, z. B. der Dokumentstamm oder der Dokumentinhalt (z. B. /document oder /document/content). Der Standardwert ist /document.
deploymentId	string	ID der Bereitstellung des Azure OpenAI-Modells für die angegebene Ressource.
description	string	Die Beschreibung des Skills, die die Eingaben, Ausgaben und die Verwendung des Skills beschreibt.
dimensions	integer (int32)	Die Anzahl der Dimensionen, die die resultierenden Ausgabeeinbettungen aufweisen sollen. Wird nur in text-embedding-3 und höheren Modellen unterstützt.
inputs	InputFieldMappingEntry[]	Bei der Eingabe der Fertigkeiten kann es sich um eine Spalte im Quelldatensatz oder um die Ausgabe einer vorgelagerten Fertigkeit handeln.
modelName	AzureOpenAIModelName	Der Name des Einbettungsmodells, das unter dem angegebenen deploymentId-Pfad bereitgestellt wird.
name	string	Der Name des Skills, der ihn innerhalb des Skillssets eindeutig identifiziert. Ein Skill, für den kein Name definiert ist, erhält einen Standardnamen seines 1-basierten Index im skills-Array mit dem Präfix "#".
outputs	OutputFieldMappingEntry[]	Die Ausgabe eines Skills ist entweder ein Feld in einem Suchindex oder ein Wert, der von einem anderen Skill als Eingabe verwendet werden kann.
resourceUri	string (uri)	Der Ressourcen-URI der Azure OpenAI-Ressource.

AzureOpenAIModelName

Enumeration

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

Wert	Beschreibung
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAIParameters

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: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird.
deploymentId	string	ID der Bereitstellung des Azure OpenAI-Modells für die angegebene Ressource.
modelName	AzureOpenAIModelName	Der Name des Einbettungsmodells, das unter dem angegebenen deploymentId-Pfad bereitgestellt wird.
resourceUri	string (uri)	Der Ressourcen-URI der Azure OpenAI-Ressource.

AzureOpenAIVectorizer

Objekt

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

Name	Typ	Beschreibung
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	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.
name	string	Der Name, der dieser bestimmten Vektorisierungsmethode zugeordnet werden soll.

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

IndexingSchedule

Objekt

Stellt einen Zeitplan für die Indexerausfü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.

InputFieldMappingEntry

Objekt

Zuordnung von Eingabefeldern für einen Skill.

Name	Typ	Beschreibung
inputs	InputFieldMappingEntry[]	Die rekursiven Eingaben, die beim Erstellen eines komplexen Typs verwendet werden.
name	string	Der Name der Eingabe.
source	string	Die Quelle der Eingabe.
sourceContext	string	Der Quellkontext, der zum Auswählen rekursiver Eingaben verwendet wird.

KnowledgeAgentAzureOpenAIModel

Objekt

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

Name	Typ	Beschreibung
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Enthält die Parameter, die für den Azure OpenAI-Modellendpunkt spezifisch sind.
kind	string: azureOpenAI	Die Art des KI-Modells.

KnowledgeAgentModelKind

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.

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.

OutputFieldMappingEntry

Objekt

Ausgabefeldzuordnung für einen Skill.

Name	Typ	Beschreibung
name	string	Der Name der Ausgabe, der durch den Skill definiert wird.
targetName	string	Der Zielname der Ausgabe. Es ist optional und standardmäßig name.

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 an, die von einer Datenquelle verwendet werden soll.

Name	Typ	Beschreibung
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Ein URI-Fragment, das den Typ der Identität angibt.
userAssignedIdentity	string	Die vollqualifizierte Azure-Ressourcen-ID einer benutzerseitig 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 hätte zugewiesen werden sollen.

SearchIndexKnowledgeSource

Objekt

Wissensquelle, die auf einen Suchindex abzielt.

Name	Typ	Beschreibung
@odata.etag	string	Das ETag des Agenten.
description	string	Optionale benutzerdefinierte Beschreibung.
encryptionKey	SearchResourceEncryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Ebene der Verschlüsselung ruhender Daten für Ihre Agent-Definition bereitzustellen, wenn Sie die vollständige Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, sie entschlüsseln kann. Nachdem Sie Ihre Agentendefinition verschlüsselt haben, bleibt sie immer verschlüsselt. Der Suchdienst ignoriert Versuche, diese Eigenschaft auf null festzulegen. Sie können diese Eigenschaft nach Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Agentendefinition ist davon nicht betroffen. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste, 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
searchIndexName	string	Der Name des Suchindexes.
sourceDataSelect	string	Wird verwendet, um zusätzliche Felder für referenzierte Quelldaten anzufordern.

SearchResourceEncryptionKey

Objekt

Ein kundenseitig verwalteter Verschlüsselungsschlüssel in Azure Key Vault. Schlüssel, die Sie erstellen und verwalten, können zum Verschlüsseln oder Entschlüsseln ruhender Daten verwendet werden, z. B. Indizes und Synonymzuordnungen.

Name	Typ	Beschreibung
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionale Azure Active Directory-Anmeldeinformationen, die für den Zugriff auf Ihren Azure Key Vault verwendet werden. Nicht erforderlich, wenn stattdessen eine verwaltete Identität verwendet wird.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Eine explizite verwaltete Identität, die für diesen Verschlüsselungsschlüssel verwendet werden soll. Wenn nicht angegeben und die Eigenschaft für die Zugriffsanmeldeinformationen null ist, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn die explizite Identität beim Aktualisieren der Ressource nicht angegeben ist, bleibt sie unverändert. Wenn "none" angegeben ist, wird der Wert dieser Eigenschaft gelöscht.
keyVaultKeyName	string	Der Name Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultKeyVersion	string	Die Version Ihres Azure Key Vault-Schlüssels, der zum Verschlüsseln ruhender Daten verwendet werden soll.
keyVaultUri	string	Der URI Ihres Azure Key Vault-Postfachs, der auch als DNS-Name bezeichnet wird und den Schlüssel enthält, der zum Verschlüsseln ruhender Daten verwendet werden soll. Ein Beispiel-URI könnte sein `https://my-keyvault-name.vault.azure.net`.

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 mit einem benutzerdefinierten Webendpunkt zur Abfragezeit.
aiServicesVision	Generieren Sie Einbettungen für eine Bild- oder Texteingabe zur Abfragezeit mithilfe der Vision Vectorize-API von Azure AI Services.
aml	Generieren Sie Einbettungen mithilfe eines Azure Machine Learning-Endpunkts, der zur Abfragezeit über den Azure AI Foundry-Modellkatalog bereitgestellt wird.

WebApiParameters

Objekt

Gibt die Eigenschaften für die Verbindung mit einem benutzerdefinierten Vektorisierer an.

Name	Typ	Beschreibung
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Die benutzerseitig zugewiesene verwaltete Identität, die für ausgehende Verbindungen verwendet wird. Wenn eine authResourceId angegeben und nicht angegeben wird, wird die systemseitig zugewiesene verwaltete Identität verwendet. Wenn bei Aktualisierungen des Indexers die Identität nicht angegeben ist, bleibt der Wert unverändert. Wenn der Wert auf "none" festgelegt ist, wird der Wert dieser Eigenschaft gelöscht.
authResourceId	string	Gilt für benutzerdefinierte Endpunkte, die eine Verbindung mit externem Code in einer Azure-Funktion oder einer anderen Anwendung herstellen, die die Transformationen bereitstellt. Bei diesem Wert sollte es sich um die Anwendungs-ID handeln, die für die Funktion oder App erstellt wurde, als sie bei Azure Active Directory registriert wurde. Wenn angegeben, stellt die Vektorisierung eine Verbindung mit der Funktion oder App her, indem sie eine verwaltete ID (entweder system- oder benutzerseitig zugewiesen) des Suchdiensts und das Zugriffstoken der Funktion oder App verwendet, wobei dieser Wert als Ressourcen-ID zum Erstellen des Bereichs des Zugriffstokens verwendet wird.
httpHeaders	object	Die Header, die zum Ausführen der HTTP-Anforderung erforderlich sind.
httpMethod	string	Die Methode für die HTTP-Anforderung.
timeout	string (duration)	Die gewünschte Zeitüberschreitung für die Anforderung. Der Standardwert ist 30 Sekunden.
uri	string (uri)	Der URI der Web-API, die den Vektorisierer bereitstellt.

WebApiVectorizer

Objekt

Gibt einen benutzerdefinierten Vektorisierer zum Generieren der Vektoreinbettung einer Abfragezeichenfolge an. Die Integration eines externen Vektorisierers erfolgt über die benutzerdefinierte Web-API-Schnittstelle eines Skillsets.

Name	Typ	Beschreibung
customWebApiParameters	WebApiParameters	Gibt die Eigenschaften des benutzerdefinierten Vektorisierers an.
kind	string: customWebApi	Der Name der Art von Vektorisierungsmethode, die für die Verwendung mit der Vektorsuche konfiguriert wird.
name	string	Der Name, der dieser bestimmten Vektorisierungsmethode zugeordnet werden soll.