Knowledge Retrieval - Retrieve

Tjänst:
Search Service
API-version:
2026-04-01

KnowledgeBase hämtar relevanta data från säkerhetskopieringsbutiker.

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

URI-parametrar

Name I Obligatorisk Typ Description
endpoint
 path True

string (uri)

Slutpunkts-URL:en för söktjänsten.
knowledgeBaseName
 path True

string

Namnet på kunskapsbasen.
api-version
 query True

string

minLength: 1

Den API-version som ska användas för den här åtgärden.

Begärandehuvud

Name Obligatorisk Typ Description
Accept

Accept

Acceptera-rubriken.
x-ms-client-request-id

string (uuid)

En ogenomskinlig, globalt unik, klientgenererad strängidentifierare för begäran.

Begärandetext

Name Typ Description
includeActivity

boolean

Anger att hämtningsresultaten ska innehålla aktivitetsinformation.
intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

En lista över avsedda frågor som ska köras utan planering av modellfrågor.
knowledgeSourceParams KnowledgeSourceParams[]:

En lista över körningsparametrar för kunskapskällorna.
maxOutputSizeInTokens

integer (int32)

Begränsar den maximala storleken på innehållet i utdata.
maxRuntimeInSeconds

integer (int32)

Den maximala körtiden i sekunder.

Svar

Name Typ Description
200 OK

KnowledgeBaseRetrievalResponse

Lyckad uttagsrespons.
Other Status Codes

KnowledgeBaseRetrievalResponse

Partiell uttagsrespons.
Other Status Codes

ErrorResponse

Ett oväntat felsvar.

Säkerhet

api-key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Omfattningar

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

Exempel

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Exempelbegäran

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

Exempelsvar

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

Exempelbegäran

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

Exempelsvar

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

Definitioner

Name Description
Accept

Acceptera-rubriken.
AzureBlobKnowledgeSourceParams

Anger körningsparametrar för en Azure Blob-kunskapskälla
ErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
ErrorDetail

Felinformationen.
ErrorResponse

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).
IndexedOneLakeKnowledgeSourceParams

Anger körningsparametrar för en indexerad OneLake-kunskapskälla
KnowledgeBaseActivityRecordType

Typen av aktivitetsregister.
KnowledgeBaseAgenticReasoningActivityRecord

Representerar en aktivitetspost för agentiskt resonemang.
KnowledgeBaseAzureBlobActivityArguments

Representerar argumenten som Azure Blob Retrieval-aktiviteten kördes med.
KnowledgeBaseAzureBlobActivityRecord

Representerar en aktivitetspost för hämtning av Azure Blob-blobar.
KnowledgeBaseAzureBlobReference

Representerar en Azure Blob Storage dokumentreferens.
KnowledgeBaseErrorAdditionalInfo

Ytterligare information om resurshanteringsfelet.
KnowledgeBaseErrorDetail

Felinformationen.
KnowledgeBaseImageContent

Bildinnehåll.
KnowledgeBaseIndexedOneLakeActivityArguments

Representerar argumenten som den indexerade OneLake-återvinningsaktiviteten kördes med.
KnowledgeBaseIndexedOneLakeActivityRecord

Representerar en indexerad OneLake-återvinningsaktivitetspost.
KnowledgeBaseIndexedOneLakeReference

Representerar en indexerad OneLake-dokumentreferens.
KnowledgeBaseMessage

Objektet för meddelandeformat på naturligt språk.
KnowledgeBaseMessageContentType

Typ av meddelandeinnehåll.
KnowledgeBaseMessageImageContent

Typ av bildmeddelande.
KnowledgeBaseMessageTextContent

Typ av textmeddelande.
KnowledgeBaseModelWebSummarizationActivityRecord

Representerar en LLM-webbsammanfattningsaktivitetspost.
KnowledgeBaseReferenceType

Typ av referens.
KnowledgeBaseRetrievalRequest

Indatakontraktet för hämtningsbegäran.
KnowledgeBaseRetrievalResponse

Utdatakontraktet för hämtningssvaret.
KnowledgeBaseSearchIndexActivityArguments

Representerar de argument som sökindexhämtningsaktiviteten kördes med.
KnowledgeBaseSearchIndexActivityRecord

Representerar en post för hämtningsaktivitet för sökindex.
KnowledgeBaseSearchIndexReference

Representerar en referens för ett Azure Search-dokument.
KnowledgeBaseWebActivityArguments

Representerar argumenten som webbåtervinningsaktiviteten kördes med.
KnowledgeBaseWebActivityRecord

