Knowledge Sources - Create

Service:: Search Service

Version d’API:: 2026-08-01-preview

Crée une nouvelle source de connaissances.

POST {endpoint}/knowledgesources?api-version=2026-08-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string (uri)	URL du point de terminaison du service de recherche.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

En-tête de la demande

Nom	Obligatoire	Type	Description
Accept		Accept	L’en-tête Accept.
x-ms-client-request-id		string (uuid)	Identificateur de chaîne opaque, globalement unique et généré par le client pour la requête.

Corps de la demande

Le corps de la requête peut être l’un des suivants :

Nom	Description
AzureBlobKnowledgeSource	Source de connaissances Configuration pour le stockage Blob Azure.
FabricDataAgentKnowledgeSource	Configuration pour la source de connaissances de Fabric Data Agent.
FabricOntologyKnowledgeSource	Source de connaissances sur la configuration pour Fabric Ontology.
FileKnowledgeSource	Configuration pour la source de connaissances de fichiers qui supporte l’upload et l’indexation directes des fichiers.
IndexedOneLakeKnowledgeSource	Configuration de la source de connaissances OneLake.
IndexedSharePointKnowledgeSource	Configuration de la source de connaissances SharePoint.
IndexedSqlKnowledgeSource	Configuration pour la source de connaissances SQL indexée.
McpServerKnowledgeSource	Configuration d’une source de connaissances soutenue par un serveur MCP (Model Context Protocol).
RemoteSharePointKnowledgeSource	Configuration de la source de connaissances SharePoint distante.
SearchIndexKnowledgeSource	Source de connaissances ciblant un index de recherche.
WebKnowledgeSource	Source de connaissances ciblant les résultats Web.
WorkIQKnowledgeSource	Configuration pour la source de connaissances WorkIQ.

AzureBlobKnowledgeSource

Source de connaissances Configuration pour le stockage Blob Azure.

Nom	Obligatoire	Type	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Le type de source de connaissances.
kind	True	string: azureBlob	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FabricDataAgentKnowledgeSource

Configuration pour la source de connaissances de Fabric Data Agent.

Nom	Obligatoire	Type	Description
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Les paramètres pour la source de connaissances de Fabric Data Agent.
kind	True	string: fabricDataAgent	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FabricOntologyKnowledgeSource

Source de connaissances sur la configuration pour Fabric Ontology.

Nom	Obligatoire	Type	Description
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Les paramètres pour la source de connaissances de Fabric Ontology.
kind	True	string: fabricOntology	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FileKnowledgeSource

Configuration pour la source de connaissances de fichiers qui supporte l’upload et l’indexation directes des fichiers.

Nom	Obligatoire	Type	Description
fileParameters	True	FileKnowledgeSourceParameters	Les paramètres pour la source de connaissances du fichier.
kind	True	string: file	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
corsOptions		CorsOptions	Options pour contrôler le partage de ressources inter-origine (CORS) pour les points de terminaison de fichiers de la source de connaissance du fichier (upload, liste, update, delete).
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedOneLakeKnowledgeSource

Configuration de la source de connaissances OneLake.

Nom	Obligatoire	Type	Description
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	Paramètres de la source de connaissances.
kind	True	string: indexedOneLake	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedSharePointKnowledgeSource

Configuration de la source de connaissances SharePoint.

Nom	Obligatoire	Type	Description
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	Paramètres de la source de connaissances.
kind	True	string: indexedSharePoint	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedSqlKnowledgeSource

Configuration pour la source de connaissances SQL indexée.

Nom	Obligatoire	Type	Description
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	Les paramètres pour la source de connaissances SQL.
kind	True	string: indexedSql	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

McpServerKnowledgeSource

Configuration d’une source de connaissances soutenue par un serveur MCP (Model Context Protocol).

Nom	Obligatoire	Type	Description
kind	True	string: mcpServer	Le type de source de connaissances.
mcpServerParameters	True	McpServerKnowledgeSourceParameters	Les paramètres pour la source de connaissances du serveur MCP.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

RemoteSharePointKnowledgeSource

Configuration de la source de connaissances SharePoint distante.

Nom	Obligatoire	Type	Description
kind	True	string: remoteSharePoint	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	Les paramètres pour la source de connaissances SharePoint à distance.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

SearchIndexKnowledgeSource

Source de connaissances ciblant un index de recherche.

Nom	Obligatoire	Type	Description
kind	True	string: searchIndex	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Paramètres de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

WebKnowledgeSource

Source de connaissances ciblant les résultats Web.

Nom	Obligatoire	Type	Description
kind	True	string: web	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.
webParameters		WebKnowledgeSourceParameters	Paramètres de la source de connaissances Web.

WorkIQKnowledgeSource

Configuration pour la source de connaissances WorkIQ.

Nom	Obligatoire	Type	Description
kind	True	string: workIQ	Le type de source de connaissances.
name	True	string	Nom de la source de connaissances.
workIQParameters	True	WorkIQKnowledgeSourceParameters	Les paramètres pour la source de connaissances WorkIQ, y compris la configuration de l’application Entra, détenue par le client, utilisée pour l’authentification au nom de l’utilisateur.
@odata.etag		string	L’ETag de la source de connaissance.
description		string	Description facultative définie par l’utilisateur.
encryptionKey		SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
resultsProcessing		KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

Réponses

Nom	Type	Description
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	La requête a réussi et une nouvelle ressource a été créée en conséquence.
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue.

Sécurité

api-key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Étendues

Nom	Description
https://search.azure.com/.default

Exemples

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSourceFabricDataAgent

SearchServiceCreateKnowledgeSourceFabricOntology

SearchServiceCreateKnowledgeSourceFile

SearchServiceCreateKnowledgeSourceIndexedOneLake

SearchServiceCreateKnowledgeSourceIndexedSharePoint

SearchServiceCreateKnowledgeSourceIndexedSql

SearchServiceCreateKnowledgeSourceMcpServer

SearchServiceCreateKnowledgeSourceWeb

SearchServiceCreateKnowledgeSourceWorkIQ

SearchServiceCreateKnowledgeSource

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Exemple de réponse

Code d’état:: 201

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

