Knowledge Retrieval - Retrieve

Service:: Search Service

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

La base de connaissances récupère les données pertinentes à partir des magasins de sauvegarde.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?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.
knowledgeBaseName	path	True	string	Nom de la base 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	Type	Description
Accept	Accept	L’en-tête Accept.
x-ms-query-source-authorization	string	Jeton identifiant l’utilisateur pour lequel la requête est exécutée. Ce jeton est utilisé pour appliquer des restrictions de sécurité sur les documents.
x-ms-query-work-iq-source-authorization	string (password)	Jeton d’assertion utilisateur pour une inscription à l’application Entra détenue par le client, configuré sur une source de connaissances Work IQ. Utilisé pour l’authentification au nom de l’API Work IQ.
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

Nom	Type	Description
includeActivity	boolean	Indique que les résultats de la récupération doivent inclure des informations sur l’activité.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Liste des requêtes prévues à exécuter sans planification de requête de modèle.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents dans la sortie.
maxOutputSize	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxOutputSizeInTokens	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.
messages	KnowledgeBaseMessage[]	Une liste d’entrées de style de message de chat.
outputMode	KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.

Réponses

Nom	Type	Description
200 OK	KnowledgeBaseRetrievalResponse	Réponse de prélèvement réussie.
Other Status Codes	KnowledgeBaseRetrievalResponse	Réponse de récupération partielle.
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

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Code d’état:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveAzureBlobImageServing

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "azureBlob",
      "enableImageServing": true
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

Code d’état:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Exemple de requête

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Code d’état:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithSourceExclusion

Exemple de requête

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview




{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "Explain the SSO provisioning steps from the product documentation only.",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "product-docs-ks",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "troubleshooting-ks",
      "neverQuerySource": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "release-notes-web",
      "neverQuerySource": true,
      "kind": "web"
    }
  ]
}

Exemple de réponse

Code d’état:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 4,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

Code d’état:: 206

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "Partial results were returned before the retrieval completed."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 1,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

Définitions

