Knowledge Sources - Get

Récupère une définition de source de connaissances.

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

Paramètres URI

Nom Dans Obligatoire Type Description
endpoint
path True

string (uri)

URL du point de terminaison du service de recherche.

sourceName
path True

string

Nom de la source de connaissances.

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.

Réponses

Nom Type Description
200 OK KnowledgeSource:

La demande a réussi.

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

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob
SearchServiceGetKnowledgeSourceFabricDataAgent
SearchServiceGetKnowledgeSourceFabricOntology
SearchServiceGetKnowledgeSourceIndexedOneLake
SearchServiceGetKnowledgeSourceIndexedSharePoint
SearchServiceGetKnowledgeSourceMcpServer
SearchServiceGetKnowledgeSourceWeb
SearchServiceGetKnowledgeSourceWorkIQ

SearchServiceGetKnowledgeSource

Exemple de requête

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

Exemple de réponse

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceGetKnowledgeSourceAzureBlob

Exemple de requête

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

Exemple de réponse

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceFabricDataAgent

Exemple de requête

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

Exemple de réponse

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

SearchServiceGetKnowledgeSourceFabricOntology

Exemple de requête

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

Exemple de réponse

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

SearchServiceGetKnowledgeSourceIndexedOneLake

Exemple de requête

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

Exemple de réponse

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "<redacted>",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceIndexedSharePoint

Exemple de requête

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

Exemple de réponse

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds",
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "model",
          "apiKey": "<redacted>",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com",
          "deploymentId": "myDeployment",
          "apiKey": "<redacted>",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "<redacted>"
      }
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceGetKnowledgeSourceMcpServer

Exemple de requête

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

Exemple de réponse

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

SearchServiceGetKnowledgeSourceWeb

Exemple de requête

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

Exemple de réponse

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

SearchServiceGetKnowledgeSourceWorkIQ

Exemple de requête

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

Exemple de réponse

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

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.

EmbeddingColumnMapping

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

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.

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.

McpServerToolInclusionMode

Contrôle la manière dont les résultats de l’outil MCP analysé sont intégrés dans l’ensemble final des résultats.

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.

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances de 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.

Accept

L’en-tête Accept.

Valeur Description
application/json;odata.metadata=minimal

AIServices

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

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

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.

AzureBlobKnowledgeSourceParameters

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.

AzureOpenAIModelName

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.

AzureOpenAIVectorizerParameters

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:

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

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.

EmbeddingColumnMapping

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.

ErrorAdditionalInfo

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

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

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

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.

FabricDataAgentKnowledgeSourceParameters

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

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.

FabricOntologyKnowledgeSourceParameters

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

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.

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.

FileKnowledgeSourceParameters

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.

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.

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

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.

IndexedOneLakeKnowledgeSourceParameters

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.

targetPath

string

Dossier ou raccourci OneLakehouse facultatif pour filtrer le contenu OneLake.

IndexedSharePointContainerName

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

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.

IndexedSharePointKnowledgeSourceParameters

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.

IndexedSqlKnowledgeSource

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.

IndexedSqlKnowledgeSourceParameters

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

tableOrView

string

Le nom du tableau ou de la vue à indexer. Peut être qualifié par le schéma (par exemple, 'dbo. MaTable').

IndexingSchedule

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

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

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

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

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:

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.

KnowledgeSourceIngestionPermissionOption

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

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.

McpServerAuthenticationKind

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

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

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

Paramètres pour l’authentification des connexions Foundry.

Nom Type Description
connectionId

string

L’identifiant de connexion Azure AI Foundry.

McpServerJsonOutputParsing

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

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.

McpServerKnowledgeSourceParameters

Paramètres pour une source de connaissances serveur MCP.

Nom Type Description
authentication McpServerAuthentication:

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

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

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

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

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

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

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

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

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

Nom Type Description
inclusionMode

McpServerToolInclusionMode

Contrôle la manière dont les résultats analysés de cet outil sont intégrés dans l’ensemble final des résultats. Par défaut, c’est « reclassé » quand ce n’est pas spécifié.

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

Nom de l’outil MCP à appeler.

outputParsing McpServerOutputParsing:

Configuration optionnelle pour analyser la sortie de l’outil.

McpServerToolInclusionMode

Contrôle la manière dont les résultats de l’outil MCP analysé sont intégrés dans l’ensemble final des résultats.

Valeur Description
reranked

Les résultats des outils passent par la chaîne de reclassement et d’agrégation parallèlement aux résultats d’autres sources de connaissances. Il s’agit du comportement par défaut.

always

Les résultats des outils contournent le reclassement et sont toujours inclus dans le contexte de l’agent.

RemoteSharePointKnowledgeSource

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.

RemoteSharePointKnowledgeSourceParameters

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 à retourner 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ées n’est retournée.

SearchIndexerDataNoneIdentity

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

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

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

Nom Type Description
name

string

Nom du champ.

SearchIndexKnowledgeSource

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.

searchIndexParameters

SearchIndexKnowledgeSourceParameters

Paramètres de la source de connaissances.

SearchIndexKnowledgeSourceParameters

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.

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.

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.

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:

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

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

Allemand

en

Anglais

es

Espagnol

et

Estonian

fi

Finnois

fr

Français

he

Hébreu

hi

hindi

hr

Croate

hu

Hongrois

id

Indonesian

is

Islandais

it

Italien

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

Valeur indiquant le mode fractionné à effectuer.

Valeur Description
pages

Fractionnez le texte en pages individuelles.

sentences

Fractionnez le texte en phrases individuelles.

VectorSearchVectorizerKind

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

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.

webParameters

WebKnowledgeSourceParameters

Paramètres de la source de connaissances Web.

WebKnowledgeSourceDomain

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

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

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

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.