SearchServiceCreateKnowledgeSourceAzureBlob

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "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>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateKnowledgeSourceFabricDataAgent

Exemple de requête

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-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>"
    }
  }
}

Exemple de réponse

Code d’état:: 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"
  }
}

SearchServiceCreateKnowledgeSourceFabricOntology

Exemple de requête

HTTP

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-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>"
    }
  }
}

Exemple de réponse

Code d’état:: 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"
  }
}

SearchServiceCreateKnowledgeSourceFile

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Exemple de réponse

Code d’état:: 201

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

SearchServiceCreateKnowledgeSourceIndexedOneLake

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "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>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSharePoint

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "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>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

Exemple de réponse

Code d’état:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "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"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceIndexedSql

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Exemple de réponse

Code d’état:: 201

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

SearchServiceCreateKnowledgeSourceMcpServer

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "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>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        },
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096
      }
    ]
  }
}

Exemple de réponse

Code d’état:: 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",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateKnowledgeSourceWeb

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-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>"
    }
  }
}

Exemple de réponse

Code d’état:: 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",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

SearchServiceCreateKnowledgeSourceWorkIQ

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



{
  "name": "ks-preview-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>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

Exemple de réponse

Code d’état:: 201

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

Définitions

Nom	Description
Accept	L’en-tête Accept.
AIServices	Paramètres pour les services d’IA.
AssetStore	Configuration d’un magasin d’assets utilisé pour stocker des assets extraits tels que des images.
AzureBlobKnowledgeSource	Source de connaissances Configuration pour le stockage Blob Azure.
AzureBlobKnowledgeSourceParameters	Source de connaissances Paramètres pour le stockage Blob Azure.
AzureOpenAIModelName	Nom du modèle Azure Open AI qui sera appelé.
AzureOpenAIVectorizerParameters	Spécifie les paramètres de connexion à la ressource Azure OpenAI.
ContentColumnMapping	Associe une colonne SQL à un champ d’index de recherche.
CorsOptions	Définit les options permettant de contrôler le partage de ressources cross-origin (CORS) pour un index.
EmbeddingColumnMapping	Associe une colonne SQL à un champ vectoriel pour l’incorporation.
EntraAppAuthentication	Configuration pour l’enregistrement d’une application Microsoft Entra appartenant à un client utilisée pour l’authentification fédérée basée sur un identifiant au nom de l’utilisateur.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).
FabricDataAgentKnowledgeSource	Configuration pour la source de connaissances de Fabric Data Agent.
FabricDataAgentKnowledgeSourceParameters	Paramètres pour la source de connaissances de Fabric Data Agent.
FabricOntologyKnowledgeSource	Source de connaissances sur la configuration pour Fabric Ontology.
FabricOntologyKnowledgeSourceParameters	Paramètres pour la source de connaissances sur Fabric Ontology.
FileKnowledgeSource	Configuration pour la source de connaissances de fichiers qui supporte l’upload et l’indexation directes des fichiers.
FileKnowledgeSourceParameters	Paramètres pour la source de connaissances du fichier.
FreshnessPolicy	Configuration pour une récupération en fonction de la fraîcheur. Une fois défini, les documents plus récents bénéficient d’un bonus de classement lors de la récupération.
IndexedOneLakeKnowledgeSource	Configuration de la source de connaissances OneLake.
IndexedOneLakeKnowledgeSourceParameters	Paramètres pour la source de connaissances OneLake.
IndexedSharePointContainerName	Spécifie les bibliothèques SharePoint auxquelles accéder.
IndexedSharePointKnowledgeSource	Configuration de la source de connaissances SharePoint.
IndexedSharePointKnowledgeSourceParameters	Paramètres pour la source de connaissances SharePoint.
IndexedSqlKnowledgeSource	Configuration pour la source de connaissances SQL indexée.
IndexedSqlKnowledgeSourceParameters	Paramètres pour la source de connaissances SQL indexée.
IndexingSchedule	Représente une planification pour l’exécution de l’indexeur.
KnowledgeBaseAzureOpenAIModel	Spécifie la ressource Azure OpenAI utilisée pour la planification des requêtes.
KnowledgeBaseModelKind	Le modèle d’IA à utiliser pour la planification des requêtes.
KnowledgeSourceAzureOpenAIVectorizer	Spécifie la ressource Azure OpenAI utilisée pour vectoriser une chaîne de requête.
KnowledgeSourceIngestionParameters	Consolide tous les paramètres généraux d’ingestion des sources de connaissances.
KnowledgeSourceIngestionPermissionOption	Types d’autorisations à intégrer avec le contenu du document.
KnowledgeSourceKind	Le type de source de connaissance.
KnowledgeSourceNetworkAccessMode	Spécifie le mode d’accès réseau pour l’ingestion de source de connaissances. Par défaut, c’est « public ».
KnowledgeSourceResultsProcessing	Contrôle si les résultats d’une source de connaissance sont reclassés.
McpServerAuthenticationKind	Le type d’authentification pour un serveur MCP.
McpServerAutoOutputParsing	Détectez automatiquement le format de sortie et analysez en conséquence.
McpServerFoundryConnectionAuthentication	Authentification via une connexion Azure AI Foundry.
McpServerFoundryConnectionParameters	Paramètres pour l’authentification des connexions Foundry.
McpServerJsonOutputParsing	Analysez la sortie comme un document JSON en utilisant les paramètres JSON configurés.
McpServerKnowledgeSource	Configuration d’une source de connaissances soutenue par un serveur MCP (Model Context Protocol).
McpServerKnowledgeSourceParameters	Paramètres pour une source de connaissances serveur MCP.
McpServerNoneOutputParsing	Traitez la sortie comme un seul bloc sans aucun pars.
McpServerOutputParsingJsonParameters	Paramètres pour l’analyse syntaxique de sortie JSON.
McpServerOutputParsingKind	Le genre d’analyse syntaxique de sortie pour un outil serveur MCP.
McpServerOutputParsingSplitParameters	Paramètres pour l’analyse syntaxique de sortie divisée.
McpServerSplitOutputParsing	Divisez la sortie en pages en utilisant les paramètres de division configurés.
McpServerStoredHeadersAuthentication	Authentification utilisant des en-têtes HTTP stockés.
McpServerStoredHeadersParameters	Paramètres pour l’authentification des en-têtes stockés.
McpServerTool	Représente un outil unique au sein d’une source de connaissances serveur MCP.
RemoteSharePointKnowledgeSource	Configuration de la source de connaissances SharePoint distante.
RemoteSharePointKnowledgeSourceParameters	Paramètres de la source de connaissances SharePoint distante.
SearchIndexerDataNoneIdentity	Efface la propriété d’identité d’une source de données.
SearchIndexerDataUserAssignedIdentity	Spécifie l’identité d’une source de données à utiliser.
SearchIndexFieldReference	Référence de champ pour un index de recherche.
SearchIndexKnowledgeSource	Source de connaissances ciblant un index de recherche.
SearchIndexKnowledgeSourceBoostKind	Le genre d’astuce pour un index de recherche source de connaissances.
SearchIndexKnowledgeSourceFieldValueBoost	Un indice qui améliore les documents en fonction de la valeur d’un champ.
SearchIndexKnowledgeSourceFilterHint	Un indice qui identifie un champ et des valeurs représentatives que le planificateur de requêtes peut utiliser lors de la construction d’un filtre.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Un indice qui améliore les documents grâce à une expression de plusieurs mots.
SearchIndexKnowledgeSourceParameters	Paramètres de la source de connaissances de l’index de recherche.
SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles pour une source de connaissances dans l’index de recherche.
SearchResourceEncryptionKey	Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.
SplitSkillLanguage	Les codes de langue pris en charge pour le texte d’entrée par SplitSkill.
TextSplitMode	Valeur indiquant le mode fractionné à effectuer.
VectorSearchVectorizerKind	Méthode de vectorisation à utiliser au moment de la requête.
WebKnowledgeSource	Source de connaissances ciblant les résultats Web.
WebKnowledgeSourceDomain	Configuration pour le domaine source de connaissances web.
WebKnowledgeSourceDomains	Configuration d’autorisation/de blocage de domaine pour la source de connaissances Web.
WebKnowledgeSourceParameters	Paramètres de la source de connaissances Web.
WorkIQKnowledgeSource	Configuration pour la source de connaissances WorkIQ.
WorkIQKnowledgeSourceParameters	Paramètres pour une source de connaissances WorkIQ.

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=minimal

