Knowledge Retrieval - Retrieve

Tjänst:
Search Service
API-version:
2026-08-01-preview

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

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

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-query-source-authorization

string

Token som identifierar den användare som frågan körs för. Denna token används för att framtvinga säkerhetsbegränsningar för dokument.
x-ms-query-work-iq-source-authorization

string (password)

Användarassertionstoken för en kundägd Entra-appregistrering konfigurerad på en Work IQ-kunskapskälla. Används för autentisering på uppdrag av autentisering till Work IQ API:et.
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.
maxOutputDocuments

integer (int32)

Begränsar det maximala antalet dokument i utdatan.
maxOutputSize

integer (int32)

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

integer (int32)

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

integer (int32)

Den maximala körtiden i sekunder.
messages

KnowledgeBaseMessage[]

En lista med indata för chattmeddelandeformat.
outputMode

KnowledgeRetrievalOutputMode

Utdatakonfigurationen för den här hämtningen.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfigurationen för återhämtningsresonemangsinsats.

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
KnowledgeBaseRetrieveAzureBlobImageServing
KnowledgeBaseRetrieveWithIntents
KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Exempelbegäran

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





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Exempelsvar

Statuskod:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}
Statuskod:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveAzureBlobImageServing

Exempelbegäran

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





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

Exempelsvar

Statuskod:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}
Statuskod:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

Exempelbegäran

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





{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

Exempelsvar

Statuskod:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}
Statuskod:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithSourceExclusion

Exempelbegäran

POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview




{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "Explain the SSO provisioning steps from the product documentation only.",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "product-docs-ks",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "troubleshooting-ks",
      "neverQuerySource": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "release-notes-web",
      "neverQuerySource": true,
      "kind": "web"
    }
  ]
}

Exempelsvar

Statuskod:
200 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 4,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}
Statuskod:
206 
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "Partial results were returned before the retrieval completed."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 1,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

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

Specificerar runtime-parametrar för en kunskapskälla för Fabric Data Agent
FabricOntologyKnowledgeSourceParams

Specificerar körtidsparametrar för en kunskapskälla om Fabric Ontology
FileKnowledgeSourceParams

Specificerar körtidsparametrar för en filkunskapskälla
ImageServingStatistics

Statistik om bildservering under en återvinningsaktivitet.
IndexedOneLakeKnowledgeSourceParams

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

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

Specificerar körtidsparametrar för en indexerad SQL-kunskapskälla
KnowledgeBaseActivityRecordModel

Representerar modellen som används för en kunskapsbas-LLM-aktivitet, inklusive dess modellnamn och distributionsidentifierare.
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.
KnowledgeBaseFabricDataAgentActivityArguments

Representerar de argument som Fabric Data Agent-hämtningsaktiviteten kördes med.
KnowledgeBaseFabricDataAgentActivityRecord

Representerar en Fabric Data Agent-återvinningsaktivitetspost.
KnowledgeBaseFabricDataAgentReference

Representerar en dokumentreferens för Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments

Representerar argumenten som Fabric Ontology-återvinningsaktiviteten kördes med.
KnowledgeBaseFabricOntologyActivityRecord

Representerar en Fabric Ontology-återvinningsaktivitetspost.
KnowledgeBaseFabricOntologyReference

Representerar en referens till Fabric Ontology-dokument.
KnowledgeBaseFileActivityArguments

Representerar de argument som filhämtningsaktiviteten kördes med.
KnowledgeBaseFileActivityRecord

Representerar en filåtervinningsaktivitetspost.
KnowledgeBaseFileReference

Representerar en fildokumentreferens.
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.
KnowledgeBaseIndexedSharePointActivityArguments

Representerar argumenten som den indexerade SharePoint-hämtningsaktiviteten kördes med.
KnowledgeBaseIndexedSharePointActivityRecord

Representerar en indexerad SharePoint-återvinningsaktivitetspost.
KnowledgeBaseIndexedSharePointReference

Representerar en indexerad SharePoint-dokumentreferens.
KnowledgeBaseIndexedSqlActivityArguments

Representerar de argument som den indexerade SQL-hämtningsaktiviteten kördes med.
KnowledgeBaseIndexedSqlActivityRecord

