Knowledge Retrieval - Retrieve

KnowledgeBase mengambil data yang relevan dari penyimpanan pendukung.

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

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
path True

string (uri)

URL titik akhir layanan pencarian.

knowledgeBaseName
path True

string

Nama pangkalan pengetahuan.

api-version
query True

string

minLength: 1

Versi API yang akan digunakan untuk operasi ini.

Header Permintaan

Nama Diperlukan 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-query-work-iq-source-authorization

string (password)

Token pernyataan pengguna untuk pendaftaran aplikasi Entra milik pelanggan yang dikonfigurasi pada sumber pengetahuan Work IQ. Digunakan untuk autentikasi atas nama ke API Work IQ.

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[]:

Daftar parameter runtime untuk sumber pengetahuan.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen dalam output.

maxOutputSize

integer (int32)

Membatasi ukuran maksimum konten dalam output.

maxOutputSizeInTokens

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:

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

KnowledgeBaseRetrieve

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Permintaan sampel

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

Respon sampel

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

Definisi

Nama Deskripsi
Accept

Header Terima.

AzureBlobKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan blob azure

ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan 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.).

FabricDataAgentKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan Fabric Data Agent

FabricOntologyKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan Fabric Ontology

FileKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan File

ImageServingStatistics

Statistik tentang penayangan gambar selama aktivitas pengambilan.

IndexedOneLakeKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan OneLake yang diindeks

IndexedSharePointKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan SharePoint yang diindeks

IndexedSqlKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan SQL yang diindeks

KnowledgeBaseActivityRecordModel

Mewakili model yang digunakan untuk aktivitas LLM basis pengetahuan, termasuk nama model dan pengenal penerapannya.

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

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

KnowledgeBaseErrorDetail

Rincian kesalahan.

KnowledgeBaseFabricDataAgentActivityArguments

Mewakili argumen yang digunakan aktivitas pengambilan Agen Data Fabric.

KnowledgeBaseFabricDataAgentActivityRecord

Mewakili rekaman aktivitas pengambilan Fabric Data Agent.

KnowledgeBaseFabricDataAgentReference

Mewakili referensi dokumen Fabric Data Agent.

KnowledgeBaseFabricOntologyActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Mewakili rekaman aktivitas pengambilan Fabric Ontology.

KnowledgeBaseFabricOntologyReference

Mewakili referensi dokumen Fabric Ontology.

KnowledgeBaseFileActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan file.

KnowledgeBaseFileActivityRecord

Mewakili rekaman aktivitas pengambilan file.

KnowledgeBaseFileReference

Mewakili referensi dokumen file.

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.

KnowledgeBaseIndexedSqlActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan SQL yang diindeks.

KnowledgeBaseIndexedSqlActivityRecord

Mewakili rekaman aktivitas pengambilan SQL yang diindeks.

KnowledgeBaseIndexedSqlReference

Mewakili referensi dokumen Azure SQL.

KnowledgeBaseMcpServerActivityArguments

Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan server MCP.

KnowledgeBaseMcpServerActivityRecord

Mewakili rekaman aktivitas pengambilan server MCP.

KnowledgeBaseMcpServerReference

Mewakili referensi dokumen server MCP.

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.

KnowledgeBaseModelWebSummarizationActivityRecord

Mewakili rekaman aktivitas ringkasan web LLM.

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas pengambilan.

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.

KnowledgeBaseWorkIQActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Mewakili catatan aktivitas pengambilan WorkIQ.

KnowledgeBaseWorkIQReference

Mewakili referensi dokumen WorkIQ.

KnowledgeRetrievalAutoReasoningEffort

Secara otomatis memilih upaya penalaran saat pengambilan. Layanan ini menanamkan setiap permintaan pada tingkat termurah dan hanya meningkat sejauh yang diperlukan, hingga tingkat maksimum yang tersedia dalam layanan.

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.

KnowledgeSourceResultsProcessing

Mengontrol apakah hasil sumber pengetahuan diurutkan ulang.

McpServerKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan server MCP

PurviewSensitivityLabelInfo

Informasi tentang label sensitivitas yang diterapkan pada dokumen

QueryType

Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene dan 'semantik' jika sintaks kueri tidak diperlukan.

RemoteSharePointKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan SharePoint jarak jauh

SearchIndexFieldReference

Referensi bidang untuk indeks pencarian.