AIServices

Objet

Paramètres pour les services d’IA.

Nom	Type	Description
apiKey	string	La clé API pour accéder aux services d’IA.
uri	string (uri)	URI du point de terminaison des services d’IA.

AssetStore

Objet

Configuration d’un magasin d’assets utilisé pour stocker des assets extraits tels que des images.

Nom	Type	Description
connectionString	string	La chaîne de connexion pour le magasin d’assets.
containerName	string	Le nom du conteneur de blob dans l’espace d’archivage des assets où les assets extraits (par exemple, les images) sont stockés.

AzureBlobKnowledgeSource

Objet

Source de connaissances Configuration pour le stockage Blob Azure.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Le type de source de connaissances.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: azureBlob	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

AzureBlobKnowledgeSourceParameters

Objet

Source de connaissances Paramètres pour le stockage Blob Azure.

Nom	Type	Valeur par défaut	Description
connectionString	string		Chaîne de connexion basée sur une clé ou au format ResourceId si vous utilisez une identité managée.
containerName	string		Nom du conteneur de stockage d’objets blob.
createdResources	object		Ressources créées par la source de connaissances.
folderPath	string		Chemin d’accès au dossier facultatif dans le conteneur.
ingestionParameters	KnowledgeSourceIngestionParameters		Consolide tous les paramètres d’ingestion généraux.
isADLSGen2	boolean	False	Définissez la valeur true si vous vous connectez à un compte de stockage ADLS Gen2. La valeur par défaut est false.
queryHints	SearchIndexKnowledgeSourceQueryHints		Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances soutenue par index. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.

AzureOpenAIModelName

Énumération

Nom du modèle Azure Open AI qui sera appelé.

Valeur	Description
text-embedding-ada-002	TextEmbeddingAda002 modèle.
text-embedding-3-large	TextEmbedding3Large modèle.
text-embedding-3-small	TextEmbedding3Small modèle.
gpt-4o	Modèle GPT4o.
gpt-4o-mini	Modèle GPT4oMini.
gpt-4.1	Modèle GPT41.
gpt-4.1-mini	Modèle GPT41Mini.
gpt-4.1-nano	Modèle Gpt41Nano.
gpt-5	Modèle GPT5.
gpt-5-mini	Modèle Gpt5Mini.
gpt-5-nano	Modèle Gpt5Nano.
gpt-5.1	Modèle GPT51.
gpt-5.2	Modèle GPT52.
gpt-5.4	Modèle GPT54.
gpt-5.4-mini	Modèle Gpt54Mini.
gpt-5.4-nano	Modèle Gpt54Nano.
gpt-5.5	Modèle GPT55.
gpt-5.6-sol	Modèle Gpt56Sol.
gpt-5.6-terra	Modèle GPT56Terra.
gpt-5.6-luna	Modèle Gpt56Luna.

AzureOpenAIVectorizerParameters

Objet

Spécifie les paramètres de connexion à la ressource Azure OpenAI.

Nom	Type	Description
apiKey	string	Clé API de la ressource Azure OpenAI désignée.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Identité managée affectée par l’utilisateur utilisée pour les connexions sortantes.
deploymentId	string	ID du déploiement du modèle Azure OpenAI sur la ressource désignée.
modelName	AzureOpenAIModelName	Nom du modèle d’incorporation déployé sur le chemin d’accès deploymentId fourni.
resourceUri	string (uri)	URI de ressource de la ressource Azure OpenAI.

ContentColumnMapping

Objet

Associe une colonne SQL à un champ d’index de recherche.

Nom	Type	Description
name	string	Nom du champ de l’index cible.
searchFieldType	string	Type de champ Recherche Azure AI (par exemple, Edm.String, Edm.Int32).
sourceField	string	Nom de colonne SQL.

