Knowledge Retrieval - Retrieve
La base de connaissances récupère les données pertinentes à partir des magasins de sauvegarde.
POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-10-01
Paramètres URI
| Nom | Dans | Obligatoire | Type | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL du point de terminaison du service de recherche. |
|
knowledge
|
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 | Obligatoire | Type | Description |
|---|---|---|---|
| Accept |
L’en-tête Accept. |
||
| x-ms-query-source-authorization |
string (password) |
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-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[]: |
Liste des requêtes prévues à exécuter sans planification de requête de modèle. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
Liste des paramètres d’exécution des sources de connaissances. |
| maxOutputDocuments |
integer (int32) |
Limite le nombre maximal de documents 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 |
Une liste d’entrées de style de message de chat. |
|
| outputMode |
Configuration de sortie pour cette extraction. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
La configuration de l’effort de raisonnement de récupération. |
Réponses
| Nom | Type | Description |
|---|---|---|
| 200 OK |
Réponse de prélèvement réussie. |
|
| Other Status Codes |
Réponse de récupération partielle. |
|
| Other Status Codes |
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
|
Knowledge |
|
Knowledge |
KnowledgeBaseRetrieve
Exemple de requête
POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01
{
"messages": [
{
"role": "user",
"content": [
{
"type": "text",
"text": "hello world"
}
]
}
],
"maxRuntimeInSeconds": 60,
"maxOutputDocuments": 5,
"maxOutputSizeInTokens": 100000,
"retrievalReasoningEffort": {
"kind": "low"
},
"includeActivity": true,
"outputMode": "answerSynthesis",
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-stable-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex",
"alwaysQuerySource": true,
"filterAddOn": "foo eq bar"
}
]
}
Exemple de réponse
{
"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": 1234
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
"searchIndexArguments": {
"search": "hello world",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-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)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"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": 1234
},
{
"type": "searchIndex",
"id": 1,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-test",
"queryTime": "2025-01-01T00:08:45.045Z",
"count": 2,
"elapsedMs": 1234,
"searchIndexArguments": {
"search": "hello world",
"filter": "(category eq 'news') and (foo eq bar)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "searchIndex",
"id": 2,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"knowledgeSourceName": "ks-stable-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)",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "category"
},
{
"name": "description"
},
{
"name": "ownerId"
},
{
"name": "id"
}
],
"searchFields": []
}
},
{
"type": "agenticReasoning",
"id": 3,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"reasoningTokens": 74
},
{
"type": "modelAnswerSynthesis",
"id": 4,
"startedAt": "2025-01-01T00:08:45.045Z",
"completedAt": "2025-01-01T00:08:46.279Z",
"inputTokens": 11,
"outputTokens": 22,
"elapsedMs": 1234
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 1,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 1,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
KnowledgeBaseRetrieveWithIntents
Exemple de requête
POST https://typespecstableexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-10-01
{
"intents": [
{
"type": "semantic",
"search": "foo"
}
],
"maxRuntimeInSeconds": 60,
"maxOutputSizeInTokens": 100000,
"retrievalReasoningEffort": {
"kind": "minimal"
},
"includeActivity": true,
"knowledgeSourceParams": [
{
"knowledgeSourceName": "ks-stable-test",
"includeReferences": true,
"includeReferenceSourceData": true,
"rerankerThreshold": 2.1,
"kind": "searchIndex",
"alwaysQuerySource": true,
"filterAddOn": "foo eq bar"
}
]
}
Exemple de réponse
{
"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-stable-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": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
{
"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-stable-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": 37
}
],
"references": [
{
"type": "searchIndex",
"id": "83dd7d40",
"activitySource": 0,
"rerankerScore": 3.5,
"docKey": "myDocKey1",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey1",
"title": "high_doc",
"content": "hello world"
}
},
{
"type": "searchIndex",
"id": "83dd7d41",
"activitySource": 0,
"rerankerScore": 2.7,
"docKey": "myDocKey2",
"citationUrl": "https://typespecstableexampleservice.search.windows.net/indexes/stable-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-10-01&allowUnsafeKeys=true",
"sourceData": {
"id": "myDocKey2",
"title": "low_doc",
"content": "goodbye world"
}
}
]
}
Définitions
| Nom | Description |
|---|---|
| Accept |
L’en-tête Accept. |
|
Azure |
Spécifie les paramètres d’exécution d’une source de connaissances d’objet blob azure |
|
Error |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Error |
Détail de l’erreur. |
|
Error |
Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.). |
|
File |
Spécifie les paramètres d’exécution pour une source de connaissances de fichier |
|
Indexed |
Spécifie les paramètres d’exécution d’une source de connaissances OneLake indexée |
|
Indexed |
Spécifie les paramètres d’exécution d’une source de connaissances SharePoint indexée |
|
Indexed |
Spécifie les paramètres d’exécution pour une source de connaissances SQL indexée |
|
Knowledge |
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. |
|
Knowledge |
Le type de dossier d’activité. |
|
Knowledge |
Représente un enregistrement d’activité de raisonnement agentique. |
|
Knowledge |
Représente les arguments avec lesquels l’activité d’extraction d’objets blob Azure a été exécutée. |
|
Knowledge |
Représente un enregistrement d’activité d’extraction d’objets blob Azure. |
|
Knowledge |
Représente une référence de document de référence sur le stockage Blob Azure. |
|
Knowledge |
Informations supplémentaires sur l’erreur de gestion des ressources. |
|
Knowledge |
Détails de l’erreur. |
|
Knowledge |
Représente les arguments avec lesquels l’activité de récupération de fichiers a été exécutée. |
|
Knowledge |
Représente un enregistrement d’activité de récupération de fichiers. |
|
Knowledge |
Représente une référence à un document de fichier. |
|
Knowledge |
Contenu d’images. |
|
Knowledge |
Représente les arguments avec lesquels l’activité de récupération indexée de OneLake a été menée. |
|
Knowledge |
Représente un enregistrement indexé d’activité de récupération OneLake. |
|
Knowledge |
Représente une référence indexée de document OneLake. |
|
Knowledge |
Représente les arguments avec lesquels l’activité indexée de récupération SharePoint a été exécutée. |
|
Knowledge |
Représente un enregistrement d’activité de récupération SharePoint indexé. |
|
Knowledge |
Représente une référence indexée à un document SharePoint. |
|
Knowledge |
Représente les arguments avec lesquels l’activité de récupération SQL indexée a été exécutée. |
|
Knowledge |
Représente un enregistrement d’activité de récupération SQL indexé. |
|
Knowledge |
Représente une référence de document Azure SQL. |
|
Knowledge |
Objet de style de message en langage naturel. |
|
Knowledge |
Le type de contenu du message. |
|
Knowledge |
Type de message d’image. |
|
Knowledge |
Type de SMS. |
|
Knowledge |
Représente un enregistrement d’activité de synthèse de réponse LLM. |
|
Knowledge |
Représente un enregistrement d’activité de planification de requête LLM. |
|
Knowledge |
Représente un enregistrement d’activité de synthèse web de LLM. |
|
Knowledge |
Type de référence. |
|
Knowledge |
Contrat d’entrée pour la demande d’extraction. |
|
Knowledge |
Contrat de sortie pour la réponse d’extraction. |
|
Knowledge |
Représente les arguments avec lesquels l’activité d’extraction d’index de recherche a été exécutée. |
|
Knowledge |
Représente un enregistrement d’activité d’extraction d’index de recherche. |
|
Knowledge |
Représente une référence de document Recherche Azure. |
|
Knowledge |
Représente les arguments avec lesquels l’activité de récupération web a été menée. |
|
Knowledge |
Représente un enregistrement d’activité de récupération web. |
|
Knowledge |
Représente une référence de document Web. |
|
Knowledge |
Le type de configuration de la base de connaissances à utiliser. |
|
Knowledge |
Exécutez la récupération des connaissances avec un faible effort de raisonnement. |
|
Knowledge |
Exécutez la récupération des connaissances avec un effort de raisonnement moyen. |
|
Knowledge |
Exécutez la récupération des connaissances avec un minimum d’effort de raisonnement. |
|
Knowledge |
Configuration de sortie pour cette extraction. |
|
Knowledge |
La quantité d’effort à fournir lors de la récupération. |
|
Knowledge |
Une intention de requête sémantique. |
|
Knowledge |
Le type de source de connaissance. |
|
Search |
Référence de champ pour un index de recherche. |
|
Search |
Spécifie les paramètres d’exécution d’une source de connaissances d’index de recherche |
|
Web |
Spécifie les paramètres d’exécution d’une source de connaissances Web |
Accept
L’en-tête Accept.
| Valeur | Description |
|---|---|
| application/json;odata.metadata=minimal |
AzureBlobKnowledgeSourceParams
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. |
| 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:
azure |
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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
ErrorAdditionalInfo
Informations supplémentaires sur l’erreur de gestion des ressources.
| Nom | Type | Description |
|---|---|---|
| info |
Informations supplémentaires |
|
| type |
string |
Le type d’informations supplémentaires. |
ErrorDetail
Détail de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations complémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
ErrorResponse
Réponse à l’erreur courante pour toutes les API Azure Resource Manager afin de renvoyer les détails d’erreur pour les opérations ratées. (Cela suit également le format de réponse d’erreur OData.).
| Nom | Type | Description |
|---|---|---|
| error |
Objet d’erreur. |
FileKnowledgeSourceParams
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. |
| 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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
IndexedOneLakeKnowledgeSourceParams
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. |
| 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:
indexed |
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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
IndexedSharePointKnowledgeSourceParams
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. |
| 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:
indexed |
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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
IndexedSqlKnowledgeSourceParams
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. |
| 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:
indexed |
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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
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.
| 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
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. |
| 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
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 |
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é. |
| reasoningTokens |
integer (int32) |
Nombre de jetons d’entrée pour le raisonnement agentique. |
| startedAt |
string (date-time) |
L’heure à laquelle l’activité a commencé. |
| type |
string:
agentic |
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
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
Représente un enregistrement d’activité d’extraction d’objets blob Azure.
| Nom | Type | Description |
|---|---|---|
| azureBlobArguments |
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 |
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é. |
| 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:
azure |
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
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. |
| sourceData |
Les données sources pour la référence. |
|
| type |
string:
azure |
Type de référence. |
KnowledgeBaseErrorAdditionalInfo
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
Détails de l’erreur.
| Nom | Type | Description |
|---|---|---|
| additionalInfo |
Informations complémentaires sur l’erreur. |
|
| code |
string |
Code d’erreur. |
| details |
Détails de l’erreur. |
|
| message |
string |
Message d’erreur. |
| target |
string |
Cible d’erreur. |
KnowledgeBaseFileActivityArguments
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
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 |
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 |
Les arguments du fichier pour l’activité de récupération. |
|
| id |
integer (int32) |
ID de l’enregistrement d’activité. |
| 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:
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
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
Contenu d’images.
| Nom | Type | Description |
|---|---|---|
| url |
string (uri) |
L’URL de l’image. |
KnowledgeBaseIndexedOneLakeActivityArguments
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
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 |
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é. |
| indexedOneLakeArguments |
Les arguments indexés de OneLake pour l’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:
indexed |
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
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. |
| sourceData |
Les données sources pour la référence. |
|
| type |
string:
indexed |
Type de référence. |
KnowledgeBaseIndexedSharePointActivityArguments
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
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 |
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é. |
| indexedSharePointArguments |
Les arguments indexés SharePoint pour l’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:
indexed |
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
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. |
| sourceData |
Les données sources pour la référence. |
|
| type |
string:
indexed |
Type de référence. |
KnowledgeBaseIndexedSqlActivityArguments
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
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 |
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é. |
| indexedSqlArguments |
Les arguments SQL indexés pour l’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:
indexed |
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
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:
indexed |
Type de référence. |
KnowledgeBaseMessage
Objet de style de message en langage naturel.
| Nom | Type | Description |
|---|---|---|
| content | KnowledgeBaseMessageContent[]: |
Contenu du message. |
| role |
string |
Le rôle de la réponse de l’outil. |
KnowledgeBaseMessageContentType
Le type de contenu du message.
| Valeur | Description |
|---|---|
| text |
Type de contenu de message texte. |
| image |
Type de contenu de message d’image. |
KnowledgeBaseMessageImageContent
Type de message d’image.
| Nom | Type | Description |
|---|---|---|
| image |
Le contenu de l’image. |
|
| type |
string:
image |
Type du message |
KnowledgeBaseMessageTextContent
Type de SMS.
| Nom | Type | Description |
|---|---|---|
| text |
string |
Contenu du texte. |
| type |
string:
text |
Type du message |
KnowledgeBaseModelAnswerSynthesisActivityRecord
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 |
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 |
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:
model |
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
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 |
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 |
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:
model |
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
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 |
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 |
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:
model |
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. |
KnowledgeBaseReferenceType
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. |
| file |
Référence de document à déposer. |
| indexedSql |
Référence de document SQL indexé. |
KnowledgeBaseRetrievalRequest
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[]: |
Liste des requêtes prévues à exécuter sans planification de requête de modèle. |
| knowledgeSourceParams | KnowledgeSourceParams[]: |
Liste des paramètres d’exécution des sources de connaissances. |
| maxOutputDocuments |
integer (int32) |
Limite le nombre maximal de documents 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 |
Une liste d’entrées de style de message de chat. |
|
| outputMode |
Configuration de sortie pour cette extraction. |
|
| retrievalReasoningEffort | KnowledgeRetrievalReasoningEffort: |
La configuration de l’effort de raisonnement de récupération. |
KnowledgeBaseRetrievalResponse
Contrat de sortie pour la réponse d’extraction.
| Nom | Type | Description |
|---|---|---|
| activity |
KnowledgeBaseActivityRecord[]:
|
Les enregistrements d’activité permettent de suivre l’avancement et les implications de facturation. |
| references | KnowledgeBaseReference[]: |
Les références des données d’extraction utilisées dans la réponse. |
| response |
Les messages de réponse. |
KnowledgeBaseSearchIndexActivityArguments
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. |
| search |
string |
Chaîne de recherche utilisée pour interroger l’index de recherche. |
| searchFields |
Quels champs ont été consultés. |
|
| semanticConfigurationName |
string |
Quelle configuration sémantique a été utilisée à partir de l’index de recherche. |
| sourceDataFields |
Quels champs ont été sélectionnés pour la recherche. |
KnowledgeBaseSearchIndexActivityRecord
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 |
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é. |
| knowledgeSourceName |
string |
Source de connaissances pour l’activité d’extraction. |
| queryTime |
string (date-time) |
Temps de requête pour cette activité d’extraction. |
| searchIndexArguments |
Arguments d’index de recherche pour l’activité d’extraction. |
|
| startedAt |
string (date-time) |
L’heure à laquelle l’activité a commencé. |
| type |
string:
search |
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
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. |
| sourceData |
Les données sources pour la référence. |
|
| type |
string:
search |
Type de référence. |
KnowledgeBaseWebActivityArguments
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
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 |
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é. |
| 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 |
Les arguments web pour l’activité de récupération. |
KnowledgeBaseWebReference
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. |
KnowledgeRetrievalIntentType
Le type de configuration de la base de connaissances à utiliser.
| Valeur | Description |
|---|---|
| semantic |
Intention de requête sémantique en langage naturel. |
KnowledgeRetrievalLowReasoningEffort
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
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
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
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
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. |
KnowledgeRetrievalSemanticIntent
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
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. |
| file |
Une source de connaissances qui supporte l’upload et l’indexation directes des fichiers. |
SearchIndexFieldReference
Référence de champ pour un index de recherche.
| Nom | Type | Description |
|---|---|---|
| name |
string |
Nom du champ. |
SearchIndexKnowledgeSourceParams
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. |
| 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:
search |
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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |
WebKnowledgeSourceParams
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. |
| 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. |
| rerankerThreshold |
number (float) |
Le seuil de reclassement que tous les documents récupérés doivent atteindre pour être inclus dans la réponse. |