Knowledge Retrieval - Retrieve

Service:
Search Service
API-versie:
2026-05-01-preview

KnowledgeBase haalt relevante gegevens op uit back-uparchieven.

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

URI-parameters

Name 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

Name Vereist 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-client-request-id

string (uuid)

Een ondoorzichtige, wereldwijd unieke, door de client gegenereerde tekenreeks-id voor de aanvraag.

Aanvraagbody

Name 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[]:

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:

De configuratie van de ophaal-redeneerinspanning.

Antwoorden

Name 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

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

Voorbeelden

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Voorbeeldaanvraag

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



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

Voorbeeldrespons

Statuscode:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ],
  "responseSensitivityLabelInfo": {
    "displayName": "Confidential",
    "sensitivityLabelId": "00000000-0000-0000-0000-000000000001",
    "toolTip": "This content is confidential.",
    "priority": 2,
    "color": "#FF0000",
    "isEncrypted": false
  }
}
Statuscode:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Voorbeeldaanvraag

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



{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Voorbeeldrespons

Statuscode:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}
Statuscode:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Definities

Name 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
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.
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.
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.
McpServerKnowledgeSourceParams

Specificeert runtime-parameters voor een MCP-serverkennisbron
PurviewSensitivityLabelInfo

Informatie over het gevoeligheidslabel dat op een document is aangebracht
RemoteSharePointKnowledgeSourceParams

Hiermee geeft u runtimeparameters op voor een externe SharePoint-kennisbron
SearchIndexFieldReference

Veldreferentie voor een zoekindex.
SearchIndexKnowledgeSourceParams

Hiermee geeft u runtimeparameters op voor een kennisbron van een zoekindex
WebKnowledgeSourceParams

Specificeert runtimeparameters voor een webkennisbron
WorkIQAttribution

Toeschrijvingsinformatie voor een WorkIQ-referentie.
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

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

ErrorAdditionalInfo

Object

Aanvullende informatie over de resourcebeheerfout.

Name Type Description
info

De aanvullende informatie.
type

string

Het extra informatietype.

ErrorDetail

Object

Het foutdetail.

Name 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.)

Name Type Description
error

ErrorDetail

Het foutobject.

FabricDataAgentKnowledgeSourceParams

Object

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

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

FabricOntologyKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een Fabric Ontology kennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

FileKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een bestandskennis bron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

ImageServingStatistics

Object

Statistieken over beeldservice tijdens een ophaalactiviteit.

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

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

IndexedSharePointKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een geïndexeerde SharePoint-kennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

IndexedSqlKnowledgeSourceParams

Object

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

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

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.

Name Type Description
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.
reasoningTokens

integer (int32)

Het aantal invoertokens voor agentisch redeneren.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

De configuratie van de ophaal-redeneerinspanning.
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.

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

Name Type Description
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

De azure blob-argumenten voor de ophaalactiviteit.
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.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
blobUrl

string

De blob-URL voor de verwijzing.
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.

Name Type Description
info

De aanvullende informatie.
type

string

Het extra informatietype.

KnowledgeBaseErrorDetail

Object

De foutgegevens.

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

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

Name Type Description
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.
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.

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

Name Type Description
search

string

De zoekstring die wordt gebruikt om de kennisbron van Fabric Ontology te bevragen.

KnowledgeBaseFabricOntologyActivityRecord

Object

Vertegenwoordigt een Fabric Ontology retrievalactiviteitsrecord.

Name Type Description
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.
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.

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

Name Type Description
search

string

De zoekstring die wordt gebruikt om bestandsinhoud op te vragen.

KnowledgeBaseFileActivityRecord

Object

Vertegenwoordigt een bestandsophaalactiviteitsrecord.

Name Type Description
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.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
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.

Name Type Description
url

string (uri)

De url van de afbeelding.

KnowledgeBaseIndexedOneLakeActivityArguments

Object

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

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

Name Type Description
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.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
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.

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

Name Type Description
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.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
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.

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

Name Type Description
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.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
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.

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

Name Type Description
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.
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.

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