CorsOptions

Objet

Définit les options permettant de contrôler le partage de ressources cross-origin (CORS) pour un index.

Nom	Type	Description
allowedOrigins	string[]	La liste des origines à partir desquelles le code JavaScript sera autorisé à accéder à votre index. Peut contenir une liste d’hôtes de la forme {protocol} ://{fully-qualified-domain-name}[ :{port#}], ou un seul '*' pour autoriser toutes les origines (non recommandé).
maxAgeInSeconds	integer (int64)	Durée pendant laquelle les navigateurs doivent mettre en cache les réponses de contrôle en amont CORS. La valeur par défaut est de 5 minutes.

EmbeddingColumnMapping

Objet

Associe une colonne SQL à un champ vectoriel pour l’incorporation.

Nom	Type	Description
name	string	Ciblez le nom du champ vectoriel dans l’index de recherche.
sourceField	string	Colonne SQL utilisée comme entrée pour la génération d’intégration.

EntraAppAuthentication

Objet

Configuration pour l’enregistrement d’une application Microsoft Entra appartenant à un client utilisée pour l’authentification fédérée basée sur un identifiant au nom de l’utilisateur.

Nom	Type	Description
applicationId	string (uuid)	L’identifiant de l’application (client) de l’enregistrement de l’application Entra, propriété du client.
federatedCredentialId	string (uuid)	L’identifiant fédéré de crédent configuré sur l’enregistrement de l’application, permettant au service de recherche de s’authentifier en tant qu’application sans secret client stocké.
tenantId	string (uuid)	L’identifiant locataire de l’enregistrement de l’application. C’est obligatoire lorsque l’inscription de l’application est sur un autre locataire que le service de recherche. Si elle est omise, le locataire du service de recherche est utilisé.

ErrorAdditionalInfo

Objet

Informations supplémentaires sur l’erreur de gestion des ressources.

Nom	Type	Description
info		Informations supplémentaires
type	string	Le type d’informations supplémentaires.

ErrorDetail

Objet

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations complémentaires sur l’erreur.
code	string	Code d’erreur.
details	ErrorDetail[]	Détails de l’erreur.
message	string	Message d’erreur.
target	string	Cible d’erreur.

ErrorResponse

Objet

Réponse d’erreur courante pour toutes les API Azure Resource Manager afin de retourner les détails de l’erreur pour les opérations ayant échoué. (Cela suit également le format de réponse d’erreur OData.).

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

FabricDataAgentKnowledgeSource

Objet

Configuration pour la source de connaissances de Fabric Data Agent.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Les paramètres pour la source de connaissances de Fabric Data Agent.
kind	string: fabricDataAgent	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FabricDataAgentKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances de Fabric Data Agent.

Nom	Type	Description
dataAgentId	string	Précise à quel Fabric Data Agent accéder.
workspaceId	string	ID de l’espace de travail Fabric.

FabricOntologyKnowledgeSource

Objet

Source de connaissances sur la configuration pour Fabric Ontology.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Les paramètres pour la source de connaissances de Fabric Ontology.
kind	string: fabricOntology	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FabricOntologyKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances sur Fabric Ontology.

Nom	Type	Description
ontologyId	string	L’ID de l’ontologie à utiliser depuis l’espace de travail Fabric.
workspaceId	string	L’identifiant de l’espace de travail Fabric contenant l’ontologie.

FileKnowledgeSource

Objet

Configuration pour la source de connaissances de fichiers qui supporte l’upload et l’indexation directes des fichiers.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
corsOptions	CorsOptions	Options pour contrôler le partage de ressources inter-origine (CORS) pour les points de terminaison de fichiers de la source de connaissance du fichier (upload, liste, update, delete).
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
fileParameters	FileKnowledgeSourceParameters	Les paramètres pour la source de connaissances du fichier.
kind	string: file	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

FileKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances du fichier.

Nom	Type	Description
createdResources	object	Ressources créées par la source de connaissances du fichier.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolide tous les paramètres généraux d’ingestion pour la source de connaissances du fichier, y compris le mode d’extraction de contenu et un embeddingModel optionnel.
queryHints	SearchIndexKnowledgeSourceQueryHints	Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances soutenue par index. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.

FreshnessPolicy

Objet

Configuration pour une récupération en fonction de la fraîcheur. Une fois défini, les documents plus récents bénéficient d’un bonus de classement lors de la récupération.

Nom	Type	Description
boostingDuration	string	Durée ISO 8601 pour la fenêtre d’augmentation de fraîcheur (par exemple « P90D » pendant 90 jours). Les documents plus récents que cette durée bénéficient d’une amélioration de classement lors de leur récupération.

IndexedOneLakeKnowledgeSource

Objet

Configuration de la source de connaissances OneLake.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Paramètres de la source de connaissances.
kind	string: indexedOneLake	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedOneLakeKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances OneLake.

Nom	Type	Description
createdResources	object	Ressources créées par la source de connaissances.
fabricWorkspaceId	string	ID de l’espace de travail OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolide tous les paramètres d’ingestion généraux.
lakehouseId	string	Précise à quel point le chalet du lac OneLake accéder.
queryHints	SearchIndexKnowledgeSourceQueryHints	Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances soutenue par index. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.
targetPath	string	Dossier ou raccourci OneLakehouse facultatif pour filtrer le contenu OneLake.

IndexedSharePointContainerName

Énumération

Spécifie les bibliothèques SharePoint auxquelles accéder.

Valeur	Description
defaultSiteLibrary	Indexez le contenu de la bibliothèque de documents par défaut du site.
allSiteLibraries	Indexez le contenu de chaque bibliothèque de documents du site.
useQuery	Utilisez une requête pour filtrer le contenu SharePoint.

IndexedSharePointKnowledgeSource

Objet

Configuration de la source de connaissances SharePoint.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	Paramètres de la source de connaissances.
kind	string: indexedSharePoint	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedSharePointKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances SharePoint.

