Knowledge Sources - Create Or Update
Új tudásforrást hoz létre, vagy frissíti a tudásforrást, ha már létezik.
PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-08-01-previewURI-paraméterek
| Név | In | Kötelező | Típus | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
A keresési szolgáltatás végpontjának URL-címe. |
|
source
|
path | True |
string |
A tudásforrás neve. |
|
api-version
|
query | True |
string minLength: 1 |
A művelethez használni kívánt API-verzió. |
Kérelem fejléce
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
A kérés átlátszatlan, globálisan egyedi, ügyfél által generált sztringazonosítója. |
|
| Accept |
Az Elfogadás fejléce. |
||
| If-Match |
string |
Meghatározza a If-Match feltételt. A művelet csak akkor lesz végrehajtva, ha a kiszolgálón lévő ETag megegyezik ezzel az értékkel. |
|
| If-None-Match |
string |
Meghatározza az If-None-Match feltételt. A művelet csak akkor lesz végrehajtva, ha a kiszolgálón lévő ETag nem egyezik meg ezzel az értékkel. |
|
| Prefer | True |
HTTP PUT-kérések esetén arra utasítja a szolgáltatást, hogy sikeres esetben adja vissza a létrehozott/frissített erőforrást. |
Kérelem törzse
A kérelem törzse az alábbiak valamelyike lehet:
| Név | Description |
|---|---|
|
Azure |
Az Azure Blob Storage tudásforrás konfigurálása. |
|
Fabric |
Konfiguráció a Fabric Data Agent tudásforrásához. |
|
Fabric |
Konfiguráció a Fabric Ontology tudásforráshoz. |
|
File |
Fájltudásforrás konfigurációja, amely támogatja a közvetlen fájlfeltöltést és indexelést. |
|
Indexed |
A OneLake tudásforrás konfigurálása. |
|
Indexed |
A SharePoint tudásforrás konfigurálása. |
|
Indexed |
Konfiguráció indexelt SQL tudásforráshoz. |
|
Mcp |
Konfiguráció egy tudásforráshoz, amelyet egy MCP (Model Context Protocol) szerver támogat. |
|
Remote |
Távoli SharePoint-tudásforrás konfigurálása. |
|
Search |
Tudásforrás keresési indexet céloz meg. |
|
Web |
Tudásforrás webes eredmények megcélzása. |
|
Work |
A WorkIQ tudásforrás konfigurációja. |
AzureBlobKnowledgeSource
Az Azure Blob Storage tudásforrás konfigurálása.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| azureBlobParameters | True |
A tudásforrás típusa. |
|
| kind | True |
string:
azure |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FabricDataAgentKnowledgeSource
Konfiguráció a Fabric Data Agent tudásforrásához.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| fabricDataAgentParameters | True |
A Fabric Data Agent tudásforrásának paraméterei. |
|
| kind | True |
string:
fabric |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FabricOntologyKnowledgeSource
Konfiguráció a Fabric Ontology tudásforráshoz.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| fabricOntologyParameters | True |
A Fabric Ontology tudásforrás paraméterei. |
|
| kind | True |
string:
fabric |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FileKnowledgeSource
Fájltudásforrás konfigurációja, amely támogatja a közvetlen fájlfeltöltést és indexelést.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| fileParameters | True |
A fájl tudásforrás paraméterei. |
|
| kind | True |
string:
file |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| corsOptions |
Opciók a Cross-Origin Resource Sharing (CORS) vezérlésére a fájl tudásforrás fájlvégpontjain (feltöltés, listázás, frissítés, törlés). |
||
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedOneLakeKnowledgeSource
A OneLake tudásforrás konfigurálása.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| indexedOneLakeParameters | True |
A tudásforrás paraméterei. |
|
| kind | True |
string:
indexed |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedSharePointKnowledgeSource
A SharePoint tudásforrás konfigurálása.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| indexedSharePointParameters | True |
A tudásforrás paraméterei. |
|
| kind | True |
string:
indexed |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedSqlKnowledgeSource
Konfiguráció indexelt SQL tudásforráshoz.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| indexedSqlParameters | True |
Az SQL tudásforrás paraméterei. |
|
| kind | True |
string:
indexed |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
McpServerKnowledgeSource
Konfiguráció egy tudásforráshoz, amelyet egy MCP (Model Context Protocol) szerver támogat.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
mcp |
A tudásforrás típusa. |
| mcpServerParameters | True |
Az MCP szerver tudásforrásának paraméterei. |
|
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
RemoteSharePointKnowledgeSource
Távoli SharePoint-tudásforrás konfigurálása.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
remote |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| remoteSharePointParameters |
A távoli SharePoint tudásforrás paraméterei. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
SearchIndexKnowledgeSource
Tudásforrás keresési indexet céloz meg.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
search |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| searchIndexParameters | True |
A tudásforrás paraméterei. |
|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
WebKnowledgeSource
Tudásforrás webes eredmények megcélzása.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
web |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
||
| webParameters |
A webes tudásforrás paraméterei. |
WorkIQKnowledgeSource
A WorkIQ tudásforrás konfigurációja.
| Név | Kötelező | Típus | Description |
|---|---|---|---|
| kind | True |
string:
workIQ |
A tudásforrás típusa. |
| name | True |
string |
A tudásforrás neve. |
| workIQParameters | True |
A WorkIQ tudásforrás paraméterei, beleértve az ügyfél által tulajdonolt Entra alkalmazás konfigurációját, amelyet az on-a hitelesítéshez használnak. |
|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
|
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
||
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
Válaszok
| Név | Típus | Description |
|---|---|---|
| 200 OK |
KnowledgeSource:
|
A kérés sikeres volt. |
| 201 Created |
KnowledgeSource:
|
A kérés sikeres volt, és ennek eredményeként új erőforrás jött létre. |
| Other Status Codes |
Váratlan hibaválasz. |
Biztonság
api-key
Típus:
apiKey
In:
header
OAuth2Auth
Típus:
oauth2
Folyamat:
implicit
Engedélyezési URL:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Hatókörök
| Név | Description |
|---|---|
| https://search.azure.com/.default |
Példák
SearchServiceCreateOrUpdateKnowledgeSource
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the knowledge source.",
"kind": "searchIndex",
"resultsProcessing": "none",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "preview-test",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"resultsProcessing": "none",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "preview-test",
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"resultsProcessing": "none",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "preview-test",
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the knowledge source.",
"kind": "azureBlob",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"isADLSGen2": false,
"ingestionParameters": {
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"rbacScope"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
},
"networkAccessMode": "private"
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"isADLSGen2": false,
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"rbacScope"
],
"contentExtractionMode": "standard",
"networkAccessMode": "private",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
},
"createdResources": {
"datasource": "ks-preview-test-datasource",
"indexer": "ks-preview-test-indexer",
"skillset": "ks-preview-test-skillset",
"index": "ks-preview-test-index"
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"isADLSGen2": false,
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"rbacScope"
],
"contentExtractionMode": "standard",
"networkAccessMode": "private",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
},
"createdResources": {
"datasource": "ks-preview-test-datasource",
"indexer": "ks-preview-test-indexer",
"skillset": "ks-preview-test-skillset",
"index": "ks-preview-test-index"
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent
Mintakérelem
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-08-01-preview
{
"fabricDataAgentParameters": {
"workspaceId": "fakeWorkspaceId",
"dataAgentId": "fakeAgentId"
},
"name": "ks-fabric-agent-test",
"description": "Description of the Fabric Data Agent knowledge source.",
"kind": "fabricDataAgent",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-fabric-agent-test",
"kind": "fabricDataAgent",
"description": "Description of the Fabric Data Agent knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"fabricDataAgentParameters": {
"workspaceId": "fakeWorkspaceId",
"dataAgentId": "fakeAgentId"
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-fabric-agent-test",
"kind": "fabricDataAgent",
"description": "Description of the Fabric Data Agent knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"fabricDataAgentParameters": {
"workspaceId": "fakeWorkspaceId",
"dataAgentId": "fakeAgentId"
}
}SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology
Mintakérelem
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-08-01-preview
{
"fabricOntologyParameters": {
"workspaceId": "12345678-1234-1234-1234-123456789abc",
"ontologyId": "ontology-456"
},
"name": "ks-fabricontology-test",
"description": "Description of the Fabric Ontology knowledge source.",
"kind": "fabricOntology",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-fabricontology-test",
"kind": "fabricOntology",
"description": "Description of the Fabric Ontology knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"fabricOntologyParameters": {
"workspaceId": "12345678-1234-1234-1234-123456789abc",
"ontologyId": "ontology-456"
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-fabricontology-test",
"kind": "fabricOntology",
"description": "Description of the Fabric Ontology knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"fabricOntologyParameters": {
"workspaceId": "12345678-1234-1234-1234-123456789abc",
"ontologyId": "ontology-456"
}
}SearchServiceCreateOrUpdateKnowledgeSourceFile
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the File knowledge source.",
"kind": "file",
"fileParameters": {
"ingestionParameters": {
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "file",
"description": "Description of the File knowledge source.",
"fileParameters": {
"ingestionParameters": {
"contentExtractionMode": "standard",
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
},
"createdResources": {
"index": "ks-preview-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "file",
"description": "Description of the File knowledge source.",
"fileParameters": {
"ingestionParameters": {
"contentExtractionMode": "standard",
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
},
"createdResources": {
"index": "ks-preview-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the OneLake knowledge source.",
"kind": "indexedOneLake",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedOneLake",
"description": "Description of the OneLake knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"disableImageVerbalization": false,
"contentExtractionMode": "standard",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedOneLake",
"description": "Description of the OneLake knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"disableImageVerbalization": false,
"contentExtractionMode": "standard",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the SharePoint knowledge source.",
"kind": "indexedSharePoint",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSharePointParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "defaultSiteLibrary",
"query": "*.docx OR *.pdf",
"ingestionParameters": {
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"userIds",
"groupIds"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedSharePoint",
"description": "Description of the SharePoint knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSharePointParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "defaultSiteLibrary",
"query": "*.docx OR *.pdf",
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds"
],
"contentExtractionMode": "standard",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedSharePoint",
"description": "Description of the SharePoint knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSharePointParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "defaultSiteLibrary",
"query": "*.docx OR *.pdf",
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds"
],
"contentExtractionMode": "standard",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"assetStore": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "image-assets"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
},
"freshnessPolicy": {
"boostingDuration": "P90D"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the SQL knowledge source.",
"kind": "indexedSql",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSqlParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"tableOrView": "dbo.Products",
"contentColumns": [
{
"name": "title",
"sourceField": "Title",
"searchFieldType": "Edm.String"
},
{
"name": "description",
"sourceField": "Description",
"searchFieldType": "Edm.String"
},
{
"name": "price",
"sourceField": "Price",
"searchFieldType": "Edm.Double"
}
],
"embeddingColumns": [
{
"name": "descriptionEmbedding",
"sourceField": "Description"
}
],
"ingestionParameters": {
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"contentExtractionMode": "minimal"
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"boostInstructions": "Document language; pick from the user's locale.",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2
}
]
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedSql",
"description": "Description of the SQL knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSqlParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"tableOrView": "dbo.Products",
"contentColumns": [
{
"name": "title",
"sourceField": "Title",
"searchFieldType": "Edm.String"
},
{
"name": "description",
"sourceField": "Description",
"searchFieldType": "Edm.String"
},
{
"name": "price",
"sourceField": "Price",
"searchFieldType": "Edm.Double"
}
],
"embeddingColumns": [
{
"name": "descriptionEmbedding",
"sourceField": "Description"
}
],
"ingestionParameters": {
"contentExtractionMode": "minimal",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "indexedSql",
"description": "Description of the SQL knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedSqlParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"tableOrView": "dbo.Products",
"contentColumns": [
{
"name": "title",
"sourceField": "Title",
"searchFieldType": "Edm.String"
},
{
"name": "description",
"sourceField": "Description",
"searchFieldType": "Edm.String"
},
{
"name": "price",
"sourceField": "Price",
"searchFieldType": "Edm.Double"
}
],
"embeddingColumns": [
{
"name": "descriptionEmbedding",
"sourceField": "Description"
}
],
"ingestionParameters": {
"contentExtractionMode": "minimal",
"identity": {
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
"userAssignedIdentity": "/my/userassigned/id"
},
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
}
},
"queryHints": {
"filters": [
{
"field": "model",
"fieldValues": [
"Model-X100",
"Model-X200",
"Model-Pro"
],
"filterInstructions": "Product model name."
}
],
"boosts": [
{
"kind": "fieldValue",
"field": "language",
"fieldValues": [
"en",
"ja",
"fr",
"de"
],
"boost": 2,
"boostInstructions": "Document language; pick from the user's locale."
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceMcpServer
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the MCP server knowledge source.",
"kind": "mcpServer",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"mcpServerParameters": {
"serverURL": "https://mcp.contoso.com/sse",
"authentication": {
"kind": "foundryConnection",
"foundryConnectionParameters": {
"connectionId": "conn-123"
}
},
"tools": [
{
"name": "search-code",
"outputParsing": {
"kind": "json",
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
}
},
"resultsProcessing": "rerank",
"maxOutputTokens": 4096
}
]
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "mcpServer",
"description": "Description of the MCP server knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"mcpServerParameters": {
"serverURL": "https://mcp.contoso.com/sse",
"authentication": {
"kind": "foundryConnection",
"foundryConnectionParameters": {
"connectionId": "conn-123"
}
},
"tools": [
{
"name": "search-code",
"resultsProcessing": "rerank",
"maxOutputTokens": 4096,
"outputParsing": {
"kind": "json",
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
}
}
}
]
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "mcpServer",
"description": "Description of the MCP server knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"mcpServerParameters": {
"serverURL": "https://mcp.contoso.com/sse",
"authentication": {
"kind": "foundryConnection",
"foundryConnectionParameters": {
"connectionId": "conn-123"
}
},
"tools": [
{
"name": "search-code",
"resultsProcessing": "rerank",
"maxOutputTokens": 4096,
"outputParsing": {
"kind": "json",
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
}
}
}
]
}
}SearchServiceCreateOrUpdateKnowledgeSourceWeb
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"webParameters": {
"domains": {
"allowedDomains": [
{
"address": "example.com",
"includeSubpages": true
},
{
"address": "another-example.com"
}
],
"blockedDomains": [
{
"address": "blocked.com"
},
{
"address": "spam.com",
"includeSubpages": true
}
]
}
},
"name": "ks-preview-test",
"description": "Description of the knowledge source.",
"kind": "web",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "web",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"webParameters": {
"domains": {
"allowedDomains": [
{
"address": "example.com",
"includeSubpages": true
},
{
"address": "another-example.com"
}
],
"blockedDomains": [
{
"address": "blocked.com"
},
{
"address": "spam.com",
"includeSubpages": true
}
]
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "web",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"webParameters": {
"domains": {
"allowedDomains": [
{
"address": "example.com",
"includeSubpages": true
},
{
"address": "another-example.com"
}
],
"blockedDomains": [
{
"address": "blocked.com"
},
{
"address": "spam.com",
"includeSubpages": true
}
]
}
}
}SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ
Mintakérelem
PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview
{
"name": "ks-preview-test",
"description": "Description of the WorkIQ knowledge source.",
"kind": "workIQ",
"@odata.etag": "0x1234568AE7E58A1",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"workIQParameters": {
"entraAppAuthentication": {
"applicationId": "11111111-1111-1111-1111-111111111111",
"federatedCredentialId": "22222222-2222-2222-2222-222222222222"
}
}
}
Mintaválasz
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "workIQ",
"description": "Description of the WorkIQ knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"workIQParameters": {
"entraAppAuthentication": {
"applicationId": "11111111-1111-1111-1111-111111111111",
"federatedCredentialId": "22222222-2222-2222-2222-222222222222"
}
}
}{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-preview-test",
"kind": "workIQ",
"description": "Description of the WorkIQ knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"isServiceLevelKey": false,
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"workIQParameters": {
"entraAppAuthentication": {
"applicationId": "11111111-1111-1111-1111-111111111111",
"federatedCredentialId": "22222222-2222-2222-2222-222222222222"
}
}
}Definíciók
| Név | Description |
|---|---|
| Accept |
Az Elfogadás fejléce. |
| AIServices |
Paraméterek az MI szolgáltatásokhoz. |
|
Asset |
Az asset tároló konfigurációja, amelyet kinyert eszközök, például képek tárolására használnak. |
|
Azure |
Az Azure Blob Storage tudásforrás konfigurálása. |
|
Azure |
Az Azure Blob Storage tudásforrás paraméterei. |
|
Azure |
A meghívott Azure Open AI-modell neve. |
|
Azure |
Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit. |
|
Content |
Egy SQL oszlopot egy keresőindexmezőre képez le. |
|
Cors |
Meghatározza az indexek forrásközi erőforrás-megosztásának (CORS) beállítását. |
|
Embedding |
Egy SQL oszlopot egy vektormezőhöz képez beágyazáshoz. |
|
Entra |
Ügyfél tulajdonában lévő Microsoft Entra alkalmazás regisztrációjának konfigurálása, amelyet federated credential-based on-beach authentication céljából használnak. |
|
Error |
Az erőforrás-kezelési hiba további információi. |
|
Error |
A hiba részletei. |
|
Error |
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.) |
|
Fabric |
Konfiguráció a Fabric Data Agent tudásforrásához. |
|
Fabric |
Paraméterek a Fabric Data Agent tudásforrásához. |
|
Fabric |
Konfiguráció a Fabric Ontology tudásforráshoz. |
|
Fabric |
Paraméterek a Fabric Ontology tudásforrásához. |
|
File |
Fájltudásforrás konfigurációja, amely támogatja a közvetlen fájlfeltöltést és indexelést. |
|
File |
Paraméterek a fájltudás forrásához. |
|
Freshness |
Konfiguráció frissesség-érzékeny visszakereséshez. Ha beállítva állítják, az újabb dokumentumok rangsorolást kapnak a visszakeresés során. |
|
Indexed |
A OneLake tudásforrás konfigurálása. |
|
Indexed |
A OneLake tudásforrás paraméterei. |
|
Indexed |
Megadja, hogy mely SharePoint-tárakat szeretné elérni. |
|
Indexed |
A SharePoint tudásforrás konfigurálása. |
|
Indexed |
A SharePoint tudásforrás paraméterei. |
|
Indexed |
Konfiguráció indexelt SQL tudásforráshoz. |
|
Indexed |
Paraméterek indexelt SQL tudásforráshoz. |
|
Indexing |
Az indexelő végrehajtásának ütemezését jelöli. |
|
Knowledge |
Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást. |
|
Knowledge |
A lekérdezések tervezéséhez használt AI-modell. |
|
Knowledge |
Megadja a lekérdezési sztring vektorizálásához használt Azure OpenAI-erőforrást. |
|
Knowledge |
Összevonja a tudásforrások összes általános betöltési beállítását. |
|
Knowledge |
Engedélytípusok, amelyekkel együtt kell beolvasni a dokumentum tartalmát. |
|
Knowledge |
A tudásforrás fajtája. |
|
Knowledge |
Megadja a hálózati hozzáférési módot a tudásforrás felvételéhez. Az alapértelmezett a 'public'. |
|
Knowledge |
Szabályozza, hogy egy tudásforrás eredményei újrarangsorolódnak-e. |
|
Mcp |
Olyan hitelesítés, mint egy MCP szerver esetében. |
|
Mcp |
Automatikusan azonosítsd a kimeneti formátumot és ennek megfelelően szűrd. |
|
Mcp |
Hitelesítés Azure AI Foundry kapcsolattal. |
|
Mcp |
Paraméterek a Foundry kapcsolathitelesítéshez. |
|
Mcp |
A kimenetet JSON dokumentumként elemzse be a konfigurált JSON paraméterekkel. |
|
Mcp |
Konfiguráció egy tudásforráshoz, amelyet egy MCP (Model Context Protocol) szerver támogat. |
|
Mcp |
Paraméterek egy MCP szerver tudásforrásához. |
|
Mcp |
Kezeld a kimenetet egyetlen blokkként parzálás nélkül. |
|
Mcp |
Paraméterek a JSON kimeneti elemzéshez. |
|
Mcp |
Olyan kimeneti parzálás, mint egy MCP szerver eszköz. |
|
Mcp |
Paraméterek a split output parsinghoz. |
|
Mcp |
A kimenetet oldalakra bontsd a beállított osztási paraméterekkel. |
|
Mcp |
Hitelesítés tárolt HTTP fejlécek használatával. |
|
Mcp |
Paraméterek a tárolt fejlécek hitelesítéséhez. |
|
Mcp |
Egyetlen eszközt képvisel egy MCP szerver tudásforráson belül. |
| Prefer |
HTTP PUT-kérések esetén arra utasítja a szolgáltatást, hogy sikeres esetben adja vissza a létrehozott/frissített erőforrást. |
|
Remote |
Távoli SharePoint-tudásforrás konfigurálása. |
|
Remote |
A távoli SharePoint-tudásforrás paraméterei. |
|
Search |
Törli az adatforrás identitástulajdonságát. |
|
Search |
Megadja a használni kívánt adatforrás identitását. |
|
Search |
Mezőreferenciát a keresési indexhez. |
|
Search |
Tudásforrás keresési indexet céloz meg. |
|
Search |
Ez a fajta boost tipp egy keresőindex-forráshoz. |
|
Search |
Egy tipp, amely a dokumentumokat egy mezőérték alapján növeli. |
|
Search |
Egy tipp, amely azonosít egy mezőt és azokat a reprezentív értékeket, amelyeket a lekérdezéstervező használhat szűrő építésekor. |
|
Search |
Egy tipp, amely több szavas kifejezés alapján erősíti a dokumentumokat. |
|
Search |
A keresési index tudásforrásának paraméterei. |
|
Search |
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé keresési index tudásforráshoz. |
|
Search |
Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók. |
|
Split |
A SplitSkill által a bemeneti szöveghez támogatott nyelvi kódok. |
|
Text |
Egy érték, amely jelzi, hogy melyik felosztási módot kell végrehajtani. |
|
Vector |
A lekérdezés során használandó vektorizálási módszer. |
|
Web |
Tudásforrás webes eredmények megcélzása. |
|
Web |
Webes tudásforrás-tartomány konfigurálása. |
|
Web |
Tartomány engedélyezési/blokkolási konfigurációja webes tudásforráshoz. |
|
Web |
A webes tudásforrás paraméterei. |
|
Work |
A WorkIQ tudásforrás konfigurációja. |
|
Work |
A WorkIQ tudásforrás paraméterei. |
Accept
Az Elfogadás fejléce.
| Érték | Description |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Paraméterek az MI szolgáltatásokhoz.
| Név | Típus | Description |
|---|---|---|
| apiKey |
string |
Az AI-szolgáltatások eléréséhez szükséges API-kulcs. |
| uri |
string (uri) |
A AI Services végpont URI-ja. |
AssetStore
Az asset tároló konfigurációja, amelyet kinyert eszközök, például képek tárolására használnak.
| Név | Típus | Description |
|---|---|---|
| connectionString |
string |
Az asset store kapcsolati karakterlánc-je. |
| containerName |
string |
Az eszköz tárolójában lévő blob konténer neve, ahol a kinyert eszközöket (például képeket) tárolják. |
AzureBlobKnowledgeSource
Az Azure Blob Storage tudásforrás konfigurálása.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| azureBlobParameters |
A tudásforrás típusa. |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
azure |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
AzureBlobKnowledgeSourceParameters
Az Azure Blob Storage tudásforrás paraméterei.
| Név | Típus | Alapértelmezett érték | Description |
|---|---|---|---|
| connectionString |
string |
Kulcsalapú kapcsolati sztring vagy a ResourceId formátum, ha felügyelt identitást használ. |
|
| containerName |
string |
A blobtároló neve. |
|
| createdResources |
object |
A tudásforrás által létrehozott erőforrások. |
|
| folderPath |
string |
Nem kötelező mappa elérési útja a tárolón belül. |
|
| ingestionParameters |
Összevonja az összes általános betöltési beállítást. |
||
| isADLSGen2 |
boolean |
False |
Állítsa igaz értékre, ha ADLS Gen2-tárfiókhoz csatlakozik. Az alapértelmezett érték false. |
| queryHints |
Alapértelmezett tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és boostok felé ebben az index-alapú tudásforrásban. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
AzureOpenAIModelName
A meghívott Azure Open AI-modell neve.
| Érték | Description |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 modell. |
| text-embedding-3-large |
TextEmbedding3Large modell. |
| text-embedding-3-small |
TextEmbedding3Small modell. |
| gpt-4o |
Gpt4o modell. |
| gpt-4o-mini |
Gpt4oMini modell. |
| gpt-4.1 |
Gpt41 modell. |
| gpt-4.1-mini |
Gpt41Mini modell. |
| gpt-4.1-nano |
Gpt41Nano modell. |
| gpt-5 |
Gpt5 modell. |
| gpt-5-mini |
Gpt5Mini modell. |
| gpt-5-nano |
Gpt5Nano modell. |
| gpt-5.1 |
Gpt51 modell. |
| gpt-5.2 |
Gpt52 modell. |
| gpt-5.4 |
Gpt54 modell. |
| gpt-5.4-mini |
Gpt54Mini modell. |
| gpt-5.4-nano |
Gpt54Nano modell. |
| gpt-5.5 |
Gpt55 modell. |
| gpt-5.6-sol |
Gpt56Sol modell. |
| gpt-5.6-terra |
Gpt56Terra modell. |
| gpt-5.6-luna |
Gpt56Luna modell. |
AzureOpenAIVectorizerParameters
Megadja az Azure OpenAI-erőforráshoz való csatlakozás paramétereit.
| Név | Típus | Description |
|---|---|---|
| apiKey |
string |
A kijelölt Azure OpenAI-erőforrás API-kulcsa. |
| authIdentity | SearchIndexerDataIdentity: |
A kimenő kapcsolatokhoz használt, felhasználó által hozzárendelt felügyelt identitás. |
| deploymentId |
string |
Az Azure OpenAI-modell üzembe helyezésének azonosítója a kijelölt erőforráson. |
| modelName |
A megadott deploymentId elérési úton üzembe helyezett beágyazási modell neve. |
|
| resourceUri |
string (uri) |
Az Azure OpenAI-erőforrás erőforrás-URI-ja. |
ContentColumnMapping
Egy SQL oszlopot egy keresőindexmezőre képez le.
| Név | Típus | Description |
|---|---|---|
| name |
string |
Célindex mező neve. |
| searchFieldType |
string |
Azure AI Keresés field type (pl., Edm.String, Edm.Int32). |
| sourceField |
string |
SQL oszlop neve. |
CorsOptions
Meghatározza az indexek forrásközi erőforrás-megosztásának (CORS) beállítását.
| Név | Típus | Description |
|---|---|---|
| allowedOrigins |
string[] |
Azon források listája, amelyekből a JavaScript-kód hozzáférést kap az indexhez. Tartalmazhatja a {protocol}://{fully-qualified-domain-name}[:{port#}] formátumú állomások listáját, vagy egyetlen "*"-ot az összes forrás engedélyezéséhez (nem ajánlott). |
| maxAgeInSeconds |
integer (int64) |
Az az időtartam, ameddig a böngészőknek gyorsítótárazniuk kell a CORS elővizsgálati válaszait. Alapértelmezés szerint 5 perc. |
EmbeddingColumnMapping
Egy SQL oszlopot egy vektormezőhöz képez beágyazáshoz.
| Név | Típus | Description |
|---|---|---|
| name |
string |
Cél vektormező neve a keresési indexben. |
| sourceField |
string |
SQL oszlop, amelyet bemenetként használnak beágyazás generálásához. |
EntraAppAuthentication
Ügyfél tulajdonában lévő Microsoft Entra alkalmazás regisztrációjának konfigurálása, amelyet federated credential-based on-beach authentication céljából használnak.
| Név | Típus | Description |
|---|---|---|
| applicationId |
string (uuid) |
Az ügyfél tulajdonában lévő Entra alkalmazás regisztrációjának alkalmazásazonosítója (kliens). |
| federatedCredentialId |
string (uuid) |
Az alkalmazás regisztrációján konfigurált szövetséges hitelesítő azonosító, lehetővé téve a kereső szolgáltatás hitelesítését alkalmazásként, nem tárolt klienstitok nélkül. |
| tenantId |
string (uuid) |
Az alkalmazás regisztrációjának bérlőazonosítója. Kötelező, ha az alkalmazás regisztrációja egy másik bérlőben van, mint a kereső szolgáltatás. Ha kihagyják, akkor a keresőszolgáltatás bérlőjét használják. |
ErrorAdditionalInfo
Az erőforrás-kezelési hiba további információi.
| Név | Típus | Description |
|---|---|---|
| info |
A további információk. |
|
| type |
string |
A további információtípus. |
ErrorDetail
A hiba részletei.
| Név | Típus | Description |
|---|---|---|
| additionalInfo |
A hiba további információi. |
|
| code |
string |
A hibakód. |
| details |
A hiba részletei. |
|
| message |
string |
A hibaüzenet. |
| target |
string |
A hiba célpontja. |
ErrorResponse
Az Összes Azure Resource Manager API gyakori hibaválasza a sikertelen műveletek hibaadatainak visszaadásához. (Ez az OData hibaválasz formátumát is követi.)
| Név | Típus | Description |
|---|---|---|
| error |
A hibaobjektum. |
FabricDataAgentKnowledgeSource
Konfiguráció a Fabric Data Agent tudásforrásához.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| fabricDataAgentParameters |
A Fabric Data Agent tudásforrásának paraméterei. |
|
| kind |
string:
fabric |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FabricDataAgentKnowledgeSourceParameters
Paraméterek a Fabric Data Agent tudásforrásához.
| Név | Típus | Description |
|---|---|---|
| dataAgentId |
string |
Megadja, melyik Fabric Data Agenthez kell hozzáférni. |
| workspaceId |
string |
Fabric workspace azonosító. |
FabricOntologyKnowledgeSource
Konfiguráció a Fabric Ontology tudásforráshoz.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| fabricOntologyParameters |
A Fabric Ontology tudásforrás paraméterei. |
|
| kind |
string:
fabric |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FabricOntologyKnowledgeSourceParameters
Paraméterek a Fabric Ontology tudásforrásához.
| Név | Típus | Description |
|---|---|---|
| ontologyId |
string |
Az ontológia azonosítója, amit a Fabric munkaterületről kell használni. |
| workspaceId |
string |
A Fabric munkaterület azonosítója, amely tartalmazza az ontológiát. |
FileKnowledgeSource
Fájltudásforrás konfigurációja, amely támogatja a közvetlen fájlfeltöltést és indexelést.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| corsOptions |
Opciók a Cross-Origin Resource Sharing (CORS) vezérlésére a fájl tudásforrás fájlvégpontjain (feltöltés, listázás, frissítés, törlés). |
|
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| fileParameters |
A fájl tudásforrás paraméterei. |
|
| kind |
string:
file |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
FileKnowledgeSourceParameters
Paraméterek a fájltudás forrásához.
| Név | Típus | Description |
|---|---|---|
| createdResources |
object |
Az erőforrásokat a fájl tudásforrása hozza létre. |
| ingestionParameters |
Konszolidálja a fájl tudásforrásának összes általános felvételi beállítását, beleértve a tartalomkivonási módot és az opcionális embeddingModel-et. |
|
| queryHints |
Alapértelmezett tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és boostok felé ebben az index-alapú tudásforrásban. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
FreshnessPolicy
Konfiguráció frissesség-érzékeny visszakereséshez. Ha beállítva állítják, az újabb dokumentumok rangsorolást kapnak a visszakeresés során.
| Név | Típus | Description |
|---|---|---|
| boostingDuration |
string |
ISO 8601 időtartama a frissességnövelő ablakhoz (pl. 'P90D' 90 napig). Az ilyen időtartamnál újabb dokumentumok rangsorolást kapnak a visszakeresés során. |
IndexedOneLakeKnowledgeSource
A OneLake tudásforrás konfigurálása.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| indexedOneLakeParameters |
A tudásforrás paraméterei. |
|
| kind |
string:
indexed |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedOneLakeKnowledgeSourceParameters
A OneLake tudásforrás paraméterei.
| Név | Típus | Description |
|---|---|---|
| createdResources |
object |
A tudásforrás által létrehozott erőforrások. |
| fabricWorkspaceId |
string |
OneLake-munkaterület azonosítója. |
| ingestionParameters |
Összevonja az összes általános betöltési beállítást. |
|
| lakehouseId |
string |
Megadja, hogy melyik OneLake tóházhoz férjen hozzá. |
| queryHints |
Alapértelmezett tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és boostok felé ebben az index-alapú tudásforrásban. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
|
| targetPath |
string |
Opcionális OneLakehouse mappa vagy parancsikon a OneLake-tartalom szűréséhez. |
IndexedSharePointContainerName
Megadja, hogy mely SharePoint-tárakat szeretné elérni.
| Érték | Description |
|---|---|
| defaultSiteLibrary |
A webhely alapértelmezett dokumentumtárának tartalmának indexelése. |
| allSiteLibraries |
A webhely összes dokumentumtárának tartalmának indexelése. |
| useQuery |
Használj lekérdezést a SharePoint tartalom szűrésére. |
IndexedSharePointKnowledgeSource
A SharePoint tudásforrás konfigurálása.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| indexedSharePointParameters |
A tudásforrás paraméterei. |
|
| kind |
string:
indexed |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedSharePointKnowledgeSourceParameters
A SharePoint tudásforrás paraméterei.
| Név | Típus | Description |
|---|---|---|
| connectionString |
string |
SharePoint-kapcsolati sztring formátumban: SharePointOnlineEndpoint=[SharePoint-webhely URL-címe]; ApplicationId=[Azure AD-alkalmazásazonosító]; ApplicationSecret=[Azure AD-alkalmazás titkos ügyfélkód]; TenantId=[SharePoint-webhely bérlőazonosítója] |
| containerName |
Megadja, hogy mely SharePoint-tárakat szeretné elérni. |
|
| createdResources |
object |
A tudásforrás által létrehozott erőforrások. |
| ingestionParameters |
Összevonja az összes általános betöltési beállítást. |
|
| query |
string |
Opcionális lekérdezés a SharePoint-tartalom szűréséhez. |
| queryHints |
Alapértelmezett tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és boostok felé ebben az index-alapú tudásforrásban. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
IndexedSqlKnowledgeSource
Konfiguráció indexelt SQL tudásforráshoz.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| indexedSqlParameters |
Az SQL tudásforrás paraméterei. |
|
| kind |
string:
indexed |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
IndexedSqlKnowledgeSourceParameters
Paraméterek indexelt SQL tudásforráshoz.
| Név | Típus | Description |
|---|---|---|
| connectionString |
string |
Az Azure SQL Database vagy az SQL Managed Instance kapcsolati karakterlánc. |
| contentColumns |
Opcionális oszlopleképezések tartalommezőkhöz. Ha kihagyják, minden oszlop automatikusan felfedezhető. |
|
| createdResources |
object |
A tudásforrás által létrehozott erőforrások. |
| embeddingColumns |
Opcionális oszlopleképezések vektormezők beágyazásához. Ha kihagyják, nem jön létre vektormezők. |
|
| highWaterMarkColumnName |
string |
Opcionális oszlopnév a magas vízjegy-változás észleléséhez. Ha megadják, a HighWaterMarkChangeDetectionPolicy funkciót használja. |
| ingestionParameters |
Konszolidálja az összes általános felvételi beállítást, beleértve a beágyazási modellt, ütemezést és identitást. |
|
| queryHints |
Alapértelmezett tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és boostok felé ebben az index-alapú tudásforrásban. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
|
| tableOrView |
string |
Az indexelt tábla vagy nézet neve. Séma alapján minősíthetők (pl. 'dbo. MyTable'). |
IndexingSchedule
Az indexelő végrehajtásának ütemezését jelöli.
| Név | Típus | Description |
|---|---|---|
| interval |
string (duration) |
Az indexelő végrehajtásai közötti időintervallum. |
| startTime |
string (date-time) |
Az az időpont, amikor az indexelő elindul. |
KnowledgeBaseAzureOpenAIModel
Megadja a lekérdezések tervezéséhez használt Azure OpenAI-erőforrást.
| Név | Típus | Description |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI paraméterek. |
|
| kind |
string:
azure |
A lekérdezések tervezéséhez használt AI-modell. |
KnowledgeBaseModelKind
A lekérdezések tervezéséhez használt AI-modell.
| Érték | Description |
|---|---|
| azureOpenAI |
Lekérdezéstervezéshez használja az Azure Open AI-modelleket. |
KnowledgeSourceAzureOpenAIVectorizer
Megadja a lekérdezési sztring vektorizálásához használt Azure OpenAI-erőforrást.
| Név | Típus | Description |
|---|---|---|
| azureOpenAIParameters |
Az Azure OpenAI beágyazott vektorizálásra jellemző paramétereket tartalmazza. |
|
| kind |
string:
azure |
A vektoros kereséshez konfigurált vektorizálási módszer neve. |
KnowledgeSourceIngestionParameters
Összevonja a tudásforrások összes általános betöltési beállítását.
| Név | Típus | Alapértelmezett érték | Description |
|---|---|---|---|
| aiServices |
Opcionális AI Services konfiguráció a tartalomfeldolgozáshoz. |
||
| assetStore |
Opcionális asset tároló konfiguráció a kinyert eszközök, például képek tárolására. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Opcionális csevegési befejezési modell a kép verbalizálásához vagy a kontextus kinyeréséhez. |
|
| contentExtractionMode |
enum:
|
minimal |
Opcionális tartalomkinyerési mód. Az alapértelmezett érték a "minimális". |
| disableImageVerbalization |
boolean |
False |
Azt jelzi, hogy a kép verbalizálását le kell-e tiltani. Az alapértelmezett érték false. |
| embeddingModel | KnowledgeSourceVectorizer: |
Opcionális vektorizáló konfiguráció a tartalom vektorizálásához. |
|
| freshnessPolicy |
Opcionális frissességi szabályzat az újabb dokumentumok iránti elfogult lekéréshez. |
||
| identity | SearchIndexerDataIdentity: |
A tudásforráshoz használandó explicit identitás. |
|
| ingestionPermissionOptions |
A dokumentum tartalmával együtt betöltendő engedélytípusok opcionális listája. Ha meg van adva, beállítja az adatforrás indexelő engedélybeállításait. |
||
| ingestionSchedule |
Az adatbetöltés nem kötelező ütemezése. |
||
| networkAccessMode | public |
Opcionális hálózati hozzáférési mód az elvételhez. Állítsd 'privát'-ra, hogy a felvételt egy privát végrehajtási környezetben futtasd, amely elérheti az adatforrásokat és függőségeket egy privát hálózaton keresztül. Az alapértelmezett a 'public'. Ez egy create-time beállítás, és nem változtatható a tudásforrás létrehozása után. |
KnowledgeSourceIngestionPermissionOption
Engedélytípusok, amelyekkel együtt kell beolvasni a dokumentum tartalmát.
| Érték | Description |
|---|---|
| userIds |
Explicit felhasználói azonosítók betöltése a dokumentum tartalma mellett. |
| groupIds |
Csoportazonosítók betöltése a dokumentum tartalma mellett. |
| rbacScope |
Az RBAC-hatókörrel kapcsolatos információk betöltése a dokumentum tartalma mellett. |
| sensitivityLabels |
Olvasd be a Microsoft Purview érzékenységi címkéket a dokumentumtartalom mellett. |
KnowledgeSourceKind
A tudásforrás fajtája.
| Érték | Description |
|---|---|
| searchIndex |
Olyan tudásforrás, amely adatokat olvas be egy keresési indexből. |
| azureBlob |
Olyan tudásforrás, amely adatokat olvas és tölt be az Azure Blob Storage-ból egy keresési indexbe. |
| indexedSharePoint |
Egy tudásforrás, amely adatokat olvas az indexelt SharePoint-ről. |
| indexedOneLake |
Egy tudásforrás, amely adatokat olvas az indexelt OneLake-ből. |
| indexedSql |
Egy tudásforrás, amely adatokat keres és fogad be Azure SQL Database-ből vagy SQL Managed Instance-ból egy Search Indexbe. |
| web |
Egy tudásforrás, amely adatokat olvas a webről. |
| remoteSharePoint |
Egy tudásforrás, amely adatokat olvas a távoli SharePoint-ról. |
| workIQ |
Egy tudásforrás, amely a munkahelyi IQ-ból olvas adatokat. |
| file |
Egy tudásforrás, amely támogatja a közvetlen fájlfeltöltést és indexelést. |
| mcpServer |
Egy MCP (Model Context Protocol) szerver által támogatott tudásforrás. |
| fabricDataAgent |
Egy tudásforrás, amely adatokat gyűjt egy Fabric Data Agent-ből. |
| fabricOntology |
Egy tudásforrás, amely adatokat keres a Microsoft Fabric Ontology ontológiaiból. |
KnowledgeSourceNetworkAccessMode
Megadja a hálózati hozzáférési módot a tudásforrás felvételéhez. Az alapértelmezett a 'public'.
| Érték | Description |
|---|---|
| public |
A felvétel a szabványos, nyilvánosan elérhető végrehajtási környezetben fut. Ez az alapértelmezett beállítás. |
| private |
Az ingestion egy privát végrehajtási környezetben fut, így elérheti az adatforrásokat és függőségeket egy privát hálózaton keresztül (privát végpont / megosztott privát kapcsolat). |
KnowledgeSourceResultsProcessing
Szabályozza, hogy egy tudásforrás eredményei újrarangsorolódnak-e.
| Érték | Description |
|---|---|
| rerank |
A tudásforrásból származó eredmények átmennek az újrarangsorolási folyamaton. Ez az alapértelmezett viselkedés. |
| none |
Ennek a tudásforrásnak az eredményei megkerülik az újrarangolást, és megőrzik az alapvető sorrendet. |
McpServerAuthenticationKind
Olyan hitelesítés, mint egy MCP szerver esetében.
| Érték | Description |
|---|---|
| foundryConnection |
Hitelesítés Azure AI Foundry kapcsolattal. |
| storedHeaders |
Hitelesíts tárolt HTTP fejléceket. |
McpServerAutoOutputParsing
Automatikusan azonosítsd a kimeneti formátumot és ennek megfelelően szűrd.
| Név | Típus | Description |
|---|---|---|
| kind |
string:
auto |
Milyen kimeneti elemzést kell alkalmazni. |
McpServerFoundryConnectionAuthentication
Hitelesítés Azure AI Foundry kapcsolattal.
| Név | Típus | Description |
|---|---|---|
| foundryConnectionParameters |
Paraméterek a Foundry kapcsolathitelesítéshez. |
|
| kind |
string:
foundry |
Milyen hitelesítési rendszert érdemes használni. |
McpServerFoundryConnectionParameters
Paraméterek a Foundry kapcsolathitelesítéshez.
| Név | Típus | Description |
|---|---|---|
| connectionId |
string |
Az Azure AI Foundry kapcsolatazonosító. |
McpServerJsonOutputParsing
A kimenetet JSON dokumentumként elemzse be a konfigurált JSON paraméterekkel.
| Név | Típus | Description |
|---|---|---|
| jsonParameters |
Paraméterek a JSON kimeneti elemzéshez. Kötelező, ha a fajta 'json'. |
|
| kind |
string:
json |
Milyen kimeneti elemzést kell alkalmazni. |
McpServerKnowledgeSource
Konfiguráció egy tudásforráshoz, amelyet egy MCP (Model Context Protocol) szerver támogat.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
mcp |
A tudásforrás típusa. |
| mcpServerParameters |
Az MCP szerver tudásforrásának paraméterei. |
|
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
McpServerKnowledgeSourceParameters
Paraméterek egy MCP szerver tudásforrásához.
| Név | Típus | Description |
|---|---|---|
| authentication | McpServerAuthentication: |
Az MCP szerver hitelesítési konfigurációja. |
| serverURL |
string |
Az MCP szerver végpontjának URL-je. |
| tools |
Az MCP szerveren megidézendő eszközök listája. |
McpServerNoneOutputParsing
Kezeld a kimenetet egyetlen blokkként parzálás nélkül.
| Név | Típus | Description |
|---|---|---|
| kind |
string:
none |
Milyen kimeneti elemzést kell alkalmazni. |
McpServerOutputParsingJsonParameters
Paraméterek a JSON kimeneti elemzéshez.
| Név | Típus | Description |
|---|---|---|
| documentsPath |
string |
A JSON út a dokumentumok tömbjéhez az eszköz kimenete. |
| includeContext |
boolean |
Hogy beillesztjük-e a JSON kimenet körüli kontextust a kinyert dokumentumok mellé. |
McpServerOutputParsingKind
Olyan kimeneti parzálás, mint egy MCP szerver eszköz.
| Érték | Description |
|---|---|
| auto |
Automatikusan azonosítsd a kimeneti formátumot és ennek megfelelően szűrd. |
| json |
A kimenetet JSON dokumentumként elemzse be a konfigurált JSON paraméterekkel. |
| split |
A kimenetet oldalakra bontsd a beállított osztási paraméterekkel. |
| none |
Kezeld a kimenetet egyetlen blokkként parzálás nélkül. |
McpServerOutputParsingSplitParameters
Paraméterek a split output parsinghoz.
| Név | Típus | Description |
|---|---|---|
| defaultLanguageCode |
Egy érték, amely jelzi, hogy melyik nyelvi kódot kell használni. Az alapértelmezett érték |
|
| maximumPageLength |
integer (int32) |
A maximális karakterszám egy oldalon. |
| maximumPagesToTake |
integer (int32) |
A maximális oldalszám, amit a kimenetből kell kivenni. |
| pageOverlapLength |
integer (int32) |
A karakterek száma, amely átfedi az oldalak között. |
| textSplitMode |
A szövegfelosztás mód használata. |
McpServerSplitOutputParsing
A kimenetet oldalakra bontsd a beállított osztási paraméterekkel.
| Név | Típus | Description |
|---|---|---|
| kind |
string:
split |
Milyen kimeneti elemzést kell alkalmazni. |
| splitParameters |
Paraméterek a split output parsinghoz. |
McpServerStoredHeadersAuthentication
Hitelesítés tárolt HTTP fejlécek használatával.
| Név | Típus | Description |
|---|---|---|
| kind |
string:
stored |
Milyen hitelesítési rendszert érdemes használni. |
| storedHeadersParameters |
Paraméterek a tárolt fejlécek hitelesítéséhez. |
McpServerStoredHeadersParameters
Paraméterek a tárolt fejlécek hitelesítéséhez.
| Név | Típus | Description |
|---|---|---|
| headers |
object |
A tárolt HTTP fejléceket, amelyeket be kell illeszteni MCP szerver kérésekbe. |
McpServerTool
Egyetlen eszközt képvisel egy MCP szerver tudásforráson belül.
| Név | Típus | Description |
|---|---|---|
| maxOutputTokens |
integer (int32) |
Opcionális elemzés utáni token korlát ennek az eszköznek a kimenetére. A megadott érték szerint nagyobbnak kell lennie 0-nál. |
| name |
string |
A meghívandó MCP-eszköz neve. |
| outputParsing | McpServerOutputParsing: |
Opcionális konfiguráció az eszköz kimenetének elemzéséhez. |
| resultsProcessing |
Szabályozza, hogy az eszközből származó elemzött eredmények újrarangolódnak-e. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
Prefer
HTTP PUT-kérések esetén arra utasítja a szolgáltatást, hogy sikeres esetben adja vissza a létrehozott/frissített erőforrást.
| Érték | Description |
|---|---|
| return=representation |
RemoteSharePointKnowledgeSource
Távoli SharePoint-tudásforrás konfigurálása.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
remote |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| remoteSharePointParameters |
A távoli SharePoint tudásforrás paraméterei. |
|
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
RemoteSharePointKnowledgeSourceParameters
A távoli SharePoint-tudásforrás paraméterei.
| Név | Típus | Description |
|---|---|---|
| containerTypeId |
string |
SharePoint Embedded-kapcsolat tárolóazonosítója. Ha ez null, akkor a SharePoint Online-t fogja használni. |
| filterExpression |
string |
Kulcsszólekérdezési nyelv (KQL) kifejezés lekérdezhető SharePoint-tulajdonságokkal és attribútumokkal a lekérdezés futtatása előtti lekérés hatóköréhez. |
| resourceMetadata |
string[] |
A válasz egyes elemeihez visszaadandó metaadatmezők listája. Csak a lekért metaadat-tulajdonságok szerepelhetnek ebben a listában. Alapértelmezés szerint a rendszer nem ad vissza metaadatokat. |
SearchIndexerDataNoneIdentity
Törli az adatforrás identitástulajdonságát.
| Név | Típus | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Az identitás típusát meghatározó URI-töredék. |
SearchIndexerDataUserAssignedIdentity
Megadja a használni kívánt adatforrás identitását.
| Név | Típus | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Az identitás típusát meghatározó URI-töredék. |
| federatedIdentityClientId |
string |
Többbérlős User-Assigned Managed Identity Support: A több-tendens alkalmazás kliensazonosítója, amelyet a felhasználó által rendelt menedzselt identitással való szövetségre konfiguráltak. |
| userAssignedIdentity |
string |
A felhasználó által hozzárendelt felügyelt identitás teljes Azure-erőforrás-azonosítója általában "/subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" formában található, amelyet hozzá kellett volna rendelni a keresési szolgáltatáshoz. |
SearchIndexFieldReference
Mezőreferenciát a keresési indexhez.
| Név | Típus | Description |
|---|---|---|
| name |
string |
A mező neve. |
SearchIndexKnowledgeSource
Tudásforrás keresési indexet céloz meg.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
search |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
|
| searchIndexParameters |
A tudásforrás paraméterei. |
SearchIndexKnowledgeSourceBoostKind
Ez a fajta boost tipp egy keresőindex-forráshoz.
| Érték | Description |
|---|---|
| fieldValue |
Boostolj dokumentumokat egy mezőérték alapján. |
| multiWordExpression |
A dokumentumok fejlesztése egy többszavas kifejezés alapján. |
SearchIndexKnowledgeSourceFieldValueBoost
Egy tipp, amely a dokumentumokat egy mezőérték alapján növeli.
| Név | Típus | Description |
|---|---|---|
| boost |
number (double) |
A dokumentumpontszám szorzója. Pozitív számnak kell lennie, amely nem egyenlő 1,0-sal. |
| boostInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell alkalmazni a boostot. |
| field |
string minLength: 1 |
A keresőindex mező neve. |
| fieldValues |
string[] |
A mező reprezentatív értékei. |
| kind |
string:
field |
Olyan erősítő tipp. |
SearchIndexKnowledgeSourceFilterHint
Egy tipp, amely azonosít egy mezőt és azokat a reprezentív értékeket, amelyeket a lekérdezéstervező használhat szűrő építésekor.
| Név | Típus | Description |
|---|---|---|
| field |
string minLength: 1 |
A szűrhető keresési index mező neve. |
| fieldValues |
string[] |
A mező reprezentatív értékei. |
| filterInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell szűrni a mezőn. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Egy tipp, amely több szavas kifejezés alapján erősíti a dokumentumokat.
| Név | Típus | Description |
|---|---|---|
| boost |
number (double) |
A dokumentumpontszám szorzója. Pozitív számnak kell lennie, amely nem egyenlő 1,0-sal. |
| boostInstructions |
string |
Természetes nyelvű utasítások, amelyek elmagyarázzák, mikor és hogyan kell alkalmazni a boostot. |
| fieldValues |
string[] |
Reprezentatív értékek a bónuszhoz. |
| kind |
string:
multi |
Olyan erősítő tipp. |
SearchIndexKnowledgeSourceParameters
A keresési index tudásforrásának paraméterei.
| Név | Típus | Description |
|---|---|---|
| baseFilter |
string |
Egy alapértelmezett szűrőfeltétel vonatkozik az indexre a lekérdezés idején (pl. 'State eq VA'). Lekérdezési időben felülírható tudásforrás futási paraméterei segítségével. |
| queryHints |
Alapértelmezett tippek, amelyek a lekérdezési tervezést hasznos szűrők és bónuszok felé vezetik ehhez a keresési index tudásforráshoz. A kérés-idős lekérdezési tippek ezeket az alapértelmezetteket teljes objektumként helyettesítik. |
|
| searchFields |
A keresési indexben keresendő mezők korlátozására szolgál. |
|
| searchIndexName |
string |
A keresési index neve. |
| semanticConfigurationName |
string |
Az alapértelmezetttől eltérő szemantikai konfiguráció megadására szolgál a cél keresési indexén. |
| sourceDataFields |
A hivatkozott forrásadatok további mezőinek kérésére szolgál. |
SearchIndexKnowledgeSourceQueryHints
Tippek, amelyek segítenek a lekérdezési tervezésben hasznos szűrők és bónuszok felé keresési index tudásforráshoz.
| Név | Típus | Description |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Erősítsd fel azokat a feltételeket, amelyeket a lekérdezési tervező használhat a dokumentumok rangsorolásának befolyásolására. |
| filters |
Szűrő tippek, amelyek azonosítják a mezőket és reprezentatív értékeket, amelyeket a lekérdezéstervező használhat szűrők építésekor. |
SearchResourceEncryptionKey
Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsok az inaktív adatok, például az indexek és a szinonimatérképek titkosítására vagy visszafejtésére használhatók.
| Név | Típus | Alapértelmezett érték | Description |
|---|---|---|---|
| accessCredentials.applicationId |
string |
Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával. |
|
| accessCredentials.applicationSecret |
string |
A megadott AAD-alkalmazás hitelesítési kulcsa. |
|
| identity | SearchIndexerDataIdentity: |
Explicit felügyelt identitás ehhez a titkosítási kulcshoz. Ha nincs megadva, és a hozzáférési hitelesítő adatok tulajdonság null értékű, akkor a rendszer a rendszer által hozzárendelt felügyelt identitást használja. Az erőforrás frissítésekor, ha az explicit identitás nincs meghatározva, az változatlan marad. Ha nincs megadva, a tulajdonság értéke törlődik. |
|
| isServiceLevelKey |
boolean |
False |
Egy opcionális érték, amely jelzi, hogy ez a kulcs szolgáltatási szintű kulcs-e. Az alapértelmezett érték false. |
| keyVaultKeyName |
string |
A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve. |
|
| keyVaultKeyVersion |
string |
Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója. |
|
| keyVaultUri |
string |
Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használandó kulcsot. Példa URI lehet |
SplitSkillLanguage
A SplitSkill által a bemeneti szöveghez támogatott nyelvi kódok.
| Érték | Description |
|---|---|
| am |
Amhara nyelv |
| bs |
Boszniai |
| cs |
Cseh |
| da |
Dán |
| de |
Német |
| en |
English |
| es |
Spanyol |
| et |
Észt |
| fi |
finn nyelv |
| fr |
French |
| he |
Héber nyelv |
| hi |
hindi |
| hr |
Horvát |
| hu |
Magyar |
| id |
indonéz nyelv |
| is |
Izlandi |
| it |
Italian |
| ja |
Japanese |
| ko |
Korean |
| lv |
lett |
| nb |
Norvég |
| nl |
Holland |
| pl |
Lengyel |
| pt |
Portugál nyelv (Portugália) |
| pt-br |
Portugál (Brazília) |
| ru |
Russian |
| sk |
Szlovák |
| sl |
Szlovén |
| sr |
Szerb |
| sv |
Svéd |
| tr |
Török |
| ur |
Urdu nyelv |
| zh |
Kínai (egyszerűsített) |
TextSplitMode
Egy érték, amely jelzi, hogy melyik felosztási módot kell végrehajtani.
| Érték | Description |
|---|---|
| pages |
Ossza fel a szöveget egyes oldalakra. |
| sentences |
A szöveg felosztása egyes mondatokra. |
VectorSearchVectorizerKind
A lekérdezés során használandó vektorizálási módszer.
| Érték | Description |
|---|---|
| azureOpenAI |
Beágyazásokat hozhat létre egy Azure OpenAI-erőforrás használatával lekérdezéskor. |
| customWebApi |
Beágyazások létrehozása egyéni webes végpont használatával lekérdezéskor. |
| aiServicesVision |
Az Azure AI Services Vision Vectorize API használatával beágyazásokat hozhat létre egy kép- vagy szövegbevitelhez lekérdezési időpontban. |
| aml |
Beágyazásokat hozhat létre egy Azure Machine Learning végponttal, amely a lekérdezéskor az Azure AI Foundry modellkatalógusán keresztül van üzembe helyezve. |
WebKnowledgeSource
Tudásforrás webes eredmények megcélzása.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
web |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
|
| webParameters |
A webes tudásforrás paraméterei. |
WebKnowledgeSourceDomain
Webes tudásforrás-tartomány konfigurálása.
| Név | Típus | Description |
|---|---|---|
| address |
string |
A domain címe. |
| includeSubpages |
boolean |
Hogy a domainből származó aloldalakat tartalmazzon-e vagy sem. |
WebKnowledgeSourceDomains
Tartomány engedélyezési/blokkolási konfigurációja webes tudásforráshoz.
| Név | Típus | Description |
|---|---|---|
| allowedDomains |
Domainek, amelyek engedélyezettek webes eredményekhez. |
|
| blockedDomains |
Olyan domainek, amelyeket a webes eredmények nem zárnak. |
WebKnowledgeSourceParameters
A webes tudásforrás paraméterei.
| Név | Típus | Description |
|---|---|---|
| count |
integer (int32) |
Az alapértelmezett számú webes eredmény, amit vissza kell hozni. Lekérdezési időben felülírható tudásforrás futási paraméterei segítségével. |
| domains |
Tartomány engedélyezési/letiltási konfigurációja webes eredményekhez. |
|
| freshness |
string |
A webes eredményekhez az alapértelmezett frissességszűrő. Lekérdezési időben felülírható tudásforrás futási paraméterei segítségével. |
| language |
string |
A webes eredmények alapértelmezett nyelve. Lekérdezési időben felülírható tudásforrás futási paraméterei segítségével. |
| market |
string |
A webes eredmények alapértelmezett piaca. Lekérdezési időben felülírható tudásforrás futási paraméterei segítségével. |
WorkIQKnowledgeSource
A WorkIQ tudásforrás konfigurációja.
| Név | Típus | Description |
|---|---|---|
| @odata.etag |
string |
A tudásforrás ETag-ja. |
| description |
string |
Opcionális felhasználó által definiált leírás. |
| encryptionKey |
Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ezt a kulcsot arra használják, hogy további szintű titkosítást biztosítson a tudásforrás definíciójához, amikor teljes biztosítékot szeretnél arra, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosítottad a tudásforrás definícióját, az mindig titkosított marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre állítására tett kísérleteket. Ezt a tulajdonságot szükség szerint módosíthatod, ha szeretnéd elforgatni a titkosítási kulcsodat; A tudásforrás definíciója nem fog változni. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el. |
|
| kind |
string:
workIQ |
A tudásforrás típusa. |
| name |
string |
A tudásforrás neve. |
| resultsProcessing |
Szabályozza, hogy az adott tudásforrásból származó eredményeket újrarangolják-e, mielőtt bekerülnének a végső eredményhalmazba. Alapértelmezettben 'újrarangolva' áll, ha nincs megadva. |
|
| workIQParameters |
A WorkIQ tudásforrás paraméterei, beleértve az ügyfél által tulajdonolt Entra alkalmazás konfigurációját, amelyet az on-a hitelesítéshez használnak. |
WorkIQKnowledgeSourceParameters
A WorkIQ tudásforrás paraméterei.
| Név | Típus | Description |
|---|---|---|
| entraAppAuthentication |
Az ügyfél tulajdonában lévő Microsoft Entra alkalmazásregisztrációs konfiguráció, amelyet a Work IQ API nevében történő hitelesítéshez használnak. Az ügyfél regisztrál egy bérlő tulajdonában lévő Entra alkalmazást, megadja neki a WorkIQAgent.Ask delegált engedélyt, és konfigurál egy szövetséges hitelesítő levelet, hogy az Azure AI Keresés ilyen alkalmazásként hitelesítse magát tárolt klienstitok nélkül. |