Knowledge Retrieval - Retrieve

Service:: Search Service

API-versie:: 2026-08-01-preview

KnowledgeBase haalt relevante gegevens op uit back-uparchieven.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-01-preview

URI-parameters

Naam	In	Vereist	Type	Description
endpoint	path	True	string (uri)	De eindpunt-URL van de zoekservice.
knowledgeBaseName	path	True	string	De naam van de kennisbank.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagkoptekst

Naam	Type	Description
Accept	Accept	De Accepteer kop.
x-ms-query-source-authorization	string	Token dat de gebruiker identificeert waarvoor de query wordt uitgevoerd. Dit token wordt gebruikt om beveiligingsbeperkingen op documenten af te dwingen.
x-ms-query-work-iq-source-authorization	string (password)	Gebruikersassertietoken voor een door de klant beheerde Entra-appregistratie geconfigureerd op een Work IQ-kennisbron. Gebruikt voor on-beside-of-authenticatie van de Work IQ API.
x-ms-client-request-id	string (uuid)	Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Naam	Type	Description
includeActivity	boolean	Geeft aan dat de ophaalresultaten activiteitsinformatie moeten bevatten.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Een lijst met beoogde query's die moeten worden uitgevoerd zonder modelqueryplanning.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Een lijst met runtime-parameters voor de kennisbronnen.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten in de output.
maxOutputSize	integer (int32)	Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxOutputSizeInTokens	integer (int32)	Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxRuntimeInSeconds	integer (int32)	De maximale looptijd in seconden.
messages	KnowledgeBaseMessage[]	Een lijst met invoer in de stijl van chatberichten.
outputMode	KnowledgeRetrievalOutputMode	De uitvoerconfiguratie voor dit ophalen.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De configuratie van de ophaal-redeneerinspanning.

Antwoorden

Naam	Type	Description
200 OK	KnowledgeBaseRetrievalResponse	Succesvolle retrievalrespons.
Other Status Codes	KnowledgeBaseRetrievalResponse	Gedeeltelijke retrievalrespons.
Other Status Codes	ErrorResponse	Een onverwachte foutreactie.

Beveiliging

api-key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Bereiken

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

Voorbeelden

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Voorbeeldaanvraag

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
          }
        ]
      }
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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"
      }
    }
  ]
}

Statuscode:: 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

Voorbeeldaanvraag

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
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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"
      }
    }
  ]
}

Statuscode:: 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

Voorbeeldaanvraag

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
          }
        ]
      }
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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"
      }
    }
  ]
}

Statuscode:: 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

Voorbeeldaanvraag

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"
    }
  ]
}

Voorbeeldrespons

Statuscode:: 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"
    }
  ]
}

Statuscode:: 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"
    }
  ]
}

Definities

