Knowledge Retrieval - Retrieve

Layanan:: Search Service

Versi API:: 2025-11-01-preview

KnowledgeBase mengambil data yang relevan dari penyimpanan pendukung.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string (uri)	URL titik akhir layanan pencarian.
knowledgeBaseName	path	True	string	Nama basis pengetahuan.
api-version	query	True	string minLength: 1	Versi API yang digunakan untuk operasi ini.

Header Permintaan

Nama	Jenis	Deskripsi
Accept	Accept	Header Terima.
x-ms-query-source-authorization	string	Token yang mengidentifikasi pengguna tempat kueri sedang dijalankan. Token ini digunakan untuk menegakkan pembatasan keamanan pada dokumen.
x-ms-client-request-id	string (uuid)	Pengidentifikasi string yang buram dan unik secara global yang dihasilkan klien untuk permintaan tersebut.

Isi Permintaan

Nama	Jenis	Deskripsi
includeActivity	boolean	Menunjukkan hasil pengambilan harus menyertakan informasi aktivitas.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Daftar kueri yang dimaksudkan untuk dijalankan tanpa perencanaan kueri model.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Daftar parameter runtime untuk sumber pengetahuan.
maxOutputSize	integer (int32)	Membatasi ukuran maksimum konten dalam output.
maxRuntimeInSeconds	integer (int32)	Runtime maksimum dalam hitungan detik.
messages	KnowledgeBaseMessage[]	Daftar input gaya pesan obrolan.
outputMode	KnowledgeRetrievalOutputMode	Konfigurasi keluaran untuk pengambilan ini.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurasi upaya penalaran pengambilan.

Respons

Nama	Jenis	Deskripsi
200 OK	KnowledgeBaseRetrievalResponse	Respons pengambilan yang berhasil.
Other Status Codes	KnowledgeBaseRetrievalResponse	Respons pengambilan parsial.
Other Status Codes	ErrorResponse	Respons kesalahan tak terduga.

Keamanan

api-key

Jenis: apiKey
Dalam: header

OAuth2Auth

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama	Deskripsi
https://search.azure.com/.default

Contoh

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Permintaan sampel

HTTP

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



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

Respon sampel

Kode status:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Kode status:: 206

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

KnowledgeBaseRetrieveWithIntents

Permintaan sampel

HTTP

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



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

Respon sampel

Kode status:: 200

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Kode status:: 206

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

Definisi