Representerar en webbsökningsaktivitetspost.
KnowledgeBaseWebReference

Representerar en referens till ett webbdokument.
KnowledgeRetrievalIntentType

Vilken typ av 知識庫-konfiguration som ska användas.
KnowledgeRetrievalMinimalReasoningEffort

Kör kunskapshämtning med minimal ansträngning för att resonera.
KnowledgeRetrievalReasoningEffortKind

Mängden ansträngning som ska användas under hämtningen.
KnowledgeRetrievalSemanticIntent

En semantisk frågeavsikt.
KnowledgeSourceKind

Typen av kunskapskälla.
SearchIndexFieldReference

Fältreferens för ett sökindex.
SearchIndexKnowledgeSourceParams

Anger körningsparametrar för en kunskapskälla för sökindex
WebKnowledgeSourceParams

Anger körningsparametrar för en webbkunskapskälla

Accept

Uppräkning

Acceptera-rubriken.

Värde Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objekt

Anger körningsparametrar för en Azure Blob-kunskapskälla

Name Typ Description
includeReferenceSourceData

boolean

Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten.
includeReferences

boolean

Anger om referenser ska inkluderas för data som hämtas från den här källan.
kind string:

azureBlob

Typen av kunskapskälla.
knowledgeSourceName

string

Namnet på det index som parametrarna gäller för.
rerankerThreshold

number (float)

Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Den ytterligare informationen.
type

string

Typen av ytterligare information.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Felet ytterligare information.
code

string

Felkoden.
details

ErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

ErrorResponse

Objekt

Vanligt felsvar för alla Azure Resource Manager-API:er för att returnera felinformation för misslyckade åtgärder. (Detta följer även formatet för OData-felsvar.).

Name Typ Description
error

ErrorDetail

Felet objektet.

IndexedOneLakeKnowledgeSourceParams

Objekt

Anger körningsparametrar för en indexerad OneLake-kunskapskälla

Name Typ Description
includeReferenceSourceData

boolean

Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten.
includeReferences

boolean

Anger om referenser ska inkluderas för data som hämtas från den här källan.
kind string:

indexedOneLake

Typen av kunskapskälla.
knowledgeSourceName

string

Namnet på det index som parametrarna gäller för.
rerankerThreshold

number (float)

Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret.

KnowledgeBaseActivityRecordType

Uppräkning

Typen av aktivitetsregister.

Värde Description
searchIndex

Sökindex-återvinningsaktivitet.
azureBlob

Azure Blob retrieval activity.
indexedOneLake

Indexerad OneLake-återvinningsaktivitet.
web

Webbåtervinningsaktivitet.
modelWebSummarization

LLM-webbsammanfattningsaktivitet.
agenticReasoning

Agentiskt resonerande aktivitet.

KnowledgeBaseAgenticReasoningActivityRecord

Objekt

Representerar en aktivitetspost för agentiskt resonemang.

Name Typ Description
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
reasoningTokens

integer (int32)

Antalet indatatoken för agentisk resonemang.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

KnowledgeRetrievalMinimalReasoningEffort

Konfigurationen för återhämtningsresonemangsinsats.
type string:

agenticReasoning

Typ av aktivitetspost.

KnowledgeBaseAzureBlobActivityArguments

Objekt

Representerar argumenten som Azure Blob Retrieval-aktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att fråga blobinnehåll.

KnowledgeBaseAzureBlobActivityRecord

Objekt

Representerar en aktivitetspost för hämtning av Azure Blob-blobar.

Name Typ Description
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Azure Blob-argumenten för hämtningsaktiviteten.
count

integer (int32)

Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning.
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

Frågetiden för den här hämtningsaktiviteten.
type string:

azureBlob

Typ av aktivitetspost.

KnowledgeBaseAzureBlobReference

Objekt

Representerar en Azure Blob Storage dokumentreferens.

Name Typ Description
activitySource

integer (int32)

Källaktivitets-ID:t för referensen.
blobUrl

string

Blob-URL:en för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

azureBlob

Typen av referens.

KnowledgeBaseErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Den ytterligare informationen.
type

string

Typen av ytterligare information.

KnowledgeBaseErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Felet ytterligare information.
code

string

Felkoden.
details

KnowledgeBaseErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

KnowledgeBaseImageContent

Objekt

Bildinnehåll.

Name Typ Description
url

string (uri)

Webbadressen till bilden.

KnowledgeBaseIndexedOneLakeActivityArguments