Naam	Description
Accept	De Accepteer kop.
AzureBlobKnowledgeSourceParams	Hiermee geeft u runtimeparameters op voor een Azure-blob-kennisbron
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	Het foutdetail.
ErrorResponse	Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
FabricDataAgentKnowledgeSourceParams	Specificeert runtime-parameters voor een kennisbron van een Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Specificeert runtime-parameters voor een Fabric Ontology kennisbron
FileKnowledgeSourceParams	Specificeert runtime-parameters voor een bestandskennis bron
ImageServingStatistics	Statistieken over beeldservice tijdens een ophaalactiviteit.
IndexedOneLakeKnowledgeSourceParams	Specificeert runtimeparameters voor een geïndexeerde OneLake-kennisbron
IndexedSharePointKnowledgeSourceParams	Specificeert runtimeparameters voor een geïndexeerde SharePoint-kennisbron
IndexedSqlKnowledgeSourceParams	Specificeert runtime-parameters voor een geïndexeerde SQL-kennisbron
KnowledgeBaseActivityRecordModel	Vertegenwoordigt het model dat wordt gebruikt voor een kennisbank-LLM-activiteit, inclusief de modelnaam en implementatie-identificatie.
KnowledgeBaseActivityRecordType	Het type activiteitsrecord.
KnowledgeBaseAgenticReasoningActivityRecord	Vertegenwoordigt een activiteitsrecord voor handelend redeneren.
KnowledgeBaseAzureBlobActivityArguments	Vertegenwoordigt de argumenten waarmee de activiteit voor het ophalen van azure-blobs is uitgevoerd.
KnowledgeBaseAzureBlobActivityRecord	Vertegenwoordigt een activiteitsrecord voor het ophalen van Azure-blobs.
KnowledgeBaseAzureBlobReference	Vertegenwoordigt een Azure Blob Storage-documentverwijzing.
KnowledgeBaseErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
KnowledgeBaseErrorDetail	De foutgegevens.
KnowledgeBaseFabricDataAgentActivityArguments	Vertegenwoordigt de argumenten waarmee de Fabric Data Agent ophaalactiviteit is uitgevoerd.
KnowledgeBaseFabricDataAgentActivityRecord	Vertegenwoordigt een Fabric Data Agent ophaalactiviteitsrecord.
KnowledgeBaseFabricDataAgentReference	Vertegenwoordigt een Fabric Data Agent-documentreferentie.
KnowledgeBaseFabricOntologyActivityArguments	Vertegenwoordigt de argumenten waarmee de Fabric Ontology retrieval-activiteit werd uitgevoerd.
KnowledgeBaseFabricOntologyActivityRecord	Vertegenwoordigt een Fabric Ontology retrievalactiviteitsrecord.
KnowledgeBaseFabricOntologyReference	Vertegenwoordigt een Fabric Ontology-documentreferentie.
KnowledgeBaseFileActivityArguments	Stelt de argumenten voor waarmee de bestandsophaalactiviteit is uitgevoerd.
KnowledgeBaseFileActivityRecord	Vertegenwoordigt een bestandsophaalactiviteitsrecord.
KnowledgeBaseFileReference	Vertegenwoordigt een referentie van een bestandsdocument.
KnowledgeBaseImageContent	Beeldinhoud.
KnowledgeBaseIndexedOneLakeActivityArguments	Geeft de argumenten weer waarmee de geïndexeerde OneLake-ophaalactiviteit is uitgevoerd.
KnowledgeBaseIndexedOneLakeActivityRecord	Vertegenwoordigt een geïndexeerd OneLake ophaalactiviteitsrecord.
KnowledgeBaseIndexedOneLakeReference	Vertegenwoordigt een geïndexeerde documentreferentie van OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Geeft de argumenten weer waarmee de geïndexeerde SharePoint-ophaalactiviteit is uitgevoerd.
KnowledgeBaseIndexedSharePointActivityRecord	Vertegenwoordigt een geïndexeerd SharePoint-ophaalactiviteitsrecord.
KnowledgeBaseIndexedSharePointReference	Vertegenwoordigt een geïndexeerde SharePoint-documentreferentie.
KnowledgeBaseIndexedSqlActivityArguments	Geeft de argumenten weer waarmee de geïndexeerde SQL-ophaalactiviteit is uitgevoerd.
KnowledgeBaseIndexedSqlActivityRecord	Vertegenwoordigt een geïndexeerd SQL-ophaalactiviteitsrecord.
KnowledgeBaseIndexedSqlReference	Vertegenwoordigt een Azure SQL-documentreferentie.
KnowledgeBaseMcpServerActivityArguments	Geeft de argumenten weer waarmee de MCP-serverophaalactiviteit is uitgevoerd.
KnowledgeBaseMcpServerActivityRecord	Vertegenwoordigt een MCP-server ophaalactiviteitsrecord.
KnowledgeBaseMcpServerReference	Stelt een MCP-serverdocumentreferentie voor.
KnowledgeBaseMessage	Het object in de stijl van berichten in natuurlijke taal.
KnowledgeBaseMessageContentType	Het type berichtinhoud.
KnowledgeBaseMessageImageContent	Afbeelding berichttype.
KnowledgeBaseMessageTextContent	Type tekstbericht.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Vertegenwoordigt een activiteitsrecord voor de synthese van LLM-antwoorden.
KnowledgeBaseModelQueryPlanningActivityRecord	Vertegenwoordigt een activiteitsrecord voor LLM-queryplanning.
KnowledgeBaseModelWebSummarizationActivityRecord	Vertegenwoordigt een LLM-websamenvattingsactiviteitsrecord.
KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor een ophaalactiviteit.
KnowledgeBaseReferenceType	Het type verwijzing.
KnowledgeBaseRemoteSharePointActivityArguments	Geeft de argumenten weer waarmee de remote SharePoint-ophaalactiviteit is uitgevoerd.
KnowledgeBaseRemoteSharePointActivityRecord	Vertegenwoordigt een remote SharePoint-ophaalactiviteitsrecord.
KnowledgeBaseRemoteSharePointReference	Vertegenwoordigt een remote SharePoint-documentreferentie.
KnowledgeBaseRetrievalRequest	Het invoercontract voor het opgehaalde verzoek.
KnowledgeBaseRetrievalResponse	Het outputcontract voor het ophaalantwoord.
KnowledgeBaseSearchIndexActivityArguments	Vertegenwoordigt de argumenten waarmee de zoekindexophaalactiviteit is uitgevoerd.
KnowledgeBaseSearchIndexActivityRecord	Vertegenwoordigt een activiteitsrecord voor het ophalen van een zoekindex.
KnowledgeBaseSearchIndexReference	Vertegenwoordigt een Azure Search-documentverwijzing.
KnowledgeBaseWebActivityArguments	Geeft de argumenten weer waarmee de webophaalactiviteit werd uitgevoerd.
KnowledgeBaseWebActivityRecord	Vertegenwoordigt een webophaalactiviteitsrecord.
KnowledgeBaseWebReference	Vertegenwoordigt een verwijzing naar een webdocument.
KnowledgeBaseWorkIQActivityArguments	Vertegenwoordigt de argumenten waarmee de WorkIQ-ophaalactiviteit werd uitgevoerd.
KnowledgeBaseWorkIQActivityRecord	Vertegenwoordigt een WorkIQ-ophaalactiviteitsrecord.
KnowledgeBaseWorkIQReference	Vertegenwoordigt een WorkIQ-documentreferentie.
KnowledgeRetrievalAutoReasoningEffort	Selecteer automatisch de redeneerinspanning tijdens het ophalen. De dienst zaadt elk verzoek op het goedkoopste niveau en escaleert alleen zover dat nodig is, tot het maximaal beschikbare niveau van de dienst.
KnowledgeRetrievalIntentType	Het soort kennisbankconfiguratie dat u kunt gebruiken.
KnowledgeRetrievalLowReasoningEffort	Voer het ophalen van kennis uit met weinig redeneerinspanning.
KnowledgeRetrievalMediumReasoningEffort	Voer het ophalen van kennis uit met gemiddelde redeneerinspanning.
KnowledgeRetrievalMinimalReasoningEffort	Voer het ophalen van kennis uit met minimale redeneerinspanning.
KnowledgeRetrievalOutputMode	De uitvoerconfiguratie voor dit ophalen.
KnowledgeRetrievalReasoningEffortKind	De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.
KnowledgeRetrievalSemanticIntent	Een semantische queryintentie.
KnowledgeSourceKind	Het soort kennisbron.
KnowledgeSourceResultsProcessing	Bepaalt of de resultaten van een kennisbron worden herschikt.
McpServerKnowledgeSourceParams	Specificeert runtime-parameters voor een MCP-serverkennisbron
PurviewSensitivityLabelInfo	Informatie over het gevoeligheidslabel dat op een document is aangebracht
QueryType	Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardwaarde is 'eenvoudig'. Gebruik 'full' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.
RemoteSharePointKnowledgeSourceParams	Hiermee geeft u runtimeparameters op voor een externe SharePoint-kennisbron
SearchIndexFieldReference	Veldreferentie voor een zoekindex.
SearchIndexKnowledgeSourceBoostKind	Het soort boost hint voor een zoekindex informatiebron.
SearchIndexKnowledgeSourceFieldValueBoost	Een tip die documenten versterkt op basis van een veldwaarde.
SearchIndexKnowledgeSourceFilterHint	Een hint die een veld en representatieve waarden identificeert die de queryplanner kan gebruiken bij het construeren van een filter.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Een tip die documenten versterkt op basis van een uitdrukking van meerdere woorden.
SearchIndexKnowledgeSourceParams	Hiermee geeft u runtimeparameters op voor een kennisbron van een zoekindex
SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning sturen naar nuttige filters en boosts voor een zoekindex-kennisbron.
ServedImage	Beschrijft een enkel beeld dat het model heeft gekozen om te worden bediend tijdens een ophaalactiviteit.
WebKnowledgeSourceParams	Specificeert runtimeparameters voor een webkennisbron
WorkIQKnowledgeSourceParams	Specificeert runtimeparameters voor een WorkIQ-kennisbron