Nom	Description
Accept	L’en-tête Accept.
AzureBlobKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances d’objet blob azure
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.).
FabricDataAgentKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances Fabric Ontology
FileKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances de fichier
ImageServingStatistics	Statistiques sur le service d’image lors d’une activité de récupération.
IndexedOneLakeKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances OneLake indexée
IndexedSharePointKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances SharePoint indexée
IndexedSqlKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances SQL indexée
KnowledgeBaseActivityRecordModel	Représente le modèle utilisé pour une activité de LLM dans une base de connaissances, incluant son nom de modèle et son identifiant de déploiement.
KnowledgeBaseActivityRecordType	Le type de dossier d’activité.
KnowledgeBaseAgenticReasoningActivityRecord	Représente un enregistrement d’activité de raisonnement agentique.
KnowledgeBaseAzureBlobActivityArguments	Représente les arguments avec lesquels l’activité d’extraction d’objets blob Azure a été exécutée.
KnowledgeBaseAzureBlobActivityRecord	Représente un enregistrement d’activité d’extraction d’objets blob Azure.
KnowledgeBaseAzureBlobReference	Représente une référence de document de référence sur le stockage Blob Azure.
KnowledgeBaseErrorAdditionalInfo	Informations supplémentaires sur l’erreur de gestion des ressources.
KnowledgeBaseErrorDetail	Détails de l’erreur.
KnowledgeBaseFabricDataAgentActivityArguments	Représente les arguments avec lesquels l’activité de récupération du Fabric Data Agent a été exécutée.
KnowledgeBaseFabricDataAgentActivityRecord	Représente un enregistrement d’activité de récupération d’un Fabric Data Agent.
KnowledgeBaseFabricDataAgentReference	Représente une référence documentaire Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments	Représente les arguments avec lesquels l’activité de récupération de Fabric Ontology a été menée.
KnowledgeBaseFabricOntologyActivityRecord	Représente un enregistrement d’activité de récupération de l’Ontologie Fabric.
KnowledgeBaseFabricOntologyReference	Représente une référence documentaire Fabric Ontology.
KnowledgeBaseFileActivityArguments	Représente les arguments avec lesquels l’activité de récupération de fichiers a été exécutée.
KnowledgeBaseFileActivityRecord	Représente un enregistrement d’activité de récupération de fichiers.
KnowledgeBaseFileReference	Représente une référence à un document de fichier.
KnowledgeBaseImageContent	Contenu d’images.
KnowledgeBaseIndexedOneLakeActivityArguments	Représente les arguments avec lesquels l’activité de récupération indexée de OneLake a été menée.
KnowledgeBaseIndexedOneLakeActivityRecord	Représente un enregistrement indexé d’activité de récupération OneLake.
KnowledgeBaseIndexedOneLakeReference	Représente une référence indexée de document OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Représente les arguments avec lesquels l’activité indexée de récupération SharePoint a été exécutée.
KnowledgeBaseIndexedSharePointActivityRecord	Représente un enregistrement d’activité de récupération SharePoint indexé.
KnowledgeBaseIndexedSharePointReference	Représente une référence indexée à un document SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Représente les arguments avec lesquels l’activité de récupération SQL indexée a été exécutée.
KnowledgeBaseIndexedSqlActivityRecord	Représente un enregistrement d’activité de récupération SQL indexé.
KnowledgeBaseIndexedSqlReference	Représente une référence de document Azure SQL.
KnowledgeBaseMcpServerActivityArguments	Représente les arguments avec lesquels l’activité de récupération du serveur MCP a été menée.
KnowledgeBaseMcpServerActivityRecord	Représente un enregistrement d’activité de récupération de serveur MCP.
KnowledgeBaseMcpServerReference	Représente une référence de document serveur MCP.
KnowledgeBaseMessage	Objet de style de message en langage naturel.
KnowledgeBaseMessageContentType	Le type de contenu du message.
KnowledgeBaseMessageImageContent	Type de message d’image.
KnowledgeBaseMessageTextContent	Type de SMS.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Représente un enregistrement d’activité de synthèse de réponse LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Représente un enregistrement d’activité de planification de requête LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Représente un enregistrement d’activité de synthèse web de LLM.
KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour une activité de récupération.
KnowledgeBaseReferenceType	Type de référence.
KnowledgeBaseRemoteSharePointActivityArguments	Représente les arguments avec lesquels l’activité de récupération SharePoint à distance a été exécutée.
KnowledgeBaseRemoteSharePointActivityRecord	Représente un enregistrement d’activité de récupération SharePoint à distance.
KnowledgeBaseRemoteSharePointReference	Représente une référence de document SharePoint distant.
KnowledgeBaseRetrievalRequest	Contrat d’entrée pour la demande d’extraction.
KnowledgeBaseRetrievalResponse	Contrat de sortie pour la réponse d’extraction.
KnowledgeBaseSearchIndexActivityArguments	Représente les arguments avec lesquels l’activité d’extraction d’index de recherche a été exécutée.
KnowledgeBaseSearchIndexActivityRecord	Représente un enregistrement d’activité d’extraction d’index de recherche.
KnowledgeBaseSearchIndexReference	Représente une référence de document Recherche Azure.
KnowledgeBaseWebActivityArguments	Représente les arguments avec lesquels l’activité de récupération web a été menée.
KnowledgeBaseWebActivityRecord	Représente un enregistrement d’activité de récupération web.
KnowledgeBaseWebReference	Représente une référence de document Web.
KnowledgeBaseWorkIQActivityArguments	Représente les arguments avec lesquels l’activité de récupération WorkIQ a été menée.
KnowledgeBaseWorkIQActivityRecord	Représente un enregistrement d’activité de récupération WorkIQ.
KnowledgeBaseWorkIQReference	Représente une référence de document WorkIQ.
KnowledgeRetrievalAutoReasoningEffort	Sélectionnez automatiquement l’effort de raisonnement lors de la récupération. Le service soumet chaque demande au niveau le moins cher et ne monte que jusqu’au niveau maximal disponible du service.
KnowledgeRetrievalIntentType	Le type de configuration de la base de connaissances à utiliser.
KnowledgeRetrievalLowReasoningEffort	Exécutez la récupération des connaissances avec un faible effort de raisonnement.
KnowledgeRetrievalMediumReasoningEffort	Exécutez la récupération des connaissances avec un effort de raisonnement moyen.
KnowledgeRetrievalMinimalReasoningEffort	Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement.
KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
KnowledgeRetrievalReasoningEffortKind	La quantité d’effort à fournir lors de la récupération.
KnowledgeRetrievalSemanticIntent	Une intention de requête sémantique.
KnowledgeSourceKind	Le type de source de connaissance.
KnowledgeSourceResultsProcessing	Contrôle si les résultats d’une source de connaissance sont reclassés.
McpServerKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances serveur MCP
PurviewSensitivityLabelInfo	Informations sur l’étiquette de sensibilité appliquée à un document
QueryType	Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene et 'semantic' si la syntaxe de requête n’est pas nécessaire.
RemoteSharePointKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances SharePoint distante
SearchIndexFieldReference	Référence de champ pour 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.
SearchIndexKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances d’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.
ServedImage	Décrit une seule image que le modèle a sélectionnée pour être servie lors d’une activité de récupération.
WebKnowledgeSourceParams	Spécifie les paramètres d’exécution d’une source de connaissances Web
WorkIQKnowledgeSourceParams	Spécifie les paramètres d’exécution pour une source de connaissances WorkIQ