Representerar en indexerad SQL-återvinningsaktivitetspost.
KnowledgeBaseIndexedSqlReference

Representerar en Azure SQL-dokumentreferens.
KnowledgeBaseMcpServerActivityArguments

Representerar de argument som MCP-serverns återhämtningsaktivitet kördes med.
KnowledgeBaseMcpServerActivityRecord

Representerar en MCP-serverhämtningsaktivitetspost.
KnowledgeBaseMcpServerReference

Representerar en MCP-serverdokumentreferens.
KnowledgeBaseMessage

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

Typ av meddelandeinnehåll.
KnowledgeBaseMessageImageContent

Typ av bildmeddelande.
KnowledgeBaseMessageTextContent

Typ av textmeddelande.
KnowledgeBaseModelAnswerSynthesisActivityRecord

Representerar en LLM-svarssyntesaktivitetspost.
KnowledgeBaseModelQueryPlanningActivityRecord

Representerar en LLM-frågeplaneringsaktivitetspost.
KnowledgeBaseModelWebSummarizationActivityRecord

Representerar en LLM-webbsammanfattningsaktivitetspost.
KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för en återvinningsaktivitet.
KnowledgeBaseReferenceType

Typen av referens.
KnowledgeBaseRemoteSharePointActivityArguments

Representerar argumenten som den fjärrstyrda SharePoint-hämtningsaktiviteten kördes med.
KnowledgeBaseRemoteSharePointActivityRecord

Representerar en fjärråtkomst av SharePoint-återvinningsaktivitet.
KnowledgeBaseRemoteSharePointReference

Representerar en fjärrreferens till SharePoint-dokument.
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.
KnowledgeBaseWorkIQActivityArguments

Representerar argumenten som WorkIQ-återvinningsaktiviteten kördes med.
KnowledgeBaseWorkIQActivityRecord

Representerar en WorkIQ-hämtningsaktivitetspost.
KnowledgeBaseWorkIQReference

Representerar en referens för WorkIQ-dokument.
KnowledgeRetrievalAutoReasoningEffort

Välj automatiskt resonemangsinsatsen under hämtningen. Tjänsten seedar varje förfrågan på den billigaste nivån och eskalerar endast så långt som behövs, upp till tjänstens maximala tillgängliga nivå.
KnowledgeRetrievalIntentType

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

Kör kunskapshämtning med låg ansträngning för att resonera.
KnowledgeRetrievalMediumReasoningEffort

Kör kunskapshämtning med medelhög ansträngning för resonemang.
KnowledgeRetrievalMinimalReasoningEffort

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

Utdatakonfigurationen för den här hämtningen.
KnowledgeRetrievalReasoningEffortKind

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

En semantisk frågeavsikt.
KnowledgeSourceKind

Typen av kunskapskälla.
KnowledgeSourceResultsProcessing

Kontrollerar om en kunskapskällas resultat omrankas.
McpServerKnowledgeSourceParams

Specificerar körtidsparametrar för en MCP-serverkunskapskälla
PurviewSensitivityLabelInfo

Information om känslighetsetiketten som appliceras på ett dokument
QueryType

Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "fullständig" om frågan använder Lucene-frågesyntaxen och "semantisk" om frågesyntaxen inte behövs.
RemoteSharePointKnowledgeSourceParams

Anger körningsparametrar för en fjärransluten SharePoint-kunskapskälla
SearchIndexFieldReference

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

Den typen av boost-tips för en sökindex-kunskapskälla.
SearchIndexKnowledgeSourceFieldValueBoost

Ett tips som förbättrar dokument baserat på ett fältvärde.
SearchIndexKnowledgeSourceFilterHint

En ledtråd som identifierar ett fält och representativa värden som frågeplaneraren kan använda när de konstruerar ett filter.
SearchIndexKnowledgeSourceMultiWordExpressionBoost

Ett tips som förstärker dokument baserat på ett flerordsuttryck.
SearchIndexKnowledgeSourceParams

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

Tips som vägleder frågeplanering mot användbara filter och förstärkningar för en sökindexkunskapskälla.
ServedImage

Beskriver en enskild bild som modellen valt att servas under en återvinningsaktivitet.
WebKnowledgeSourceParams