Accept

Opsomming

De Accepteer kop.

Waarde	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

Hiermee geeft u runtimeparameters op voor een Azure-blob-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: azureBlob	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Naam	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

Object

Het foutdetail.

Naam	Type	Description
additionalInfo	ErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	ErrorDetail[]	De foutgegevens.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

ErrorResponse

Object

Veelvoorkomende foutreactie voor alle Azure Resource Manager-API's om foutdetails te retourneren voor mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)

Naam	Type	Description
error	ErrorDetail	Het foutobject.

FabricDataAgentKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een kennisbron van een Fabric Data Agent

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: fabricDataAgent	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

FabricOntologyKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een Fabric Ontology kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: fabricOntology	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

FileKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een bestandskennis bron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: file	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

ImageServingStatistics

Object

Statistieken over beeldservice tijdens een ophaalactiviteit.

Naam	Type	Description
imagesRetrieved	integer (int32)	Het aantal afbeeldingen dat uit de asset store is gehaald.
imagesSentToModel	integer (int32)	Het aantal beelden dat naar het downstreammodel wordt gestuurd.
servedImages	ServedImage[]	De set beelden die het model heeft gekozen om aan het downstreammodel te worden geleverd voor deze ophaalactiviteit.
totalImageSizeBytes	integer (int64)	De totale grootte in bytes aan afbeeldingen die naar het model worden gestuurd.
verbalizationUsed	boolean	Geeft aan of beeldverbalisatie is gebruikt in plaats van direct beeldservering.

IndexedOneLakeKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een geïndexeerde OneLake-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: indexedOneLake	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

IndexedSharePointKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een geïndexeerde SharePoint-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: indexedSharePoint	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

IndexedSqlKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een geïndexeerde SQL-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: indexedSql	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

KnowledgeBaseActivityRecordModel

Object

Vertegenwoordigt het model dat wordt gebruikt voor een kennisbank-LLM-activiteit, inclusief de modelnaam en implementatie-identificatie.

Naam	Type	Description
deploymentId	string	De deployment-identificatie van het model dat voor de activiteit wordt gebruikt.
modelName	string	De naam van het model dat voor de activiteit werd gebruikt.

KnowledgeBaseActivityRecordType

Opsomming

Het type activiteitsrecord.

Waarde	Description
searchIndex	Zoek indexophaalactiviteit.
azureBlob	Azure Blob ophaalactiviteit.
indexedSharePoint	Geïndexeerde SharePoint-ophaalactiviteit.
indexedOneLake	Geïndexeerde OneLake ophaalactiviteit.
web	Webopzoekactiviteit.
remoteSharePoint	Externe SharePoint-ophaalactiviteit.
workIQ	WorkIQ ophaalactiviteit.
fabricDataAgent	Fabric Data Agent ophaalactiviteit.
fabricOntology	Fabric Ontology opsporingsactiviteit.
mcpServer	MCP-serverophaalactiviteit.
file	Activiteit voor het ophalen van bestand.
indexedSql	Geïndexeerde SQL-opzoekactiviteit.
modelQueryPlanning	LLM-queryplanningsactiviteit.
modelAnswerSynthesis	LLM-antwoordsyntheseactiviteit.
modelWebSummarization	LLM-websamenvattingsactiviteit.
agenticReasoning	Agentisch redeneeractiviteit.

KnowledgeBaseAgenticReasoningActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor handelend redeneren.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De logische redeneerinspanning die door de klant wordt gevraagd. Dit is anders dan `retrievalReasoningEffort`, dat de redeneerinspanning rapporteert die wordt gebruikt voor facturering.
reasoningTokens	integer (int32)	Het aantal invoertokens voor agentisch redeneren.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De configuratie van de ophaal-redeneerinspanning.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: agenticReasoning	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseAzureBlobActivityArguments

Object

Vertegenwoordigt de argumenten waarmee de activiteit voor het ophalen van azure-blobs is uitgevoerd.

Naam	Type	Description
search	string	De zoekreeks die wordt gebruikt om de inhoud van blobs op te vragen.

KnowledgeBaseAzureBlobActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor het ophalen van Azure-blobs.

Naam	Type	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	De azure blob-argumenten voor de ophaalactiviteit.
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: azureBlob	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseAzureBlobReference

Object

Vertegenwoordigt een Azure Blob Storage-documentverwijzing.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
blobUrl	string	De blob-URL voor de verwijzing.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: azureBlob	Het type referentie.

KnowledgeBaseErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Naam	Type	Description
info		De aanvullende informatie.
type	string	Het extra informatietype.

KnowledgeBaseErrorDetail

Object

De foutgegevens.

Naam	Type	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Aanvullende informatie over de fout.
code	string	De foutcode.
details	KnowledgeBaseErrorDetail[]	De foutgegevens.
message	string	Het foutbericht.
target	string	Het foutdoelwit.

KnowledgeBaseFabricDataAgentActivityArguments

Object

Vertegenwoordigt de argumenten waarmee de Fabric Data Agent ophaalactiviteit is uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om de kennisbron van de Fabric Data Agent te bevragen.

KnowledgeBaseFabricDataAgentActivityRecord

Object

Vertegenwoordigt een Fabric Data Agent ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	De Fabric Data Agent argumenteert voor de ophaalactiviteit.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: fabricDataAgent	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseFabricDataAgentReference

Object

Vertegenwoordigt een Fabric Data Agent-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
dataAgentId	string	De Fabric Data Agent ID.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
type	string: fabricDataAgent	Het type referentie.
workspaceId	string	De Fabric werkruimte-id.

KnowledgeBaseFabricOntologyActivityArguments

Object

Vertegenwoordigt de argumenten waarmee de Fabric Ontology retrieval-activiteit werd uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om de kennisbron van Fabric Ontology te bevragen.

KnowledgeBaseFabricOntologyActivityRecord

Object

Vertegenwoordigt een Fabric Ontology retrievalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	De argumenten van de Fabric Ontology voor de ophaalactiviteit.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: fabricOntology	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseFabricOntologyReference

Object

Vertegenwoordigt een Fabric Ontology-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
id	string	De ID van de referentie.
ontologyId	string	De ontologie-ID binnen de werkruimte.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
type	string: fabricOntology	Het type referentie.
workspaceId	string	De Fabric werkruimte-id.

KnowledgeBaseFileActivityArguments

Object

Stelt de argumenten voor waarmee de bestandsophaalactiviteit is uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om bestandsinhoud op te vragen.

KnowledgeBaseFileActivityRecord

Object

Vertegenwoordigt een bestandsophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
fileArguments	KnowledgeBaseFileActivityArguments	Het bestand bevat argumenten voor de ophaalactiviteit.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: file	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseFileReference

Object

Vertegenwoordigt een referentie van een bestandsdocument.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
docName	string	De documentnaam voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
type	string: file	Het type referentie.

KnowledgeBaseImageContent

Object

Beeldinhoud.

Naam	Type	Description
url	string (uri)	De url van de afbeelding.

KnowledgeBaseIndexedOneLakeActivityArguments

Object

Geeft de argumenten weer waarmee de geïndexeerde OneLake-ophaalactiviteit is uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om geïndexeerde OneLake-inhoud op te vragen.

KnowledgeBaseIndexedOneLakeActivityRecord

Object

Vertegenwoordigt een geïndexeerd OneLake ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	De geïndexeerde OneLake-argumenten voor de ophaalactiviteit.
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: indexedOneLake	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseIndexedOneLakeReference

Object

Vertegenwoordigt een geïndexeerde documentreferentie van OneLake.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
docUrl	string	De document-URL voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: indexedOneLake	Het type referentie.

KnowledgeBaseIndexedSharePointActivityArguments

Object

Geeft de argumenten weer waarmee de geïndexeerde SharePoint-ophaalactiviteit is uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om geïndexeerde SharePoint-inhoud op te zoeken.

KnowledgeBaseIndexedSharePointActivityRecord

Object

Vertegenwoordigt een geïndexeerd SharePoint-ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	De geïndexeerde SharePoint-argumenten voor de ophaalactiviteit.
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: indexedSharePoint	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseIndexedSharePointReference

Object

Vertegenwoordigt een geïndexeerde SharePoint-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
docUrl	string	De document-URL voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: indexedSharePoint	Het type referentie.

KnowledgeBaseIndexedSqlActivityArguments

Object

Geeft de argumenten weer waarmee de geïndexeerde SQL-ophaalactiviteit is uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om geïndexeerde SQL-inhoud op te zoeken.

KnowledgeBaseIndexedSqlActivityRecord

Object

Vertegenwoordigt een geïndexeerd SQL-ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	De geïndexeerde SQL-argumenten voor de ophaalactiviteit.
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: indexedSql	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseIndexedSqlReference

Object

Vertegenwoordigt een Azure SQL-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
docUrl	string	De document-URL voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
type	string: indexedSql	Het type referentie.

KnowledgeBaseMcpServerActivityArguments

Object

Geeft de argumenten weer waarmee de MCP-serverophaalactiviteit is uitgevoerd.

Naam	Type	Description
toolArguments		De argumenten werden doorgegeven aan de MCP-servertool.
toolName	string	De naam van de MCP-servertool die voor de ophaalactiviteit wordt gebruikt.