SearchIndexKnowledgeSourceBoostKind

Tipe tips boost untuk sumber pengetahuan indeks pencarian.

SearchIndexKnowledgeSourceFieldValueBoost

Petunjuk yang meningkatkan dokumen berdasarkan nilai bidang.

SearchIndexKnowledgeSourceFilterHint

Petunjuk yang mengidentifikasi bidang dan nilai representatif yang dapat digunakan perencana kueri saat membangun filter.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Petunjuk yang meningkatkan dokumen berdasarkan ekspresi multi-kata.

SearchIndexKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan indeks pencarian

SearchIndexKnowledgeSourceQueryHints

Petunjuk yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna untuk sumber pengetahuan indeks pencarian.

ServedImage

Menjelaskan satu gambar yang dipilih model untuk disajikan selama aktivitas pengambilan.

WebKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan web

WorkIQKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan WorkIQ

Accept

Header Terima.

Nilai Deskripsi
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

ErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama Jenis Deskripsi
info

Info tambahan.

type

string

Jenis informasi tambahan.

ErrorDetail

Detail kesalahan.

Nama Jenis Deskripsi
additionalInfo

ErrorAdditionalInfo[]

Informasi tambahan tentang kesalahan.

code

string

Kode kesalahan.

details

ErrorDetail[]

Rincian kesalahan.

message

string

Pesan kesalahan.

target

string

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

Nama Jenis Deskripsi
error

ErrorDetail

Objek kesalahan.

FabricDataAgentKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan Fabric Data Agent

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

fabricDataAgent

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

FabricOntologyKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan Fabric Ontology

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

fabricOntology

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

FileKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan File

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

file

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

ImageServingStatistics

Statistik tentang penayangan gambar selama aktivitas pengambilan.

Nama Jenis Deskripsi
imagesRetrieved

integer (int32)

Jumlah gambar yang diambil dari penyimpanan aset.

imagesSentToModel

integer (int32)

Jumlah gambar yang dikirim ke model hilir.

servedImages

ServedImage[]

Set gambar yang dipilih model untuk disajikan ke model hilir untuk aktivitas pengambilan ini.

totalImageSizeBytes

integer (int64)

Ukuran total dalam byte gambar yang dikirim ke model.

verbalizationUsed

boolean

Menunjukkan apakah verbalisasi gambar digunakan alih-alih penayangan gambar langsung.

IndexedOneLakeKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

IndexedSharePointKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

IndexedSqlKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan SQL yang diindeks

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

indexedSql

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

KnowledgeBaseActivityRecordModel

Mewakili model yang digunakan untuk aktivitas LLM basis pengetahuan, termasuk nama model dan pengenal penerapannya.

Nama Jenis Deskripsi
deploymentId

string

Pengenal penerapan model yang digunakan untuk aktivitas tersebut.

modelName

string

Nama model yang digunakan untuk aktivitas tersebut.

KnowledgeBaseActivityRecordType

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.

workIQ

Aktivitas pengambilan WorkIQ.

fabricDataAgent

Aktivitas pengambilan Agen Data Fabric.

fabricOntology

Aktivitas pengambilan Fabric Ontology.

mcpServer

Aktivitas pengambilan server MCP.

file

Aktivitas pengambilan file.

indexedSql

Aktivitas pengambilan SQL yang diindeks.

modelQueryPlanning

Aktivitas perencanaan kueri LLM.

modelAnswerSynthesis

Aktivitas sintesis jawaban LLM.

modelWebSummarization

Aktivitas ringkasan web LLM.

agenticReasoning

Aktivitas penalaran agen.

KnowledgeBaseAgenticReasoningActivityRecord

Mewakili catatan aktivitas penalaran agen.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

logicalReasoningEffort KnowledgeRetrievalReasoningEffort:

Upaya penalaran logis yang diminta oleh pelanggan. Ini berbeda dari retrievalReasoningEffort, yang melaporkan upaya penalaran yang digunakan untuk penagihan.

reasoningTokens

integer (int32)

Jumlah token input untuk penalaran agen.

retrievalReasoningEffort KnowledgeRetrievalReasoningEffort:

Konfigurasi upaya penalaran pengambilan.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

agenticReasoning

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseAzureBlobActivityArguments

Mewakili argumen yang digunakan aktivitas pengambilan blob Azure.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri konten blob.

KnowledgeBaseAzureBlobActivityRecord