Anger körningsparametrar för en webbkunskapskälla
WorkIQKnowledgeSourceParams

Specificerar körtidsparametrar för en WorkIQ-kunskapskä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
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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.
maxOutputDocuments

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

ErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Ytterligare information.
type

string

Ytterligare informationstyp.

ErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

ErrorAdditionalInfo[]

Ytterligare information om felet.
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

Felobjektet.

FabricDataAgentKnowledgeSourceParams

Objekt

Specificerar runtime-parametrar för en kunskapskälla för Fabric Data Agent

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

fabricDataAgent

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

FabricOntologyKnowledgeSourceParams

Objekt

Specificerar körtidsparametrar för en kunskapskälla om Fabric Ontology

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

fabricOntology

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

FileKnowledgeSourceParams

Objekt

Specificerar körtidsparametrar för en filkunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

file

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

ImageServingStatistics

Objekt

Statistik om bildservering under en återvinningsaktivitet.

Name Typ Description
imagesRetrieved

integer (int32)

Antalet bilder hämtade från tillgångsbutiken.
imagesSentToModel

integer (int32)

Antalet bilder som skickas till nedströmsmodellen.
servedImages

ServedImage[]

Den uppsättning bilder som modellen valt att leverera till nedströmsmodellen för denna hämtningsaktivitet.
totalImageSizeBytes

integer (int64)

Den totala storleken i byte av bilder som skickas till modellen.
verbalizationUsed

boolean

Anger om bildverbalisering användes istället för direkt bildservering.

IndexedOneLakeKnowledgeSourceParams

Objekt

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

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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.
maxOutputDocuments

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

IndexedSharePointKnowledgeSourceParams

Objekt

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

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

indexedSharePoint

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

IndexedSqlKnowledgeSourceParams

Objekt

Specificerar körtidsparametrar för en indexerad SQL-kunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

indexedSql

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

KnowledgeBaseActivityRecordModel

Objekt

Representerar modellen som används för en kunskapsbas-LLM-aktivitet, inklusive dess modellnamn och distributionsidentifierare.

Name Typ Description
deploymentId

string

Distributionsidentifieraren för modellen som används för aktiviteten.
modelName

string

Namnet på modellen som användes för aktiviteten.

KnowledgeBaseActivityRecordType

Uppräkning

Typen av aktivitetsregister.

Värde Description
searchIndex

Sökindex-återvinningsaktivitet.
azureBlob

Azure Blob retrieval activity.
indexedSharePoint

Indexerad SharePoint-återvinningsaktivitet.
indexedOneLake

Indexerad OneLake-återvinningsaktivitet.
web

Webbåtervinningsaktivitet.
remoteSharePoint

Fjärråtkomst av SharePoint.
workIQ

WorkIQ-återhämtningsaktivitet.
fabricDataAgent

Fabric Data Agent-återvinningsaktivitet.
fabricOntology

Fabric Ontology-återvinningsaktivitet.
mcpServer

MCP-serverhämtningsaktivitet.
file

Filhämtningsaktivitet.
indexedSql

Indexerad SQL-återvinningsaktivitet.
modelQueryPlanning

LLM-frågeplaneringsaktivitet.
modelAnswerSynthesis

LLM-svarssyntesaktivitet.
modelWebSummarization

LLM-webbsammanfattningsaktivitet.
agenticReasoning

Agentiskt resonerande aktivitet.

KnowledgeBaseAgenticReasoningActivityRecord

Objekt

Representerar en aktivitetspost för agentiskt resonemang.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
logicalReasoningEffort KnowledgeRetrievalReasoningEffort:

Den logiska resonemangsinsatsen som kunden begär. Detta skiljer sig från retrievalReasoningEffort, som rapporterar den resonemangsinsats som används för fakturering.
reasoningTokens

integer (int32)

Antalet indatatoken för agentisk resonemang.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfigurationen för återhämtningsresonemangsinsats.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

agenticReasoning

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

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

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

azureBlob

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
sourceData

Källdata för referensen.
type string:

azureBlob

Typen av referens.

KnowledgeBaseErrorAdditionalInfo

Objekt

Ytterligare information om resurshanteringsfelet.

