Knowledge Sources - Create Or Update
Tworzy nowe źródło wiedzy lub aktualizuje źródło wiedzy, jeśli już istnieje.
PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-08-01-previewParametry identyfikatora URI
| Nazwa | W | Wymagane | Typ | Opis |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Adres URL punktu końcowego usługi wyszukiwania. |
|
source
|
path | True |
string |
Nazwa źródła wiedzy. |
|
api-version
|
query | True |
string minLength: 1 |
Wersja interfejsu API do użycia dla tej operacji. |
Nagłówek żądania
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| Accept |
Nagłówek Accept. |
||
| If-Match |
string |
Definiuje warunek If-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze jest zgodny z tą wartością. |
|
| If-None-Match |
string |
Definiuje warunek If-None-Match. Operacja zostanie wykonana tylko wtedy, gdy element ETag na serwerze nie jest zgodny z tą wartością. |
|
| Prefer | True |
W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia. |
|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
Treść żądania
Treść żądania może być jedną z następujących:
| Nazwa | Opis |
|---|---|
|
Azure |
Konfiguracja źródła wiedzy Azure Blob Storage. |
|
Fabric |
Konfiguracja dla źródła wiedzy Fabric Data Agent. |
|
Fabric |
Konfiguracja dla źródła wiedzy Fabric Ontology. |
|
File |
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików. |
|
Indexed |
Konfiguracja dla źródła wiedzy OneLake. |
|
Indexed |
Konfiguracja źródła wiedzy programu SharePoint. |
|
Indexed |
Konfiguracja dla indeksowanego źródła wiedzy SQL. |
|
Mcp |
Konfiguracja dla źródła wiedzy wspieranego przez serwer MCP (Model Context Protocol). |
|
Remote |
Konfiguracja zdalnego źródła wiedzy programu SharePoint. |
|
Search |
Źródło wiedzy przeznaczone dla indeksu wyszukiwania. |
|
Web |
Źródło wiedzy kierowane na wyniki w internecie. |
|
Work |
Konfiguracja dla źródła wiedzy WorkIQ. |
AzureBlobKnowledgeSource
Konfiguracja źródła wiedzy Azure Blob Storage.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| azureBlobParameters | True |
Typ źródła wiedzy. |
|
| kind | True |
string:
azure |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FabricDataAgentKnowledgeSource
Konfiguracja dla źródła wiedzy Fabric Data Agent.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| fabricDataAgentParameters | True |
Parametry źródła wiedzy Fabric Data Agent. |
|
| kind | True |
string:
fabric |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FabricOntologyKnowledgeSource
Konfiguracja dla źródła wiedzy Fabric Ontology.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| fabricOntologyParameters | True |
Parametry źródła wiedzy Fabric Ontology. |
|
| kind | True |
string:
fabric |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FileKnowledgeSource
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| fileParameters | True |
Parametry dla źródła wiedzy pliku. |
|
| kind | True |
string:
file |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| corsOptions |
Opcje sterowania Cross-Origin Resource Sharing (CORS) dla końcowych punktów plików źródła wiedzy plikowej (przesyłanie, listowanie, aktualizacja, usuwanie). |
||
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedOneLakeKnowledgeSource
Konfiguracja dla źródła wiedzy OneLake.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| indexedOneLakeParameters | True |
Parametry źródła wiedzy. |
|
| kind | True |
string:
indexed |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedSharePointKnowledgeSource
Konfiguracja źródła wiedzy programu SharePoint.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| indexedSharePointParameters | True |
Parametry źródła wiedzy. |
|
| kind | True |
string:
indexed |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedSqlKnowledgeSource
Konfiguracja dla indeksowanego źródła wiedzy SQL.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| indexedSqlParameters | True |
Parametry źródła wiedzy SQL. |
|
| kind | True |
string:
indexed |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
McpServerKnowledgeSource
Konfiguracja dla źródła wiedzy wspieranego przez serwer MCP (Model Context Protocol).
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| kind | True |
string:
mcp |
Typ źródła wiedzy. |
| mcpServerParameters | True |
Parametry źródła wiedzy serwera MCP. |
|
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
RemoteSharePointKnowledgeSource
Konfiguracja zdalnego źródła wiedzy programu SharePoint.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| kind | True |
string:
remote |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| remoteSharePointParameters |
Parametry zdalnego źródła wiedzy SharePoint. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
SearchIndexKnowledgeSource
Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| kind | True |
string:
search |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| searchIndexParameters | True |
Parametry źródła wiedzy. |
|
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
WebKnowledgeSource
Źródło wiedzy kierowane na wyniki w internecie.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| kind | True |
string:
web |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
||
| webParameters |
Parametry internetowego źródła wiedzy. |
WorkIQKnowledgeSource
Konfiguracja dla źródła wiedzy WorkIQ.
| Nazwa | Wymagane | Typ | Opis |
|---|---|---|---|
| kind | True |
string:
workIQ |
Typ źródła wiedzy. |
| name | True |
string |
Nazwa źródła wiedzy. |
| workIQParameters | True |
Parametry dla źródła wiedzy WorkIQ, w tym konfiguracja aplikacji Entra należąca do klienta, używana do uwierzytelniania w imieniu użytkownika. |
|
| @odata.etag |
string |
ETag źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
|
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
||
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
Odpowiedzi
| Nazwa | Typ | Opis |
|---|---|---|
| 200 OK |
KnowledgeSource:
|
Żądanie zakończyło się pomyślnie. |
| 201 Created |
KnowledgeSource:
|
Żądanie zakończyło się pomyślnie i w rezultacie został utworzony nowy zasób. |
| Other Status Codes |
Nieoczekiwana odpowiedź na błąd. |
Zabezpieczenia
api-key
Typ:
apiKey
W:
header
OAuth2Auth
Typ:
oauth2
Flow:
implicit
Adres URL autoryzacji:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Zakresy
| Nazwa | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchServiceCreateOrUpdateKnowledgeSource
Przykładowe żądanie
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
}
]
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
]
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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>"
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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>"
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
]
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
]
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
]
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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
}
]
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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>"
}
}
}
Przykładowa odpowiedź
{
"@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
Przykładowe żądanie
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"
}
}
}
Przykładowa odpowiedź
{
"@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"
}
}
}Definicje
| Nazwa | Opis |
|---|---|
| Accept |
Nagłówek Accept. |
| AIServices |
Parametry dla usług AI. |
|
Asset |
Konfiguracja magazynu zasobów używanego do przechowywania wyodrębnionych zasobów, takich jak obrazy. |
|
Azure |
Konfiguracja źródła wiedzy Azure Blob Storage. |
|
Azure |
Parametry źródła wiedzy Azure Blob Storage. |
|
Azure |
Nazwa modelu Azure Open AI, który zostanie wywołany. |
|
Azure |
Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI. |
|
Content |
Mapuje kolumnę SQL na pole indeksu wyszukiwania. |
|
Cors |
Definiuje opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu. |
|
Embedding |
Mapuje kolumnę SQL na pole wektorowe do osadzania. |
|
Entra |
Konfiguracja rejestracji aplikacji Microsoft Entra należącej do klienta do federacyjnej uwierzytelniania opartej na poświadczeniu na zlecenie. |
|
Error |
Dodatkowe informacje o błędzie zarządzania zasobami. |
|
Error |
Szczegóły błędu. |
|
Error |
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData). |
|
Fabric |
Konfiguracja dla źródła wiedzy Fabric Data Agent. |
|
Fabric |
Parametry dla źródła wiedzy Fabric Data Agent. |
|
Fabric |
Konfiguracja dla źródła wiedzy Fabric Ontology. |
|
Fabric |
Parametry dla źródła wiedzy o Fabric Ontology. |
|
File |
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików. |
|
File |
Parametry dla źródła wiedzy pliku. |
|
Freshness |
Konfiguracja do pobierania z uwzględnieniem świeżości. Po ustawieniu nowsze dokumenty otrzymują wzrost rankingu podczas pobierania. |
|
Indexed |
Konfiguracja dla źródła wiedzy OneLake. |
|
Indexed |
Parametry źródła wiedzy OneLake. |
|
Indexed |
Określa, do których bibliotek programu SharePoint należy uzyskać dostęp. |
|
Indexed |
Konfiguracja źródła wiedzy programu SharePoint. |
|
Indexed |
Parametry źródła wiedzy programu SharePoint. |
|
Indexed |
Konfiguracja dla indeksowanego źródła wiedzy SQL. |
|
Indexed |
Parametry dla indeksowanego źródła wiedzy SQL. |
|
Indexing |
Reprezentuje harmonogram wykonywania indeksatora. |
|
Knowledge |
Określa zasób usługi Azure OpenAI używany do planowania zapytań. |
|
Knowledge |
Model sztucznej inteligencji, który ma być używany do planowania zapytań. |
|
Knowledge |
Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania. |
|
Knowledge |
Konsoliduje wszystkie ogólne ustawienia pozyskiwania dla źródeł wiedzy. |
|
Knowledge |
Rodzaje uprawnień do pobierania razem z treścią dokumentu. |
|
Knowledge |
Rodzaj źródła wiedzy. |
|
Knowledge |
Określa tryb dostępu sieciowego do pobierania źródeł danych. Domyślnie jest 'publiczne'. |
|
Knowledge |
Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane. |
|
Mcp |
Taki rodzaj uwierzytelniania dla serwera MCP. |
|
Mcp |
Automatycznie wykrywaj format wyjściowy i analizuj odpowiednio. |
|
Mcp |
Uwierzytelnianie za pomocą połączenia Azure AI Foundry. |
|
Mcp |
Parametry uwierzytelniania połączenia z Foundry. |
|
Mcp |
Analizuj wynik jako dokument JSON, używając skonfigurowanych parametrów JSON. |
|
Mcp |
Konfiguracja dla źródła wiedzy wspieranego przez serwer MCP (Model Context Protocol). |
|
Mcp |
Parametry dla źródła wiedzy serwera MCP. |
|
Mcp |
Traktuj wyjście jako pojedynczy blok bez żadnego parsowania. |
|
Mcp |
Parametry parsowania wyjściowego JSON. |
|
Mcp |
Taki rodzaj parsowania wyników dla narzędzia serwera MCP. |
|
Mcp |
Parametry do parsowania wyjścia podzielonego. |
|
Mcp |
Podziel wyjście na strony za pomocą skonfigurowanych parametrów podziału. |
|
Mcp |
Uwierzytelnianie za pomocą zapisanych nagłówków HTTP. |
|
Mcp |
Parametry uwierzytelniania zapisanych nagłówków. |
|
Mcp |
Reprezentuje pojedyncze narzędzie w źródle wiedzy serwera MCP. |
| Prefer |
W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia. |
|
Remote |
Konfiguracja zdalnego źródła wiedzy programu SharePoint. |
|
Remote |
Parametry zdalnego źródła wiedzy programu SharePoint. |
|
Search |
Czyści właściwość tożsamości źródła danych. |
|
Search |
Określa tożsamość źródła danych do użycia. |
|
Search |
Referencja polowa dla indeksu wyszukiwania. |
|
Search |
Źródło wiedzy przeznaczone dla indeksu wyszukiwania. |
|
Search |
Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy. |
|
Search |
Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola. |
|
Search |
Podpojka identyfikująca pole i reprezentatywne wartości, którą planista zapytań może wykorzystać podczas tworzenia filtra. |
|
Search |
Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu. |
|
Search |
Parametry źródła wiedzy indeksu wyszukiwania. |
|
Search |
Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania. |
|
Search |
Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów. |
|
Split |
Kody języków obsługiwane dla tekstu wejściowego przez SplitSkill. |
|
Text |
Wartość wskazująca tryb podziału do wykonania. |
|
Vector |
Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania. |
|
Web |
Źródło wiedzy kierowane na wyniki w internecie. |
|
Web |
Konfiguracja domeny źródła wiedzy sieci Web. |
|
Web |
Konfiguracja zezwalania/blokowania domeny dla internetowego źródła wiedzy. |
|
Web |
Parametry źródła wiedzy internetowej. |
|
Work |
Konfiguracja dla źródła wiedzy WorkIQ. |
|
Work |
Parametry dla źródła wiedzy o WorkIQ. |
Accept
Nagłówek Accept.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Parametry dla usług AI.
| Nazwa | Typ | Opis |
|---|---|---|
| apiKey |
string |
Klucz interfejsu API służący do uzyskiwania dostępu do usług AI. |
| uri |
string (uri) |
Identyfikator URI punktu końcowego usług AI. |
AssetStore
Konfiguracja magazynu zasobów używanego do przechowywania wyodrębnionych zasobów, takich jak obrazy.
| Nazwa | Typ | Opis |
|---|---|---|
| connectionString |
string |
Ciąg parametry połączenia dla magazynu zasobów. |
| containerName |
string |
Nazwa kontenera blob w magazynie zasobów, gdzie przechowywane są wyodrębnione zasoby (na przykład obrazy). |
AzureBlobKnowledgeSource
Konfiguracja źródła wiedzy Azure Blob Storage.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| azureBlobParameters |
Typ źródła wiedzy. |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
azure |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
AzureBlobKnowledgeSourceParameters
Parametry źródła wiedzy Azure Blob Storage.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| connectionString |
string |
Parametry połączenia oparte na kluczach lub format ResourceId w przypadku korzystania z tożsamości zarządzanej. |
|
| containerName |
string |
Nazwa kontenera przechowywania blobów. |
|
| createdResources |
object |
Zasoby utworzone przez źródło wiedzy. |
|
| folderPath |
string |
Opcjonalna ścieżka folderu w kontenerze. |
|
| ingestionParameters |
Konsoliduje wszystkie ogólne ustawienia pozyskiwania. |
||
| isADLSGen2 |
boolean |
False |
Ustaw wartość true w przypadku nawiązywania połączenia z kontem magazynu usługi ADLS Gen2. Wartość domyślna to „false”. |
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy opartego na indeksach. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
AzureOpenAIModelName
Nazwa modelu Azure Open AI, który zostanie wywołany.
| Wartość | Opis |
|---|---|
| text-embedding-ada-002 |
Model TextEmbeddingAda002. |
| text-embedding-3-large |
TextEmbedding3Large model. |
| text-embedding-3-small |
Model TextEmbedding3Small. |
| gpt-4o |
Model Gpt4o. |
| gpt-4o-mini |
Model Gpt4oMini. |
| gpt-4.1 |
Model Gpt41. |
| gpt-4.1-mini |
Model Gpt41Mini. |
| gpt-4.1-nano |
Model Gpt41Nano. |
| gpt-5 |
Model GPT5. |
| gpt-5-mini |
Model Gpt5Mini. |
| gpt-5-nano |
Model Gpt5Nano. |
| gpt-5.1 |
Model Gpt51. |
| gpt-5.2 |
Model Gpt52. |
| gpt-5.4 |
Model Gpt54. |
| gpt-5.4-mini |
Model Gpt54Mini. |
| gpt-5.4-nano |
Model Gpt54Nano. |
| gpt-5.5 |
Model Gpt55. |
| gpt-5.6-sol |
Model Gpt56Sol. |
| gpt-5.6-terra |
Model Gpt56Terra. |
| gpt-5.6-luna |
Model Gpt56Luna. |
AzureOpenAIVectorizerParameters
Określa parametry nawiązywania połączenia z zasobem usługi Azure OpenAI.
| Nazwa | Typ | Opis |
|---|---|---|
| apiKey |
string |
Klucz interfejsu API wyznaczonego zasobu usługi Azure OpenAI. |
| authIdentity | SearchIndexerDataIdentity: |
Tożsamość zarządzana przypisana przez użytkownika używana na potrzeby połączeń wychodzących. |
| deploymentId |
string |
Identyfikator wdrożenia modelu Usługi Azure OpenAI w wyznaczonym zasobie. |
| modelName |
Nazwa modelu osadzania wdrożonego w podanej ścieżce deploymentId. |
|
| resourceUri |
string (uri) |
Identyfikator URI zasobu usługi Azure OpenAI. |
ContentColumnMapping
Mapuje kolumnę SQL na pole indeksu wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola indeksu docelowego. |
| searchFieldType |
string |
Wyszukiwanie AI platformy Azure field type (np. Edm.String, Edm.Int32). |
| sourceField |
string |
Nazwa kolumny SQL. |
CorsOptions
Definiuje opcje kontrolowania współużytkowania zasobów między źródłami (CORS) dla indeksu.
| Nazwa | Typ | Opis |
|---|---|---|
| allowedOrigins |
string[] |
Lista źródeł, z których kod JavaScript będzie miał dostęp do indeksu. Może zawierać listę hostów w postaci {protocol}://{fully-qualified-domain-name}[:{port#}] lub pojedynczy znak "*", aby zezwolić na wszystkie źródła (niezalecane). |
| maxAgeInSeconds |
integer (int64) |
Czas, przez jaki przeglądarki powinny buforować odpowiedzi inspekcji wstępnej CORS. Wartość domyślna to 5 minut. |
EmbeddingColumnMapping
Mapuje kolumnę SQL na pole wektorowe do osadzania.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola wektora docelowego w indeksie wyszukiwania. |
| sourceField |
string |
Kolumna SQL używana jako wejście do generowania osadzeń. |
EntraAppAuthentication
Konfiguracja rejestracji aplikacji Microsoft Entra należącej do klienta do federacyjnej uwierzytelniania opartej na poświadczeniu na zlecenie.
| Nazwa | Typ | Opis |
|---|---|---|
| applicationId |
string (uuid) |
ID aplikacji (klienta) rejestracji aplikacji Entra należącej do klienta. |
| federatedCredentialId |
string (uuid) |
Federowany identyfikator uwierzytelniający konfigurował się podczas rejestracji aplikacji, umożliwiając usłudze wyszukiwania uwierzytelnianie się jako aplikacja bez zapisanego sekretu klienta. |
| tenantId |
string (uuid) |
Identyfikator najemcy rejestracji aplikacji. Wymagane, gdy rejestracja aplikacji jest w innym najemcy niż usługa wyszukiwania. Jeśli zostanie pominięty, używa się najemcy usługi wyszukiwania. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwa | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwa | Typ | Opis |
|---|---|---|
| additionalInfo |
Dodatkowe informacje o błędzie |
|
| code |
string |
Kod błędu. |
| details |
Szczegóły błędu. |
|
| message |
string |
Komunikat o błędzie. |
| target |
string |
Cel błędu. |
ErrorResponse
Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
| Nazwa | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
FabricDataAgentKnowledgeSource
Konfiguracja dla źródła wiedzy Fabric Data Agent.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| fabricDataAgentParameters |
Parametry źródła wiedzy Fabric Data Agent. |
|
| kind |
string:
fabric |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FabricDataAgentKnowledgeSourceParameters
Parametry dla źródła wiedzy Fabric Data Agent.
| Nazwa | Typ | Opis |
|---|---|---|
| dataAgentId |
string |
Określa, do którego agenta danych Fabric należy uruchomić. |
| workspaceId |
string |
Fabric workspace ID. |
FabricOntologyKnowledgeSource
Konfiguracja dla źródła wiedzy Fabric Ontology.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| fabricOntologyParameters |
Parametry źródła wiedzy Fabric Ontology. |
|
| kind |
string:
fabric |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FabricOntologyKnowledgeSourceParameters
Parametry dla źródła wiedzy o Fabric Ontology.
| Nazwa | Typ | Opis |
|---|---|---|
| ontologyId |
string |
ID ontologii do użycia z przestrzeni roboczej Fabric. |
| workspaceId |
string |
Identyfikator przestrzeni roboczej Fabric zawierający ontologię. |
FileKnowledgeSource
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| corsOptions |
Opcje sterowania Cross-Origin Resource Sharing (CORS) dla końcowych punktów plików źródła wiedzy plikowej (przesyłanie, listowanie, aktualizacja, usuwanie). |
|
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| fileParameters |
Parametry dla źródła wiedzy pliku. |
|
| kind |
string:
file |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
FileKnowledgeSourceParameters
Parametry dla źródła wiedzy pliku.
| Nazwa | Typ | Opis |
|---|---|---|
| createdResources |
object |
Zasoby tworzone przez źródło wiedzy pliku. |
| ingestionParameters |
Konsoliduje wszystkie ogólne ustawienia pobierania dla źródła wiedzy pliku, w tym tryb ekstrakcji treści oraz opcjonalny model embedding. |
|
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy opartego na indeksach. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
FreshnessPolicy
Konfiguracja do pobierania z uwzględnieniem świeżości. Po ustawieniu nowsze dokumenty otrzymują wzrost rankingu podczas pobierania.
| Nazwa | Typ | Opis |
|---|---|---|
| boostingDuration |
string |
Czas trwania ISO 8601 dla okna wzmacniającego świeżość (np. 'P90D' przez 90 dni). Dokumenty nowsze niż ten czas otrzymują podwyższenie podczas wyszukiwania. |
IndexedOneLakeKnowledgeSource
Konfiguracja dla źródła wiedzy OneLake.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| indexedOneLakeParameters |
Parametry źródła wiedzy. |
|
| kind |
string:
indexed |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedOneLakeKnowledgeSourceParameters
Parametry źródła wiedzy OneLake.
| Nazwa | Typ | Opis |
|---|---|---|
| createdResources |
object |
Zasoby utworzone przez źródło wiedzy. |
| fabricWorkspaceId |
string |
Identyfikator obszaru roboczego usługi OneLake. |
| ingestionParameters |
Konsoliduje wszystkie ogólne ustawienia pozyskiwania. |
|
| lakehouseId |
string |
Określa, do którego lakehouse'u OneLake chcesz uzyskać dostęp. |
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy opartego na indeksach. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
|
| targetPath |
string |
Opcjonalny folder lub skrót OneLakehouse do filtrowania zawartości OneLake. |
IndexedSharePointContainerName
Określa, do których bibliotek programu SharePoint należy uzyskać dostęp.
| Wartość | Opis |
|---|---|
| defaultSiteLibrary |
Indeksowanie zawartości z domyślnej biblioteki dokumentów witryny. |
| allSiteLibraries |
Indeksowanie zawartości z każdej biblioteki dokumentów w witrynie. |
| useQuery |
Użyj zapytania, aby filtrować zawartość SharePoint. |
IndexedSharePointKnowledgeSource
Konfiguracja źródła wiedzy programu SharePoint.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| indexedSharePointParameters |
Parametry źródła wiedzy. |
|
| kind |
string:
indexed |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedSharePointKnowledgeSourceParameters
Parametry źródła wiedzy programu SharePoint.
| Nazwa | Typ | Opis |
|---|---|---|
| connectionString |
string |
Parametry połączenia z programem SharePoint w formacie: SharePointOnlineEndpoint=[Adres URL witryny programu SharePoint]; ApplicationId=[Identyfikator aplikacji Azure AD]; ApplicationSecret=[Klucz tajny klienta aplikacji Azure AD]; TenantId=[Identyfikator dzierżawy witryny SharePoint] |
| containerName |
Określa, do których bibliotek programu SharePoint należy uzyskać dostęp. |
|
| createdResources |
object |
Zasoby utworzone przez źródło wiedzy. |
| ingestionParameters |
Konsoliduje wszystkie ogólne ustawienia pozyskiwania. |
|
| query |
string |
Opcjonalne zapytanie do filtrowania zawartości programu SharePoint. |
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy opartego na indeksach. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
IndexedSqlKnowledgeSource
Konfiguracja dla indeksowanego źródła wiedzy SQL.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| indexedSqlParameters |
Parametry źródła wiedzy SQL. |
|
| kind |
string:
indexed |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
IndexedSqlKnowledgeSourceParameters
Parametry dla indeksowanego źródła wiedzy SQL.
| Nazwa | Typ | Opis |
|---|---|---|
| connectionString |
string |
Ciąg parametry połączenia dla Azure SQL Database lub SQL Managed Instance. |
| contentColumns |
Opcjonalne mapowanie kolumn dla pól treści. Jeśli zostanie pominięty, wszystkie kolumny są automatycznie odkrywane. |
|
| createdResources |
object |
Zasoby utworzone przez źródło wiedzy. |
| embeddingColumns |
Opcjonalne odwzorowania kolumn do osadzania pól wektorowych. Jeśli zostanie pominięta, nie tworzy się żadnych pól wektorowych. |
|
| highWaterMarkColumnName |
string |
Opcjonalna nazwa kolumny do wykrywania wysokich zmian znaków wody. Jeśli jest dostępna, używa HighWaterMarkChangeDetectionPolicy. |
| ingestionParameters |
Konsoliduje wszystkie ogólne ustawienia pobierania, w tym model osadzania, harmonogram i tożsamość. |
|
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy opartego na indeksach. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
|
| tableOrView |
string |
Nazwa tabeli lub widoku do indeksowania. Może być kwalifikowany według schematu (np. 'dbo. MyTable'). |
IndexingSchedule
Reprezentuje harmonogram wykonywania indeksatora.
| Nazwa | Typ | Opis |
|---|---|---|
| interval |
string (duration) |
Interwał czasu między wykonaniami indeksatora. |
| startTime |
string (date-time) |
Czas, w którym indeksator powinien zacząć działać. |
KnowledgeBaseAzureOpenAIModel
Określa zasób usługi Azure OpenAI używany do planowania zapytań.
| Nazwa | Typ | Opis |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI parametry. |
|
| kind |
string:
azure |
Model sztucznej inteligencji, który ma być używany do planowania zapytań. |
KnowledgeBaseModelKind
Model sztucznej inteligencji, który ma być używany do planowania zapytań.
| Wartość | Opis |
|---|---|
| azureOpenAI |
Używanie modeli sztucznej inteligencji usługi Azure Open do planowania zapytań. |
KnowledgeSourceAzureOpenAIVectorizer
Określa zasób usługi Azure OpenAI używany do wektoryzacji ciągu zapytania.
| Nazwa | Typ | Opis |
|---|---|---|
| azureOpenAIParameters |
Zawiera parametry specyficzne dla wektoryzacji osadzania usługi Azure OpenAI. |
|
| kind |
string:
azure |
Nazwa rodzaju metody wektoryzacji konfigurowanej do użycia z wyszukiwaniem wektorowym. |
KnowledgeSourceIngestionParameters
Konsoliduje wszystkie ogólne ustawienia pozyskiwania dla źródeł wiedzy.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| aiServices |
Opcjonalna konfiguracja usług AI Services do przetwarzania zawartości. |
||
| assetStore |
Opcjonalna konfiguracja magazynu zasobów do przechowywania wyodrębnionych zasobów, takich jak obrazy. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Opcjonalny model uzupełniania czatu do werbalizacji obrazu lub wyodrębniania kontekstu. |
|
| contentExtractionMode |
enum:
|
minimal |
Opcjonalny tryb wyodrębniania zawartości. Wartość domyślna to "minimalny". |
| disableImageVerbalization |
boolean |
False |
Wskazuje, czy werbalizacja obrazu powinna być wyłączona. Wartość domyślna to „false”. |
| embeddingModel | KnowledgeSourceVectorizer: |
Opcjonalna konfiguracja wektoryzatora do wektoryzacji zawartości. |
|
| freshnessPolicy |
Opcjonalna polityka świeżości w celu skłaniania wyszukiwania do nowszych dokumentów. |
||
| identity | SearchIndexerDataIdentity: |
Jawna tożsamość do użycia dla tego źródła wiedzy. |
|
| ingestionPermissionOptions |
Opcjonalna lista typów uprawnień do pozyskiwania wraz z zawartością dokumentu. Jeśli zostanie określony, ustawi opcje uprawnień indeksatora dla źródła danych. |
||
| ingestionSchedule |
Opcjonalny harmonogram pozyskiwania danych. |
||
| networkAccessMode | public |
Opcjonalny tryb dostępu sieciowego do pobierania danych. Ustaw na "prywatne", aby uruchamiać pobieranie w prywatnym środowisku wykonawczym, które może dotrzeć do źródeł danych i zależności przez sieć prywatną. Domyślnie jest 'publiczne'. Jest to ustawienie w czasie tworzenia i nie można go zmienić po utworzeniu źródła wiedzy. |
KnowledgeSourceIngestionPermissionOption
Rodzaje uprawnień do pobierania razem z treścią dokumentu.
| Wartość | Opis |
|---|---|
| userIds |
Pozyskiwanie jawnych identyfikatorów użytkowników wraz z zawartością dokumentu. |
| groupIds |
Pozyskiwanie identyfikatorów grup wraz z zawartością dokumentu. |
| rbacScope |
Pozyskiwanie informacji o zakresie RBAC wraz z zawartością dokumentu. |
| sensitivityLabels |
Pobieraj etykiety wrażliwości Microsoft Purview obok treści dokumentu. |
KnowledgeSourceKind
Rodzaj źródła wiedzy.
| Wartość | Opis |
|---|---|
| searchIndex |
Źródło wiedzy, które odczytuje dane z indeksu wyszukiwania. |
| azureBlob |
Źródło wiedzy, które odczytuje i pozyskuje dane z Azure Blob Storage do indeksu wyszukiwania. |
| indexedSharePoint |
Źródło wiedzy odczytujące dane z indeksowanego SharePoint. |
| indexedOneLake |
Źródło wiedzy odczytujące dane z indeksowanego OneLake. |
| indexedSql |
Źródło wiedzy, które pobiera i przetwarza dane z Azure SQL Database lub SQL Managed Instance do indeksu wyszukiwania. |
| web |
Źródło wiedzy, które odczytuje dane z internetu. |
| remoteSharePoint |
Źródło wiedzy, które odczytuje dane ze zdalnego SharePoint. |
| workIQ |
Źródło wiedzy, które odczytuje dane z IQ pracy |
| file |
Źródło wiedzy wspierające bezpośredni przesyłanie i indeksowanie plików. |
| mcpServer |
Źródło wiedzy wspierane przez serwer MCP (Model Context Protocol). |
| fabricDataAgent |
Źródło wiedzy pobierające dane z agenta danych Fabric. |
| fabricOntology |
Źródło wiedzy pozyskujące dane z ontologii ontologii Microsoft Fabric. |
KnowledgeSourceNetworkAccessMode
Określa tryb dostępu sieciowego do pobierania źródeł danych. Domyślnie jest 'publiczne'.
| Wartość | Opis |
|---|---|
| public |
Ingestion działa w standardowym, publicznie dostępnym środowisku wykonawczym. Jest to opcja domyślna. |
| private |
Ingestion działa w prywatnym środowisku wykonawczym, dzięki czemu może docierać do źródeł danych i zależności przez sieć prywatną (prywatny punkt końcowy / wspólne połączenie prywatne). |
KnowledgeSourceResultsProcessing
Kontroluje, czy wyniki źródła wiedzy zostaną ponownie uszeregowane.
| Wartość | Opis |
|---|---|
| rerank |
Wyniki z tego źródła wiedzy przechodzą przez proces rerankingu. Jest to zachowanie domyślne. |
| none |
Wyniki tego źródła wiedzy omijają ponowne rankingi i zachowują ich pierwotny porządek. |
McpServerAuthenticationKind
Taki rodzaj uwierzytelniania dla serwera MCP.
| Wartość | Opis |
|---|---|
| foundryConnection |
Uwierzytelnij za pomocą połączenia Azure AI Foundry. |
| storedHeaders |
Uwierzytelniaj się za pomocą zapisanych nagłówków HTTP. |
McpServerAutoOutputParsing
Automatycznie wykrywaj format wyjściowy i analizuj odpowiednio.
| Nazwa | Typ | Opis |
|---|---|---|
| kind |
string:
auto |
Taki rodzaj parsowania wyniku, który należy zastosować. |
McpServerFoundryConnectionAuthentication
Uwierzytelnianie za pomocą połączenia Azure AI Foundry.
| Nazwa | Typ | Opis |
|---|---|---|
| foundryConnectionParameters |
Parametry uwierzytelniania połączenia z Foundry. |
|
| kind |
string:
foundry |
Rodzaj uwierzytelniania, którego warto użyć. |
McpServerFoundryConnectionParameters
Parametry uwierzytelniania połączenia z Foundry.
| Nazwa | Typ | Opis |
|---|---|---|
| connectionId |
string |
Identyfikator połączenia Azure AI Foundry. |
McpServerJsonOutputParsing
Analizuj wynik jako dokument JSON, używając skonfigurowanych parametrów JSON.
| Nazwa | Typ | Opis |
|---|---|---|
| jsonParameters |
Parametry parsowania wyjściowego JSON. Wymagane, gdy rodzaj to 'json'. |
|
| kind |
string:
json |
Taki rodzaj parsowania wyniku, który należy zastosować. |
McpServerKnowledgeSource
Konfiguracja dla źródła wiedzy wspieranego przez serwer MCP (Model Context Protocol).
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
mcp |
Typ źródła wiedzy. |
| mcpServerParameters |
Parametry źródła wiedzy serwera MCP. |
|
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
McpServerKnowledgeSourceParameters
Parametry dla źródła wiedzy serwera MCP.
| Nazwa | Typ | Opis |
|---|---|---|
| authentication | McpServerAuthentication: |
Konfiguracja uwierzytelniania dla serwera MCP. |
| serverURL |
string |
URL punktu końcowego serwera MCP. |
| tools |
Lista narzędzi do wywołania na serwerze MCP. |
McpServerNoneOutputParsing
Traktuj wyjście jako pojedynczy blok bez żadnego parsowania.
| Nazwa | Typ | Opis |
|---|---|---|
| kind |
string:
none |
Taki rodzaj parsowania wyniku, który należy zastosować. |
McpServerOutputParsingJsonParameters
Parametry parsowania wyjściowego JSON.
| Nazwa | Typ | Opis |
|---|---|---|
| documentsPath |
string |
Ścieżka JSON do tablicy dokumentów w wyjściu narzędzia. |
| includeContext |
boolean |
Czy uwzględnić kontekst z wydanych danych JSON obok wyodrębnionych dokumentów. |
McpServerOutputParsingKind
Taki rodzaj parsowania wyników dla narzędzia serwera MCP.
| Wartość | Opis |
|---|---|
| auto |
Automatycznie wykrywaj format wyjściowy i analizuj odpowiednio. |
| json |
Analizuj wynik jako dokument JSON, używając skonfigurowanych parametrów JSON. |
| split |
Podziel wyjście na strony za pomocą skonfigurowanych parametrów podziału. |
| none |
Traktuj wyjście jako pojedynczy blok bez żadnego parsowania. |
McpServerOutputParsingSplitParameters
Parametry do parsowania wyjścia podzielonego.
| Nazwa | Typ | Opis |
|---|---|---|
| defaultLanguageCode |
Wartość wskazująca, który kod języka ma być używany. Wartość domyślna to |
|
| maximumPageLength |
integer (int32) |
Maksymalna liczba znaków na stronie. |
| maximumPagesToTake |
integer (int32) |
Maksymalna liczba stron, które należy pobrać z wydruku. |
| pageOverlapLength |
integer (int32) |
Liczba znaków, które nakładają się na strony. |
| textSplitMode |
Tryb podziału tekstu do użycia. |
McpServerSplitOutputParsing
Podziel wyjście na strony za pomocą skonfigurowanych parametrów podziału.
| Nazwa | Typ | Opis |
|---|---|---|
| kind |
string:
split |
Taki rodzaj parsowania wyniku, który należy zastosować. |
| splitParameters |
Parametry do parsowania wyjścia podzielonego. |
McpServerStoredHeadersAuthentication
Uwierzytelnianie za pomocą zapisanych nagłówków HTTP.
| Nazwa | Typ | Opis |
|---|---|---|
| kind |
string:
stored |
Rodzaj uwierzytelniania, którego warto użyć. |
| storedHeadersParameters |
Parametry uwierzytelniania zapisanych nagłówków. |
McpServerStoredHeadersParameters
Parametry uwierzytelniania zapisanych nagłówków.
| Nazwa | Typ | Opis |
|---|---|---|
| headers |
object |
Przechowywane nagłówki HTTP do uwzględnienia w żądaniach serwera MCP. |
McpServerTool
Reprezentuje pojedyncze narzędzie w źródle wiedzy serwera MCP.
| Nazwa | Typ | Opis |
|---|---|---|
| maxOutputTokens |
integer (int32) |
Opcjonalny limit tokenów po parsowaniu dla wyjścia tego narzędzia. Musi być większa niż 0, gdy jest to zaznaczone. |
| name |
string |
Nazwa narzędzia MCP do wywołania. |
| outputParsing | McpServerOutputParsing: |
Opcjonalna konfiguracja do parsowania wyników narzędzia. |
| resultsProcessing |
Kontroluje, czy wyniki parsowane z tego narzędzia są ponownie rangowane. Domyślnie zmienia ranking, gdy nie jest to określone. |
Prefer
W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.
| Wartość | Opis |
|---|---|
| return=representation |
RemoteSharePointKnowledgeSource
Konfiguracja zdalnego źródła wiedzy programu SharePoint.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
remote |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| remoteSharePointParameters |
Parametry zdalnego źródła wiedzy SharePoint. |
|
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
RemoteSharePointKnowledgeSourceParameters
Parametry zdalnego źródła wiedzy programu SharePoint.
| Nazwa | Typ | Opis |
|---|---|---|
| containerTypeId |
string |
Identyfikator kontenera dla połączenia z systemem SharePoint Embedded. Jeśli ta wartość ma wartość null, będzie używać usługi SharePoint Online. |
| filterExpression |
string |
Wyrażenie języka KQL (Keyword Query Language) z właściwościami i atrybutami programu SharePoint z możliwością wykonywania zapytań w celu określenia zakresu pobierania przed uruchomieniem zapytania. |
| resourceMetadata |
string[] |
Lista pól metadanych, które mają zostać zwrócone dla każdego elementu w odpowiedzi. Na tej liście można uwzględnić tylko właściwości metadanych, które można pobrać. Domyślnie nie są zwracane żadne metadane. |
SearchIndexerDataNoneIdentity
Czyści właściwość tożsamości źródła danych.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragment identyfikatora URI określający typ tożsamości. |
SearchIndexerDataUserAssignedIdentity
Określa tożsamość źródła danych do użycia.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Fragment identyfikatora URI określający typ tożsamości. |
| federatedIdentityClientId |
string |
Wsparcie tożsamości zarządzanej User-Assigned wielodzierżawcowej: identyfikator klienta aplikacji wielonamiętnej, skonfigurowanej do federacji z przypisaną przez użytkownika tożsamością zarządzaną. |
| userAssignedIdentity |
string |
W pełni kwalifikowany identyfikator zasobu platformy Azure przypisanej przez użytkownika tożsamości zarządzanej zazwyczaj w postaci "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", który powinien zostać przypisany do usługi wyszukiwania. |
SearchIndexFieldReference
Referencja polowa dla indeksu wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola. |
SearchIndexKnowledgeSource
Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
search |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
|
| searchIndexParameters |
Parametry źródła wiedzy. |
SearchIndexKnowledgeSourceBoostKind
Taki rodzaj podpowiedzi do indeksu wyszukiwania jako źródło wiedzy.
| Wartość | Opis |
|---|---|
| fieldValue |
Ulepszaj dokumenty na podstawie wartości pola. |
| multiWordExpression |
Ulepszaj dokumenty oparte na wielowyrazowym wyrażeniu. |
SearchIndexKnowledgeSourceFieldValueBoost
Wskazówka, która zwiększa liczbę dokumentów na podstawie wartości pola.
| Nazwa | Typ | Opis |
|---|---|---|
| boost |
number (double) |
Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0. |
| boostInstructions |
string |
Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost. |
| field |
string minLength: 1 |
Nazwa pola indeksu wyszukiwania. |
| fieldValues |
string[] |
Reprezentatywne wartości dla tej dziedziny. |
| kind |
string:
field |
Taka wskazówka do boostu. |
SearchIndexKnowledgeSourceFilterHint
Podpojka identyfikująca pole i reprezentatywne wartości, którą planista zapytań może wykorzystać podczas tworzenia filtra.
| Nazwa | Typ | Opis |
|---|---|---|
| field |
string minLength: 1 |
Nazwa filtrowalnego pola indeksu wyszukiwania. |
| fieldValues |
string[] |
Reprezentatywne wartości dla tej dziedziny. |
| filterInstructions |
string |
Instrukcje w języku naturalnym, które wyjaśniają, kiedy i jak filtrować na polu. |
SearchIndexKnowledgeSourceMultiWordExpressionBoost
Wskazówka, która wzmacnia dokumenty oparte na wielowyrazowym wyrażeniu.
| Nazwa | Typ | Opis |
|---|---|---|
| boost |
number (double) |
Mnożnik dla wyniku dokumentu. Musi być liczbą dodatnią, która nie jest równa 1,0. |
| boostInstructions |
string |
Instrukcje w naturalnym języku, które wyjaśniają, kiedy i jak zastosować boost. |
| fieldValues |
string[] |
Reprezentatywne wartości dla boostu. |
| kind |
string:
multi |
Taka wskazówka do boostu. |
SearchIndexKnowledgeSourceParameters
Parametry źródła wiedzy indeksu wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| baseFilter |
string |
Domyślny warunek filtra stosowany do indeksu w czasie pobierania (np. 'Stan eq VA'). Można je nadpisać w czasie zapytań za pomocą parametrów wykonawczych źródła wiedzy. |
| queryHints |
Domyślne wskazówki, które kierują planowaniem zapytań w kierunku przydatnych filtrów i wzmocnień dla tego źródła wiedzy indeksu wyszukiwania. Wskazówki zapytania w czasie żądania zastępują te domyślne jako kompletny obiekt. |
|
| searchFields |
Służy do ograniczania pól do przeszukania w indeksie wyszukiwania. |
|
| searchIndexName |
string |
Nazwa indeksu wyszukiwania. |
| semanticConfigurationName |
string |
Służy do określania innej konfiguracji semantycznej w docelowym indeksie wyszukiwania innej niż domyślna. |
| sourceDataFields |
Służy do żądania dodatkowych pól dla danych źródłowych, do których się odwołuje. |
SearchIndexKnowledgeSourceQueryHints
Wskazówki, które prowadzą planowanie zapytań do przydatnych filtrów i wzmocnień dla źródła wiedzy indeksu wyszukiwania.
| Nazwa | Typ | Opis |
|---|---|---|
| boosts | SearchIndexKnowledgeSourceBoost[]: |
Wzmacniaj wskazówki, które identyfikują warunki, które planista zapytań może wykorzystać, aby wpłynąć na pozycję dokumentu. |
| filters |
Podpowiedzi filtrujące identyfikujące pola i reprezentatywne wartości, których planer zapytań może używać podczas tworzenia filtrów. |
SearchResourceEncryptionKey
Klucz szyfrowania zarządzany przez klienta w usłudze Azure Key Vault. Klucze, które tworzysz i którymi zarządzasz, mogą służyć do szyfrowania lub odszyfrowywania danych magazynowanych, takich jak indeksy i mapy synonimów.
| Nazwa | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| accessCredentials.applicationId |
string |
Identyfikator aplikacji usługi AAD, któremu udzielono wymaganych uprawnień dostępu do usługi Azure Key Vault, która ma być używana podczas szyfrowania danych magazynowanych. Identyfikator aplikacji nie powinien być mylony z identyfikatorem obiektu aplikacji usługi AAD. |
|
| accessCredentials.applicationSecret |
string |
Klucz uwierzytelniania określonej aplikacji usługi AAD. |
|
| identity | SearchIndexerDataIdentity: |
Jawna tożsamość zarządzana używana dla tego klucza szyfrowania. Jeśli nie zostanie określona, a właściwość poświadczeń dostępu ma wartość null, zostanie użyta tożsamość zarządzana przypisana przez system. Po zaktualizowaniu zasobu, jeśli tożsamość jawna jest nieokreślona, pozostaje niezmieniona. Jeśli określono wartość "none", wartość tej właściwości zostanie wyczyszczone. |
|
| isServiceLevelKey |
boolean |
False |
Opcjonalna wartość wskazująca, czy ten klucz jest kluczem poziomu usługi. Wartość domyślna to „false”. |
| keyVaultKeyName |
string |
Nazwa klucza usługi Azure Key Vault, który ma być używany do szyfrowania danych magazynowanych. |
|
| keyVaultKeyVersion |
string |
Wersja klucza usługi Azure Key Vault, która ma być używana do szyfrowania danych magazynowanych. |
|
| keyVaultUri |
string |
Identyfikator URI usługi Azure Key Vault, nazywany również nazwą DNS, który zawiera klucz używany do szyfrowania danych magazynowanych. Przykładowy identyfikator URI może być |
SplitSkillLanguage
Kody języków obsługiwane dla tekstu wejściowego przez SplitSkill.
| Wartość | Opis |
|---|---|
| am |
Amharski |
| bs |
Bośniacki |
| cs |
Czeski |
| da |
Duński |
| de |
Niemiecki |
| en |
angielski |
| es |
Hiszpański |
| et |
Estoński |
| fi |
Fiński |
| fr |
Francuski |
| he |
Hebrajski |
| hi |
Język hindi |
| hr |
Chorwacki |
| hu |
Węgierski |
| id |
Indonesian |
| is |
Islandzki |
| it |
Włoski |
| ja |
Japoński |
| ko |
Koreański |
| lv |
Łotewski |
| nb |
Norweski |
| nl |
Niderlandzki |
| pl |
Polski |
| pt |
Język portugalski (Portugalia) |
| pt-br |
portugalski (Brazylia) |
| ru |
Rosyjski |
| sk |
Słowacki |
| sl |
Słoweński |
| sr |
Serbski |
| sv |
Szwedzki |
| tr |
Turecki |
| ur |
język urdu |
| zh |
Chiński (uproszczony) |
TextSplitMode
Wartość wskazująca tryb podziału do wykonania.
| Wartość | Opis |
|---|---|
| pages |
Podziel tekst na poszczególne strony. |
| sentences |
Podziel tekst na poszczególne zdania. |
VectorSearchVectorizerKind
Metoda wektoryzacji, która ma być używana w czasie wykonywania zapytania.
| Wartość | Opis |
|---|---|
| azureOpenAI |
Generowanie osadzania przy użyciu zasobu usługi Azure OpenAI w czasie wykonywania zapytania. |
| customWebApi |
Generowanie osadzania przy użyciu niestandardowego internetowego punktu końcowego w czasie wykonywania zapytań. |
| aiServicesVision |
Generuj osadzanie dla obrazu lub tekstu wejściowego w czasie wykonywania zapytania przy użyciu interfejsu API przetwarzania obrazów usług Azure AI Services Vision Vectorize. |
| aml |
Generowanie osadzania przy użyciu punktu końcowego usługi Azure Machine Learning wdrożonego za pośrednictwem wykazu modeli usługi Azure AI Foundry w czasie wykonywania zapytania. |
WebKnowledgeSource
Źródło wiedzy kierowane na wyniki w internecie.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
web |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
|
| webParameters |
Parametry internetowego źródła wiedzy. |
WebKnowledgeSourceDomain
Konfiguracja domeny źródła wiedzy sieci Web.
| Nazwa | Typ | Opis |
|---|---|---|
| address |
string |
Adres domeny. |
| includeSubpages |
boolean |
Czy uwzględnić podstrony z tej domeny, czy nie. |
WebKnowledgeSourceDomains
Konfiguracja zezwalania/blokowania domeny dla internetowego źródła wiedzy.
| Nazwa | Typ | Opis |
|---|---|---|
| allowedDomains |
Domeny dozwolone dla wyników internetowych. |
|
| blockedDomains |
Domeny zablokowane w wynikach wyszukiwania w sieci. |
WebKnowledgeSourceParameters
Parametry źródła wiedzy internetowej.
| Nazwa | Typ | Opis |
|---|---|---|
| count |
integer (int32) |
Domyślna liczba wyników internetowych do zwrócenia. Można je nadpisać w czasie zapytań za pomocą parametrów wykonawczych źródła wiedzy. |
| domains |
Konfiguracja zezwalania/blokowania domeny dla wyników internetowych. |
|
| freshness |
string |
Domyślny filtr świeżości wyników internetowych. Można je nadpisać w czasie zapytań za pomocą parametrów wykonawczych źródła wiedzy. |
| language |
string |
Domyślny język wyników internetowych. Można je nadpisać w czasie zapytań za pomocą parametrów wykonawczych źródła wiedzy. |
| market |
string |
Domyślny rynek wyników internetowych. Można je nadpisać w czasie zapytań za pomocą parametrów wykonawczych źródła wiedzy. |
WorkIQKnowledgeSource
Konfiguracja dla źródła wiedzy WorkIQ.
| Nazwa | Typ | Opis |
|---|---|---|
| @odata.etag |
string |
ETag źródła wiedzy. |
| description |
string |
Opcjonalny opis zdefiniowany przez użytkownika. |
| encryptionKey |
Opis klucza szyfrowania utworzonego w usłudze Azure Key Vault. Ten klucz służy do zapewnienia dodatkowego poziomu szyfrowania w spoczynku dla definicji źródła wiedzy, gdy chcesz mieć pełną pewność, że nikt, nawet Microsoft, nie jest w stanie go odszyfrować. Gdy już zaszyfrujesz definicję źródła wiedzy, zawsze pozostanie ona zaszyfrowana. Usługa wyszukiwania zignoruje próby ustawienia tej właściwości na wartość null. Możesz zmienić tę właściwość w razie potrzeby, jeśli chcesz obracać klucz szyfrujący; Definicja źródła wiedzy nie zostanie zmieniona. Szyfrowanie za pomocą kluczy zarządzanych przez klienta nie jest dostępne dla bezpłatnych usług wyszukiwania i jest dostępne tylko dla płatnych usług utworzonych w dniu 1 stycznia 2019 r. lub po 1 stycznia 2019 r. |
|
| kind |
string:
workIQ |
Typ źródła wiedzy. |
| name |
string |
Nazwa źródła wiedzy. |
| resultsProcessing |
Kontroluje, czy wyniki z tego źródła wiedzy zostaną ponownie ocenione, zanim zostaną uwzględnione w ostatecznym zestawie wyników. Domyślnie zmienia ranking, gdy nie jest to określone. |
|
| workIQParameters |
Parametry dla źródła wiedzy WorkIQ, w tym konfiguracja aplikacji Entra należąca do klienta, używana do uwierzytelniania w imieniu użytkownika. |
WorkIQKnowledgeSourceParameters
Parametry dla źródła wiedzy o WorkIQ.
| Nazwa | Typ | Opis |
|---|---|---|
| entraAppAuthentication |
Konfiguracja rejestracji aplikacji Microsoft Entra należąca do klienta służyła do uwierzytelniania w imieniu użytkownika do API Work IQ. Klient rejestruje aplikację Entra należącą do dzierżawicy, nadaje jej uprawnienia WorkIQAgent.Ask oraz konfiguruje federowane dane uwierzytelniające tak, aby Wyszukiwanie AI platformy Azure mogło uwierzytelnić się jako ta aplikacja bez zapisanego sekretu klienta. |