Mewakili rekaman aktivitas pengambilan blob Azure.

Nama Jenis Deskripsi
azureBlobArguments

KnowledgeBaseAzureBlobActivityArguments

Argumen blob azure untuk aktivitas pengambilan.

completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

azureBlob

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseAzureBlobReference

Mewakili referensi dokumen Azure Blob Storage.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

blobUrl

string

URL blob untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

azureBlob

Jenis referensi.

KnowledgeBaseErrorAdditionalInfo

Informasi tambahan tentang kesalahan pengelolaan sumber daya.

Nama Jenis Deskripsi
info

Info tambahan.

type

string

Jenis informasi tambahan.

KnowledgeBaseErrorDetail

Rincian kesalahan.

Nama Jenis Deskripsi
additionalInfo

KnowledgeBaseErrorAdditionalInfo[]

Informasi tambahan tentang kesalahan.

code

string

Kode kesalahan.

details

KnowledgeBaseErrorDetail[]

Rincian kesalahan.

message

string

Pesan kesalahan.

target

string

Sasaran kesalahan.

KnowledgeBaseFabricDataAgentActivityArguments

Mewakili argumen yang digunakan aktivitas pengambilan Agen Data Fabric.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri sumber pengetahuan Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Mewakili rekaman aktivitas pengambilan Fabric Data Agent.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

fabricDataAgentArguments

KnowledgeBaseFabricDataAgentActivityArguments

Argumen Fabric Data Agent untuk aktivitas pengambilan.

id

integer (int32)

ID rekaman aktivitas.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

fabricDataAgent

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseFabricDataAgentReference

Mewakili referensi dokumen Fabric Data Agent.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

dataAgentId

string

ID Agen Data Fabric.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

sourceData

Data sumber untuk referensi.

type string:

fabricDataAgent

Jenis referensi.

workspaceId

string

ID ruang kerja Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan Fabric Ontology.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri sumber pengetahuan Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Mewakili rekaman aktivitas pengambilan Fabric Ontology.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

fabricOntologyArguments

KnowledgeBaseFabricOntologyActivityArguments

Argumen Fabric Ontology untuk aktivitas pengambilan.

id

integer (int32)

ID rekaman aktivitas.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

fabricOntology

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseFabricOntologyReference

Mewakili referensi dokumen Fabric Ontology.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

id

string

ID referensi.

ontologyId

string

ID ontologi dalam ruang kerja.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

sourceData

Data sumber untuk referensi.

type string:

fabricOntology

Jenis referensi.

workspaceId

string

ID ruang kerja Fabric.

KnowledgeBaseFileActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan file.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri konten file.

KnowledgeBaseFileActivityRecord

Mewakili rekaman aktivitas pengambilan file.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

fileArguments

KnowledgeBaseFileActivityArguments

Argumen File untuk aktivitas pengambilan.

id

integer (int32)

ID rekaman aktivitas.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

file

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseFileReference

Mewakili referensi dokumen file.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

docName

string

Nama dokumen untuk referensi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

sourceData

Data sumber untuk referensi.

type string:

file

Jenis referensi.

KnowledgeBaseImageContent

Konten gambar.

Nama Jenis Deskripsi
url

string (uri)

Url gambar.

KnowledgeBaseIndexedOneLakeActivityArguments

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

Mewakili rekaman aktivitas pengambilan OneLake yang diindeks.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

indexedOneLakeArguments

KnowledgeBaseIndexedOneLakeActivityArguments

Argumen OneLake yang diindeks untuk aktivitas pengambilan.

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

indexedOneLake

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseIndexedOneLakeReference

Mewakili referensi dokumen OneLake yang diindeks.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

docUrl

string

URL dokumen untuk referensi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

indexedOneLake

Jenis referensi.

KnowledgeBaseIndexedSharePointActivityArguments

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

Mewakili rekaman aktivitas pengambilan SharePoint yang diindeks.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

indexedSharePointArguments

KnowledgeBaseIndexedSharePointActivityArguments

Argumen SharePoint yang diindeks untuk aktivitas pengambilan.

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

indexedSharePoint

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseIndexedSharePointReference

Mewakili referensi dokumen SharePoint yang diindeks.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

docUrl

string

URL dokumen untuk referensi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

indexedSharePoint

Jenis referensi.

KnowledgeBaseIndexedSqlActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan SQL yang diindeks.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri konten SQL yang diindeks.