Name Typ Description
info

Ytterligare information.
type

string

Ytterligare informationstyp.

KnowledgeBaseErrorDetail

Objekt

Felinformationen.

Name Typ Description
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Ytterligare information om felet.
code

string

Felkoden.
details

KnowledgeBaseErrorDetail[]

Felinformationen.
message

string

Felmeddelandet.
target

string

Felmålet.

KnowledgeBaseFabricDataAgentActivityArguments

Objekt

Representerar de argument som Fabric Data Agent-hämtningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka kunskapskällan från Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Objekt

Representerar en Fabric Data Agent-återvinningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
fabricDataAgentArguments

KnowledgeBaseFabricDataAgentActivityArguments

Fabric Data Agent argumenterar för återhämtningsaktiviteten.
id

integer (int32)

ID för aktivitetsposten.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

fabricDataAgent

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseFabricDataAgentReference

Objekt

Representerar en dokumentreferens för Fabric Data Agent.

Name Typ Description
activitySource

integer (int32)

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

string

Fabric Data Agent ID.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

fabricDataAgent

Typen av referens.
workspaceId

string

ID:t för Fabric arbetsyta.

KnowledgeBaseFabricOntologyActivityArguments

Objekt

Representerar argumenten som Fabric Ontology-återvinningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka i kunskapskällan från Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Objekt

Representerar en Fabric Ontology-återvinningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
fabricOntologyArguments

KnowledgeBaseFabricOntologyActivityArguments

Fabric Ontology-argumenten för återhämtningsaktiviteten.
id

integer (int32)

ID för aktivitetsposten.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

fabricOntology

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseFabricOntologyReference

Objekt

Representerar en referens till Fabric Ontology-dokument.

Name Typ Description
activitySource

integer (int32)

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

string

ID för referensen.
ontologyId

string

Ontologi-ID:t inom arbetsytan.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

fabricOntology

Typen av referens.
workspaceId

string

ID:t för Fabric arbetsyta.

KnowledgeBaseFileActivityArguments

Objekt

Representerar de argument som filhämtningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka filinnehåll.

KnowledgeBaseFileActivityRecord

Objekt

Representerar en filåtervinningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
fileArguments

KnowledgeBaseFileActivityArguments

Filen argumenten för återhämtningsaktiviteten.
id

integer (int32)

ID för aktivitetsposten.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

file

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseFileReference

Objekt

Representerar en fildokumentreferens.

Name Typ Description
activitySource

integer (int32)

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
docName

string

Dokumentnamnet på referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
sourceData

Källdata för referensen.
type string:

file

Typen av referens.

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
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

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

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

indexedOneLake

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseIndexedOneLakeReference

Objekt

Representerar en indexerad OneLake-dokumentreferens.

Name Typ Description
activitySource

integer (int32)

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
docUrl

string

Dokumentets URL för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
sourceData

Källdata för referensen.
type string:

indexedOneLake

Typen av referens.

KnowledgeBaseIndexedSharePointActivityArguments

Objekt

Representerar argumenten som den indexerade SharePoint-hämtningsaktiviteten kördes med.

Name Typ Description
search

string

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

KnowledgeBaseIndexedSharePointActivityRecord

Objekt

Representerar en indexerad SharePoint-återvinningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

De indexerade SharePoint-argumenten för hämtaaktiviteten.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

indexedSharePoint

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseIndexedSharePointReference

Objekt

Representerar en indexerad SharePoint-dokumentreferens.

Name Typ Description
activitySource

integer (int32)

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
docUrl

string

Dokumentets URL för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
sourceData

Källdata för referensen.
type string:

indexedSharePoint

Typen av referens.

KnowledgeBaseIndexedSqlActivityArguments

Objekt

Representerar de argument som den indexerade SQL-hämtningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka indexerat SQL-innehåll.

KnowledgeBaseIndexedSqlActivityRecord

Objekt

Representerar en indexerad SQL-återvinningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

De indexerade SQL-argumenten för hämtandet.
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

indexedSql

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseIndexedSqlReference

Objekt

Representerar en Azure SQL-dokumentreferens.

Name Typ Description
activitySource

integer (int32)

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
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:

indexedSql

Typen av referens.