Nama	Deskripsi
Accept	Header Terima.
AzureBlobKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan blob azure
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).
IndexedOneLakeKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan OneLake yang diindeks
IndexedSharePointKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan SharePoint yang diindeks
KnowledgeBaseActivityRecordType	Jenis catatan aktivitas.
KnowledgeBaseAgenticReasoningActivityRecord	Mewakili catatan aktivitas penalaran agen.
KnowledgeBaseAzureBlobActivityArguments	Mewakili argumen yang digunakan aktivitas pengambilan blob Azure.
KnowledgeBaseAzureBlobActivityRecord	Mewakili rekaman aktivitas pengambilan blob Azure.
KnowledgeBaseAzureBlobReference	Mewakili referensi dokumen Azure Blob Storage.
KnowledgeBaseErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
KnowledgeBaseErrorDetail	Detail kesalahan.
KnowledgeBaseImageContent	Konten gambar.
KnowledgeBaseIndexedOneLakeActivityArguments	Mewakili argumen yang dijalankan dengan aktivitas pengambilan OneLake yang diindeks.
KnowledgeBaseIndexedOneLakeActivityRecord	Mewakili rekaman aktivitas pengambilan OneLake yang diindeks.
KnowledgeBaseIndexedOneLakeReference	Mewakili referensi dokumen OneLake yang diindeks.
KnowledgeBaseIndexedSharePointActivityArguments	Mewakili argumen yang digunakan untuk aktivitas pengambilan SharePoint yang diindeks.
KnowledgeBaseIndexedSharePointActivityRecord	Mewakili rekaman aktivitas pengambilan SharePoint yang diindeks.
KnowledgeBaseIndexedSharePointReference	Mewakili referensi dokumen SharePoint yang diindeks.
KnowledgeBaseMessage	Objek gaya pesan bahasa alami.
KnowledgeBaseMessageContentType	Jenis konten pesan.
KnowledgeBaseMessageImageContent	Jenis pesan gambar.
KnowledgeBaseMessageTextContent	Jenis pesan teks.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Mewakili rekaman aktivitas sintesis jawaban LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Mewakili rekaman aktivitas perencanaan kueri LLM.
KnowledgeBaseReferenceType	Jenis referensi.
KnowledgeBaseRemoteSharePointActivityArguments	Mewakili argumen yang digunakan untuk aktivitas pengambilan SharePoint jarak jauh.
KnowledgeBaseRemoteSharePointActivityRecord	Mewakili rekaman aktivitas pengambilan SharePoint jarak jauh.
KnowledgeBaseRemoteSharePointReference	Mewakili referensi dokumen SharePoint jarak jauh.
KnowledgeBaseRetrievalRequest	Kontrak input untuk permintaan pengambilan.
KnowledgeBaseRetrievalResponse	Kontrak keluaran untuk respons pengambilan.
KnowledgeBaseSearchIndexActivityArguments	Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan indeks pencarian.
KnowledgeBaseSearchIndexActivityRecord	Mewakili rekaman aktivitas pengambilan indeks pencarian.
KnowledgeBaseSearchIndexReference	Mewakili referensi dokumen Azure Search.
KnowledgeBaseWebActivityArguments	Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan web.
KnowledgeBaseWebActivityRecord	Mewakili rekaman aktivitas pengambilan web.
KnowledgeBaseWebReference	Mewakili referensi dokumen web.
KnowledgeRetrievalIntentType	Jenis konfigurasi basis pengetahuan yang akan digunakan.
KnowledgeRetrievalLowReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran yang rendah.
KnowledgeRetrievalMediumReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran sedang.
KnowledgeRetrievalMinimalReasoningEffort	Jalankan pengambilan pengetahuan dengan upaya penalaran minimal.
KnowledgeRetrievalOutputMode	Konfigurasi keluaran untuk pengambilan ini.
KnowledgeRetrievalReasoningEffortKind	Jumlah upaya yang digunakan selama pengambilan.
KnowledgeRetrievalSemanticIntent	Intent kueri semantik.
KnowledgeSourceKind	Jenis sumber pengetahuan.
RemoteSharePointKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan SharePoint jarak jauh
SearchIndexFieldReference	Referensi bidang untuk indeks pencarian.
SearchIndexKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan indeks pencarian
SharePointSensitivityLabelInfo	Informasi tentang label sensitivitas yang diterapkan ke dokumen SharePoint.
WebKnowledgeSourceParams	Menentukan parameter runtime untuk sumber pengetahuan web

Accept

Enumerasi

Header Terima.

Nilai	Deskripsi
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan blob azure

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: azureBlob	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan umum untuk semua API Azure Resource Manager untuk mengembalikan detail kesalahan untuk operasi yang gagal. (Ini juga mengikuti format respons kesalahan OData.).

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

IndexedOneLakeKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan OneLake yang diindeks

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: indexedOneLake	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

IndexedSharePointKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan SharePoint yang diindeks

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: indexedSharePoint	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

KnowledgeBaseActivityRecordType

Enumerasi

Jenis catatan aktivitas.

Nilai	Deskripsi
searchIndex	Aktivitas pengambilan indeks pencarian.
azureBlob	Aktivitas pengambilan Azure Blob.
indexedSharePoint	Aktivitas pengambilan SharePoint yang diindeks.
indexedOneLake	Aktivitas pengambilan OneLake yang diindeks.
web	Aktivitas pengambilan web.
remoteSharePoint	Aktivitas pengambilan SharePoint jarak jauh.
modelQueryPlanning	Aktivitas perencanaan kueri LLM.
modelAnswerSynthesis	Aktivitas sintesis jawaban LLM.
agenticReasoning	Aktivitas penalaran agen.

KnowledgeBaseAgenticReasoningActivityRecord

Objek

Mewakili catatan aktivitas penalaran agen.

Nama	Jenis	Deskripsi
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
reasoningTokens	integer (int32)	Jumlah token input untuk penalaran agen.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurasi upaya penalaran pengambilan.
type	string: agenticReasoning	Jenis rekaman aktivitas.

KnowledgeBaseAzureBlobActivityArguments

Objek

Mewakili argumen yang digunakan aktivitas pengambilan blob Azure.

Nama	Jenis	Deskripsi
search	string	String pencarian yang digunakan untuk mengkueri konten blob.

KnowledgeBaseAzureBlobActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan blob Azure.

Nama	Jenis	Deskripsi
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Argumen blob azure untuk aktivitas pengambilan.
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
type	string: azureBlob	Jenis rekaman aktivitas.

KnowledgeBaseAzureBlobReference

Objek

Mewakili referensi dokumen Azure Blob Storage.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
blobUrl	string	URL blob untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
sourceData		Data sumber untuk referensi.
type	string: azureBlob	Jenis referensi.

KnowledgeBaseErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info		Info tambahan.
type	string	Jenis info tambahan.

KnowledgeBaseErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	KnowledgeBaseErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

KnowledgeBaseImageContent

Objek

Konten gambar.

Nama	Jenis	Deskripsi
url	string (uri)	Url gambar.

KnowledgeBaseIndexedOneLakeActivityArguments

Objek

Mewakili argumen yang dijalankan dengan aktivitas pengambilan OneLake yang diindeks.

Nama	Jenis	Deskripsi
search	string	String pencarian yang digunakan untuk mengkueri konten OneLake yang diindeks.

KnowledgeBaseIndexedOneLakeActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan OneLake yang diindeks.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Argumen OneLake yang diindeks untuk aktivitas pengambilan.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
type	string: indexedOneLake	Jenis rekaman aktivitas.

KnowledgeBaseIndexedOneLakeReference

Objek

Mewakili referensi dokumen OneLake yang diindeks.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
docUrl	string	URL dokumen untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
sourceData		Data sumber untuk referensi.
type	string: indexedOneLake	Jenis referensi.

KnowledgeBaseIndexedSharePointActivityArguments

Objek

Mewakili argumen yang digunakan untuk aktivitas pengambilan SharePoint yang diindeks.

Nama	Jenis	Deskripsi
search	string	String pencarian yang digunakan untuk mengkueri konten SharePoint yang diindeks.

KnowledgeBaseIndexedSharePointActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan SharePoint yang diindeks.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Argumen SharePoint yang diindeks untuk aktivitas pengambilan.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
type	string: indexedSharePoint	Jenis rekaman aktivitas.

KnowledgeBaseIndexedSharePointReference

Objek

Mewakili referensi dokumen SharePoint yang diindeks.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
docUrl	string	URL dokumen untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
sourceData		Data sumber untuk referensi.
type	string: indexedSharePoint	Jenis referensi.

KnowledgeBaseMessage

Objek

Objek gaya pesan bahasa alami.

Nama	Jenis	Deskripsi
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Isi pesan.
role	string	Peran respons alat.

KnowledgeBaseMessageContentType

Enumerasi

Jenis konten pesan.

Nilai	Deskripsi
text	Jenis konten pesan teks.
image	Jenis konten pesan gambar.

KnowledgeBaseMessageImageContent

Objek

Jenis pesan gambar.

Nama	Jenis	Deskripsi
image	KnowledgeBaseImageContent	Konten gambar.
type	string: image	Jenis pesan

KnowledgeBaseMessageTextContent

Objek

Jenis pesan teks.

Nama	Jenis	Deskripsi
text	string	Isi teks.
type	string: text	Jenis pesan

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objek

Mewakili rekaman aktivitas sintesis jawaban LLM.

Nama	Jenis	Deskripsi
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
inputTokens	integer (int32)	Jumlah token input untuk aktivitas sintesis jawaban LLM.
outputTokens	integer (int32)	Jumlah token keluaran untuk aktivitas sintesis jawaban LLM.
type	string: modelAnswerSynthesis	Jenis rekaman aktivitas.

KnowledgeBaseModelQueryPlanningActivityRecord

Objek

Mewakili rekaman aktivitas perencanaan kueri LLM.

Nama	Jenis	Deskripsi
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
inputTokens	integer (int32)	Jumlah token input untuk aktivitas perencanaan kueri LLM.
outputTokens	integer (int32)	Jumlah token output untuk aktivitas perencanaan kueri LLM.
type	string: modelQueryPlanning	Jenis rekaman aktivitas.

KnowledgeBaseReferenceType

Enumerasi

Jenis referensi.

Nilai	Deskripsi
searchIndex	Cari referensi dokumen indeks.
azureBlob	Referensi dokumen Azure Blob.
indexedSharePoint	Referensi dokumen SharePoint yang diindeks.
indexedOneLake	Referensi dokumen OneLake yang diindeks.
web	Referensi dokumen web.
remoteSharePoint	Referensi dokumen SharePoint jarak jauh.

KnowledgeBaseRemoteSharePointActivityArguments

Objek

Mewakili argumen yang digunakan untuk aktivitas pengambilan SharePoint jarak jauh.

Nama	Jenis	Deskripsi
filterExpressionAddOn	string	Add-on ekspresi filter untuk aktivitas pengambilan.
search	string	String pencarian yang digunakan untuk mengkueri sumber pengetahuan SharePoint jarak jauh.

KnowledgeBaseRemoteSharePointActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan SharePoint jarak jauh.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Argumen SharePoint jarak jauh untuk aktivitas pengambilan.
type	string: remoteSharePoint	Jenis rekaman aktivitas.

KnowledgeBaseRemoteSharePointReference

Objek

Mewakili referensi dokumen SharePoint jarak jauh.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
searchSensitivityLabelInfo	SharePointSensitivityLabelInfo	Informasi tentang label sensitivitas yang diterapkan ke dokumen SharePoint.
sourceData		Data sumber untuk referensi.
type	string: remoteSharePoint	Jenis referensi.
webUrl	string (uri)	URL asal data referensi.

KnowledgeBaseRetrievalRequest

Objek

Kontrak input untuk permintaan pengambilan.

Nama	Jenis	Deskripsi
includeActivity	boolean	Menunjukkan hasil pengambilan harus menyertakan informasi aktivitas.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Daftar kueri yang dimaksudkan untuk dijalankan tanpa perencanaan kueri model.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Daftar parameter runtime untuk sumber pengetahuan.
maxOutputSize	integer (int32)	Membatasi ukuran maksimum konten dalam output.
maxRuntimeInSeconds	integer (int32)	Runtime maksimum dalam hitungan detik.
messages	KnowledgeBaseMessage[]	Daftar input gaya pesan obrolan.
outputMode	KnowledgeRetrievalOutputMode	Konfigurasi keluaran untuk pengambilan ini.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Konfigurasi upaya penalaran pengambilan.

KnowledgeBaseRetrievalResponse

Objek

Kontrak keluaran untuk respons pengambilan.

Nama	Jenis	Deskripsi
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Catatan aktivitas untuk melacak kemajuan dan implikasi penagihan.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Referensi untuk data pengambilan yang digunakan dalam respons.
response	KnowledgeBaseMessage[]	Pesan tanggapan.

KnowledgeBaseSearchIndexActivityArguments

Objek

Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan indeks pencarian.

Nama	Jenis	Deskripsi
filter	string	String filter.
search	string	String pencarian yang digunakan untuk mengkueri indeks pencarian.
searchFields	SearchIndexFieldReference[]	Bidang apa yang dicari.
semanticConfigurationName	string	Konfigurasi semantik apa yang digunakan dari indeks pencarian.
sourceDataFields	SearchIndexFieldReference[]	Bidang apa yang dipilih untuk pencarian.

KnowledgeBaseSearchIndexActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan indeks pencarian.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Argumen indeks pencarian untuk aktivitas pengambilan.
type	string: searchIndex	Jenis rekaman aktivitas.

KnowledgeBaseSearchIndexReference

Objek

Mewakili referensi dokumen Azure Search.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
docKey	string	Kunci dokumen untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
sourceData		Data sumber untuk referensi.
type	string: searchIndex	Jenis referensi.

KnowledgeBaseWebActivityArguments

Objek

Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan web.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah hasil web yang ditampilkan.
freshness	string	Kesegaran untuk aktivitas pengambilan.
language	string	Bahasa untuk aktivitas pengambilan.
market	string	Pasar untuk aktivitas pengambilan.
search	string	String pencarian yang digunakan untuk mengkueri web.

KnowledgeBaseWebActivityRecord

Objek

Mewakili rekaman aktivitas pengambilan web.

Nama	Jenis	Deskripsi
count	integer (int32)	Jumlah dokumen yang diambil yang cukup relevan untuk melewati ambang batas reranker.
elapsedMs	integer (int32)	Waktu yang berlalu dalam milidetik untuk aktivitas pengambilan.
error	KnowledgeBaseErrorDetail	Detail kesalahan yang menjelaskan mengapa operasi gagal. Properti ini hanya disertakan jika aktivitas tidak berhasil.
id	integer (int32)	ID rekaman aktivitas.
knowledgeSourceName	string	Sumber pengetahuan untuk aktivitas pengambilan.
queryTime	string (date-time)	Waktu kueri untuk aktivitas pengambilan ini.
type	string: web	Jenis rekaman aktivitas.
webArguments	KnowledgeBaseWebActivityArguments	Argumen web untuk aktivitas pengambilan.

KnowledgeBaseWebReference

Objek

Mewakili referensi dokumen web.

Nama	Jenis	Deskripsi
activitySource	integer (int32)	ID aktivitas sumber untuk referensi.
id	string	ID referensi.
rerankerScore	number (float)	Skor reranker untuk referensi dokumen.
sourceData		Data sumber untuk referensi.
title	string	Judul dokumen web.
type	string: web	Jenis referensi.
url	string (uri)	URL asal data referensi.

KnowledgeRetrievalIntentType