KnowledgeBaseIndexedSqlActivityRecord

Mewakili rekaman aktivitas pengambilan SQL yang diindeks.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

indexedSqlArguments

KnowledgeBaseIndexedSqlActivityArguments

Argumen SQL yang diindeks untuk aktivitas pengambilan.

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

indexedSql

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseIndexedSqlReference

Mewakili referensi dokumen Azure SQL.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

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:

indexedSql

Jenis referensi.

KnowledgeBaseMcpServerActivityArguments

Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan server MCP.

Nama Jenis Deskripsi
toolArguments

Argumen diteruskan ke alat server MCP.

toolName

string

Nama alat server MCP yang digunakan untuk aktivitas pengambilan.

KnowledgeBaseMcpServerActivityRecord

Mewakili rekaman aktivitas pengambilan server MCP.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

mcpServerArguments

KnowledgeBaseMcpServerActivityArguments

Argumen server MCP untuk aktivitas pengambilan.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

mcpServer

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseMcpServerReference

Mewakili referensi dokumen server MCP.

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 hasil alat server MCP.

toolName

string

Nama alat server MCP yang menghasilkan referensi.

type string:

mcpServer

Jenis referensi.

KnowledgeBaseMessage

Objek gaya pesan bahasa alami.

Nama Jenis Deskripsi
content KnowledgeBaseMessageContent[]:

Isi pesan.

role

string

Peran respons alat.

KnowledgeBaseMessageContentType

Jenis konten pesan.

Nilai Deskripsi
text

Jenis konten pesan teks.

image

Jenis konten pesan gambar.

KnowledgeBaseMessageImageContent

Jenis pesan gambar.

Nama Jenis Deskripsi
image

KnowledgeBaseImageContent

Konten gambar.

type string:

image

Jenis pesan

KnowledgeBaseMessageTextContent

Jenis pesan teks.

Nama Jenis Deskripsi
text

string

Isi teks.

type string:

text

Jenis pesan

KnowledgeBaseModelAnswerSynthesisActivityRecord

Mewakili rekaman aktivitas sintesis jawaban LLM.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

model

KnowledgeBaseActivityRecordModel

Model yang digunakan untuk aktivitas sintesis jawaban LLM.

outputTokens

integer (int32)

Jumlah token keluaran untuk aktivitas sintesis jawaban LLM.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

modelAnswerSynthesis

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseModelQueryPlanningActivityRecord

Mewakili rekaman aktivitas perencanaan kueri LLM.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

model

KnowledgeBaseActivityRecordModel

Model yang digunakan untuk aktivitas perencanaan kueri LLM.

outputTokens

integer (int32)

Jumlah token output untuk aktivitas perencanaan kueri LLM.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

modelQueryPlanning

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseModelWebSummarizationActivityRecord

Mewakili rekaman aktivitas ringkasan web LLM.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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 ringkasan web LLM.

model

KnowledgeBaseActivityRecordModel

Model yang digunakan untuk aktivitas ringkasan web LLM.

outputTokens

integer (int32)

Jumlah token output untuk aktivitas ringkasan web LLM.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

modelWebSummarization

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas pengambilan.

Nama Jenis Deskripsi
generatedBoost

string

Klausa pencarian yang dihasilkan dari petunjuk boost untuk aktivitas ini.

generatedFilter

string

Ekspresi filter yang dihasilkan dari petunjuk filter untuk aktivitas ini.

KnowledgeBaseReferenceType

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.

workIQ

Referensi dokumen IQ kerja.

fabricDataAgent

Referensi dokumen Fabric Data Agent.

fabricOntology

Referensi dokumen Fabric Ontology.

mcpServer

Referensi dokumen server MCP.

file

File referensi dokumen.

indexedSql

Referensi dokumen SQL yang diindeks.

KnowledgeBaseRemoteSharePointActivityArguments

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

Mewakili rekaman aktivitas pengambilan SharePoint jarak jauh.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

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.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

remoteSharePoint

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseRemoteSharePointReference

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

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

remoteSharePoint

Jenis referensi.

webUrl

string (uri)

URL asal data referensi.

KnowledgeBaseRetrievalRequest

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[]:

Daftar parameter runtime untuk sumber pengetahuan.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen dalam output.

maxOutputSize

integer (int32)

Membatasi ukuran maksimum konten dalam output.

