Knowledge Retrieval - Retrieve

Baza wiedzy KnowledgeBase pobiera odpowiednie dane z magazynów zapasowych.

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
endpoint
path True

string (uri)

Adres URL punktu końcowego usługi wyszukiwania.

knowledgeBaseName
path True

string

Nazwa bazy wiedzy.

api-version
query True

string

minLength: 1

Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa Wymagane Typ Opis
Accept

Accept

Nagłówek Accept.

x-ms-query-source-authorization

string

Token identyfikujący użytkownika, dla którego jest wykonywane zapytanie. Ten token służy do wymuszania ograniczeń zabezpieczeń dokumentów.

x-ms-query-work-iq-source-authorization

string (password)

Token asercji użytkownika dla rejestracji aplikacji Entra należącej do klienta, skonfigurowany na źródle wiedzy Work IQ. Używany do uwierzytelniania na zlecenie do API Work IQ.

x-ms-client-request-id

string (uuid)

Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

Treść żądania

Nazwa Typ Opis
includeActivity

boolean

Wskazuje, że wyniki pobierania powinny zawierać informacje o aktywności.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Lista zamierzonych zapytań, które mają być wykonywane bez planowania zapytań modelu.

knowledgeSourceParams KnowledgeSourceParams[]:

Lista parametrów środowiska uruchomieniowego dla źródeł wiedzy.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów w wydruku.

maxOutputSize

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxOutputSizeInTokens

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxRuntimeInSeconds

integer (int32)

Maksymalny czas pracy w sekundach.

messages

KnowledgeBaseMessage[]

Lista danych wejściowych stylu wiadomości czatu.

outputMode

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfiguracja wysiłku rozumowania wyszukiwania.

Odpowiedzi

Nazwa Typ Opis
200 OK

KnowledgeBaseRetrievalResponse

Pomyślna reakcja na pobranie.

Other Status Codes

KnowledgeBaseRetrievalResponse

Częściowa reakcja na pobranie.

Other Status Codes

ErrorResponse

Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa Opis
https://search.azure.com/.default

Przykłady

KnowledgeBaseRetrieve
KnowledgeBaseRetrieveAzureBlobImageServing
KnowledgeBaseRetrieveWithIntents
KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
Accept

Nagłówek Accept.

AzureBlobKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy obiektu blob platformy Azure

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

ErrorDetail

Szczegóły błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

FabricDataAgentKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Data Agent

FabricOntologyKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Ontology

FileKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy plikowej

ImageServingStatistics

Statystyki dotyczące serwowania obrazu podczas aktywności wyszukiwania.

IndexedOneLakeKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy OneLake

IndexedSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy programu SharePoint

IndexedSqlKnowledgeSourceParams

Określa parametry wykonawcze dla indeksowanego źródła wiedzy SQL

KnowledgeBaseActivityRecordModel

Reprezentuje model używany w aktywności LLM bazy wiedzy, w tym nazwę modelu i identyfikator wdrożenia.

KnowledgeBaseActivityRecordType

Rodzaj rejestru aktywności.

KnowledgeBaseAgenticReasoningActivityRecord

Reprezentuje rekord działania wnioskowania agentycznego.

KnowledgeBaseAzureBlobActivityArguments

Reprezentuje argumenty, z którymi uruchomiono działanie pobierania obiektów blob platformy Azure.

KnowledgeBaseAzureBlobActivityRecord

Reprezentuje rekord działania pobierania obiektów blob platformy Azure.

KnowledgeBaseAzureBlobReference

Reprezentuje dokumentację Azure Blob Storage.

KnowledgeBaseErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

KnowledgeBaseErrorDetail

Szczegóły błędu.

KnowledgeBaseFabricDataAgentActivityArguments

Reprezentuje argumenty, na których wykonano aktywność pobierania Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Reprezentuje rekord aktywności pobierania agentów danych Fabric.

KnowledgeBaseFabricDataAgentReference

Reprezentuje referencję dokumentu Fabric Data Agent.

KnowledgeBaseFabricOntologyActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność pobierania Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Reprezentuje rekord aktywności pobierania Fabric Ontology.

KnowledgeBaseFabricOntologyReference

Reprezentuje referencję do dokumentu Fabric Ontology.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania plików.

KnowledgeBaseFileActivityRecord

Reprezentuje rekord aktywności pobierania plików.

KnowledgeBaseFileReference

Reprezentuje referencję do pliku dokumentu.

KnowledgeBaseImageContent

Treści obrazowe.

KnowledgeBaseIndexedOneLakeActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania indeksowanego OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Reprezentuje indeksowany rekord aktywności pobierania OneLake.

KnowledgeBaseIndexedOneLakeReference

Reprezentuje indeksowany dokument OneLake.

KnowledgeBaseIndexedSharePointActivityArguments

Reprezentuje argumenty, z których wykonano aktywność wyszukiwania indeksowanego SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Reprezentuje zindeksowany rekord aktywności pobierania w SharePoint.

KnowledgeBaseIndexedSharePointReference

Reprezentuje indeksowany dokument SharePoint.

KnowledgeBaseIndexedSqlActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność wyszukiwania indeksowanego SQL.

KnowledgeBaseIndexedSqlActivityRecord

Reprezentuje zindeksowany rekord aktywności wyszukiwania SQL.

KnowledgeBaseIndexedSqlReference

Reprezentuje referencję dokumentu Azure SQL.

KnowledgeBaseMcpServerActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania serwera MCP.

KnowledgeBaseMcpServerActivityRecord

Reprezentuje rekord aktywności pobierania serwera MCP.

KnowledgeBaseMcpServerReference

Reprezentuje referencję do dokumentu serwera MCP.

KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.

KnowledgeBaseMessageContentType

Typ treści wiadomości.

KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.

KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.

KnowledgeBaseModelAnswerSynthesisActivityRecord

Reprezentuje rekord działania syntezy odpowiedzi LLM.

KnowledgeBaseModelQueryPlanningActivityRecord

Reprezentuje rekord działania planowania zapytań LLM.

KnowledgeBaseModelWebSummarizationActivityRecord

Reprezentuje rekord aktywności streszczającej LLM w sieci.

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla aktywności pobierania.

KnowledgeBaseReferenceType

Typ odwołania.

KnowledgeBaseRemoteSharePointActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność zdalnego pobierania SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Reprezentuje zdalny rekord aktywności pobierania SharePoint.

KnowledgeBaseRemoteSharePointReference

Reprezentuje zdalne odniesienie do dokumentu programu SharePoint.

KnowledgeBaseRetrievalRequest

Kontrakt wejściowy dla żądania pobrania.

KnowledgeBaseRetrievalResponse

Kontrakt wyjściowy dla odpowiedzi pobierania.

KnowledgeBaseSearchIndexActivityArguments

Reprezentuje argumenty, z którymi zostało uruchomione działanie pobierania indeksu wyszukiwania.

KnowledgeBaseSearchIndexActivityRecord

Reprezentuje rekord działania pobierania indeksu wyszukiwania.

KnowledgeBaseSearchIndexReference

Reprezentuje dokumentację usługi Azure Search.

KnowledgeBaseWebActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania sieci.

KnowledgeBaseWebActivityRecord

Reprezentuje rekord aktywności wyszukiwania w sieci.

KnowledgeBaseWebReference

Reprezentuje odniesienie do dokumentu sieci Web.

KnowledgeBaseWorkIQActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Reprezentuje rekord aktywności wyszukiwania WorkIQ.

KnowledgeBaseWorkIQReference

Reprezentuje referencję do dokumentu WorkIQ.

KnowledgeRetrievalAutoReasoningEffort

Automatycznie wybierz wysiłek rozumowania podczas pobierania. Usługa zasiewa każde żądanie na najtańszym poziomie i eskaluje tylko do poziomu potrzebnego, do maksymalnego dostępnego poziomu usługi.

KnowledgeRetrievalIntentType

Rodzaj konfiguracji bazy wiedzy, która ma być używana.

KnowledgeRetrievalLowReasoningEffort

Uruchamiaj pobieranie wiedzy przy niewielkim wysiłku związanym z rozumowaniem.

KnowledgeRetrievalMediumReasoningEffort

Uruchamianie wyszukiwania wiedzy ze średnim wysiłkiem rozumowania.

KnowledgeRetrievalMinimalReasoningEffort

Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem.

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

KnowledgeRetrievalReasoningEffortKind

Ilość wysiłku do użycia podczas pobierania.

KnowledgeRetrievalSemanticIntent

Zamiar zapytania semantycznego.

KnowledgeSourceKind

Rodzaj źródła wiedzy.

KnowledgeSourceResultsProcessing

Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane.

McpServerKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy serwera MCP

PurviewSensitivityLabelInfo

Informacje o etykiecie wrażliwości zastosowanej do dokumentu

QueryType

Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "pełna", jeśli zapytanie używa składni zapytania Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.

RemoteSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla zdalnego źródła wiedzy programu SharePoint

SearchIndexFieldReference

Referencja polowa dla indeksu wyszukiwania.

SearchIndexKnowledgeSourceBoostKind

Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy.

SearchIndexKnowledgeSourceFieldValueBoost

Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola.

SearchIndexKnowledgeSourceFilterHint

Podpojka identyfikująca pole i reprezentatywne wartości, którą planista zapytań może wykorzystać podczas tworzenia filtra.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu.

SearchIndexKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy indeksu wyszukiwania

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania.

ServedImage

Opisuje pojedynczy obraz, który model wybrał do obsługi podczas aktywności pobierania.

WebKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla internetowego źródła wiedzy

WorkIQKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy WorkIQ

Accept

Nagłówek Accept.

Wartość Opis
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy obiektu blob platformy Azure

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

azureBlob

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

ErrorAdditionalInfo[]

Dodatkowe informacje o błędzie

code

string

Kod błędu.

details

ErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Cel błędu.

ErrorResponse

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa Typ Opis
error

ErrorDetail

Obiekt błędu.

FabricDataAgentKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Data Agent

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