Enumerasi

Jenis konfigurasi basis pengetahuan yang akan digunakan.

Nilai	Deskripsi
semantic	Maksud kueri semantik bahasa alami.

KnowledgeRetrievalLowReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran yang rendah.

Nama	Jenis	Deskripsi
kind	string: low	Jenis upaya penalaran.

KnowledgeRetrievalMediumReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran sedang.

Nama	Jenis	Deskripsi
kind	string: medium	Jenis upaya penalaran.

KnowledgeRetrievalMinimalReasoningEffort

Objek

Jalankan pengambilan pengetahuan dengan upaya penalaran minimal.

Nama	Jenis	Deskripsi
kind	string: minimal	Jenis upaya penalaran.

KnowledgeRetrievalOutputMode

Enumerasi

Konfigurasi keluaran untuk pengambilan ini.

Nilai	Deskripsi
extractiveData	Mengembalikan data dari sumber pengetahuan secara langsung tanpa perubahan generatif.
answerSynthesis	Mensintesis jawaban untuk payload respons.

KnowledgeRetrievalReasoningEffortKind

Enumerasi

Jumlah upaya yang digunakan selama pengambilan.

Nilai	Deskripsi
minimal	Tidak melakukan pemilihan sumber, perencanaan kueri, atau pencarian berulang.
low	Gunakan penalaran rendah selama pengambilan.
medium	Gunakan penalaran dalam jumlah sedang selama pengambilan.

KnowledgeRetrievalSemanticIntent

Objek

Intent kueri semantik.

Nama	Jenis	Deskripsi
search	string	Kueri semantik yang akan dieksekusi
type	string: semantic	Jenis niat.

KnowledgeSourceKind

Enumerasi

Jenis sumber pengetahuan.

Nilai	Deskripsi
searchIndex	Sumber pengetahuan yang membaca data dari Indeks Pencarian.
azureBlob	Sumber pengetahuan yang membaca dan menyerap data dari Azure Blob Storage ke Indeks Pencarian.
indexedSharePoint	Sumber pengetahuan yang membaca data dari SharePoint yang diindeks.
indexedOneLake	Sumber pengetahuan yang membaca data dari OneLake yang diindeks.
web	Sumber pengetahuan yang membaca data dari web.
remoteSharePoint	Sumber pengetahuan yang membaca data dari SharePoint jarak jauh.

RemoteSharePointKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan SharePoint jarak jauh

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
filterExpressionAddOn	string	Kondisi filter yang diterapkan ke sumber data SharePoint. Ini harus ditentukan dalam sintaks Bahasa Kueri Kata Kunci. Ini akan digabungkan sebagai konjungsi dengan ekspresi filter yang ditentukan dalam definisi sumber pengetahuan.
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: remoteSharePoint	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

SearchIndexFieldReference

Objek

Referensi bidang untuk indeks pencarian.

Nama	Jenis	Deskripsi
name	string	Nama bidang.

SearchIndexKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan indeks pencarian

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
filterAddOn	string	Kondisi filter yang diterapkan ke indeks (misalnya, 'State eq VA').
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: searchIndex	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

SharePointSensitivityLabelInfo

Objek

Informasi tentang label sensitivitas yang diterapkan ke dokumen SharePoint.

Nama	Jenis	Deskripsi
color	string	Warna yang harus ditampilkan UI untuk label, jika dikonfigurasi.
displayName	string	Nama tampilan untuk label sensitivitas.
isEncrypted	boolean	Menunjukkan apakah label sensitivitas menerapkan enkripsi.
priority	integer (int32)	Prioritas di mana label sensitivitas diterapkan.
sensitivityLabelId	string	ID label sensitivitas.
tooltip	string	Tooltip yang harus ditampilkan untuk label di UI.

WebKnowledgeSourceParams

Objek

Menentukan parameter runtime untuk sumber pengetahuan web

Nama	Jenis	Deskripsi
alwaysQuerySource	boolean	Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.
count	integer (int32)	Jumlah hasil web yang akan ditampilkan.
freshness	string	Kesegaran hasil web.
includeReferenceSourceData	boolean	Menunjukkan apakah referensi harus menyertakan data terstruktur yang diperoleh selama pengambilan dalam payload mereka.
includeReferences	boolean	Menunjukkan apakah referensi harus disertakan untuk data yang diambil dari sumber ini.
kind	string: web	Jenis sumber pengetahuan.
knowledgeSourceName	string	Nama indeks yang diterapkan param.
language	string	Bahasa hasil web.
market	string	Pasar hasil web.
rerankerThreshold	number (float)	Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.