KnowledgeBaseMcpServerActivityRecord

Object

Vertegenwoordigt een MCP-server ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	De MCP-server voert argumenten voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: mcpServer	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseMcpServerReference

Object

Stelt een MCP-serverdocumentreferentie voor.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
title	string	De titel van de MCP-servertool.
toolName	string	De naam van de MCP-servertool die de referentie produceerde.
type	string: mcpServer	Het type referentie.

KnowledgeBaseMessage

Object

Het object in de stijl van berichten in natuurlijke taal.

Naam	Type	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	De inhoud van het bericht.
role	string	De rol van de reactie van de tool.

KnowledgeBaseMessageContentType

Opsomming

Het type berichtinhoud.

Waarde	Description
text	Soort van inhoud van sms-berichten.
image	Soort afbeeldingsbericht.

KnowledgeBaseMessageImageContent

Object

Afbeelding berichttype.

Naam	Type	Description
image	KnowledgeBaseImageContent	De beeldinhoud.
type	string: image	Het type bericht

KnowledgeBaseMessageTextContent

Object

Type tekstbericht.

Naam	Type	Description
text	string	De tekstinhoud.
type	string: text	Het type bericht

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor de synthese van LLM-antwoorden.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
inputTokens	integer (int32)	Het aantal invoertokens voor de LLM-antwoordsyntheseactiviteit.
model	KnowledgeBaseActivityRecordModel	Het model dat wordt gebruikt voor de LLM-antwoordsynthese-activiteit.
outputTokens	integer (int32)	Het aantal uitvoertokens voor de LLM-antwoordsyntheseactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: modelAnswerSynthesis	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseModelQueryPlanningActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor LLM-queryplanning.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
inputTokens	integer (int32)	Het aantal invoertokens voor de LLM-queryplanningsactiviteit.
model	KnowledgeBaseActivityRecordModel	Het model dat wordt gebruikt voor de LLM-queryplanningsactiviteit.
outputTokens	integer (int32)	Het aantal uitvoertokens voor de LLM-queryplanningsactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: modelQueryPlanning	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseModelWebSummarizationActivityRecord

Object

Vertegenwoordigt een LLM-websamenvattingsactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
inputTokens	integer (int32)	Het aantal invoertokens voor de LLM-websamenvattingsactiviteit.
model	KnowledgeBaseActivityRecordModel	Het model dat wordt gebruikt voor de LLM-websamenvattingsactiviteit.
outputTokens	integer (int32)	Het aantal outputtokens voor de LLM-websamenvattingsactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: modelWebSummarization	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseQueryHintProcessing

Object

Details over de expressies die worden gegenereerd uit queryhints voor een ophaalactiviteit.

Naam	Type	Description
generatedBoost	string	De zoekclausule is gegenereerd uit boost-hints voor deze activiteit.
generatedFilter	string	De filterexpressie die uit het filter wordt gegenereerd, geeft aanwijzingen voor deze activiteit.

KnowledgeBaseReferenceType

Opsomming

Het type verwijzing.

Waarde	Description
searchIndex	Zoek indexdocumentreferentie.
azureBlob	Azure Blob document reference.
indexedSharePoint	Geïndexeerde SharePoint-documentreferentie.
indexedOneLake	Geïndexeerde documentreferentie van OneLake.
web	Webdocumentreferentie.
remoteSharePoint	Externe SharePoint-documentreferentie.
workIQ	Werk-IQ documentreferentie.
fabricDataAgent	Fabric Data Agent documentreferentie.
fabricOntology	Fabric Ontology documentreferentie.
mcpServer	MCP-serverdocumentreferentie.
file	Dien documentreferentie in.
indexedSql	Geïndexeerde SQL-documentreferentie.

KnowledgeBaseRemoteSharePointActivityArguments

Object

Geeft de argumenten weer waarmee de remote SharePoint-ophaalactiviteit is uitgevoerd.

Naam	Type	Description
filterExpressionAddOn	string	De filterexpressie-add-on voor de ophaalactiviteit.
search	string	De zoekstring die wordt gebruikt om de externe SharePoint-kennisbron te bevragen.

KnowledgeBaseRemoteSharePointActivityRecord

Object

Vertegenwoordigt een remote SharePoint-ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	De externe SharePoint-argumenten voor de ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: remoteSharePoint	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseRemoteSharePointReference

Object

Vertegenwoordigt een remote SharePoint-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: remoteSharePoint	Het type referentie.
webUrl	string (uri)	De url waar de referentiegegevens vandaan komen.

KnowledgeBaseRetrievalRequest

Object

Het invoercontract voor het opgehaalde verzoek.

Naam	Type	Description
includeActivity	boolean	Geeft aan dat de ophaalresultaten activiteitsinformatie moeten bevatten.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Een lijst met beoogde query's die moeten worden uitgevoerd zonder modelqueryplanning.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Een lijst met runtime-parameters voor de kennisbronnen.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten in de output.
maxOutputSize	integer (int32)	Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxOutputSizeInTokens	integer (int32)	Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxRuntimeInSeconds	integer (int32)	De maximale looptijd in seconden.
messages	KnowledgeBaseMessage[]	Een lijst met invoer in de stijl van chatberichten.
outputMode	KnowledgeRetrievalOutputMode	De uitvoerconfiguratie voor dit ophalen.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	De configuratie van de ophaal-redeneerinspanning.

KnowledgeBaseRetrievalResponse

Object

Het outputcontract voor het ophaalantwoord.