Accept

Énumération

L’en-tête Accept.

Valeur	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances d’objet blob azure

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: azureBlob	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

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.

FabricDataAgentKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances Fabric Data Agent

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: fabricDataAgent	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

FabricOntologyKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances Fabric Ontology

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: fabricOntology	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

FileKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances de fichier

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: file	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

ImageServingStatistics

Objet

Statistiques sur le service d’image lors d’une activité de récupération.

Nom	Type	Description
imagesRetrieved	integer (int32)	Le nombre d’images récupérées dans la boutique d’assets.
imagesSentToModel	integer (int32)	Le nombre d’images envoyées au modèle en aval.
servedImages	ServedImage[]	L’ensemble d’images que le modèle a sélectionné pour être servi au modèle en aval pour cette activité de récupération.
totalImageSizeBytes	integer (int64)	La taille totale en octets des images envoyées au modèle.
verbalizationUsed	boolean	Indique si la verbalisation d’image a été utilisée au lieu d’une diffusion directe d’image.

IndexedOneLakeKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances OneLake indexée

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: indexedOneLake	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

IndexedSharePointKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances SharePoint indexée

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: indexedSharePoint	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

IndexedSqlKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances SQL indexée

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: indexedSql	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

KnowledgeBaseActivityRecordModel

Objet

Représente le modèle utilisé pour une activité de LLM dans une base de connaissances, incluant son nom de modèle et son identifiant de déploiement.

Nom	Type	Description
deploymentId	string	L’identifiant de déploiement du modèle utilisé pour l’activité.
modelName	string	Le nom du modèle utilisé pour l’activité.

KnowledgeBaseActivityRecordType

Énumération

Le type de dossier d’activité.

Valeur	Description
searchIndex	Activité de recherche dans l’index.
azureBlob	Activité de récupération Azure Blob.
indexedSharePoint	Activité indexée de récupération de SharePoint.
indexedOneLake	Activité indexée de récupération OneLake.
web	Activité de recherche web.
remoteSharePoint	Activité de récupération SharePoint à distance.
workIQ	Activité de récupération WorkIQ.
fabricDataAgent	Activité de récupération de l’agent de données Fabric.
fabricOntology	Activité de récupération de l’ontologie Fabric.
mcpServer	Activité de récupération des serveurs MCP.
file	Activité de récupération de fichiers.
indexedSql	Activité de récupération SQL indexée.
modelQueryPlanning	Activité de planification des requêtes LLM.
modelAnswerSynthesis	Activité de synthèse de réponses LLM.
modelWebSummarization	Activité de résumé web de LLM.
agenticReasoning	Activité de raisonnement agentique.

KnowledgeBaseAgenticReasoningActivityRecord

Objet

Représente un enregistrement d’activité de raisonnement agentique.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	L’effort de raisonnement logique demandé par le client. Cela se distingue de `retrievalReasoningEffort`, qui rapporte l’effort de raisonnement utilisé pour la facturation.
reasoningTokens	integer (int32)	Nombre de jetons d’entrée pour le raisonnement agentique.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: agenticReasoning	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseAzureBlobActivityArguments

Objet

Représente les arguments avec lesquels l’activité d’extraction d’objets blob Azure a été exécutée.