Name Type Description
content KnowledgeBaseMessageContent[]:

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.

Name Type Description
image

KnowledgeBaseImageContent

De beeldinhoud.
type string:

image

Het type bericht

KnowledgeBaseMessageTextContent

Object

Type tekstbericht.

Name Type Description
text

string

De tekstinhoud.
type string:

text

Het type bericht

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

Vertegenwoordigt een activiteitsrecord voor de synthese van LLM-antwoorden.

Name Type Description
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.
modelName

string

De naam van het model dat wordt gebruikt voor de LLM-antwoordsynthese-activiteit.
outputTokens

integer (int32)

Het aantal uitvoertokens voor de LLM-antwoordsyntheseactiviteit.
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.

Name Type Description
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.
modelName

string

De naam van het model dat wordt gebruikt voor de LLM-queryplanningsactiviteit.
outputTokens

integer (int32)

Het aantal uitvoertokens voor de LLM-queryplanningsactiviteit.
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.

Name Type Description
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.
modelName

string

De naam van het model dat wordt gebruikt voor de LLM-websamenvattingsactiviteit.
outputTokens

integer (int32)

Het aantal outputtokens voor de LLM-websamenvattingsactiviteit.
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.

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.

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

Name Type Description
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.
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.

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

Name 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[]:

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:

De configuratie van de ophaal-redeneerinspanning.

KnowledgeBaseRetrievalResponse

Object

Het outputcontract voor het ophaalantwoord.

Name Type Description
activity KnowledgeBaseActivityRecord[]:

De activiteitsrecords voor het bijhouden van de voortgang en de gevolgen voor de facturering.
references KnowledgeBaseReference[]:

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.

Name Type Description
filter

string

De filtertekenreeks.
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.

Name Type Description
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.
searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

De zoekindex argumenten voor de ophaalactiviteit.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
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.

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

Name Type Description
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.
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.

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

Name Type Description
search

string

De zoekstring die wordt gebruikt om de kennisbron van WorkIQ te bevragen.

KnowledgeBaseWorkIQActivityRecord

Object

Vertegenwoordigt een WorkIQ-ophaalactiviteitsrecord.

Name Type Description
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.
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.

Name Type Description
activitySource

integer (int32)

De bronactiviteit-id voor de referentie.
attributions

WorkIQAttribution[]

De bronvermeldingen 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:

workIQ

Het type referentie.

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.

Name Type Description
kind string:

low

Het soort redeneerinspanning.

KnowledgeRetrievalMediumReasoningEffort

Object

Voer het ophalen van kennis uit met gemiddelde redeneerinspanning.

Name Type Description
kind string:

medium

Het soort redeneerinspanning.

KnowledgeRetrievalMinimalReasoningEffort

Object

Voer het ophalen van kennis uit met minimale redeneerinspanning.

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

KnowledgeRetrievalSemanticIntent

Object

Een semantische queryintentie.

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

McpServerKnowledgeSourceParams

Object

Specificeert runtime-parameters voor een MCP-serverkennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

PurviewSensitivityLabelInfo

Object

Informatie over het gevoeligheidslabel dat op een document is aangebracht

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

RemoteSharePointKnowledgeSourceParams

Object

Hiermee geeft u runtimeparameters op voor een externe SharePoint-kennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

SearchIndexFieldReference

Object

Veldreferentie voor een zoekindex.

Name Type Description
name

string

De naam van het veld.

SearchIndexKnowledgeSourceParams

Object

Hiermee geeft u runtimeparameters op voor een kennisbron van een zoekindex

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

WebKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een webkennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.

WorkIQAttribution

Object

Toeschrijvingsinformatie voor een WorkIQ-referentie.

Name Type Description
seeMoreWebUrl

string (uri)

De URL voor de bronvermelding.

WorkIQKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een WorkIQ-kennisbron

Name 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.
rerankerThreshold

number (float)

De herrangschikkingsdrempel waaraan alle opgehaalde documenten moeten voldoen om in de reactie te worden opgenomen.