Nom	Type	Description
connectionString	string	Chaîne de connexion SharePoint au format : SharePointOnlineEndpoint=[URL du site SharePoint] ; ApplicationId=[ID d’application Azure AD] ; ApplicationSecret=[Clé secrète client de l’application Azure AD] ; TenantId=[ID de locataire du site SharePoint]
containerName	IndexedSharePointContainerName	Spécifie les bibliothèques SharePoint auxquelles accéder.
createdResources	object	Ressources créées par la source de connaissances.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolide tous les paramètres d’ingestion généraux.
query	string	Requête facultative pour filtrer le contenu SharePoint.
queryHints	SearchIndexKnowledgeSourceQueryHints	Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances soutenue par index. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.

IndexedSqlKnowledgeSource

Objet

Configuration pour la source de connaissances SQL indexée.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	Les paramètres pour la source de connaissances SQL.
kind	string: indexedSql	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

IndexedSqlKnowledgeSourceParameters

Objet

Paramètres pour la source de connaissances SQL indexée.

Nom	Type	Description
connectionString	string	La chaîne de connexion pour Azure SQL Database ou SQL Managed Instance.
contentColumns	ContentColumnMapping[]	Correspondances optionnelles de colonnes pour les champs de contenu. Si elles sont omises, toutes les colonnes sont automatiquement découvertes.
createdResources	object	Ressources créées par la source de connaissances.
embeddingColumns	EmbeddingColumnMapping[]	Applications optionnelles de colonnes pour l’intégration de champs vectoriels. Si elle est omise de l’existence, aucun champ vectoriel n’est créé.
highWaterMarkColumnName	string	Nom de colonne optionnel pour la détection de changement de marque d’eau élevée. Si disponible, utilise HighWaterMarkChangeDetectionPolicy.
ingestionParameters	KnowledgeSourceIngestionParameters	Consolide tous les paramètres généraux d’ingestion, y compris le modèle d’intégration, le planning et l’identité.
queryHints	SearchIndexKnowledgeSourceQueryHints	Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances soutenue par index. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.
tableOrView	string	Le nom du tableau ou de la vue à indexer. Peut être qualifié par le schéma (par exemple, 'dbo. MaTable').

IndexingSchedule

Objet

Représente une planification pour l’exécution de l’indexeur.

Nom	Type	Description
interval	string (duration)	Intervalle de temps entre les exécutions de l’indexeur.
startTime	string (date-time)	Heure à laquelle un indexeur doit commencer à s’exécuter.

KnowledgeBaseAzureOpenAIModel

Objet

Spécifie la ressource Azure OpenAI utilisée pour la planification des requêtes.

Nom	Type	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI paramètres.
kind	string: azureOpenAI	Le modèle d’IA à utiliser pour la planification des requêtes.

KnowledgeBaseModelKind

Énumération

Le modèle d’IA à utiliser pour la planification des requêtes.

Valeur	Description
azureOpenAI	Utilisez les modèles Azure Open AI pour la planification des requêtes.

KnowledgeSourceAzureOpenAIVectorizer

Objet

Spécifie la ressource Azure OpenAI utilisée pour vectoriser une chaîne de requête.

Nom	Type	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Contient les paramètres spécifiques à la vectorisation d’incorporation Azure OpenAI.
kind	string: azureOpenAI	Nom du type de méthode de vectorisation configuré pour être utilisé avec la recherche vectorielle.

KnowledgeSourceIngestionParameters

Objet

Consolide tous les paramètres généraux d’ingestion des sources de connaissances.

Nom	Type	Valeur par défaut	Description
aiServices	AIServices		Configuration optionnelle des services d’IA pour le traitement de contenu.
assetStore	AssetStore		Configuration optionnelle du stockage d’assets pour stocker les assets extraits tels que les images.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Modèle de complétion de chat facultatif pour la verbalisation d’image ou l’extraction de contexte.
contentExtractionMode	enum: minimal standard	minimal	Mode d’extraction de contenu en option. La valeur par défaut est « minimal ».
disableImageVerbalization	boolean	False	Indique si la verbalisation de l’image doit être désactivée. La valeur par défaut est false.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Configuration facultative du vectoriseur pour la vectorisation du contenu.
freshnessPolicy	FreshnessPolicy		Politique optionnelle de fraîcheur pour biaiser la récupération vers des documents plus récents.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Une identité explicite à utiliser pour cette source de connaissances.
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		Liste optionnelle des types de permissions à intégrer avec le contenu du document. Si spécifié, il définira les options d’autorisation de l’indexeur pour la source de données.
ingestionSchedule	IndexingSchedule		Planification facultative de l’ingestion des données.
networkAccessMode	KnowledgeSourceNetworkAccessMode	public	Mode d’accès réseau optionnel pour l’ingestion. Réglez sur « privé » pour exécuter l’ingestion dans un environnement d’exécution privé pouvant atteindre les sources de données et dépendances via un réseau privé. Par défaut, c’est « public ». Il s’agit d’un paramètre de création et ne peut pas être modifié après la création de la source de connaissances.

KnowledgeSourceIngestionPermissionOption

Énumération

Types d’autorisations à intégrer avec le contenu du document.

Valeur	Description
userIds	Ingérez des identificateurs d’utilisateur explicites en plus du contenu du document.
groupIds	Ingérez des identificateurs de groupe en même temps que le contenu du document.
rbacScope	Ingérez les informations de portée RBAC en même temps que le contenu du document.
sensitivityLabels	Ingérer les labels de sensibilité Microsoft Purview aux côtés du contenu du document.

KnowledgeSourceKind

Énumération

Le type de source de connaissance.

Valeur	Description
searchIndex	Source de connaissances qui lit les données d’un index de recherche.
azureBlob	Source de connaissances qui lit et ingère des données de Stockage Blob Azure dans un index de recherche.
indexedSharePoint	Une source de connaissances qui lit les données provenant de SharePoint indexé.
indexedOneLake	Une source de connaissances qui lit les données provenant de OneLake indexé.
indexedSql	Une source de connaissances qui récupère et intègre des données d’Azure SQL Database ou SQL Managed Instance vers un index de recherche.
web	Une source de connaissances qui lit des données du web.
remoteSharePoint	Une source de connaissances qui lit les données provenant de SharePoint distant.
workIQ	Une source de connaissances qui lit les données issues de QI au travail
file	Une source de connaissances qui supporte l’upload et l’indexation directes des fichiers.
mcpServer	Une source de connaissances soutenue par un serveur MCP (Model Context Protocol).
fabricDataAgent	Une source de connaissances qui récupère des données à partir d’un Fabric Data Agent.
fabricOntology	Une source de connaissances qui récupère des données des ontologies Microsoft Fabric.