Nom	Type	Description
search	string	Chaîne de recherche utilisée pour interroger le contenu d’un objet blob.

KnowledgeBaseAzureBlobActivityRecord

Objet

Représente un enregistrement d’activité d’extraction d’objets blob Azure.

Nom	Type	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Les arguments blob Azure pour l’activité d’extraction.
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: azureBlob	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseAzureBlobReference

Objet

Représente une référence de document de référence sur le stockage Blob Azure.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
blobUrl	string	URL de l’objet blob de référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: azureBlob	Type de référence.

KnowledgeBaseErrorAdditionalInfo

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.

KnowledgeBaseErrorDetail

Objet

Détails de l’erreur.

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

KnowledgeBaseFabricDataAgentActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération du Fabric Data Agent a été exécutée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger la source de connaissances de l’agent de données Fabric.

KnowledgeBaseFabricDataAgentActivityRecord

Objet

Représente un enregistrement d’activité de récupération d’un Fabric Data Agent.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	Les arguments de l’agent de données Fabric pour l’activité de récupération.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: fabricDataAgent	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseFabricDataAgentReference

Objet

Représente une référence documentaire Fabric Data Agent.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
dataAgentId	string	L’ID de l’agent de données Fabric.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: fabricDataAgent	Type de référence.
workspaceId	string	ID de l’espace de travail Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération de Fabric Ontology a été menée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger la source de connaissances de Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Objet

Représente un enregistrement d’activité de récupération de l’Ontologie Fabric.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	Les arguments de l’ontologie Fabric pour l’activité de récupération.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: fabricOntology	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseFabricOntologyReference

Objet

Représente une référence documentaire Fabric Ontology.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
ontologyId	string	L’identifiant de l’ontologie dans l’espace de travail.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: fabricOntology	Type de référence.
workspaceId	string	ID de l’espace de travail Fabric.

KnowledgeBaseFileActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération de fichiers a été exécutée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger le contenu du fichier.

KnowledgeBaseFileActivityRecord

Objet

Représente un enregistrement d’activité de récupération de fichiers.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
fileArguments	KnowledgeBaseFileActivityArguments	Les arguments du fichier pour l’activité de récupération.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: file	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseFileReference

Objet

Représente une référence à un document de fichier.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
docName	string	Le nom du document pour la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: file	Type de référence.

KnowledgeBaseImageContent

Objet

Contenu d’images.

Nom	Type	Description
url	string (uri)	L’URL de l’image.

KnowledgeBaseIndexedOneLakeActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération indexée de OneLake a été menée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger indexait le contenu OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objet

Représente un enregistrement indexé d’activité de récupération OneLake.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Les arguments indexés de OneLake pour l’activité de récupération.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: indexedOneLake	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseIndexedOneLakeReference

Objet

Représente une référence indexée de document OneLake.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
docUrl	string	URL du document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: indexedOneLake	Type de référence.

KnowledgeBaseIndexedSharePointActivityArguments

Objet

Représente les arguments avec lesquels l’activité indexée de récupération SharePoint a été exécutée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger les contenus SharePoint indexés.

KnowledgeBaseIndexedSharePointActivityRecord

Objet

Représente un enregistrement d’activité de récupération SharePoint indexé.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Les arguments indexés SharePoint pour l’activité de récupération.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: indexedSharePoint	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseIndexedSharePointReference

Objet

Représente une référence indexée à un document SharePoint.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
docUrl	string	URL du document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: indexedSharePoint	Type de référence.

KnowledgeBaseIndexedSqlActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération SQL indexée a été exécutée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger le contenu SQL indexé.

KnowledgeBaseIndexedSqlActivityRecord

Objet

Représente un enregistrement d’activité de récupération SQL indexé.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	Les arguments SQL indexés pour l’activité de récupération.
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: indexedSql	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseIndexedSqlReference

Objet

Représente une référence de document Azure SQL.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
docUrl	string	URL du document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
type	string: indexedSql	Type de référence.

KnowledgeBaseMcpServerActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération du serveur MCP a été menée.

Nom	Type	Description
toolArguments		Les arguments ont été transférés à l’outil serveur MCP.
toolName	string	Le nom de l’outil serveur MCP utilisé pour l’activité de récupération.

KnowledgeBaseMcpServerActivityRecord