fabricDataAgent

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

FabricOntologyKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy Fabric Ontology

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

fabricOntology

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

FileKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy plikowej

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

file

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

ImageServingStatistics

Statystyki dotyczące serwowania obrazu podczas aktywności wyszukiwania.

Nazwa Typ Opis
imagesRetrieved

integer (int32)

Liczba obrazów pobranych ze sklepu zasobów.

imagesSentToModel

integer (int32)

Liczba obrazów przesyłanych do modelu downstream.

servedImages

ServedImage[]

Zestaw obrazów wybranych przez model do przekazania modelu dalszemu w tej aktywności.

totalImageSizeBytes

integer (int64)

Całkowity rozmiar w bajtach obrazów przesyłanych do modelu.

verbalizationUsed

boolean

Wskazuje, czy użyto werbalizacji obrazów zamiast bezpośredniego podawania obrazu.

IndexedOneLakeKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy OneLake

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedOneLake

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

IndexedSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla indeksowanego źródła wiedzy programu SharePoint

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedSharePoint

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

IndexedSqlKnowledgeSourceParams

Określa parametry wykonawcze dla indeksowanego źródła wiedzy SQL

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

indexedSql

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

KnowledgeBaseActivityRecordModel

Reprezentuje model używany w aktywności LLM bazy wiedzy, w tym nazwę modelu i identyfikator wdrożenia.

Nazwa Typ Opis
deploymentId

string

Identyfikator wdrożenia modelu użytego w danej aktywności.

modelName

string

Nazwa modelu użytego w danej aktywności.

KnowledgeBaseActivityRecordType

Rodzaj rejestru aktywności.

Wartość Opis
searchIndex

Wyszukaj aktywność wyszukiwania indeksu.

azureBlob

Azure Blob retrieval activity.

indexedSharePoint

Aktywność wyszukiwania indeksowanego SharePoint.

indexedOneLake

Indeksowana aktywność odzyskiwania OneLake.

web

Aktywność wyszukiwania w sieci.

remoteSharePoint

Aktywność zdalnego pobierania SharePoint.

workIQ

Aktywność odzyskiwania WorkIQ.

fabricDataAgent

Aktywność pobierania agentów danych Fabric.

fabricOntology

Aktywność pobierania Fabric Ontology.

mcpServer

Aktywność pobierania serwerów MCP.

file

Aktywność pobierania plików.

indexedSql

Aktywność wyszukiwania indeksowanego SQL.

modelQueryPlanning

Aktywność planowania zapytań LLM.

modelAnswerSynthesis

Aktywność syntezy odpowiedzi LLM.

modelWebSummarization

Aktywność podsumowująca LLM w sieci.

agenticReasoning

Aktywność rozumowania agentycznego.

KnowledgeBaseAgenticReasoningActivityRecord

Reprezentuje rekord działania wnioskowania agentycznego.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

logicalReasoningEffort KnowledgeRetrievalReasoningEffort:

Wysiłek logicznego rozumowania, o który prosi klient. Różni się to od retrievalReasoningEffort, które raportuje wysiłek uzasadniający rozliczenie.

reasoningTokens

integer (int32)

Liczba tokenów wejściowych na potrzeby wnioskowania agenta.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfiguracja wysiłku rozumowania wyszukiwania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

agenticReasoning

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseAzureBlobActivityArguments

Reprezentuje argumenty, z którymi uruchomiono działanie pobierania obiektów blob platformy Azure.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do wykonywania zapytań dotyczących zawartości obiektu blob.

KnowledgeBaseAzureBlobActivityRecord

Reprezentuje rekord działania pobierania obiektów blob platformy Azure.

Nazwa Typ Opis
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Argumenty obiektu blob platformy Azure dla działania pobierania.

completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

azureBlob

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseAzureBlobReference

Reprezentuje dokumentację Azure Blob Storage.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

blobUrl

string

Adres URL obiektu blob dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

azureBlob

Typ odwołania.

KnowledgeBaseErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa Typ Opis
info

Dodatkowe informacje.

type

string

Dodatkowy typ informacji.

KnowledgeBaseErrorDetail

Szczegóły błędu.

Nazwa Typ Opis
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Dodatkowe informacje o błędzie

code

string

Kod błędu.

details

KnowledgeBaseErrorDetail[]

Szczegóły błędu.

message

string

Komunikat o błędzie.

target

string

Cel błędu.

KnowledgeBaseFabricDataAgentActivityArguments

Reprezentuje argumenty, na których wykonano aktywność pobierania Fabric Data Agent.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania do źródła wiedzy Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Reprezentuje rekord aktywności pobierania agentów danych Fabric.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

fabricDataAgentArguments

KnowledgeBaseFabricDataAgentActivityArguments

Argumenty Fabric Data Agent dla aktywności pobierania.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

fabricDataAgent

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseFabricDataAgentReference

Reprezentuje referencję dokumentu Fabric Data Agent.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

dataAgentId

string

Identyfikator agenta danych Fabric.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

fabricDataAgent

Typ odwołania.

workspaceId

string