KnowledgeSourceNetworkAccessMode

Énumération

Spécifie le mode d’accès réseau pour l’ingestion de source de connaissances. Par défaut, c’est « public ».

Valeur	Description
public	L’ingestion s’exécute dans l’environnement d’exécution standard, accessible au public. Il s’agit de la valeur par défaut.
private	L’ingestion s’exécute dans un environnement d’exécution privé afin d’atteindre les sources de données et dépendances via un réseau privé (point de terminaison privé / lien privé partagé).

KnowledgeSourceResultsProcessing

Énumération

Contrôle si les résultats d’une source de connaissance sont reclassés.

Valeur	Description
rerank	Les résultats de cette source de connaissances passent par le pipeline de reclassement. Il s’agit du comportement par défaut.
none	Les résultats de cette source de connaissance contournent le reclassement et préservent leur ordre sous-jacent.

McpServerAuthenticationKind

Énumération

Le type d’authentification pour un serveur MCP.

Valeur	Description
foundryConnection	Authentifiez en utilisant une connexion Azure AI Foundry.
storedHeaders	Authentifier en utilisant les en-têtes HTTP stockés.

McpServerAutoOutputParsing

Objet

Détectez automatiquement le format de sortie et analysez en conséquence.

Nom	Type	Description
kind	string: auto	Le genre d’analyse syntaxique de sortie à appliquer.

McpServerFoundryConnectionAuthentication

Objet

Authentification via une connexion Azure AI Foundry.

Nom	Type	Description
foundryConnectionParameters	McpServerFoundryConnectionParameters	Paramètres pour l’authentification des connexions Foundry.
kind	string: foundryConnection	Le type d’authentification à utiliser.

McpServerFoundryConnectionParameters

Objet

Paramètres pour l’authentification des connexions Foundry.

Nom	Type	Description
connectionId	string	L’identifiant de connexion Azure AI Foundry.

McpServerJsonOutputParsing

Objet

Analysez la sortie comme un document JSON en utilisant les paramètres JSON configurés.

Nom	Type	Description
jsonParameters	McpServerOutputParsingJsonParameters	Paramètres pour l’analyse syntaxique de sortie JSON. Obligatoire quand le type est « json ».
kind	string: json	Le genre d’analyse syntaxique de sortie à appliquer.

McpServerKnowledgeSource

Objet

Configuration d’une source de connaissances soutenue par un serveur MCP (Model Context Protocol).

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: mcpServer	Le type de source de connaissances.
mcpServerParameters	McpServerKnowledgeSourceParameters	Les paramètres pour la source de connaissances du serveur MCP.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

McpServerKnowledgeSourceParameters

Objet

Paramètres pour une source de connaissances serveur MCP.

Nom	Type	Description
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	La configuration d’authentification pour le serveur MCP.
serverURL	string	L’URL du point de terminaison du serveur MCP.
tools	McpServerTool[]	La liste des outils à invoquer sur le serveur MCP.

McpServerNoneOutputParsing

Objet

Traitez la sortie comme un seul bloc sans aucun pars.

Nom	Type	Description
kind	string: none	Le genre d’analyse syntaxique de sortie à appliquer.

McpServerOutputParsingJsonParameters

Objet

Paramètres pour l’analyse syntaxique de sortie JSON.

Nom	Type	Description
documentsPath	string	Le chemin JSON vers l’array de documents dans la sortie de l’outil.
includeContext	boolean	S’il faut inclure le contexte environnant issu de la sortie JSON aux côtés des documents extraits.

McpServerOutputParsingKind

Énumération

Le genre d’analyse syntaxique de sortie pour un outil serveur MCP.

Valeur	Description
auto	Détectez automatiquement le format de sortie et analysez en conséquence.
json	Analysez la sortie comme un document JSON en utilisant les paramètres JSON configurés.
split	Divisez la sortie en pages en utilisant les paramètres de division configurés.
none	Traitez la sortie comme un seul bloc sans aucun pars.

McpServerOutputParsingSplitParameters

Objet

Paramètres pour l’analyse syntaxique de sortie divisée.

Nom	Type	Description
defaultLanguageCode	SplitSkillLanguage	Valeur indiquant le code de langue à utiliser. La valeur par défaut est `en`.
maximumPageLength	integer (int32)	Le nombre maximal de caractères par page.
maximumPagesToTake	integer (int32)	Le nombre maximal de pages à prendre dans la sortie.
pageOverlapLength	integer (int32)	Le nombre de caractères à superposer entre les pages.
textSplitMode	TextSplitMode	Le mode de division de texte à utiliser.

McpServerSplitOutputParsing

Objet

Divisez la sortie en pages en utilisant les paramètres de division configurés.

Nom	Type	Description
kind	string: split	Le genre d’analyse syntaxique de sortie à appliquer.
splitParameters	McpServerOutputParsingSplitParameters	Paramètres pour l’analyse syntaxique de sortie divisée.

McpServerStoredHeadersAuthentication

Objet

Authentification utilisant des en-têtes HTTP stockés.

Nom	Type	Description
kind	string: storedHeaders	Le type d’authentification à utiliser.
storedHeadersParameters	McpServerStoredHeadersParameters	Paramètres pour l’authentification des en-têtes stockés.

McpServerStoredHeadersParameters

Objet

Paramètres pour l’authentification des en-têtes stockés.

Nom	Type	Description
headers	object	Les en-têtes HTTP stockés à inclure dans les requêtes serveur MCP.

McpServerTool

Objet

Représente un outil unique au sein d’une source de connaissances serveur MCP.

Nom	Type	Description
maxOutputTokens	integer (int32)	Un cap de jeton optionnel après analyse pour la sortie de cet outil. Doit être supérieur à 0 lorsqu’indiqué est indiqué.
name	string	Le nom de l’outil MCP à invoquer.
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	Configuration optionnelle pour analyser la sortie de l’outil.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats analysés de cet outil sont reclassés. Par défaut, le mode « reclassement » n’est pas spécifié.