Objekt

Representerar argumenten som den indexerade OneLake-återvinningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka indexerade innehåll i OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objekt

Representerar en indexerad OneLake-återvinningsaktivitetspost.

Name Typ Description
count

integer (int32)

Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning.
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

De indexerade OneLake-argumenten för återvinningsaktiviteten.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

Frågetiden för den här hämtningsaktiviteten.
type string:

indexedOneLake

Typ av aktivitetspost.

KnowledgeBaseIndexedOneLakeReference

Objekt

Representerar en indexerad OneLake-dokumentreferens.

Name Typ Description
activitySource

integer (int32)

Källaktivitets-ID:t för referensen.
docUrl

string

Dokumentets URL för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

indexedOneLake

Typen av referens.

KnowledgeBaseMessage

Objekt

Objektet för meddelandeformat på naturligt språk.

Name Typ Description
content KnowledgeBaseMessageContent[]:

Innehållet i meddelandet.
role

string

Rollen för verktygets svar.

KnowledgeBaseMessageContentType

Uppräkning

Typ av meddelandeinnehåll.

Värde Description
text

Typ av textmeddelandeinnehåll.
image

Typ av innehåll i bildmeddelanden.

KnowledgeBaseMessageImageContent

Objekt

Typ av bildmeddelande.

Name Typ Description
image

KnowledgeBaseImageContent

Bildinnehållet.
type string:

image

Typ av meddelande

KnowledgeBaseMessageTextContent

Objekt

Typ av textmeddelande.

Name Typ Description
text

string

Textinnehållet.
type string:

text

Typ av meddelande

KnowledgeBaseModelWebSummarizationActivityRecord

Objekt

Representerar en LLM-webbsammanfattningsaktivitetspost.

Name Typ Description
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
inputTokens

integer (int32)

Antalet inmatningstokens för LLM:s webbsammanfattningsaktivitet.
outputTokens

integer (int32)

Antalet utdatatoken för LLM:s webbsammanfattningsaktivitet.
type string:

modelWebSummarization

Typ av aktivitetspost.

KnowledgeBaseReferenceType

Uppräkning

Typ av referens.

Värde Description
searchIndex

Sök i indexdokumentreferens.
azureBlob

Azure Blob dokumentreferens.
indexedOneLake

Indexerad dokumentreferens från OneLake.
web

Webbdokumentreferens.

KnowledgeBaseRetrievalRequest

Objekt

Indatakontraktet för hämtningsbegäran.

Name Typ Description
includeActivity

boolean

Anger att hämtningsresultaten ska innehålla aktivitetsinformation.
intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

En lista över avsedda frågor som ska köras utan planering av modellfrågor.
knowledgeSourceParams KnowledgeSourceParams[]:

En lista över körningsparametrar för kunskapskällorna.
maxOutputSizeInTokens

integer (int32)

Begränsar den maximala storleken på innehållet i utdata.
maxRuntimeInSeconds

integer (int32)

Den maximala körtiden i sekunder.

KnowledgeBaseRetrievalResponse

Objekt

Utdatakontraktet för hämtningssvaret.

Name Typ Description
activity KnowledgeBaseActivityRecord[]:

Aktivitetsposterna för att spåra förlopp och faktureringskonsekvenser.
references KnowledgeBaseReference[]:

Referenserna för de hämtningsdata som används i svaret.
response

KnowledgeBaseMessage[]

Svarsmeddelandena.

KnowledgeBaseSearchIndexActivityArguments

Objekt

Representerar de argument som sökindexhämtningsaktiviteten kördes med.

Name Typ Description
filter

string

Filtersträngen.
search

string

Söksträngen som används för att fråga sökindexet.
searchFields

SearchIndexFieldReference[]

Vilka fält genomsöktes.
semanticConfigurationName

string

Vilken semantisk konfiguration som användes från sökindexet.
sourceDataFields

SearchIndexFieldReference[]

Vilka fält som valdes för sökning.

KnowledgeBaseSearchIndexActivityRecord

Objekt

Representerar en post för hämtningsaktivitet för sökindex.

Name Typ Description
count

integer (int32)

Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning.
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

Frågetiden för den här hämtningsaktiviteten.
searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Sökindexargumenten för hämtningsaktiviteten.
type string:

searchIndex

Typ av aktivitetspost.

KnowledgeBaseSearchIndexReference

Objekt

Representerar en referens för ett Azure Search-dokument.

Name Typ Description
activitySource

integer (int32)

