Knowledge Agents - List

Référence

Service:: Search Service

Version d'API:: 2025-05-01-preview

Répertorie tous les agents disponibles pour un service de recherche.

GET {endpoint}/agents?api-version=2025-05-01-preview

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
endpoint	path	True	string	URL du point de terminaison du service de recherche.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
x-ms-client-request-id		string (uuid)	ID de suivi envoyé avec la demande pour faciliter le débogage.

Réponses

Nom	Type	Description
200 OK	ListKnowledgeAgentsResult
Other Status Codes	ErrorResponse	Réponse d’erreur.

Exemples

SearchServiceListKnowledgeAgents

Exemple de requête

HTTP

GET https://previewexampleservice.search.windows.net/agents?api-version=2025-05-01-preview

Exemple de réponse

Code d’état:: 200

{
  "value": [
    {
      "@odata.etag": "0x1234568AE7E58A1",
      "name": "agent-preview-test",
      "description": "Description of the agent.",
      "targetIndexes": [
        {
          "indexName": "preview-test",
          "defaultRerankerThreshold": 2.5,
          "defaultIncludeReferenceSourceData": true,
          "defaultMaxDocsForReranker": 100
        }
      ],
      "models": [
        {
          "kind": "azureOpenAI",
          "azureOpenAIParameters": {
            "resourceUri": "https://test-sample.openai.azure.com",
            "deploymentId": "myDeployment",
            "apiKey": "<redacted>",
            "modelName": "gpt-4o-mini"
          }
        }
      ],
      "requestLimits": {
        "maxRuntimeInSeconds": 60,
        "maxOutputSize": 100000
      },
      "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
AzureActiveDirectoryApplicationCredentials	Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.
AzureOpenAIEmbeddingSkill	Vous permet de générer un incorporation vectorielle pour une entrée de texte donnée à l’aide de la ressource Azure OpenAI.
AzureOpenAIModelName	Nom du modèle Azure Open AI qui sera appelé.
AzureOpenAIParameters	Spécifie les paramètres de connexion à la ressource Azure OpenAI.
ErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
ErrorDetail	Détail de l’erreur.
ErrorResponse	Réponse d’erreur
InputFieldMappingEntry	Mappage de champs d’entrée pour une compétence.
KnowledgeAgent
KnowledgeAgentAzureOpenAIModel	Spécifie la ressource Azure OpenAI utilisée pour la planification des requêtes.
KnowledgeAgentModelKind	Le modèle d’IA à utiliser pour la planification des requêtes.
KnowledgeAgentRequestLimits	Garde-fous pour limiter la quantité de ressources utilisées pour une demande d’extraction d’un seul agent.
KnowledgeAgentTargetIndex
ListKnowledgeAgentsResult
OutputFieldMappingEntry	Mappage de champs de sortie pour une compétence.
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.
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 mappages de synonymes.

AzureActiveDirectoryApplicationCredentials

Object

Informations d’identification d’une application inscrite créée pour votre service de recherche, utilisée pour l’accès authentifié aux clés de chiffrement stockées dans Azure Key Vault.

Nom	Type	Description
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.
applicationSecret	string	Clé d’authentification de l’application AAD spécifiée.

AzureOpenAIEmbeddingSkill

Object

Vous permet de générer un incorporation vectorielle pour une entrée de texte donnée à l’aide de la ressource Azure OpenAI.

Nom	Type	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Fragment d’URI spécifiant le type de compétence.
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.
context	string	Représente le niveau auquel les opérations se produisent, telles que la racine du document ou le contenu du document (par exemple, /document ou /document/content). La valeur par défaut est /document.
deploymentId	string	ID du déploiement du modèle Azure OpenAI sur la ressource désignée.
description	string	Description de la compétence qui décrit les entrées, sorties et utilisation de la compétence.
dimensions	integer (int32)	Nombre de dimensions que les incorporations de sortie obtenues doivent avoir. Uniquement pris en charge dans les modèles text-embedding-3 et ultérieur.
inputs	InputFieldMappingEntry[]	Les entrées des compétences peuvent être une colonne dans le jeu de données source ou la sortie d’une compétence en amont.
modelName	AzureOpenAIModelName	Nom du modèle d’incorporation déployé sur le chemin d’accès deploymentId fourni.
name	string	Nom de la compétence qui l’identifie de manière unique dans l’ensemble de compétences. Une compétence sans nom défini reçoit un nom par défaut de son index basé sur 1 dans le tableau de compétences, précédé du caractère « # ».
outputs	OutputFieldMappingEntry[]	La sortie d’une compétence est soit un champ dans un index de recherche, soit une valeur qui peut être consommée comme entrée par une autre compétence.
resourceUri	string (uri)	URI de ressource de la ressource Azure OpenAI.

AzureOpenAIModelName

Énumération

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

Valeur	Description
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano
gpt-4o
gpt-4o-mini
text-embedding-3-large
text-embedding-3-small
text-embedding-ada-002

AzureOpenAIParameters

Object

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.

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

Détail de l’erreur.

Nom	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Informations supplé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

Object

Réponse d’erreur

Nom	Type	Description
error	ErrorDetail	Objet d’erreur.

InputFieldMappingEntry

Object

Mappage de champs d’entrée pour une compétence.

Nom	Type	Description
inputs	InputFieldMappingEntry[]	Entrées récursives utilisées lors de la création d’un type complexe.
name	string	Nom de l’entrée.
source	string	Source de l’entrée.
sourceContext	string	Contexte source utilisé pour sélectionner des entrées récursives.

KnowledgeAgent

Object

Nom	Type	Description
@odata.etag	string	L’ETag de l’agent.
description	string	Description de l’agent.
encryptionKey	SearchResourceEncryptionKey	Description d’une clé de chiffrement que vous créez dans Azure Key Vault. Cette clé est utilisée pour fournir un niveau supplémentaire de chiffrement au repos pour la définition de votre agent lorsque vous voulez avoir l’assurance que personne, pas même Microsoft, ne peut les déchiffrer. Une fois que vous avez chiffré la définition de votre agent, celle-ci reste 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 nécessaire si vous souhaitez faire pivoter votre clé de chiffrement ; La définition de votre agent n’est pas affectée. Le chiffrement avec des 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 le 1er janvier 2019.
models	KnowledgeAgentModel[]: KnowledgeAgentAzureOpenAIModel[]	Contient des options de configuration sur la façon de se connecter aux modèles d’IA.
name	string	Nom de l’agent de connaissances.
requestLimits	KnowledgeAgentRequestLimits	Garde-fous pour limiter la quantité de ressources utilisées pour une demande d’extraction d’un seul agent.
targetIndexes	KnowledgeAgentTargetIndex[]

KnowledgeAgentAzureOpenAIModel

Object

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

Nom	Type	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Contient les paramètres spécifiques au point de terminaison du modèle Azure OpenAI.
kind	string: azureOpenAI	Le type de modèle d’IA.

KnowledgeAgentModelKind

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

KnowledgeAgentRequestLimits

Object

Garde-fous pour limiter la quantité de ressources utilisées pour une demande d’extraction d’un seul agent.

Nom	Type	Description
maxOutputSize	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.

KnowledgeAgentTargetIndex

Object

Nom	Type	Description
defaultIncludeReferenceSourceData	boolean	Indique si les données de la source de référence doivent être incluses.
defaultMaxDocsForReranker	integer (int32)	Limite le nombre de documents pris en compte pour le classement.
defaultRerankerThreshold	number (float) minimum: 0 maximum: 4	Un seuil pour les résultats de reclassement (plage : 0-4).
indexName	string	Nom de l’index cible.

ListKnowledgeAgentsResult

Object

Nom	Type	Description
value	KnowledgeAgent[]

OutputFieldMappingEntry

Object

Mappage de champs de sortie pour une compétence.

Nom	Type	Description
name	string	Nom de la sortie définie par la compétence.
targetName	string	Nom cible de la sortie. Il est facultatif et le nom par défaut.

SearchIndexerDataNoneIdentity

Object

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

Object

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

SearchResourceEncryptionKey

Object

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 mappages de synonymes.

Nom	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Informations d’identification Azure Active Directory facultatives utilisées pour accéder à votre coffre de clés Azure. Non obligatoire si vous utilisez plutôt une identité managé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.
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`.

Partager via

Knowledge Agents - List

Paramètres URI

En-tête de la demande

Réponses

Exemples

SearchServiceListKnowledgeAgents

Exemple de requête

Exemple de réponse

Définitions

AzureActiveDirectoryApplicationCredentials

AzureOpenAIEmbeddingSkill

AzureOpenAIModelName

AzureOpenAIParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

InputFieldMappingEntry

KnowledgeAgent

KnowledgeAgentAzureOpenAIModel

KnowledgeAgentModelKind

KnowledgeAgentRequestLimits

KnowledgeAgentTargetIndex

ListKnowledgeAgentsResult

OutputFieldMappingEntry

SearchIndexerDataNoneIdentity

SearchIndexerDataUserAssignedIdentity

SearchResourceEncryptionKey