KnowledgeBaseMcpServerActivityArguments

Objekt

Representerar de argument som MCP-serverns återhämtningsaktivitet kördes med.

Name Typ Description
toolArguments

Argumenten skickades vidare till MCP:s serververktyg.
toolName

string

Namnet på MCP-serververktyget som används för hämtandet.

KnowledgeBaseMcpServerActivityRecord

Objekt

Representerar en MCP-serverhämtningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
mcpServerArguments

KnowledgeBaseMcpServerActivityArguments

MCP-servern argumenterar för återhämtningsaktiviteten.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

mcpServer

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseMcpServerReference

Objekt

Representerar en MCP-serverdokumentreferens.

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

Resultatet är namnet på MCP-serververktyget.
toolName

string

Namnet på MCP-serververktyget som producerade referensen.
type string:

mcpServer

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

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objekt

Representerar en LLM-svarssyntesaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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 indatatoken för LLM-svarssyntesaktiviteten.
model

KnowledgeBaseActivityRecordModel

Modellen som används för LLM-svarssyntesaktiviteten.
outputTokens

integer (int32)

Antalet utdatatoken för LLM-svarssyntesaktiviteten.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

modelAnswerSynthesis

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseModelQueryPlanningActivityRecord

Objekt

Representerar en LLM-frågeplaneringsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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 indatatoken för LLM-frågeplaneringsaktiviteten.
model

KnowledgeBaseActivityRecordModel

Modellen som används för LLM-frågeplaneringsaktiviteten.
outputTokens

integer (int32)

Antalet utdatatoken för LLM-frågeplaneringsaktiviteten.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

modelQueryPlanning

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseModelWebSummarizationActivityRecord

Objekt

Representerar en LLM-webbsammanfattningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
model

KnowledgeBaseActivityRecordModel

Modellen som används för LLM:s webbsammanfattningsaktivitet.
outputTokens

integer (int32)

Antalet utdatatoken för LLM:s webbsammanfattningsaktivitet.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

modelWebSummarization

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseQueryHintProcessing

Objekt

Detaljer om uttrycken som genereras från frågeledtrådar för en återvinningsaktivitet.

Name Typ Description
generatedBoost

string

Sökklausulen genereras från boost-ledtrådar för denna aktivitet.
generatedFilter

string

Filteruttrycket som genereras från filtret ger ledtrådar för denna aktivitet.

KnowledgeBaseReferenceType

Uppräkning

Typen av referens.

Värde Description
searchIndex

Sök i indexdokumentreferens.
azureBlob

Azure Blob dokumentreferens.
indexedSharePoint

Indexerad SharePoint-dokumentreferens.
indexedOneLake

Indexerad dokumentreferens från OneLake.
web

Webbdokumentreferens.
remoteSharePoint

Fjärrreferens för SharePoint-dokument.
workIQ

Referens för arbetsintelligensdokument.
fabricDataAgent

Fabric Data Agent dokumentreferens.
fabricOntology

Fabric Ontology-dokumentreferens.
mcpServer

MCP-serverdokumentreferens.
file

Arkivera dokumentreferens.
indexedSql

Indexerad SQL-dokumentreferens.

KnowledgeBaseRemoteSharePointActivityArguments

Objekt

Representerar argumenten som den fjärrstyrda SharePoint-hämtningsaktiviteten kördes med.

Name Typ Description
filterExpressionAddOn

string

Filteruttryckstillägget för återhämtningsaktiviteten.
search

string

Söksträngen som används för att söka den fjärrstyrda SharePoint-kunskapskällan.

KnowledgeBaseRemoteSharePointActivityRecord

Objekt

Representerar en fjärråtkomst av SharePoint-återvinningsaktivitet.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

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

KnowledgeBaseRemoteSharePointActivityArguments

De fjärrstyrda SharePoint-argumenten för hämtningsaktiviteten.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

remoteSharePoint

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseRemoteSharePointReference

Objekt

Representerar en fjärrreferens till SharePoint-dokument.

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

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
sourceData

Källdata för referensen.
type string:

remoteSharePoint

Typen av referens.
webUrl

string (uri)

Den URL som referensdata kommer från.

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

integer (int32)