Naam	Type	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	De activiteitsrecords voor het bijhouden van de voortgang en de gevolgen voor de facturering.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	De verwijzingen naar de ophaalgegevens die in het antwoord worden gebruikt.
response	KnowledgeBaseMessage[]	De antwoordberichten.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de algemene respons.

KnowledgeBaseSearchIndexActivityArguments

Object

Vertegenwoordigt de argumenten waarmee de zoekindexophaalactiviteit is uitgevoerd.

Naam	Type	Description
filter	string	De filtertekenreeks.
queryType	QueryType	De querysyntaxis die wordt gebruikt om de zoekopdracht uit te voeren. Query hints kunnen ervoor zorgen dat semantische queries volledige querysyntaxis gebruiken.
search	string	De zoekreeks die wordt gebruikt om een query uit te voeren op de zoekindex.
searchFields	SearchIndexFieldReference[]	Tegen welke velden werd gezocht.
semanticConfigurationName	string	Welke semantische configuratie is gebruikt uit de zoekindex?
sourceDataFields	SearchIndexFieldReference[]	Welke velden zijn geselecteerd voor zoek.

KnowledgeBaseSearchIndexActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor het ophalen van een zoekindex.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Details over de expressies die worden gegenereerd uit queryhints voor deze activiteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	De zoekindex argumenten voor de ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: searchIndex	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.

KnowledgeBaseSearchIndexReference

Object

Vertegenwoordigt een Azure Search-documentverwijzing.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
citationUrl	string (uri)	Een door Search beheerde URL die naar het backingdocument voor deze referentie verwijst, bruikbaar als citatiedoel.
docKey	string	De documentsleutel voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: searchIndex	Het type referentie.

KnowledgeBaseWebActivityArguments

Object

Geeft de argumenten weer waarmee de webophaalactiviteit werd uitgevoerd.

Naam	Type	Description
count	integer (int32)	Het aantal webresultaten werd teruggegeven.
freshness	string	De frisheid voor de ophaalactiviteit.
language	string	De taal voor de ophaalactiviteit.
market	string	De markt voor de terughaalactiviteit.
search	string	De zoekstring die wordt gebruikt om het web te bevragen.

KnowledgeBaseWebActivityRecord

Object

Vertegenwoordigt een webophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: web	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.
webArguments	KnowledgeBaseWebActivityArguments	De webargumenten voor de ophaalactiviteit.

KnowledgeBaseWebReference

Object

Vertegenwoordigt een verwijzing naar een webdocument.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
sourceData		De brongegevens voor de referentie.
title	string	De titel van het webdocument.
type	string: web	Het type referentie.
url	string (uri)	De url waar de referentiegegevens vandaan komen.

KnowledgeBaseWorkIQActivityArguments

Object

Vertegenwoordigt de argumenten waarmee de WorkIQ-ophaalactiviteit werd uitgevoerd.

Naam	Type	Description
search	string	De zoekstring die wordt gebruikt om de kennisbron van WorkIQ te bevragen.

KnowledgeBaseWorkIQActivityRecord

Object

Vertegenwoordigt een WorkIQ-ophaalactiviteitsrecord.

Naam	Type	Description
completedAt	string (date-time)	Het tijdstip waarop de activiteit werd voltooid.
count	integer (int32)	Het aantal opgehaalde documenten dat voldoende relevant was om de herrangschikkingsdrempel te overschrijden.
elapsedMs	integer (int32)	De verstreken tijd in milliseconden voor de ophaalactiviteit.
error	KnowledgeBaseErrorDetail	De fout die uitlegt waarom de operatie mislukte. Deze eigenschap wordt alleen opgenomen wanneer de activiteit niet slaagt.
id	integer (int32)	De ID van de activiteitsrecord.
imageServing	ImageServingStatistics	Statistieken over beeldservice voor deze ophaalactiviteit
knowledgeSourceName	string	De kennisbron voor de ophaalactiviteit.
queryTime	string (date-time)	De querytijd voor deze ophaalactiviteit.
startedAt	string (date-time)	Het moment waarop de activiteit begon.
type	string: workIQ	Het type activiteitsrecord.
warning	string	Een waarschuwingsbericht dat mogelijke configuratieproblemen aan het licht brengt die tijdens de activiteit zijn waargenomen, zoals documenten die zijn weggevallen door scoredrempeling, het afkappen van tokenlimieten of time-outcondities.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	De WorkIQ-argumenten voor de ophaalactiviteit.

KnowledgeBaseWorkIQReference

Object

Vertegenwoordigt een WorkIQ-documentreferentie.

Naam	Type	Description
activitySource	integer (int32)	De bronactiviteit-id voor de referentie.
id	string	De ID van de referentie.
rerankerScore	number (float)	De herindelingsscore voor de documentreferentie.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	De gevoeligheidslabelinformatie voor de referentie.
sourceData		De brongegevens voor de referentie.
type	string: workIQ	Het type referentie.

KnowledgeRetrievalAutoReasoningEffort

Object

Selecteer automatisch de redeneerinspanning tijdens het ophalen. De dienst zaadt elk verzoek op het goedkoopste niveau en escaleert alleen zover dat nodig is, tot het maximaal beschikbare niveau van de dienst.

Naam	Type	Description
kind	string: auto	Het soort redeneerinspanning.

KnowledgeRetrievalIntentType

Opsomming

Het soort kennisbankconfiguratie dat u kunt gebruiken.

Waarde	Description
semantic	Een semantische query-intentie in natuurlijke taal.

KnowledgeRetrievalLowReasoningEffort

Object

Voer het ophalen van kennis uit met weinig redeneerinspanning.