Objet

Représente un enregistrement d’activité de récupération de serveur MCP.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	Le serveur MCP argumente en faveur de l’activité de récupération.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: mcpServer	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseMcpServerReference

Objet

Représente une référence de document serveur MCP.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
title	string	Le titre du résultat de l’outil serveur MCP.
toolName	string	Le nom de l’outil serveur MCP qui a produit la référence.
type	string: mcpServer	Type de référence.

KnowledgeBaseMessage

Objet

Objet de style de message en langage naturel.

Nom	Type	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Contenu du message.
role	string	Le rôle de la réponse de l’outil.

KnowledgeBaseMessageContentType

Énumération

Le type de contenu du message.

Valeur	Description
text	Type de contenu de message texte.
image	Type de contenu de message d’image.

KnowledgeBaseMessageImageContent

Objet

Type de message d’image.

Nom	Type	Description
image	KnowledgeBaseImageContent	Le contenu de l’image.
type	string: image	Type du message

KnowledgeBaseMessageTextContent

Objet

Type de SMS.

Nom	Type	Description
text	string	Contenu du texte.
type	string: text	Type du message

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objet

Représente un enregistrement d’activité de synthèse de réponse LLM.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
inputTokens	integer (int32)	Nombre de jetons d’entrée pour l’activité de synthèse de réponse LLM.
model	KnowledgeBaseActivityRecordModel	Le modèle utilisé pour l’activité de synthèse de réponses du LLM.
outputTokens	integer (int32)	Nombre de jetons de sortie pour l’activité de synthèse de réponse LLM.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: modelAnswerSynthesis	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseModelQueryPlanningActivityRecord

Objet

Représente un enregistrement d’activité de planification de requête LLM.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
inputTokens	integer (int32)	Nombre de jetons d’entrée pour l’activité de planification de requête LLM.
model	KnowledgeBaseActivityRecordModel	Le modèle utilisé pour l’activité de planification des requêtes LLM.
outputTokens	integer (int32)	Nombre de jetons de sortie pour l’activité de planification de requête LLM.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: modelQueryPlanning	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseModelWebSummarizationActivityRecord

Objet

Représente un enregistrement d’activité de synthèse web de LLM.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
inputTokens	integer (int32)	Le nombre de jetons d’entrée pour l’activité de résumé web du LLM.
model	KnowledgeBaseActivityRecordModel	Le modèle utilisé pour l’activité de résumé web des LLM.
outputTokens	integer (int32)	Le nombre de jetons de sortie pour l’activité de résumé web des LLM.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: modelWebSummarization	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseQueryHintProcessing

Objet

Détails sur les expressions générées à partir des indices de requête pour une activité de récupération.

Nom	Type	Description
generatedBoost	string	La clause de recherche générée à partir des indices boost pour cette activité.
generatedFilter	string	L’expression du filtre générée à partir des indices de filtre pour cette activité.

KnowledgeBaseReferenceType

Énumération

Type de référence.

Valeur	Description
searchIndex	Recherchez l’index des références du document.
azureBlob	Référence de document Azure Blob.
indexedSharePoint	Référence indexée du document SharePoint.
indexedOneLake	Référence indexée du document OneLake.
web	Référence de document web.
remoteSharePoint	Référence de document SharePoint à distance.
workIQ	Référence de document sur le QI de travail.
fabricDataAgent	Référence documentaire Fabric Data Agent.
fabricOntology	Référence documentaire Fabric Ontology.
mcpServer	Référence de document serveur MCP.
file	Référence de document à déposer.
indexedSql	Référence de document SQL indexé.

KnowledgeBaseRemoteSharePointActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération SharePoint à distance a été exécutée.

Nom	Type	Description
filterExpressionAddOn	string	L’extension d’expression du filtre pour l’activité de récupération.
search	string	La chaîne de recherche utilisée pour interroger la source de connaissances SharePoint distante.

KnowledgeBaseRemoteSharePointActivityRecord

Objet

Représente un enregistrement d’activité de récupération SharePoint à distance.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Les arguments SharePoint à distance pour l’activité de récupération.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: remoteSharePoint	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseRemoteSharePointReference

Objet

Représente une référence de document SharePoint distant.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: remoteSharePoint	Type de référence.
webUrl	string (uri)	L’URL d’où proviennent les données de référence.