Identyfikator obszaru roboczego Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność pobierania Fabric Ontology.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania do źródła wiedzy Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Reprezentuje rekord aktywności pobierania Fabric Ontology.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

fabricOntologyArguments

KnowledgeBaseFabricOntologyActivityArguments

Argumenty Fabric Ontology za aktywnością odzyskiwania.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

fabricOntology

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseFabricOntologyReference

Reprezentuje referencję do dokumentu Fabric Ontology.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

ontologyId

string

ID ontologii w przestrzeni roboczej.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

fabricOntology

Typ odwołania.

workspaceId

string

Identyfikator obszaru roboczego Fabric.

KnowledgeBaseFileActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania plików.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania o zawartość plików.

KnowledgeBaseFileActivityRecord

Reprezentuje rekord aktywności pobierania plików.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

fileArguments

KnowledgeBaseFileActivityArguments

Argument pliku za aktywnością odzysku.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

file

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseFileReference

Reprezentuje referencję do pliku dokumentu.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docName

string

Nazwa dokumentu dla odniesienia.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

file

Typ odwołania.

KnowledgeBaseImageContent

Treści obrazowe.

Nazwa Typ Opis
url

string (uri)

Adres URL obrazu.

KnowledgeBaseIndexedOneLakeActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania indeksowanego OneLake.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania do indeksowanych treści OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Reprezentuje indeksowany rekord aktywności pobierania OneLake.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

Indeksowane argumenty OneLake za aktywnością odzyskiwania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedOneLake

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedOneLakeReference

Reprezentuje indeksowany dokument OneLake.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedOneLake

Typ odwołania.

KnowledgeBaseIndexedSharePointActivityArguments

Reprezentuje argumenty, z których wykonano aktywność wyszukiwania indeksowanego SharePoint.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytań o indeksowane treści SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Reprezentuje zindeksowany rekord aktywności pobierania w SharePoint.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

Zindeksowane argumenty SharePoint dla aktywności pobierania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedSharePoint

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedSharePointReference

Reprezentuje indeksowany dokument SharePoint.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedSharePoint

Typ odwołania.

KnowledgeBaseIndexedSqlActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność wyszukiwania indeksowanego SQL.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytań o indeksowane treści SQL.

KnowledgeBaseIndexedSqlActivityRecord

Reprezentuje zindeksowany rekord aktywności wyszukiwania SQL.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

Zindeksowane argumenty SQL dla aktywności pobierania.

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

indexedSql

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseIndexedSqlReference

Reprezentuje referencję dokumentu Azure SQL.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docUrl

string

Adres URL dokumentu referencyjnego.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

type string:

indexedSql

Typ odwołania.

KnowledgeBaseMcpServerActivityArguments

Reprezentuje argumenty, z którymi wykonano aktywność pobierania serwera MCP.

Nazwa Typ Opis
toolArguments

Argumenty przekazywane do narzędzia serwera MCP.

toolName

string

Nazwa narzędzia serwera MCP używanego do aktywności pobierania.

KnowledgeBaseMcpServerActivityRecord

Reprezentuje rekord aktywności pobierania serwera MCP.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

mcpServerArguments

KnowledgeBaseMcpServerActivityArguments

Argumenty serwera MCP dla aktywności pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

mcpServer

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseMcpServerReference

Reprezentuje referencję do dokumentu serwera MCP.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

title

string

Tytuł wyniku narzędzia serwera MCP.

toolName

string

Nazwa narzędzia serwera MCP, które generowało referencję.

type string:

mcpServer

Typ odwołania.

KnowledgeBaseMessage

Obiekt stylu komunikatu w języku naturalnym.

Nazwa Typ Opis
content KnowledgeBaseMessageContent[]:

Zawartość wiadomości.

role

string

Rola odpowiedzi narzędzia.

KnowledgeBaseMessageContentType

Typ treści wiadomości.

Wartość Opis
text

Rodzaj treści wiadomości tekstowej.

image

Rodzaj treści wiadomości obrazu.

KnowledgeBaseMessageImageContent

Typ wiadomości obrazu.

Nazwa Typ Opis
image

KnowledgeBaseImageContent

Treść obrazów.

type string:

image

Typ komunikatu

KnowledgeBaseMessageTextContent

Typ wiadomości tekstowej.

Nazwa Typ Opis
text

string

Zawartość tekstowa.

type string:

text

Typ komunikatu

KnowledgeBaseModelAnswerSynthesisActivityRecord

Reprezentuje rekord działania syntezy odpowiedzi LLM.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla działania syntezy odpowiedzi LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do syntezy odpowiedzi w LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania syntezy odpowiedzi LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelAnswerSynthesis

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseModelQueryPlanningActivityRecord

Reprezentuje rekord działania planowania zapytań LLM.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla działania planowania zapytań LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do planowania zapytań LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania planowania zapytań LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelQueryPlanning

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseModelWebSummarizationActivityRecord

Reprezentuje rekord aktywności streszczającej LLM w sieci.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

inputTokens

integer (int32)

Liczba tokenów wejściowych dla aktywności podsumowania stron LLM.