Naam	Type	Description
kind	string: low	Het soort redeneerinspanning.

KnowledgeRetrievalMediumReasoningEffort

Object

Voer het ophalen van kennis uit met gemiddelde redeneerinspanning.

Naam	Type	Description
kind	string: medium	Het soort redeneerinspanning.

KnowledgeRetrievalMinimalReasoningEffort

Object

Voer het ophalen van kennis uit met minimale redeneerinspanning.

Naam	Type	Description
kind	string: minimal	Het soort redeneerinspanning.

KnowledgeRetrievalOutputMode

Opsomming

De uitvoerconfiguratie voor dit ophalen.

Waarde	Description
extractiveData	Retourneer gegevens uit de kennisbronnen direct zonder generatieve wijziging.
answerSynthesis	Synthetiseer een antwoord voor de payload van het antwoord.

KnowledgeRetrievalReasoningEffortKind

Opsomming

De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.

Waarde	Description
minimal	Voert geen bronselecties, queryplanning of iteratieve zoekopdrachten uit.
low	Gebruik een lage redenering tijdens het ophalen.
medium	Gebruik een matige hoeveelheid redeneren tijdens het ophalen.
auto	Selecteer automatisch de redeneerinspanning tijdens het ophalen, en escaleer vanaf de goedkoopste laag alleen zo ver als nodig is.

KnowledgeRetrievalSemanticIntent

Object

Een semantische queryintentie.

Naam	Type	Description
search	string	De semantische query die moet worden uitgevoerd
type	string: semantic	Het type intentie.

KnowledgeSourceKind

Opsomming

Het soort kennisbron.

Waarde	Description
searchIndex	Een kennisbron die gegevens uit een zoekindex leest.
azureBlob	Een kennisbron die gegevens van Azure Blob Storage leest en opneemt in een zoekindex.
indexedSharePoint	Een kennisbron die data leest van geïndexeerde SharePoint.
indexedOneLake	Een kennisbron die gegevens leest van geïndexeerde OneLake.
indexedSql	Een kennisbron die gegevens ophaalt en opneemt van Azure SQL Database of SQL Managed Instance naar een Search Index.
web	Een kennisbron die data van het web leest.
remoteSharePoint	Een kennisbron die data leest van remote SharePoint.
workIQ	Een kennisbron die gegevens leest van werk-IQ
file	Een kennisbron die directe bestandsupload en indexering ondersteunt.
mcpServer	Een kennisbron ondersteund door een MCP (Model Context Protocol) server.
fabricDataAgent	Een kennisbron die data ophaalt van een Fabric Data Agent.
fabricOntology	Een kennisbron die data ophaalt uit Microsoft Fabric Ontology ontologieën.

KnowledgeSourceResultsProcessing

Opsomming

Bepaalt of de resultaten van een kennisbron worden herschikt.

Waarde	Description
rerank	De resultaten van deze kennisbron gaan door de herrangeringspijplijn. Dit is het standaardgedrag.
none	Resultaten van deze kennisbron omzeilen herrangschikking en behouden hun onderliggende volgorde.

McpServerKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een MCP-serverkennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: mcpServer	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

PurviewSensitivityLabelInfo

Object

Informatie over het gevoeligheidslabel dat op een document is aangebracht

Naam	Type	Description
color	string	De kleur die de gebruikersinterface moet weergeven voor het label, indien geconfigureerd.
displayName	string	De weergavenaam van het gevoeligheidslabel.
isEncrypted	boolean	Geeft aan of het vertrouwelijkheidslabel versleuteling afdwingt.
priority	integer (int32)	De prioriteit waarin het vertrouwelijkheidslabel wordt toegepast.
sensitivityLabelId	string	De ID van het gevoeligheidslabel.
toolTip	string	De knopinfo die moet worden weergegeven voor het label in een gebruikersinterface.

QueryType

Opsomming

Hiermee geeft u de syntaxis van de zoekopdracht op. De standaardwaarde is 'eenvoudig'. Gebruik 'full' als uw query gebruikmaakt van de Lucene-querysyntaxis en 'semantisch' als de querysyntaxis niet nodig is.

Waarde	Description
simple	Gebruikt de eenvoudige querysyntaxis voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van een eenvoudige zoektaal die symbolen zoals +, * en "" mogelijk maakt. Query's worden standaard geëvalueerd in alle doorzoekbare velden, tenzij de parameter searchFields is opgegeven.
full	Gebruikt de volledige syntaxis van de Lucene-query voor zoekopdrachten. Zoektekst wordt geïnterpreteerd met behulp van de Lucene-querytaal die veldspecifieke en gewogen zoekopdrachten mogelijk maakt, evenals andere geavanceerde functies.
semantic	Het meest geschikt voor zoekopdrachten die worden uitgedrukt in natuurlijke taal in tegenstelling tot trefwoorden. Verbetert de precisie van zoekresultaten door de hoogste rangschikking van de belangrijkste zoekresultaten opnieuw te bepalen met behulp van een rangschikkingsmodel dat is getraind op het webcorpus.

RemoteSharePointKnowledgeSourceParams

Object

Hiermee geeft u runtimeparameters op voor een externe SharePoint-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
filterExpressionAddOn	string	Een filtervoorwaarde die wordt toegepast op de SharePoint-gegevensbron. Het moet worden opgegeven in de syntaxis van de taal van de zoekwoordquery. Het wordt gecombineerd als een combinatie met de filterexpressie die is gespecificeerd in de definitie van de kennisbron.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: remoteSharePoint	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

SearchIndexFieldReference

Object

Veldreferentie voor een zoekindex.