Begränsar det maximala antalet dokument i utdatan.
maxOutputSize

integer (int32)

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

integer (int32)

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

integer (int32)

Den maximala körtiden i sekunder.
messages

KnowledgeBaseMessage[]

En lista med indata för chattmeddelandeformat.
outputMode

KnowledgeRetrievalOutputMode

Utdatakonfigurationen för den här hämtningen.
retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfigurationen för återhämtningsresonemangsinsats.

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

PurviewSensitivityLabelInfo

Känslighetsetikettinformationen för det övergripande svaret.

KnowledgeBaseSearchIndexActivityArguments

Objekt

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

Name Typ Description
filter

string

Filtersträngen.
queryType

QueryType

Frågesyntaxen som används för att utföra sökningen. Frågeledtrådar kan göra att semantiska frågor använder full frågesyntax.
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
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detaljer om uttrycken som genereras från frågeledtrådar för denna aktivitet.
queryTime

string (date-time)

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

KnowledgeBaseSearchIndexActivityArguments

Sökindexargumenten för hämtningsaktiviteten.
startedAt

string (date-time)

Tiden då aktiviteten började.
type string:

searchIndex

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.

KnowledgeBaseSearchIndexReference

Objekt

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

Name Typ Description
activitySource

integer (int32)

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

string (uri)

En sök-ägd URL som pekar på backing-dokumentet för denna referens, användbar som referensmål.
docKey

string

Dokumentnyckeln för referensen.
id

string

ID för referensen.
rerankerScore

number (float)

Rankningspoängen för dokumentreferensen.
searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
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
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

web

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.
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.

KnowledgeBaseWorkIQActivityArguments

Objekt

Representerar argumenten som WorkIQ-återvinningsaktiviteten kördes med.

Name Typ Description
search

string

Söksträngen som används för att söka i WorkIQ:s kunskapskälla.

KnowledgeBaseWorkIQActivityRecord

Objekt

Representerar en WorkIQ-hämtningsaktivitetspost.

Name Typ Description
completedAt

string (date-time)

Den tid då aktiviteten slutfördes.
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.
imageServing

ImageServingStatistics

Statistik om bildservering för denna återvinningsaktivitet
knowledgeSourceName

string

Kunskapskällan för hämtningsaktiviteten.
queryTime

string (date-time)

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

string (date-time)

Tiden då aktiviteten började.
type string:

workIQ

Typ av aktivitetspost.
warning

string

Ett varningsmeddelande som visar potentiella konfigurationsproblem som observerats under aktiviteten, såsom dokument som tappas på grund av poängtröskel, tokenbegränsning eller timeout-villkor.
workIQArguments

KnowledgeBaseWorkIQActivityArguments

WorkIQ-argumenten för återhämtningsaktiviteten.

KnowledgeBaseWorkIQReference

Objekt

Representerar en referens för WorkIQ-dokument.

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

PurviewSensitivityLabelInfo

Informationen om känslighetsetiketten för referensen.
sourceData

Källdata för referensen.
type string:

workIQ

Typen av referens.

KnowledgeRetrievalAutoReasoningEffort

Objekt

Välj automatiskt resonemangsinsatsen under hämtningen. Tjänsten seedar varje förfrågan på den billigaste nivån och eskalerar endast så långt som behövs, upp till tjänstens maximala tillgängliga nivå.

Name Typ Description
kind string:

auto

Den sortens resonemangsförsök.

KnowledgeRetrievalIntentType

Uppräkning

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

Värde Description
semantic

En semantisk frågeavsikt med naturligt språk.

KnowledgeRetrievalLowReasoningEffort

Objekt

Kör kunskapshämtning med låg ansträngning för att resonera.

Name Typ Description
kind string:

low

Den sortens resonemangsförsök.

KnowledgeRetrievalMediumReasoningEffort

Objekt

Kör kunskapshämtning med medelhög ansträngning för resonemang.

Name Typ Description
kind string:

medium

Den sortens resonemangsförsö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.

KnowledgeRetrievalOutputMode

Uppräkning

Utdatakonfigurationen för den här hämtningen.

Värde Description
extractiveData

Returnera data från kunskapskällorna direkt utan generativ förändring.
answerSynthesis