maxOutputSizeInTokens

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:

Konfigurasi upaya penalaran pengambilan.

KnowledgeBaseRetrievalResponse

Kontrak keluaran untuk respons pengambilan.

Nama Jenis Deskripsi
activity KnowledgeBaseActivityRecord[]:

Catatan aktivitas untuk melacak kemajuan dan implikasi penagihan.

references KnowledgeBaseReference[]:

Referensi untuk data pengambilan yang digunakan dalam respons.

response

KnowledgeBaseMessage[]

Pesan tanggapan.

responseSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk respons keseluruhan.

KnowledgeBaseSearchIndexActivityArguments

Mewakili argumen yang digunakan untuk menjalankan aktivitas pengambilan indeks pencarian.

Nama Jenis Deskripsi
filter

string

String filter.

queryType

QueryType

Sintaks kueri yang digunakan untuk menjalankan pencarian. Petunjuk kueri dapat menyebabkan kueri semantik menggunakan sintaks kueri penuh.

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

Mewakili rekaman aktivitas pengambilan indeks pencarian.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryHintProcessing

KnowledgeBaseQueryHintProcessing

Detail tentang ekspresi yang dihasilkan dari petunjuk kueri untuk aktivitas ini.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Argumen indeks pencarian untuk aktivitas pengambilan.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

searchIndex

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

KnowledgeBaseSearchIndexReference

Mewakili referensi dokumen Azure Search.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

citationUrl

string (uri)

URL milik Pencarian yang menunjuk ke dokumen pendukung untuk referensi ini, dapat digunakan sebagai target sitasi.

docKey

string

Kunci dokumen untuk referensi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

searchIndex

Jenis referensi.

KnowledgeBaseWebActivityArguments

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

Mewakili rekaman aktivitas pengambilan web.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

web

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

webArguments

KnowledgeBaseWebActivityArguments

Argumen web untuk aktivitas pengambilan.

KnowledgeBaseWebReference

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.

KnowledgeBaseWorkIQActivityArguments

Mewakili argumen yang dijalankan dengan aktivitas pengambilan WorkIQ.

Nama Jenis Deskripsi
search

string

String pencarian yang digunakan untuk mengkueri sumber pengetahuan WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Mewakili catatan aktivitas pengambilan WorkIQ.

Nama Jenis Deskripsi
completedAt

string (date-time)

Waktu di mana aktivitas selesai.

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.

imageServing

ImageServingStatistics

Statistik tentang penayangan gambar untuk aktivitas pengambilan ini

knowledgeSourceName

string

Sumber pengetahuan untuk aktivitas pengambilan.

queryTime

string (date-time)

Waktu kueri untuk aktivitas pengambilan ini.

startedAt

string (date-time)

Waktu aktivitas dimulai.

type string:

workIQ

Jenis rekaman aktivitas.

warning

string

Pesan peringatan yang memunculkan potensi masalah konfigurasi yang diamati selama aktivitas, seperti dokumen terputus karena ambang batas skor, pemotongan batas token, atau kondisi batas waktu.

workIQArguments

KnowledgeBaseWorkIQActivityArguments

Argumen WorkIQ untuk aktivitas pengambilan.

KnowledgeBaseWorkIQReference

Mewakili referensi dokumen WorkIQ.

Nama Jenis Deskripsi
activitySource

integer (int32)

ID aktivitas sumber untuk referensi.

id

string

ID referensi.

rerankerScore

number (float)

Skor reranker untuk referensi dokumen.

searchSensitivityLabelInfo

PurviewSensitivityLabelInfo

Informasi label sensitivitas untuk referensi.

sourceData

Data sumber untuk referensi.

type string:

workIQ

Jenis referensi.

KnowledgeRetrievalAutoReasoningEffort

Secara otomatis memilih upaya penalaran saat pengambilan. Layanan ini menanamkan setiap permintaan pada tingkat termurah dan hanya meningkat sejauh yang diperlukan, hingga tingkat maksimum yang tersedia dalam layanan.

Nama Jenis Deskripsi
kind string:

auto

Jenis upaya penalaran.

KnowledgeRetrievalIntentType

Jenis konfigurasi basis pengetahuan yang akan digunakan.

Nilai Deskripsi
semantic

Maksud kueri semantik bahasa alami.

KnowledgeRetrievalLowReasoningEffort

Jalankan pengambilan pengetahuan dengan upaya penalaran yang rendah.