Naam	Type	Description
name	string	De naam van het veld.

SearchIndexKnowledgeSourceBoostKind

Opsomming

Het soort boost hint voor een zoekindex informatiebron.

Waarde	Description
fieldValue	Verbeter documenten op basis van een veldwaarde.
multiWordExpression	Verbeter documenten op basis van een uitdrukking van meerdere woorden.

SearchIndexKnowledgeSourceFieldValueBoost

Object

Een tip die documenten versterkt op basis van een veldwaarde.

Naam	Type	Description
boost	number (double)	Een vermenigvuldiger voor de documentscore. Moet een positief getal zijn dat niet gelijk is aan 1,0.
boostInstructions	string	Instructies in natuurlijke taal die uitleggen wanneer en hoe je de boost moet toepassen.
field	string minLength: 1	De naam van het zoekindexveld.
fieldValues	string[]	Representatieve waarden voor het veld.
kind	string: fieldValue	Het soort boost-hint.

SearchIndexKnowledgeSourceFilterHint

Object

Een hint die een veld en representatieve waarden identificeert die de queryplanner kan gebruiken bij het construeren van een filter.

Naam	Type	Description
field	string minLength: 1	De naam van het filterbare zoekindexveld.
fieldValues	string[]	Representatieve waarden voor het veld.
filterInstructions	string	Natuurlijke taalinstructies die uitleggen wanneer en hoe je op het veld moet filteren.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

Een tip die documenten versterkt op basis van een uitdrukking van meerdere woorden.

Naam	Type	Description
boost	number (double)	Een vermenigvuldiger voor de documentscore. Moet een positief getal zijn dat niet gelijk is aan 1,0.
boostInstructions	string	Instructies in natuurlijke taal die uitleggen wanneer en hoe je de boost moet toepassen.
fieldValues	string[]	Representatieve waarden voor de boost.
kind	string: multiWordExpression	Het soort boost-hint.

SearchIndexKnowledgeSourceParams

Object

Hiermee geeft u runtimeparameters op voor een kennisbron van een zoekindex

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
filterAddOn	string	Een filtervoorwaarde die op de index wordt toegepast (bijvoorbeeld 'Staat eq VA').
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: searchIndex	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Tips die queryplanning begeleiden naar nuttige filters en boosts. Indien gespecificeerd, vervangt dit object de volledige set queryhints die op de kennisbron zijn geconfigureerd.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

SearchIndexKnowledgeSourceQueryHints

Object

Tips die queryplanning sturen naar nuttige filters en boosts voor een zoekindex-kennisbron.

Naam	Type	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Boost hints die voorwaarden identificeren die de queryplanner kan gebruiken om de rangschikking van documenten te beïnvloeden.
filters	SearchIndexKnowledgeSourceFilterHint[]	Filterhints die velden en representatieve waarden identificeren die de queryplanner kan gebruiken bij het bouwen van filters.

ServedImage

Object

Beschrijft een enkel beeld dat het model heeft gekozen om te worden bediend tijdens een ophaalactiviteit.

Naam	Type	Description
imageId	string	Het afbeeldingslabel is uit het brondocument gehaald door Content Understanding enrichment. Komt overeen met de cijfernummering in het originele document.
imagePath	string	Het relatieve pad naar de afbeelding binnen de asset store.
sizeBytes	integer (int64)	De grootte in bytes van deze afbeelding zoals verzonden naar het model.

WebKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een webkennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
count	integer (int32)	Het aantal webresultaten dat moet worden geretourneerd.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
freshness	string	De frisheid van webresultaten.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: web	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
language	string	De taal van het web resultaten.
market	string	De markt van het web resultaten.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.

WorkIQKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een WorkIQ-kennisbron

Naam	Type	Description
alwaysQuerySource	boolean	Geeft aan dat deze kennisbron de bronselectie moet overslaan en altijd moet worden opgevraagd op het moment dat deze wordt opgehaald.
enableImageServing	boolean	Geeft aan of image serving voor deze kennisbron bij het ophalen moet worden ingeschakeld. Wanneer ze waar zijn, worden tijdens het opnemen extraheren beelden geleverd aan downstream-modellen.
failOnError	boolean	Geeft aan dat het gehele ophaalverzoek zou moeten mislukken als het ophalen van deze kennisbron een fout ondervindt. Standaard ingesteld op onwaar.
includeReferenceSourceData	boolean	Geeft aan of referenties de gestructureerde gegevens die tijdens het ophalen zijn verkregen, in hun payload moeten opnemen.
includeReferences	boolean	Geeft aan of referenties moeten worden opgenomen voor gegevens die uit deze bron worden opgehaald.
kind	string: workIQ	Het type kennisbron.
knowledgeSourceName	string	De naam van de index waarop de parameters van toepassing zijn.
maxOutputDocuments	integer (int32)	Beperkt het maximale aantal documenten dat uit deze kennisbron wordt teruggestuurd.
neverQuerySource	boolean	Geeft aan dat deze kennisbron moet worden uitgesloten van de kandidatenset van het verzoek en nooit bij het ophalen wordt bevraagd. De uitsluiting is request-lokaal en verandert het lidmaatschap van de kennisbank niet. Kan niet gecombineerd worden met alwaysQuerySource op dezelfde kennisbron.
rerankerThreshold	number (float)	De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.
resultsProcessing	KnowledgeSourceResultsProcessing	Overschrijft de opgeslagen resultaten van de kennisbronProcessing voor deze ophaaloproep. Wanneer deze wordt weggelaten, geldt de waarde van opgeslagen kennisbron.