KnowledgeBaseRetrievalRequest

Objet

Contrat d’entrée pour la demande d’extraction.

Nom	Type	Description
includeActivity	boolean	Indique que les résultats de la récupération doivent inclure des informations sur l’activité.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Liste des requêtes prévues à exécuter sans planification de requête de modèle.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Liste des paramètres d’exécution des sources de connaissances.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents dans la sortie.
maxOutputSize	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxOutputSizeInTokens	integer (int32)	Limite la taille maximale du contenu dans la sortie.
maxRuntimeInSeconds	integer (int32)	Durée d’exécution maximale en secondes.
messages	KnowledgeBaseMessage[]	Une liste d’entrées de style de message de chat.
outputMode	KnowledgeRetrievalOutputMode	Configuration de sortie pour cette extraction.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuration de l’effort de raisonnement de récupération.

KnowledgeBaseRetrievalResponse

Objet

Contrat de sortie pour la réponse d’extraction.

Nom	Type	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	Les enregistrements d’activité permettent de suivre l’avancement et les implications de facturation.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	Les références des données d’extraction utilisées dans la réponse.
response	KnowledgeBaseMessage[]	Les messages de réponse.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la réponse globale.

KnowledgeBaseSearchIndexActivityArguments

Objet

Représente les arguments avec lesquels l’activité d’extraction d’index de recherche a été exécutée.

Nom	Type	Description
filter	string	Chaîne de filtre.
queryType	QueryType	La syntaxe de la requête utilisée pour exécuter la recherche. Les indices de requête peuvent amener les requêtes sémantiques à utiliser la syntaxe complète des requêtes.
search	string	Chaîne de recherche utilisée pour interroger l’index de recherche.
searchFields	SearchIndexFieldReference[]	Quels champs ont été consultés.
semanticConfigurationName	string	Quelle configuration sémantique a été utilisée à partir de l’index de recherche.
sourceDataFields	SearchIndexFieldReference[]	Quels champs ont été sélectionnés pour la recherche.

KnowledgeBaseSearchIndexActivityRecord

Objet

Représente un enregistrement d’activité d’extraction d’index de recherche.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Détails sur les expressions générées à partir des indices de requête pour cette activité.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Arguments d’index de recherche pour l’activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: searchIndex	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.

KnowledgeBaseSearchIndexReference

Objet

Représente une référence de document Recherche Azure.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
citationUrl	string (uri)	Une URL appartenant à Search, pointant vers le document de soutien de cette référence, utilisable comme cible de citation.
docKey	string	Clé de document de référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: searchIndex	Type de référence.

KnowledgeBaseWebActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération web a été menée.

Nom	Type	Description
count	integer (int32)	Le nombre de résultats web est revenu.
freshness	string	La fraîcheur pour l’activité de récupération.
language	string	Le langage pour l’activité de récupération.
market	string	Le marché pour l’activité de récupération.
search	string	La chaîne de recherche utilisée pour interroger le web.

KnowledgeBaseWebActivityRecord

Objet

Représente un enregistrement d’activité de récupération web.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: web	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.
webArguments	KnowledgeBaseWebActivityArguments	Les arguments web pour l’activité de récupération.

KnowledgeBaseWebReference

Objet

Représente une référence de document Web.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
sourceData		Les données sources pour la référence.
title	string	Le titre du document web.
type	string: web	Type de référence.
url	string (uri)	L’URL d’où proviennent les données de référence.

KnowledgeBaseWorkIQActivityArguments

Objet

Représente les arguments avec lesquels l’activité de récupération WorkIQ a été menée.

Nom	Type	Description
search	string	La chaîne de recherche utilisée pour interroger la source de connaissances WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Objet

Représente un enregistrement d’activité de récupération WorkIQ.