model

KnowledgeBaseActivityRecordModel

Model używany do działania podsumowania stron internetowych LLM.

outputTokens

integer (int32)

Liczba tokenów wyjściowych dla działania podsumowania stron LLM.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

modelWebSummarization

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla aktywności pobierania.

Nazwa Typ Opis
generatedBoost

string

Klauzula wyszukiwania wygenerowana przez boost podpowiedzi dla tej aktywności.

generatedFilter

string

Wyrażenie filtra generowane przez filtr podpowiedzi dla tej aktywności.

KnowledgeBaseReferenceType

Typ odwołania.

Wartość Opis
searchIndex

Wyszukaj indeks dokumentów referencyjnych.

azureBlob

Azure Blob document reference.

indexedSharePoint

Indeksowane odniesienie dokumentów SharePoint.

indexedOneLake

Indeksowany dokument OneLake.

web

Odniesienie do dokumentu internetowego.

remoteSharePoint

Zdalne odwołanie do dokumentu SharePoint.

workIQ

Referencja do dokumentu o IQ pracy.

fabricDataAgent

Referencja dokumentu Fabric Data Agent.

fabricOntology

Referencja do dokumentu Fabric Ontology.

mcpServer

Referencja do dokumentu serwera MCP.

file

Referencje do dokumentu.

indexedSql

Indeksowane odniesienie do dokumentu SQL.

KnowledgeBaseRemoteSharePointActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność zdalnego pobierania SharePoint.

Nazwa Typ Opis
filterExpressionAddOn

string

Dodatek wyrażeń filtracyjnych dla aktywności wyszukiwania.

search

string

Ciąg wyszukiwania używany do zapytania do zdalnego źródła wiedzy SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Reprezentuje zdalny rekord aktywności pobierania SharePoint.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

remoteSharePointArguments

KnowledgeBaseRemoteSharePointActivityArguments

Argumenty zdalnego SharePoint za aktywnością pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

remoteSharePoint

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseRemoteSharePointReference

Reprezentuje zdalne odniesienie do dokumentu programu SharePoint.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

remoteSharePoint

Typ odwołania.

webUrl

string (uri)

Adres URL, z którego pochodzą dane referencyjne.

KnowledgeBaseRetrievalRequest

Kontrakt wejściowy dla żądania pobrania.

Nazwa Typ Opis
includeActivity

boolean

Wskazuje, że wyniki pobierania powinny zawierać informacje o aktywności.

intents KnowledgeRetrievalIntent[]:

KnowledgeRetrievalSemanticIntent[]

Lista zamierzonych zapytań, które mają być wykonywane bez planowania zapytań modelu.

knowledgeSourceParams KnowledgeSourceParams[]:

Lista parametrów środowiska uruchomieniowego dla źródeł wiedzy.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów w wydruku.

maxOutputSize

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxOutputSizeInTokens

integer (int32)

Ogranicza maksymalny rozmiar zawartości w danych wyjściowych.

maxRuntimeInSeconds

integer (int32)

Maksymalny czas pracy w sekundach.

messages

KnowledgeBaseMessage[]

Lista danych wejściowych stylu wiadomości czatu.

outputMode

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfiguracja wysiłku rozumowania wyszukiwania.

KnowledgeBaseRetrievalResponse

Kontrakt wyjściowy dla odpowiedzi pobierania.

Nazwa Typ Opis
activity KnowledgeBaseActivityRecord[]:

Rejestry aktywności do śledzenia postępów i implikacji rozliczeniowych.

references KnowledgeBaseReference[]:

Odwołania do danych wyszukiwania używanych w odpowiedzi.

response

KnowledgeBaseMessage[]

Wiadomości z odpowiedziami.

responseSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości dla całej odpowiedzi.

KnowledgeBaseSearchIndexActivityArguments

Reprezentuje argumenty, z którymi zostało uruchomione działanie pobierania indeksu wyszukiwania.

Nazwa Typ Opis
filter

string

Ciąg filtru.

queryType

QueryType

Składnia zapytań użyta do wykonania wyszukiwania. Podpowiedzi zapytań mogą sprawić, że zapytania semantyczne będą wykorzystywać pełną składnię zapytań.

search

string

Ciąg wyszukiwania używany do wykonywania zapytań dotyczących indeksu wyszukiwania.

searchFields

SearchIndexFieldReference[]

Jakie pola były przeszukiwane.

semanticConfigurationName

string

Jaka konfiguracja semantyczna została użyta z indeksu wyszukiwania.

sourceDataFields

SearchIndexFieldReference[]

Jakie pola zostały wybrane do wyszukiwania.

KnowledgeBaseSearchIndexActivityRecord

Reprezentuje rekord działania pobierania indeksu wyszukiwania.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Szczegóły dotyczące wyrażeń generowanych z podpowiedzi zapytań dla tej aktywności.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Argumenty indeksu wyszukiwania dla działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

searchIndex

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

KnowledgeBaseSearchIndexReference

Reprezentuje dokumentację usługi Azure Search.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

citationUrl

string (uri)