Nama Jenis Deskripsi
kind string:

low

Jenis upaya penalaran.

KnowledgeRetrievalMediumReasoningEffort

Jalankan pengambilan pengetahuan dengan upaya penalaran sedang.

Nama Jenis Deskripsi
kind string:

medium

Jenis upaya penalaran.

KnowledgeRetrievalMinimalReasoningEffort

Jalankan pengambilan pengetahuan dengan upaya penalaran minimal.

Nama Jenis Deskripsi
kind string:

minimal

Jenis upaya penalaran.

KnowledgeRetrievalOutputMode

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

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.

auto

Secara otomatis pilih usaha penalaran saat pengambilan, naik dari tingkat termurah hanya sejauh yang diperlukan.

KnowledgeRetrievalSemanticIntent

Intent kueri semantik.

Nama Jenis Deskripsi
search

string

Kueri semantik yang akan dieksekusi

type string:

semantic

Jenis niat.

KnowledgeSourceKind

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.

indexedSql

Sumber pengetahuan yang mengambil dan menyerap data dari Azure SQL Database atau SQL Managed Instance ke Indeks Pencarian.

web

Sumber pengetahuan yang membaca data dari web.

remoteSharePoint

Sumber pengetahuan yang membaca data dari SharePoint jarak jauh.

workIQ

Sumber pengetahuan yang membaca data dari IQ kerja

file

Sumber pengetahuan yang mendukung pengunggahan dan pengindeksan file langsung.

mcpServer

Sumber pengetahuan yang didukung oleh server MCP (Model Context Protocol).

fabricDataAgent

Sumber pengetahuan yang mengambil data dari Agen Data Fabric.

fabricOntology

Sumber pengetahuan yang mengambil data dari ontologi Microsoft Fabric Ontology.

KnowledgeSourceResultsProcessing

Mengontrol apakah hasil sumber pengetahuan diurutkan ulang.

Nilai Deskripsi
rerank

Hasil dari sumber pengetahuan ini akan melalui proses reranking. Ini adalah perilaku default.

none

Hasil dari sumber pengetahuan ini melewati reranking dan mempertahankan urutan dasarnya.

McpServerKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan server MCP

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

mcpServer

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

PurviewSensitivityLabelInfo

Informasi tentang label sensitivitas yang diterapkan pada dokumen

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.

QueryType

Menentukan sintaks kueri pencarian. Defaultnya adalah 'sederhana'. Gunakan 'full' jika kueri Anda menggunakan sintaks kueri Lucene dan 'semantik' jika sintaks kueri tidak diperlukan.

Nilai Deskripsi
simple

Menggunakan sintaks kueri sederhana untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri sederhana yang memungkinkan simbol seperti +, * dan "". Kueri dievaluasi di semua bidang yang dapat dicari secara default, kecuali parameter searchFields ditentukan.

full

Menggunakan sintaks kueri Lucene lengkap untuk pencarian. Teks pencarian ditafsirkan menggunakan bahasa kueri Lucene yang memungkinkan pencarian khusus bidang dan berbobot, serta fitur lanjutan lainnya.

semantic

Paling cocok untuk kueri yang diekspresikan dalam bahasa alami dibandingkan dengan kata kunci. Meningkatkan presisi hasil pencarian dengan memberi peringkat ulang hasil pencarian teratas menggunakan model peringkat yang dilatih pada korpus Web.

RemoteSharePointKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

SearchIndexFieldReference

Referensi bidang untuk indeks pencarian.

Nama Jenis Deskripsi
name

string

Nama bidang.

SearchIndexKnowledgeSourceBoostKind

Tipe tips boost untuk sumber pengetahuan indeks pencarian.

Nilai Deskripsi
fieldValue

Tingkatkan dokumen berdasarkan nilai bidang.

multiWordExpression

Tingkatkan dokumen berdasarkan ekspresi multi-kata.

SearchIndexKnowledgeSourceFieldValueBoost

Petunjuk yang meningkatkan dokumen berdasarkan nilai bidang.

Nama Jenis Deskripsi
boost

number (double)

Pengali untuk skor dokumen. Harus berupa angka positif yang tidak sama dengan 1,0.

boostInstructions

string

Instruksi dalam bahasa alami yang menjelaskan kapan dan bagaimana menerapkan boost.

field

string

minLength: 1