Syntetisera ett svar för svarsnyttolasten.

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

Använd lågt resonemang under hämtningen.
medium

Använd en måttlig mängd resonemang under hämtningen.
auto

Välj automatiskt resonemangsinsatsen vid hämtningen, och eskalera från den billigaste nivån bara så långt som behövs.

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

En kunskapskälla som läser data från indexerad SharePoint.
indexedOneLake

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

En kunskapskälla som hämtar och tar in data från Azure SQL Database eller SQL Managed Instance till ett sökindex.
web

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

En kunskapskälla som läser data från fjärr-SharePoint.
workIQ

En kunskapskälla som läser data från arbets-IQ
file

En kunskapskälla som stödjer direkt filuppladdning och indexering.
mcpServer

En kunskapskälla som backas upp av en MCP (Model Context Protocol)-server.
fabricDataAgent

En kunskapskälla som hämtar data från en Fabric Data Agent.
fabricOntology

En kunskapskälla som hämtar data från Microsoft Fabric Ontology-ontologier.

KnowledgeSourceResultsProcessing

Uppräkning

Kontrollerar om en kunskapskällas resultat omrankas.

Värde Description
rerank

Resultaten från denna kunskapskälla går genom omklassificeringsprocessen. Det här är standardbeteendet.
none

Resultat från denna kunskapskälla kringgår omklassificering och bevarar sin underliggande ordning.

McpServerKnowledgeSourceParams

Objekt

Specificerar körtidsparametrar för en MCP-serverkunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

mcpServer

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

PurviewSensitivityLabelInfo

Objekt

Information om känslighetsetiketten som appliceras på ett dokument

Name Typ Description
color

string

Den färg som användargränssnittet ska visa för etiketten, om den är konfigurerad.
displayName

string

Visningsnamnet för känslighetsetiketten.
isEncrypted

boolean

Anger om känslighetsetiketten framtvingar kryptering.
priority

integer (int32)

Den prioritet som känslighetsetiketten används i.
sensitivityLabelId

string

ID:t för känslighetsetiketten.
toolTip

string

Knappbeskrivningen som ska visas för etiketten i ett användargränssnitt.

QueryType

Uppräkning

Anger syntaxen för sökfrågan. Standardvärdet är "enkelt". Använd "fullständig" om frågan använder Lucene-frågesyntaxen och "semantisk" om frågesyntaxen inte behövs.

Värde Description
simple

Använder den enkla frågesyntaxen för sökningar. Söktext tolkas med hjälp av ett enkelt frågespråk som tillåter symboler som +, * och "". Frågor utvärderas i alla sökbara fält som standard, såvida inte parametern searchFields har angetts.
full

Använder den fullständiga Lucene-frågesyntaxen för sökningar. Söktexten tolkas med hjälp av frågespråket Lucene, som tillåter fältspecifika och viktade sökningar, samt andra avancerade funktioner.
semantic

Passar bäst för frågor som uttrycks på naturligt språk i motsats till nyckelord. Förbättrar precisionen i sökresultaten genom att rangordna om de främsta sökresultaten med hjälp av en rankningsmodell som tränats på webbkorpusen.

RemoteSharePointKnowledgeSourceParams

Objekt

Anger körningsparametrar för en fjärransluten SharePoint-kunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
filterExpressionAddOn

string

Ett filtervillkor som tillämpas på SharePoint-datakällan. Den måste anges i syntaxen för nyckelordsfrågespråk. Det kombineras som en kombination med det filteruttryck som anges i definitionen av kunskapskällan.
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:

remoteSharePoint

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

SearchIndexFieldReference

Objekt

Fältreferens för ett sökindex.

Name Typ Description
name

string

Namnet på fältet.

SearchIndexKnowledgeSourceBoostKind

Uppräkning

Den typen av boost-tips för en sökindex-kunskapskälla.

Värde Description
fieldValue

Förbättra dokument baserat på ett fältvärde.
multiWordExpression

Förstärk dokument baserat på ett uttryck med flera ord.

SearchIndexKnowledgeSourceFieldValueBoost

Objekt

Ett tips som förbättrar dokument baserat på ett fältvärde.

Name Typ Description
boost

number (double)