URL należący do wyszukiwania, który wskazuje na dokument podkładny dla tego źródła, używany jako cel cytowania.

docKey

string

Klucz dokumentu dla referencji.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

searchIndex

Typ odwołania.

KnowledgeBaseWebActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania sieci.

Nazwa Typ Opis
count

integer (int32)

Liczba wyników internetowych.

freshness

string

Świeżość do aktywności odzyskiwania.

language

string

Język do aktywności odzyskiwania.

market

string

Rynek aktywności odzyskiwania.

search

string

Ciąg wyszukiwania używany do zapytania w sieci.

KnowledgeBaseWebActivityRecord

Reprezentuje rekord aktywności wyszukiwania w sieci.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

web

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

webArguments

KnowledgeBaseWebActivityArguments

Argumenty internetowe za aktywnością wyszukiwania.

KnowledgeBaseWebReference

Reprezentuje odniesienie do dokumentu sieci Web.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

sourceData

Dane źródłowe do odniesienia.

title

string

Tytuł dokumentu internetowego.

type string:

web

Typ odwołania.

url

string (uri)

Adres URL, z którego pochodzą dane referencyjne.

KnowledgeBaseWorkIQActivityArguments

Reprezentuje argumenty, na których przeprowadzono aktywność wyszukiwania WorkIQ.

Nazwa Typ Opis
search

string

Ciąg wyszukiwania używany do zapytania do źródła wiedzy WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Reprezentuje rekord aktywności wyszukiwania WorkIQ.

Nazwa Typ Opis
completedAt

string (date-time)

Czas, w którym zakończyła się aktywność.

count

integer (int32)

Liczba odzyskanych dokumentów, które były wystarczająco istotne, aby przekroczyć próg przeszeregowania.

elapsedMs

integer (int32)

Czas, który upłynął w milisekundach dla działania pobierania.

error

KnowledgeBaseErrorDetail

Szczegółowy błąd wyjaśniający, dlaczego operacja nie powiodła się. Ta właściwość jest uwzględniana tylko wtedy, gdy działanie nie powiedzie się.

id

integer (int32)

Identyfikator rekordu działania.

imageServing

ImageServingStatistics

Statystyki dotyczące obsługi obrazów w tej aktywności wyszukiwania

knowledgeSourceName

string

Źródło wiedzy dla działania pobierania.

queryTime

string (date-time)

Czas zapytania dla tego działania pobierania.

startedAt

string (date-time)

Czas, w którym rozpoczęła się ta aktywność.

type string:

workIQ

Typ rekordu działania.

warning

string

Komunikat ostrzegawczy ujawniający potencjalne problemy konfiguracyjne zaobserwowane podczas aktywności, takie jak porzucone dokumenty z powodu progu punktowego, obcięcia limitu tokenów lub warunków limitu czasu.

workIQArguments

KnowledgeBaseWorkIQActivityArguments

Argumenty WorkIQ za aktywnością odzyskiwania.

KnowledgeBaseWorkIQReference

Reprezentuje referencję do dokumentu WorkIQ.

Nazwa Typ Opis
activitySource

integer (int32)

Identyfikator działania źródłowego dla odwołania.

id

string

Identyfikator odwołania.

rerankerScore

number (float)

Wynik rerankera dla odwołania do dokumentu.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informacje o etykiecie czułości do odniesienia.

sourceData

Dane źródłowe do odniesienia.

type string:

workIQ

Typ odwołania.

KnowledgeRetrievalAutoReasoningEffort

Automatycznie wybierz wysiłek rozumowania podczas pobierania. Usługa zasiewa każde żądanie na najtańszym poziomie i eskaluje tylko do poziomu potrzebnego, do maksymalnego dostępnego poziomu usługi.

Nazwa Typ Opis
kind string:

auto

Rodzaj wysiłku rozumowania.

KnowledgeRetrievalIntentType

Rodzaj konfiguracji bazy wiedzy, która ma być używana.

Wartość Opis
semantic

Intencja zapytania semantycznego języka naturalnego.

KnowledgeRetrievalLowReasoningEffort

Uruchamiaj pobieranie wiedzy przy niewielkim wysiłku związanym z rozumowaniem.

Nazwa Typ Opis
kind string:

low

Rodzaj wysiłku rozumowania.

KnowledgeRetrievalMediumReasoningEffort

Uruchamianie wyszukiwania wiedzy ze średnim wysiłkiem rozumowania.

Nazwa Typ Opis
kind string:

medium

Rodzaj wysiłku rozumowania.

KnowledgeRetrievalMinimalReasoningEffort

Uruchamiaj wyszukiwanie wiedzy przy minimalnym wysiłku związanym z rozumowaniem.

Nazwa Typ Opis
kind string:

minimal

Rodzaj wysiłku rozumowania.

KnowledgeRetrievalOutputMode

Konfiguracja wyjściowa dla tego pobierania.

Wartość Opis
extractiveData

Zwracanie danych ze źródeł wiedzy bezpośrednio bez generatywnych zmian.

answerSynthesis