Nom	Type	Description
completedAt	string (date-time)	Le moment auquel l’activité s’est terminée.
count	integer (int32)	Le nombre de documents récupérés qui étaient suffisamment pertinents pour passer le seuil de reranker.
elapsedMs	integer (int32)	Temps écoulé en millisecondes pour l’activité d’extraction.
error	KnowledgeBaseErrorDetail	L’erreur détaille la raison de l’échec de l’opération. Cette propriété n’est incluse que lorsque l’activité ne réussit pas.
id	integer (int32)	ID de l’enregistrement d’activité.
imageServing	ImageServingStatistics	Statistiques sur le service d’image pour cette activité de récupération
knowledgeSourceName	string	Source de connaissances pour l’activité d’extraction.
queryTime	string (date-time)	Temps de requête pour cette activité d’extraction.
startedAt	string (date-time)	L’heure à laquelle l’activité a commencé.
type	string: workIQ	Type d’enregistrement d’activité.
warning	string	Un message d’avertissement révélant d’éventuels problèmes de configuration observés pendant l’activité, tels que des documents perdus en raison du seuil de score, de la troncature de la limite de jetons ou des conditions d’expiration de temps.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	Les arguments WorkIQ pour l’activité de récupération.

KnowledgeBaseWorkIQReference

Objet

Représente une référence de document WorkIQ.

Nom	Type	Description
activitySource	integer (int32)	ID de l’activité source de la référence.
id	string	ID de la référence.
rerankerScore	number (float)	Le score du reranker pour la référence du document.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Les informations sur l’étiquette de sensibilité pour la référence.
sourceData		Les données sources pour la référence.
type	string: workIQ	Type de référence.

KnowledgeRetrievalAutoReasoningEffort

Objet

Sélectionnez automatiquement l’effort de raisonnement lors de la récupération. Le service soumet chaque demande au niveau le moins cher et ne monte que jusqu’au niveau maximal disponible du service.

Nom	Type	Description
kind	string: auto	Le genre d’effort de raisonnement.

KnowledgeRetrievalIntentType

Énumération

Le type de configuration de la base de connaissances à utiliser.

Valeur	Description
semantic	Intention de requête sémantique en langage naturel.

KnowledgeRetrievalLowReasoningEffort

Objet

Exécutez la récupération des connaissances avec un faible effort de raisonnement.

Nom	Type	Description
kind	string: low	Le genre d’effort de raisonnement.

KnowledgeRetrievalMediumReasoningEffort

Objet

Exécutez la récupération des connaissances avec un effort de raisonnement moyen.

Nom	Type	Description
kind	string: medium	Le genre d’effort de raisonnement.

KnowledgeRetrievalMinimalReasoningEffort

Objet

Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement.

Nom	Type	Description
kind	string: minimal	Le genre d’effort de raisonnement.

KnowledgeRetrievalOutputMode

Énumération

Configuration de sortie pour cette extraction.

Valeur	Description
extractiveData	Retournez des données à partir des sources de connaissances directement sans modification générative.
answerSynthesis	Synthétisez une réponse pour la charge utile de réponse.

KnowledgeRetrievalReasoningEffortKind

Énumération

La quantité d’effort à fournir lors de la récupération.

Valeur	Description
minimal	N’effectue pas de sélections de sources, de planification de requêtes ou de recherche itérative.
low	Utilisez un raisonnement faible lors de la récupération.
medium	Utilisez une quantité modérée de raisonnement pendant la récupération.
auto	Sélectionnez automatiquement l’effort de raisonnement lors de la récupération, en augmentant du niveau le moins cher uniquement dans la mesure des besoins.

KnowledgeRetrievalSemanticIntent

Objet

Une intention de requête sémantique.

Nom	Type	Description
search	string	La requête sémantique à exécuter
type	string: semantic	Type d’intention.

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.

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.

McpServerKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances serveur MCP

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: mcpServer	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

PurviewSensitivityLabelInfo

Objet

Informations sur l’étiquette de sensibilité appliquée à un document

Nom	Type	Description
color	string	Couleur que l’interface utilisateur doit afficher pour l’étiquette, si elle est configurée.
displayName	string	Nom d’affichage de l’étiquette de confidentialité.
isEncrypted	boolean	Indique si l’étiquette de confidentialité applique le chiffrement.
priority	integer (int32)	Priorité dans laquelle l’étiquette de confidentialité est appliquée.
sensitivityLabelId	string	ID de l’étiquette de confidentialité.
toolTip	string	Info-bulle qui doit être affichée pour l’étiquette dans une interface utilisateur.

QueryType

Énumération

Spécifie la syntaxe de la requête de recherche. La valeur par défaut est « simple ». Utilisez 'full' si votre requête utilise la syntaxe de requête Lucene et 'semantic' si la syntaxe de requête n’est pas nécessaire.

