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-10-01
Parametry identyfikatora URI
| Nazwisko | 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
| Nazwisko | Wymagane | Typ | Opis |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania. |
|
| 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. |
Treść żądania
Treść żądania może być jedną z następujących:
| Nazwisko | Opis |
|---|---|
|
Azure |
Konfiguracja źródła wiedzy Azure Blob Storage. |
|
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. |
|
Search |
Źródło wiedzy przeznaczone dla indeksu wyszukiwania. |
|
Web |
Źródło wiedzy kierowane na wyniki w internecie. |
AzureBlobKnowledgeSource
Konfiguracja źródła wiedzy Azure Blob Storage.
| Nazwisko | 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. |
FileKnowledgeSource
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików.
| Nazwisko | 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. |
IndexedOneLakeKnowledgeSource
Konfiguracja dla źródła wiedzy OneLake.
| Nazwisko | 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. |
IndexedSharePointKnowledgeSource
Konfiguracja źródła wiedzy programu SharePoint.
| Nazwisko | 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. |
IndexedSqlKnowledgeSource
Konfiguracja dla indeksowanego źródła wiedzy SQL.
| Nazwisko | 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. |
SearchIndexKnowledgeSource
Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
| Nazwisko | 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. |
WebKnowledgeSource
Źródło wiedzy kierowane na wyniki w internecie.
| Nazwisko | 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. |
||
| webParameters |
Parametry internetowego źródła wiedzy. |
Odpowiedzi
| Nazwisko | 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
| Nazwisko | Opis |
|---|---|
| https://search.azure.com/.default |
Przykłady
SearchServiceCreateOrUpdateKnowledgeSource
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-test",
"description": "Description of the knowledge source.",
"kind": "searchIndex",
"@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": "stable-test",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'"
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "stable-test",
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
]
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "searchIndex",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"searchIndexParameters": {
"searchIndexName": "stable-test",
"semanticConfigurationName": "testconfig",
"baseFilter": "category eq 'news'",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
]
}
}
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-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-5-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"
}
}
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "azureBlob",
"description": "Description of the knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceFile
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-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-5-mini"
}
},
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-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-5-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"index": "ks-stable-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-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-5-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"index": "ks-stable-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-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-5-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"
}
}
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedOneLake",
"description": "Description of the OneLake knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedOneLake",
"description": "Description of the OneLake knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-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-5-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"
}
}
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSharePoint",
"description": "Description of the SharePoint knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSharePoint",
"description": "Description of the SharePoint knowledge source.",
"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": {
"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-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql
Przykładowe żądanie
PUT https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
{
"name": "ks-stable-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"
}
}
}
Przykładowa odpowiedź
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSql",
"description": "Description of the SQL knowledge source.",
"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": {
"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"
}
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "indexedSql",
"description": "Description of the SQL knowledge source.",
"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": {
"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"
}
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceWeb
Przykładowe żądanie
PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-10-01
{
"webParameters": {
"domains": {
"allowedDomains": [
{
"address": "example.com",
"includeSubpages": true
},
{
"address": "another-example.com"
}
],
"blockedDomains": [
{
"address": "blocked.com"
},
{
"address": "spam.com",
"includeSubpages": true
}
]
},
"language": "en",
"market": "en-US",
"count": 10,
"freshness": "Week"
},
"name": "ks-example-index",
"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-example-index",
"kind": "web",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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
}
]
},
"language": "en",
"market": "en-US",
"count": 10,
"freshness": "Week"
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-example-index",
"kind": "web",
"description": "Description of the knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"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
}
]
},
"language": "en",
"market": "en-US",
"count": 10,
"freshness": "Week"
}
}
Definicje
| Nazwisko | Opis |
|---|---|
| Accept |
Nagłówek „Accept”. |
| AIServices |
Parametry dla usług AI. |
|
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. |
|
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). |
|
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. |
|
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'. |
| Prefer |
W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia. |
|
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 |
Parametry ź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. |
|
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. |
Accept
Nagłówek „Accept”.
| Wartość | Opis |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Parametry dla usług AI.
| Nazwisko | 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. |
AzureBlobKnowledgeSource
Konfiguracja źródła wiedzy Azure Blob Storage.
| Nazwisko | 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. |
AzureBlobKnowledgeSourceParameters
Parametry źródła wiedzy Azure Blob Storage.
| Nazwisko | 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”. |
AzureOpenAIModelName
Nazwa modelu Azure Open AI, który zostanie wywołany.
| Wartość | Opis |
|---|---|
| text-embedding-ada-002 |
Model TextEmbeddingAda002. |
| text-embedding-3-large |
Model TextEmbedding3Large. |
| text-embedding-3-small |
Model TextEmbedding3Small. |
| gpt-5-mini |
Model Gpt5Mini. |
| gpt-5-nano |
Model Gpt5Nano. |
| 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.
| Nazwisko | 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.
| Nazwisko | 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.
| Nazwisko | 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.
| Nazwisko | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola wektora docelowego w indeksie wyszukiwania. |
| sourceField |
string |
Kolumna SQL używana jako wejście do generowania osadzeń. |
ErrorAdditionalInfo
Dodatkowe informacje o błędzie zarządzania zasobami.
| Nazwisko | Typ | Opis |
|---|---|---|
| info |
Dodatkowe informacje. |
|
| type |
string |
Dodatkowy typ informacji. |
ErrorDetail
Szczegóły błędu.
| Nazwisko | 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).
| Nazwisko | Typ | Opis |
|---|---|---|
| error |
Obiekt błędu. |
FileKnowledgeSource
Konfiguracja dla źródła wiedzy plików, które obsługuje bezpośredni upload i indeksowanie plików.
| Nazwisko | 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. |
FileKnowledgeSourceParameters
Parametry dla źródła wiedzy pliku.
| Nazwisko | 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. |
IndexedOneLakeKnowledgeSource
Konfiguracja dla źródła wiedzy OneLake.
| Nazwisko | 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. |
IndexedOneLakeKnowledgeSourceParameters
Parametry źródła wiedzy OneLake.
| Nazwisko | 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. |
| 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. |
| allSiteLists |
Indeksuj zawartość ze wszystkich list na stronie. |
| allSitePages |
Indeksuj zawartość ze wszystkich stron witryny. |
| allSiteContent |
Indeksuj zawartość ze wszystkich obsługiwanych bibliotek, list i stron w witrynie. |
IndexedSharePointKnowledgeSource
Konfiguracja źródła wiedzy programu SharePoint.
| Nazwisko | 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. |
IndexedSharePointKnowledgeSourceParameters
Parametry źródła wiedzy programu SharePoint.
| Nazwisko | 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. |
IndexedSqlKnowledgeSource
Konfiguracja dla indeksowanego źródła wiedzy SQL.
| Nazwisko | 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. |
IndexedSqlKnowledgeSourceParameters
Parametry dla indeksowanego źródła wiedzy SQL.
| Nazwisko | 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ść. |
|
| tableOrView |
string |
Nazwa tabeli lub widoku do indeksowania. Może być kwalifikowany według schematu (np. 'dbo. MyTable'). |
IndexingSchedule
Reprezentuje harmonogram wykonywania indeksatora.
| Nazwisko | 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ń.
| Nazwisko | 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.
| Nazwisko | 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.
| Nazwisko | Typ | Domyślna wartość | Opis |
|---|---|---|---|
| aiServices |
Opcjonalna konfiguracja usług AI Services do przetwarzania zawartości. |
||
| 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. |
|
| 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. |
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. |
| file |
Źródło wiedzy wspierające bezpośredni przesyłanie i indeksowanie plików. |
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). |
Prefer
W przypadku żądań HTTP PUT instruuje usługę, aby zwróciła utworzony/zaktualizowany zasób w przypadku powodzenia.
| Wartość | Opis |
|---|---|
| return=representation |
SearchIndexerDataNoneIdentity
Czyści właściwość tożsamości źródła danych.
| Nazwisko | 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.
| Nazwisko | 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.
| Nazwisko | Typ | Opis |
|---|---|---|
| name |
string |
Nazwa pola. |
SearchIndexKnowledgeSource
Źródło wiedzy przeznaczone dla indeksu wyszukiwania.
| Nazwisko | 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. |
| searchIndexParameters |
Parametry źródła wiedzy. |
SearchIndexKnowledgeSourceParameters
Parametry źródła wiedzy indeksu wyszukiwania.
| Nazwisko | 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. |
| 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. |
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.
| Nazwisko | Typ | 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. |
| 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ć |
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.
| Nazwisko | 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. |
| webParameters |
Parametry internetowego źródła wiedzy. |
WebKnowledgeSourceDomain
Konfiguracja domeny źródła wiedzy sieci Web.
| Nazwisko | 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.
| Nazwisko | Typ | Opis |
|---|---|---|
| allowedDomains |
Domeny dozwolone dla wyników internetowych. |
|
| blockedDomains |
Domeny zablokowane w wynikach wyszukiwania w sieci. |
WebKnowledgeSourceParameters
Parametry źródła wiedzy internetowej.
| Nazwisko | 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. |