Nama bidang indeks pencarian.

fieldValues

string[]

Nilai representatif untuk bidang.

kind string:

fieldValue

Tipe petunjuk boost.

SearchIndexKnowledgeSourceFilterHint

Petunjuk yang mengidentifikasi bidang dan nilai representatif yang dapat digunakan perencana kueri saat membangun filter.

Nama Jenis Deskripsi
field

string

minLength: 1

Nama bidang indeks pencarian yang dapat difilter.

fieldValues

string[]

Nilai representatif untuk bidang.

filterInstructions

string

Instruksi bahasa alami yang menjelaskan kapan dan bagaimana menyaring di lapangan.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Petunjuk yang meningkatkan dokumen berdasarkan ekspresi multi-kata.

Nama Jenis Deskripsi
boost

number (double)

Pengali untuk skor dokumen. Harus berupa angka positif yang tidak sama dengan 1,0.

boostInstructions

string

Instruksi dalam bahasa alami yang menjelaskan kapan dan bagaimana menerapkan boost.

fieldValues

string[]

Nilai representatif untuk boost.

kind string:

multiWordExpression

Tipe petunjuk boost.

SearchIndexKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

queryHintOverrides

SearchIndexKnowledgeSourceQueryHints

Tips yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna. Jika ditentukan, objek ini menggantikan seluruh set petunjuk kueri yang dikonfigurasi pada sumber pengetahuan.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

SearchIndexKnowledgeSourceQueryHints

Petunjuk yang membimbing perencanaan kueri menuju filter dan peningkatan yang berguna untuk sumber pengetahuan indeks pencarian.

Nama Jenis Deskripsi
boosts SearchIndexKnowledgeSourceBoost[]:

Meningkatkan petunjuk yang mengidentifikasi kondisi yang dapat digunakan perencana kueri untuk memengaruhi peringkat dokumen.

filters

SearchIndexKnowledgeSourceFilterHint[]

Filter hint yang mengidentifikasi bidang dan nilai representatif yang dapat digunakan perencana kueri saat membangun filter.

ServedImage

Menjelaskan satu gambar yang dipilih model untuk disajikan selama aktivitas pengambilan.

Nama Jenis Deskripsi
imageId

string

Label gambar yang diekstrak dari dokumen sumber melalui Content Understanding enrichment. Sesuai dengan penomoran gambar dalam dokumen asli.

imagePath

string

Jalur relatif ke gambar di dalam asset store.

sizeBytes

integer (int64)

Ukuran dalam byte dari gambar ini saat dikirim ke model.

WebKnowledgeSourceParams

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.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.

WorkIQKnowledgeSourceParams

Menentukan parameter runtime untuk sumber pengetahuan WorkIQ

Nama Jenis Deskripsi
alwaysQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus melewati pemilihan sumber dan selalu dikueri pada waktu pengambilan.

enableImageServing

boolean

Menunjukkan apakah penayangan gambar harus diaktifkan untuk sumber pengetahuan ini pada waktu pengambilan. Jika benar, gambar yang diekstraksi selama penyerapan dikirimkan ke model hilir.

failOnError

boolean

Menunjukkan bahwa seluruh permintaan pengambilan akan gagal jika pengambilan dari sumber pengetahuan ini mengalami kesalahan. Secara default diatur ke false.

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:

workIQ

Jenis sumber pengetahuan.

knowledgeSourceName

string

Nama indeks yang diterapkan param.

maxOutputDocuments

integer (int32)

Membatasi jumlah maksimum dokumen yang dikembalikan dari sumber pengetahuan ini.

neverQuerySource

boolean

Menunjukkan bahwa sumber pengetahuan ini harus dikecualikan dari set kandidat permintaan dan tidak pernah dikueri saat waktu pengambilan. Pengecualian ini bersifat request-local dan tidak mengubah keanggotaan basis pengetahuan. Tidak dapat digabungkan dengan alwaysQuerySource pada sumber pengetahuan yang sama.

rerankerThreshold

number (float)

Ambang batas reranker yang harus dipenuhi semua dokumen yang diambil untuk disertakan dalam respons.

resultsProcessing

KnowledgeSourceResultsProcessing

Mengatasi hasil yang disimpan dari sumber pengetahuan Pemrosesan hanya untuk panggilan pengambilan ini. Jika dihilangkan, nilai sumber pengetahuan yang tersimpan berlaku.