Knowledge Retrieval - Retrieve

Service:
Search Service
API-versie:
2026-04-01

KnowledgeBase haalt relevante gegevens op uit back-uparchieven.

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

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

integer (int32)

Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxRuntimeInSeconds

integer (int32)

De maximale looptijd in seconden.

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://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "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-example-index",
      "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": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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"
    }
  ]
}
Statuscode:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Voorbeeldrespons

Statuscode:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-example-index",
      "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,
      "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-example-index",
      "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,
      "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

De foutdetails.
ErrorResponse

Veelvoorkomende foutrespons voor alle Azure Resource Manager API's om foutdetails terug te geven bij mislukte bewerkingen. (Dit volgt ook de OData-foutreactieindeling.)
IndexedOneLakeKnowledgeSourceParams

Specificeert runtimeparameters voor een geïndexeerde OneLake-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 foutdetails.
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.
KnowledgeBaseMessage

Het object in de stijl van berichten in natuurlijke taal.
KnowledgeBaseMessageContentType

Het type berichtinhoud.
KnowledgeBaseMessageImageContent

Afbeelding berichttype.
KnowledgeBaseMessageTextContent

Type tekstbericht.
KnowledgeBaseModelWebSummarizationActivityRecord

Vertegenwoordigt een LLM-websamenvattingsactiviteitsrecord.
KnowledgeBaseReferenceType

Het type verwijzing.
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.
KnowledgeRetrievalIntentType

Het soort kennisbankconfiguratie dat u kunt gebruiken.
KnowledgeRetrievalMinimalReasoningEffort

Voer het ophalen van kennis uit met minimale redeneerinspanning.
KnowledgeRetrievalReasoningEffortKind

De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.
KnowledgeRetrievalSemanticIntent

Een semantische queryintentie.
KnowledgeSourceKind

Het soort kennisbron.
SearchIndexFieldReference

Veldreferentie voor een zoekindex.
SearchIndexKnowledgeSourceParams

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

Specificeert runtimeparameters voor een webkennisbron

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

De foutdetails.

Name Type Description
additionalInfo

ErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

ErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoelwit.

ErrorResponse

Object

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

Name Type Description
error

ErrorDetail

Het foutobject.

IndexedOneLakeKnowledgeSourceParams

Object

Specificeert runtimeparameters voor een geïndexeerde OneLake-kennisbron

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

Geïndexeerde OneLake ophaalactiviteit.
web

Webopzoekactiviteit.
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:

KnowledgeRetrievalMinimalReasoningEffort

De configuratie van de ophaal-redeneerinspanning.
type string:

agenticReasoning

Het type activiteitsrecord.

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

string

De kennisbron voor de ophaalactiviteit.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
type string:

azureBlob

Het type activiteitsrecord.

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

Name Type Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

De fout bevat aanvullende informatie.
code

string

De foutcode.
details

KnowledgeBaseErrorDetail[]

De foutdetails.
message

string

Het foutbericht.
target

string

Het foutdoelwit.

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

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

De brongegevens voor de referentie.
type string:

indexedOneLake

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

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

integer (int32)

Het aantal outputtokens voor de LLM-websamenvattingsactiviteit.
type string:

modelWebSummarization

Het type activiteitsrecord.

KnowledgeBaseReferenceType

Opsomming

Het type verwijzing.

Waarde Description
searchIndex

Zoek indexdocumentreferentie.
azureBlob

Azure Blob document reference.
indexedOneLake

Geïndexeerde documentreferentie van OneLake.
web

Webdocumentreferentie.

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

integer (int32)

Hiermee beperkt u de maximale grootte van de inhoud in de uitvoer.
maxRuntimeInSeconds

integer (int32)

De maximale looptijd in seconden.

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.

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

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

string

De kennisbron voor de ophaalactiviteit.
queryTime

string (date-time)

De querytijd voor deze ophaalactiviteit.
type string:

web

Het type activiteitsrecord.
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.

KnowledgeRetrievalIntentType

Opsomming

Het soort kennisbankconfiguratie dat u kunt gebruiken.

Waarde Description
semantic

Een semantische query-intentie in natuurlijke taal.

KnowledgeRetrievalMinimalReasoningEffort

Object

Voer het ophalen van kennis uit met minimale redeneerinspanning.

Name Type Description
kind string:

minimal

Het soort redeneerinspanning.

KnowledgeRetrievalReasoningEffortKind

Opsomming

De hoeveelheid inspanning die moet worden gebruikt tijdens het ophalen.

Waarde Description
minimal

Voert geen bronselecties, queryplanning of iteratieve zoekopdrachten uit.

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

Een kennisbron die gegevens leest van geïndexeerde OneLake.
web

Een kennisbron die data van het web leest.

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

integer (int32)

Het aantal webresultaten dat moet worden geretourneerd.
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.
rerankerThreshold

number (float)

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