Zsyntetyzuj odpowiedź dla ładunku odpowiedzi.

KnowledgeRetrievalReasoningEffortKind

Ilość wysiłku do użycia podczas pobierania.

Wartość Opis
minimal

Nie wykonuje żadnych wyborów źródłowych, planowania zapytań ani wyszukiwania iteracyjnego.

low

Używaj niskiego rozumowania podczas pobierania.

medium

Używaj umiarkowanej ilości rozumowania podczas pobierania.

auto

Automatycznie wybieraj wysiłek rozumowania podczas pobierania, eskalując od najtańszego poziomu tylko do potrzeby.

KnowledgeRetrievalSemanticIntent

Zamiar zapytania semantycznego.

Nazwa Typ Opis
search

string

Zapytanie semantyczne do wykonania

type string:

semantic

Typ intencji.

KnowledgeSourceKind

Rodzaj źródła wiedzy.

Wartość Opis
searchIndex

Źródło wiedzy, które odczytuje dane z indeksu wyszukiwania.

azureBlob

Źródło wiedzy, które odczytuje i pozyskuje dane z Azure Blob Storage do indeksu wyszukiwania.

indexedSharePoint

Źródło wiedzy odczytujące dane z indeksowanego SharePoint.

indexedOneLake

Źródło wiedzy odczytujące dane z indeksowanego OneLake.

indexedSql

Źródło wiedzy, które pobiera i przetwarza dane z Azure SQL Database lub SQL Managed Instance do indeksu wyszukiwania.

web

Źródło wiedzy, które odczytuje dane z internetu.

remoteSharePoint

Źródło wiedzy, które odczytuje dane ze zdalnego SharePoint.

workIQ

Źródło wiedzy, które odczytuje dane z IQ pracy

file

Źródło wiedzy wspierające bezpośredni przesyłanie i indeksowanie plików.

mcpServer

Źródło wiedzy wspierane przez serwer MCP (Model Context Protocol).

fabricDataAgent

Źródło wiedzy pobierające dane z agenta danych Fabric.

fabricOntology

Źródło wiedzy pozyskujące dane z ontologii ontologii Microsoft Fabric.

KnowledgeSourceResultsProcessing

Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane.

Wartość Opis
rerank

Wyniki z tego źródła wiedzy przechodzą przez proces rerankingu. Jest to zachowanie domyślne.

none

Wyniki tego źródła wiedzy omijają ponowne rankingi i zachowują ich pierwotny porządek.

McpServerKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy serwera MCP

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

mcpServer

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

PurviewSensitivityLabelInfo

Informacje o etykiecie wrażliwości zastosowanej do dokumentu

Nazwa Typ Opis
color

string

Kolor, który powinien być wyświetlany w interfejsie użytkownika dla etykiety, jeśli jest skonfigurowany.

displayName

string

Nazwa wyświetlana etykiety poufności.

isEncrypted

boolean

Wskazuje, czy etykieta poufności wymusza szyfrowanie.

priority

integer (int32)

Priorytet, w jakim etykieta czułości jest stosowana.

sensitivityLabelId

string

Identyfikator etykiety poufności.

toolTip

string

Etykietka narzędzia, która powinna być wyświetlana dla etykiety w interfejsie użytkownika.

QueryType

Określa składnię zapytania wyszukiwania. Wartość domyślna to "simple". Użyj wartości "pełna", jeśli zapytanie używa składni zapytania Lucene i "semantycznej", jeśli składnia zapytania nie jest potrzebna.

Wartość Opis
simple

Używa prostej składni zapytania do wyszukiwania. Wyszukiwany tekst jest interpretowany przy użyciu prostego języka zapytań, który zezwala na symbole, takie jak +, * i "". Zapytania są domyślnie oceniane we wszystkich polach z możliwością wyszukiwania, chyba że określono parametr searchFields.

full

Używa pełnej składni zapytania Lucene do wyszukiwania. Tekst wyszukiwania jest interpretowany przy użyciu języka zapytań Lucene, który umożliwia wyszukiwanie specyficzne dla pola i ważone, a także inne zaawansowane funkcje.

semantic

Najlepiej nadaje się do zapytań wyrażonych w języku naturalnym, a nie w słowach kluczowych. Zwiększa precyzję wyników wyszukiwania przez ponowne uszeregowanie najlepszych wyników wyszukiwania przy użyciu modelu klasyfikacji wytrenowanego w korpusie sieci Web.

RemoteSharePointKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla zdalnego źródła wiedzy programu SharePoint

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

filterExpressionAddOn

string

Warunek filtru zastosowany do źródła danych programu SharePoint. Musi być ona określona w składni języka zapytań słów kluczowych. Zostanie on połączony jako połączenie z wyrażeniem filtru określonym w definicji źródła wiedzy.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

remoteSharePoint

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

SearchIndexFieldReference

Referencja polowa dla indeksu wyszukiwania.

Nazwa Typ Opis
name

string

Nazwa pola.

SearchIndexKnowledgeSourceBoostKind

Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy.

Wartość Opis
fieldValue

Ulepszaj dokumenty na podstawie wartości pola.