Källaktivitets-ID:t för referensen.
docKey

string

Dokumentnyckeln för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

searchIndex

Typen av referens.

KnowledgeBaseWebActivityArguments

Objekt

Representerar argumenten som webbåtervinningsaktiviteten kördes med.

Name Typ Description
count

integer (int32)

Antalet webbresultat returnerades.
freshness

string

Fräschheten för hämtningsaktiviteten.
language

string

Språket för återhämtningsaktiviteten.
market

string

Marknaden för återvinningsaktiviteten.
search

string

Söksträngen som används för att söka på webben.

KnowledgeBaseWebActivityRecord

Objekt

Representerar en webbsökningsaktivitetspost.

Name Typ Description
count

integer (int32)

Antalet dokument som hämtats som var tillräckligt relevanta för att passera tröskelvärdet för omrankning.
elapsedMs

integer (int32)

Den förflutna tiden i millisekunder för hämtningsaktiviteten.
error

KnowledgeBaseErrorDetail

Felinformationen som förklarar varför åtgärden misslyckades. Den här egenskapen ingår bara när aktiviteten inte lyckas.
id

integer (int32)

ID för aktivitetsposten.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

Frågetiden för den här hämtningsaktiviteten.
type string:

web

Typ av aktivitetspost.
webArguments

KnowledgeBaseWebActivityArguments

Webbargumenten för återvinningsaktiviteten.

KnowledgeBaseWebReference

Objekt

Representerar en referens till ett webbdokument.

Name Typ Description
activitySource

integer (int32)

Källaktivitets-ID:t för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
title

string

Titeln på webbdokumentet.
type string:

web

Typen av referens.
url

string (uri)

Den URL som referensdata kommer från.

KnowledgeRetrievalIntentType

Uppräkning

Vilken typ av 知識庫-konfiguration som ska användas.

Värde Description
semantic

En semantisk frågeavsikt med naturligt språk.

KnowledgeRetrievalMinimalReasoningEffort

Objekt

Kör kunskapshämtning med minimal ansträngning för att resonera.

Name Typ Description
kind string:

minimal

Den sortens resonemangsförsök.

KnowledgeRetrievalReasoningEffortKind

Uppräkning

Mängden ansträngning som ska användas under hämtningen.

Värde Description
minimal

Utför inga källval, frågeplanering eller iterativ sökning.

KnowledgeRetrievalSemanticIntent

Objekt

En semantisk frågeavsikt.

Name Typ Description
search

string

Den semantiska fråga som ska köras
type string:

semantic

Typen av avsikt.

KnowledgeSourceKind

Uppräkning

Typen av kunskapskälla.

Värde Description
searchIndex

En kunskapskälla som läser data från ett sökindex.
azureBlob

En kunskapskälla som läser och matar in data från Azure Blob Storage till ett sökindex.
indexedOneLake

En kunskapskälla som läser data från indexerad OneLake.
web

En kunskapskälla som läser data från webben.

SearchIndexFieldReference

Objekt

Fältreferens för ett sökindex.

Name Typ Description
name

string

Namnet på fältet.

SearchIndexKnowledgeSourceParams

Objekt

Anger körningsparametrar för en kunskapskälla för sökindex

Name Typ Description
filterAddOn

string

Ett filtervillkor som tillämpas på indexet (t.ex. "State eq VA").
includeReferenceSourceData

boolean

Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten.
includeReferences

boolean

Anger om referenser ska inkluderas för data som hämtas från den här källan.
kind string:

searchIndex

Typen av kunskapskälla.
knowledgeSourceName

string

Namnet på det index som parametrarna gäller för.
rerankerThreshold

number (float)

Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret.

WebKnowledgeSourceParams

Objekt

Anger körningsparametrar för en webbkunskapskälla

Name Typ Description
count

integer (int32)

Antalet webbresultat som ska returneras.
freshness

string

Färskheten i webbresultaten.
includeReferenceSourceData

boolean

Anger om referenser ska innehålla strukturerade data som erhålls under hämtningen i nyttolasten.
includeReferences

boolean

Anger om referenser ska inkluderas för data som hämtas från den här källan.
kind string:

web

Typen av kunskapskälla.
knowledgeSourceName

string

Namnet på det index som parametrarna gäller för.
language

string

Språket i webbresultaten.
market

string

Marknaden för webbens resultat.
rerankerThreshold

number (float)

Tröskelvärdet för omrankning som alla hämtade dokument måste uppfylla för att tas med i svaret.