Valeur	Description
simple	Utilise la syntaxe de requête simple pour les recherches. Le texte de recherche est interprété à l’aide d’un langage de requête simple qui autorise l’utilisation de symboles tels que +, * et « ». Par défaut, les requêtes sont évaluées dans tous les champs pouvant faire l’objet d’une recherche, sauf si le paramètre searchFields est spécifié.
full	Utilise la syntaxe de requête Lucene complète pour les recherches. Le texte de recherche est interprété à l’aide du langage de requête Lucene qui permet des recherches spécifiques aux champs et pondérées, ainsi que d’autres fonctionnalités avancées.
semantic	Idéal pour les requêtes exprimées en langage naturel plutôt que pour les mots-clés. Améliore la précision des résultats de recherche en reclassant les premiers résultats de recherche à l’aide d’un modèle de classement entraîné sur le corpus Web.

RemoteSharePointKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances SharePoint distante

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
filterExpressionAddOn	string	Condition de filtre appliquée à la source de données SharePoint. Il doit être spécifié dans la syntaxe du langage de requête de mots-clés. Elle sera combinée en conjonction avec l’expression de filtre spécifiée dans la définition de la source de connaissances.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: remoteSharePoint	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

SearchIndexFieldReference

Objet

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

Nom	Type	Description
name	string	Nom du champ.

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.

SearchIndexKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances d’index de recherche

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
filterAddOn	string	Une condition de filtre appliquée à l’index (par exemple, 'State eq VA').
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: searchIndex	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Des astuces qui guident la planification des requêtes vers des filtres et des améliorations utiles. Si spécifié, cet objet remplace l’ensemble complet des indices de requête configurés sur la source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

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.

ServedImage

Objet

Décrit une seule image que le modèle a sélectionnée pour être servie lors d’une activité de récupération.

Nom	Type	Description
imageId	string	L’étiquette de l’image extraite du document source par Content Understanding enrichment. Correspond à la numérotation des chiffres dans le document original.
imagePath	string	Le chemin relatif vers l’image dans le magasin d’assets.
sizeBytes	integer (int64)	La taille en octets de cette image telle qu’envoyée au modèle.

WebKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution d’une source de connaissances Web

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
count	integer (int32)	Le nombre de résultats web à renvoyer.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
freshness	string	La fraîcheur des résultats web.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: web	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
language	string	La langue des résultats web.
market	string	Le marché des résultats web.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.

WorkIQKnowledgeSourceParams

Objet

Spécifie les paramètres d’exécution pour une source de connaissances WorkIQ

Nom	Type	Description
alwaysQuerySource	boolean	Indique que cette source de connaissances doit contourner la sélection de la source et être toujours interrogée au moment de la récupération.
enableImageServing	boolean	Indique si le service d’image doit être activé pour cette source de connaissances au moment de la récupération. Lorsque c’est vrai, les images extraites lors de l’ingestion sont transmises aux modèles en aval.
failOnError	boolean	Indique que l’ensemble de la requête de récupération devrait échouer si la récupération depuis cette source de connaissances rencontre une erreur. La valeur par défaut est false.
includeReferenceSourceData	boolean	Indique si les références doivent inclure les données structurées obtenues lors de l’extraction dans leur charge utile.
includeReferences	boolean	Indique si des références doivent être incluses pour les données extraites de cette source.
kind	string: workIQ	Le type de source de connaissances.
knowledgeSourceName	string	Nom de l’index auquel les paramètres s’appliquent.
maxOutputDocuments	integer (int32)	Limite le nombre maximal de documents retournés depuis cette source de connaissances.
neverQuerySource	boolean	Indique que cette source de connaissances doit être exclue de l’ensemble de candidats de la requête et jamais interrogée au moment de la récupération. L’exclusion est requête-locale et ne modifie pas l’appartenance à la base de connaissances. Ne peut pas être combiné avec alwaysQuerySource sur la même source de connaissances.
rerankerThreshold	number (float)	Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse.
resultsProcessing	KnowledgeSourceResultsProcessing	Supprime uniquement les résultats de traitement stockés par la source de connaissance pour cet appel de récupération. Lorsqu’elle est omise, la valeur de la source de connaissances stockée s’applique.