RemoteSharePointKnowledgeSource

Objet

Configuration de la source de connaissances SharePoint distante.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: remoteSharePoint	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	Les paramètres pour la source de connaissances SharePoint à distance.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.

RemoteSharePointKnowledgeSourceParameters

Objet

Paramètres de la source de connaissances SharePoint distante.

Nom	Type	Description
containerTypeId	string	ID de conteneur pour la connexion SharePoint Embedded. Lorsque ce problème est nul, il utilisera SharePoint Online.
filterExpression	string	Expression KQL (Keyword Query Language) avec des propriétés et des attributs SharePoint interrogeables pour étendre l’extraction avant l’exécution de la requête.
resourceMetadata	string[]	Liste des champs de métadonnées à renvoyer pour chaque élément de la réponse. Seules les propriétés de métadonnées récupérables peuvent être incluses dans cette liste. Par défaut, aucune métadonnée n’est renvoyée.

SearchIndexerDataNoneIdentity

Objet

Efface la propriété d’identité d’une source de données.

Nom	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment d’URI spécifiant le type d’identité.

SearchIndexerDataUserAssignedIdentity

Objet

Spécifie l’identité d’une source de données à utiliser.

Nom	Type	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment d’URI spécifiant le type d’identité.
federatedIdentityClientId	string	Support de l’identité gérée multi-locataire User-Assigned : l’identifiant client de l’application multi-tentant configurée pour fédérer avec l’identité managée attribuée par l’utilisateur.
userAssignedIdentity	string	Id de ressource Azure complet d’une identité managée affectée par l’utilisateur sous la forme « /subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId » qui doit avoir été affecté au service de recherche.

SearchIndexFieldReference

Objet

Référence de champ pour un index de recherche.

Nom	Type	Description
name	string	Nom du champ.

SearchIndexKnowledgeSource

Objet

Source de connaissances ciblant un index de recherche.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: searchIndex	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Paramètres de la source de connaissances.

SearchIndexKnowledgeSourceBoostKind

Énumération

Le genre d’astuce pour un index de recherche source de connaissances.

Valeur	Description
fieldValue	Boostez les documents en fonction d’une valeur de champ.
multiWordExpression	Boostez les documents à partir d’une expression de plusieurs mots.

SearchIndexKnowledgeSourceFieldValueBoost

Objet

Un indice qui améliore les documents en fonction de la valeur d’un champ.

Nom	Type	Description
boost	number (double)	Un multiplicateur pour le score du document. Doit être un nombre positif non égal à 1,0.
boostInstructions	string	Des instructions en langage naturel expliquant quand et comment appliquer le boost.
field	string minLength: 1	Le nom du champ d’index de recherche.
fieldValues	string[]	Valeurs représentatives pour le domaine.
kind	string: fieldValue	Le genre d’indice de boost.

SearchIndexKnowledgeSourceFilterHint

Objet

Un indice qui identifie un champ et des valeurs représentatives que le planificateur de requêtes peut utiliser lors de la construction d’un filtre.

Nom	Type	Description
field	string minLength: 1	Le nom du champ d’index de recherche filtrable.
fieldValues	string[]	Valeurs représentatives pour le domaine.
filterInstructions	string	Des instructions en langage naturel qui expliquent quand et comment filtrer sur le terrain.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Objet

Un indice qui améliore les documents grâce à une expression de plusieurs mots.

Nom	Type	Description
boost	number (double)	Un multiplicateur pour le score du document. Doit être un nombre positif non égal à 1,0.
boostInstructions	string	Des instructions en langage naturel expliquant quand et comment appliquer le boost.
fieldValues	string[]	Des valeurs représentatives pour le boost.
kind	string: multiWordExpression	Le genre d’indice de boost.

SearchIndexKnowledgeSourceParameters

Objet

Paramètres de la source de connaissances de l’index de recherche.

Nom	Type	Description
baseFilter	string	Une condition de filtre par défaut appliquée à l’index au moment de la récupération (par exemple, « State EQ VA »). Peut être écrasé au moment de la requête via les paramètres d’exécution de la source de connaissances.
queryHints	SearchIndexKnowledgeSourceQueryHints	Des indices par défaut qui guident la planification des requêtes vers des filtres et des améliorations utiles pour cette source de connaissances indexée de recherche. Les indices de requête au moment de la requête remplacent ces paramètres par défaut comme un objet complet.
searchFields	SearchIndexFieldReference[]	Utilisé pour restreindre les champs à rechercher dans l’index de recherche.
searchIndexName	string	Nom de l’index de recherche.
semanticConfigurationName	string	Permet de spécifier une configuration sémantique différente de celle par défaut sur l’index de recherche cible.
sourceDataFields	SearchIndexFieldReference[]	Permet de demander des champs supplémentaires pour les données sources référencées.

SearchIndexKnowledgeSourceQueryHints

Objet

Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles pour une source de connaissances dans l’index de recherche.

Nom	Type	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Boostez les indices qui identifient les conditions que le planificateur de requêtes peut utiliser pour influencer le classement des documents.
filters	SearchIndexKnowledgeSourceFilterHint[]	Des indices de filtre qui identifient les champs et les valeurs représentatives que le planificateur de requêtes peut utiliser lors de la construction de filtres.

SearchResourceEncryptionKey

Objet

Clé de chiffrement gérée par le client dans Azure Key Vault. Les clés que vous créez et gérez peuvent être utilisées pour chiffrer ou déchiffrer des données au repos, telles que des index et des cartes de synonymes.