multiWordExpression

Ulepszaj dokumenty oparte na wielowyrazowym wyrażeniu.

SearchIndexKnowledgeSourceFieldValueBoost

Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola.

Nazwa Typ Opis
boost

number (double)

Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0.

boostInstructions

string

Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost.

field

string

minLength: 1

Nazwa pola indeksu wyszukiwania.

fieldValues

string[]

Reprezentatywne wartości dla tej dziedziny.

kind string:

fieldValue

Taka wskazówka do boostu.

SearchIndexKnowledgeSourceFilterHint

Podpojka identyfikująca pole i reprezentatywne wartości, którą planista zapytań może wykorzystać podczas tworzenia filtra.

Nazwa Typ Opis
field

string

minLength: 1

Nazwa filtrowalnego pola indeksu wyszukiwania.

fieldValues

string[]

Reprezentatywne wartości dla tej dziedziny.

filterInstructions

string

Instrukcje w języku naturalnym, które wyjaśniają, kiedy i jak filtrować na polu.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu.

Nazwa Typ Opis
boost

number (double)

Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0.

boostInstructions

string

Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost.

fieldValues

string[]

Reprezentatywne wartości dla boostu.

kind string:

multiWordExpression

Taka wskazówka do boostu.

SearchIndexKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla źródła wiedzy indeksu wyszukiwania

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

filterAddOn

string

Warunek filtru zastosowany do indeksu (np. "State eq VA").

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

searchIndex

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i podstrzygań. Jeśli jest to określone, obiekt ten zastępuje pełny zestaw podpowiedzi zapytań skonfigurowanych w źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

SearchIndexKnowledgeSourceQueryHints

Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania.

Nazwa Typ Opis
boosts SearchIndexKnowledgeSourceBoost[]:

Wzmacniaj wskazówki, które identyfikują warunki, które planista zapytań może wykorzystać, aby wpłynąć na pozycję dokumentu.

filters

SearchIndexKnowledgeSourceFilterHint[]

Podpowiedzi filtrujące identyfikujące pola i reprezentatywne wartości, których planer zapytań może używać podczas tworzenia filtrów.

ServedImage

Opisuje pojedynczy obraz, który model wybrał do obsługi podczas aktywności pobierania.

Nazwa Typ Opis
imageId

string

Etykieta obrazu została wyodrębniona z dokumentu źródłowego przez Content Understanding enrichment. Odpowiada numeracji liczb w oryginalnym dokumencie.

imagePath

string

Relatywna ścieżka do obrazu w magazynie zasobów.

sizeBytes

integer (int64)

Rozmiar tego obrazu w bajtach przesłany do modelu.

WebKnowledgeSourceParams

Określa parametry środowiska uruchomieniowego dla internetowego źródła wiedzy

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

count

integer (int32)

Liczba wyników z sieci Web do zwrócenia.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

freshness

string

Świeżość wyników internetowych.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

web

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

language

string

Język wyników internetowych.

market

string

Wyniki rynku internetowego.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.

WorkIQKnowledgeSourceParams

Określa parametry wykonawcze dla źródła wiedzy WorkIQ

Nazwa Typ Opis
alwaysQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno pomijać wybór źródła i zawsze być odpytywane w czasie pobierania.

enableImageServing

boolean

Wskazuje, czy serwowanie obrazów powinno być włączone dla tego źródła wiedzy w momencie pobierania. Gdy jest to prawdziwe, obrazy wyodrębnione podczas pobierania są dostarczane do modeli kolejnych.

failOnError

boolean

Wskazuje, że całe żądanie pobierania powinno się nie powiedzieć, jeśli pobieranie z tego źródła wiedzy napotyka błąd. Wartość domyślna to fałsz.

includeReferenceSourceData

boolean

Wskazuje, czy odwołania powinny zawierać w swoim ładunku uporządkowane dane uzyskane podczas pobierania.

includeReferences

boolean

Wskazuje, czy odwołania powinny być uwzględniane dla danych pobranych z tego źródła.

kind string:

workIQ

Typ źródła wiedzy.

knowledgeSourceName

string

Nazwa indeksu, do którego mają zastosowanie parametry.

maxOutputDocuments

integer (int32)

Ogranicza maksymalną liczbę dokumentów zwróconych z tego źródła wiedzy.

neverQuerySource

boolean

Wskazuje, że to źródło wiedzy powinno być wyłączone z kandydatów żądania i nigdy nie zapytywane podczas pobierania. Wyłączenie jest lokalne na żądanie i nie modyfikuje członkostwa w bazie wiedzy. Nie można go łączyć z alwaysQuerySource na tym samym źródle wiedzy.

rerankerThreshold

number (float)

Próg rerankera, który muszą spełniać wszystkie pobrane dokumenty, aby mogły zostać uwzględnione w odpowiedzi.

resultsProcessing

KnowledgeSourceResultsProcessing

Nadpisuje zapisane wyniki źródła wiedzyPrzetwarzanie tylko dla tego wywołania pobierania. Po pominięciu wartości źródłowej zapisanej wiedzy ma zastosowanie.