En multiplikator för dokumentpoängen. Måste vara ett positivt tal som inte är lika med 1,0.
boostInstructions

string

Instruktioner på naturligt språk som förklarar när och hur man applicerar boosten.
field

string

minLength: 1

Namnet på sökindexfältet.
fieldValues

string[]

Representativa värden för fältet.
kind string:

fieldValue

Den typen av boost-hint.

SearchIndexKnowledgeSourceFilterHint

Objekt

En ledtråd som identifierar ett fält och representativa värden som frågeplaneraren kan använda när de konstruerar ett filter.

Name Typ Description
field

string

minLength: 1

Namnet på det filtrerbara sökindexfältet.
fieldValues

string[]

Representativa värden för fältet.
filterInstructions

string

Naturliga språkinstruktioner som förklarar när och hur man ska filtrera på fältet.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Objekt

Ett tips som förstärker dokument baserat på ett flerordsuttryck.

Name Typ Description
boost

number (double)

En multiplikator för dokumentpoängen. Måste vara ett positivt tal som inte är lika med 1,0.
boostInstructions

string

Instruktioner på naturligt språk som förklarar när och hur man applicerar boosten.
fieldValues

string[]

Representativa värden för ökningen.
kind string:

multiWordExpression

Den typen av boost-hint.

SearchIndexKnowledgeSourceParams

Objekt

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

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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.
maxOutputDocuments

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips som vägleder frågeplanering mot användbara filter och boostar. Om det anges ersätter detta objekt den kompletta uppsättningen av frågeledtrådar konfigurerade på kunskapskällan.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

SearchIndexKnowledgeSourceQueryHints

Objekt

Tips som vägleder frågeplanering mot användbara filter och förstärkningar för en sökindexkunskapskälla.

Name Typ Description
boosts SearchIndexKnowledgeSourceBoost[]:

Förstärk ledtrådar som identifierar förutsättningar som frågeplaneraren kan använda för att påverka dokumentrankningen.
filters

SearchIndexKnowledgeSourceFilterHint[]

Filterledtrådar som identifierar fält och representativa värden som frågeplaneraren kan använda när den konstruerar filter.

ServedImage

Objekt

Beskriver en enskild bild som modellen valt att servas under en återvinningsaktivitet.

Name Typ Description
imageId

string

Bildetiketten extraherad från källdokumentet av Content Understanding enrichment. Motsvarar siffrorerna i originaldokumentet.
imagePath

string

Den relativa vägen till bilden inom tillgångslagret.
sizeBytes

integer (int64)

Storleken i byte av denna bild som skickas till modellen.

WebKnowledgeSourceParams

Objekt

Anger körningsparametrar för en webbkunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
count

integer (int32)

Antalet webbresultat som ska returneras.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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.
maxOutputDocuments

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.

WorkIQKnowledgeSourceParams

Objekt

Specificerar körtidsparametrar för en WorkIQ-kunskapskälla

Name Typ Description
alwaysQuerySource

boolean

Anger att den här kunskapskällan ska kringgå valet av källa och alltid efterfrågas vid hämtningen.
enableImageServing

boolean

Anger om bildservering bör aktiveras för denna kunskapskälla vid hämtningstillfället. När de är sanna levereras bilder som extraheras under intagning till modeller nedströms.
failOnError

boolean

Indikerar att hela hämtningsförfrågan ska misslyckas om hämtan från denna kunskapskälla stöter på ett fel. Standardvärdet är falskt.
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:

workIQ

Typen av kunskapskälla.
knowledgeSourceName

string

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

integer (int32)

Begränsar det maximala antalet dokument som returneras från denna kunskapskälla.
neverQuerySource

boolean

Indikerar att denna kunskapskälla bör uteslutas från förfrågans kandidatuppsättning och aldrig frågas vid hämtan. Undantaget är request-local och ändrar inte medlemskapet i kunskapsbasen. Kan inte kombineras med alwaysQuerySource på samma kunskapskälla.
rerankerThreshold

number (float)

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

KnowledgeSourceResultsProcessing

Överskriver kunskapskällans lagrade resultat Bearbetning endast för detta hämtaanrop. När den utelämnas gäller värdet för lagrad kunskapskälla.