Nom	Type	Valeur par défaut	Description
accessCredentials.applicationId	string		ID d’application AAD qui a reçu les autorisations d’accès requises au coffre de clés Azure à utiliser lors du chiffrement de vos données au repos. L’ID d’application ne doit pas être confondu avec l’ID d’objet de votre application AAD.
accessCredentials.applicationSecret	string		Clé d’authentification de l’application AAD spécifiée.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Identité managée explicite à utiliser pour cette clé de chiffrement. Si elle n’est pas spécifiée et que la propriété d’informations d’identification d’accès est null, l’identité managée affectée par le système est utilisée. Lors de la mise à jour vers la ressource, si l’identité explicite n’est pas spécifiée, elle reste inchangée. Si « none » est spécifié, la valeur de cette propriété est effacée.
isServiceLevelKey	boolean	False	Une valeur optionnelle indiquant si cette clé est une clé de niveau service. La valeur par défaut est false.
keyVaultKeyName	string		Nom de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.
keyVaultKeyVersion	string		Version de votre clé Azure Key Vault à utiliser pour chiffrer vos données au repos.
keyVaultUri	string		URI de votre coffre de clés Azure, également appelé nom DNS, qui contient la clé à utiliser pour chiffrer vos données au repos. Un exemple d’URI peut être `https://my-keyvault-name.vault.azure.net`.

SplitSkillLanguage

Énumération

Les codes de langue pris en charge pour le texte d’entrée par SplitSkill.

Valeur	Description
am	Amharic
bs	Bosnian
cs	Tchèque
da	Danois
de	German
en	English
es	Spanish
et	Estonian
fi	Finnois
fr	French
he	Hébreu
hi	hindi
hr	Croate
hu	Hongrois
id	Indonesian
is	Islandais
it	Italian
ja	Japonais
ko	Coréen
lv	Letton
nb	Norvégien
nl	Néerlandais
pl	Polonais
pt	portugais (Portugal)
pt-br	Portugais (Brésil)
ru	Russian
sk	Slovak
sl	Slovenian
sr	Serbe
sv	Suédois
tr	Turc
ur	Urdu
zh	Chinois (simplifié)

TextSplitMode

Énumération

Valeur indiquant le mode fractionné à effectuer.

Valeur	Description
pages	Fractionnez le texte en pages individuelles.
sentences	Fractionnez le texte en phrases individuelles.

VectorSearchVectorizerKind

Énumération

Méthode de vectorisation à utiliser au moment de la requête.

Valeur	Description
azureOpenAI	Générez des incorporations à l’aide d’une ressource Azure OpenAI au moment de la requête.
customWebApi	Générez des incorporations à l’aide d’un point de terminaison web personnalisé au moment de la requête.
aiServicesVision	Générez des incorporations pour une entrée image ou texte au moment de la requête à l’aide de l’API Vision Vectorize d’Azure AI Services.
aml	Générez des intégrations à l’aide d’un point de terminaison Azure Machine Learning déployé via le catalogue de modèles Azure AI Foundry au moment de la requête.

WebKnowledgeSource

Objet

Source de connaissances ciblant les résultats Web.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: web	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.
webParameters	WebKnowledgeSourceParameters	Paramètres de la source de connaissances Web.

WebKnowledgeSourceDomain

Objet

Configuration pour le domaine source de connaissances web.

Nom	Type	Description
address	string	L’adresse du domaine.
includeSubpages	boolean	S’il faut ou non inclure des sous-pages de ce domaine.

WebKnowledgeSourceDomains

Objet

Configuration d’autorisation/de blocage de domaine pour la source de connaissances Web.

Nom	Type	Description
allowedDomains	WebKnowledgeSourceDomain[]	Des domaines autorisés pour les résultats web.
blockedDomains	WebKnowledgeSourceDomain[]	Des domaines bloqués dans les résultats web.

WebKnowledgeSourceParameters

Objet

Paramètres de la source de connaissances Web.

Nom	Type	Description
count	integer (int32)	Le nombre par défaut de résultats web à revenir. Peut être écrasé au moment de la requête via les paramètres d’exécution de la source de connaissances.
domains	WebKnowledgeSourceDomains	Configuration d’autorisation/blocage du domaine pour les résultats Web.
freshness	string	Le filtre de fraîcheur par défaut pour les résultats web. Peut être écrasé au moment de la requête via les paramètres d’exécution de la source de connaissances.
language	string	Le langage par défaut pour les résultats web. Peut être écrasé au moment de la requête via les paramètres d’exécution de la source de connaissances.
market	string	Le marché par défaut des résultats web. Peut être écrasé au moment de la requête via les paramètres d’exécution de la source de connaissances.

WorkIQKnowledgeSource

Objet

Configuration pour la source de connaissances WorkIQ.

Nom	Type	Description
@odata.etag	string	L’ETag de la source de connaissance.
description	string	Description facultative définie par l’utilisateur.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé sert à fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre source de connaissance lorsque vous souhaitez être pleinement assuré que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre source de connaissance, elle restera toujours chiffrée. Le service de recherche ignore les tentatives de définition de cette propriété sur null. Vous pouvez modifier cette propriété si vous souhaitez faire tourner votre clé de chiffrement ; La définition de votre source de connaissance ne sera pas affectée. Le chiffrement à l’aide de clés gérées par le client n’est pas disponible pour les services de recherche gratuits et n’est disponible que pour les services payants créés à partir du 1er janvier 2019.
kind	string: workIQ	Le type de source de connaissances.
name	string	Nom de la source de connaissances.
resultsProcessing	KnowledgeSourceResultsProcessing	Contrôle si les résultats de cette source de connaissances sont reclassés avant d’être inclus dans l’ensemble final de résultats. Par défaut, le mode « reclassement » n’est pas spécifié.
workIQParameters	WorkIQKnowledgeSourceParameters	Les paramètres pour la source de connaissances WorkIQ, y compris la configuration de l’application Entra, détenue par le client, utilisée pour l’authentification au nom de l’utilisateur.

WorkIQKnowledgeSourceParameters

Objet

Paramètres pour une source de connaissances WorkIQ.

Nom	Type	Description
entraAppAuthentication	EntraAppAuthentication	La configuration d’enregistrement de l’application Microsoft Entra, propriété du client, est utilisée pour l’authentification au nom de l’API Work IQ. Le client enregistre une application Entra détenue par un locataire, lui accorde l’autorisation déléguée WorkIQAgent.Ask, et configure une identifiante fédérée pour que Recherche Azure AI puisse s’authentifier sous cette application sans secret client stocké.