Knowledge Sources - Get
Bir bilgi kaynağı tanımı alır.
GET {endpoint}/knowledgesources('{sourceName}')?api-version=2026-10-01
URI Parametreleri
| Veri Akışı Adı | İçinde | Gerekli | Tür | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
Arama hizmetinin uç nokta URL'si. |
|
source
|
path | True |
string |
Bilgi kaynağının adı. |
|
api-version
|
query | True |
string minLength: 1 |
Bu işlem için kullanılacak API sürümü. |
İstek Başlığı
| Veri Akışı Adı | Gerekli | Tür | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı. |
|
| Accept |
Accept başlığı. |
Yanıtlar
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| 200 OK | KnowledgeSource: |
İstek başarılı oldu. |
| Other Status Codes |
Beklenmeyen bir hata yanıtı. |
Güvenlik
api-key
Tür:
apiKey
İçinde:
header
OAuth2Auth
Tür:
oauth2
Akış:
implicit
Yetkilendirme URL’si:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Kapsamlar
| Veri Akışı Adı | Description |
|---|---|
| https://search.azure.com/.default |
Örnekler
SearchServiceGetKnowledgeSource
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@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": "*"
}
]
}
}
SearchServiceGetKnowledgeSourceAzureBlob
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@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": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "<redacted>"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceGetKnowledgeSourceFile
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-stable-test",
"kind": "file",
"description": "Description of the File knowledge source.",
"fileParameters": {
"ingestionParameters": {
"ingestionPermissionOptions": [],
"contentExtractionMode": "standard",
"embeddingModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "model",
"apiKey": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-mini"
}
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "<redacted>"
}
},
"createdResources": {
"index": "ks-stable-test-index"
}
},
"corsOptions": {
"allowedOrigins": [
"https://myapp.example.com"
],
"maxAgeInSeconds": 300
}
}
SearchServiceGetKnowledgeSourceIndexedOneLake
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@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": "<redacted>",
"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": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "<redacted>"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceGetKnowledgeSourceIndexedSharePoint
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@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",
"networkAccessMode": "public",
"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": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"chatCompletionModel": {
"kind": "azureOpenAI",
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com",
"deploymentId": "myDeployment",
"apiKey": "<redacted>",
"modelName": "gpt-5-mini"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "<redacted>"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceGetKnowledgeSourceIndexedSql
Örnek isteği
GET https://typespecstableexampleservice.search.windows.net/knowledgesources('ks-stable-test')?api-version=2026-10-01
Örnek yanıt
{
"@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": {
"ingestionPermissionOptions": [],
"contentExtractionMode": "minimal",
"networkAccessMode": "public",
"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": "<redacted>",
"modelName": "text-embedding-3-large"
}
},
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
}
},
"createdResources": {
"datasource": "ks-stable-test-datasource",
"indexer": "ks-stable-test-indexer",
"skillset": "ks-stable-test-skillset",
"index": "ks-stable-test-index"
}
}
}
SearchServiceGetKnowledgeSourceWeb
Örnek isteği
GET https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-10-01
Örnek yanıt
{
"@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"
}
}
Tanımlar
| Veri Akışı Adı | Description |
|---|---|
| Accept |
Accept başlığı. |
| AIServices |
Yapay Zeka Hizmetleri için Parametreler. |
|
Azure |
Azure Blob Depolama bilgi kaynağı yapılandırması. |
|
Azure |
Azure Blob Depolama bilgi kaynağı için parametreler. |
|
Azure |
Çağrılacak Azure Open AI model adı. |
|
Azure |
Azure OpenAI kaynağına bağlanmak için parametreleri belirtir. |
|
Content |
Bir SQL sütununu arama indeks alanına eşler. |
|
Cors |
Dizin için Çıkış Noktaları Arası Kaynak Paylaşımını (CORS) denetleme seçeneklerini tanımlar. |
|
Embedding |
Bir SQL sütununu gömmek için bir vektör alanına eşler. |
|
Error |
Kaynak yönetimi hatasına ilişkin ek bilgiler. |
|
Error |
Hata ayrıntısı. |
|
Error |
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.). |
|
File |
Dosya bilgi kaynağının doğrudan dosya yükleme ve indekslemesini destekleyen yapılandırma. |
|
File |
Dosya bilgi kaynağı için parametreler. |
|
Indexed |
OneLake bilgi kaynağı için yapılandırma. |
|
Indexed |
OneLake bilgi kaynağı için parametreler. |
|
Indexed |
Hangi SharePoint kitaplıklarına erişileceğini belirtir. |
|
Indexed |
SharePoint bilgi kaynağı yapılandırması. |
|
Indexed |
SharePoint bilgi kaynağı parametreleri. |
|
Indexed |
Indeksli SQL bilgi kaynağı için yapılandırma. |
|
Indexed |
İndekslenmiş SQL bilgi kaynağı parametreleri. |
|
Indexing |
Dizin oluşturucu yürütme zamanlamasını temsil eder. |
|
Knowledge |
Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir. |
|
Knowledge |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
|
Knowledge |
Bir sorgu dizesini vektörleştirmek için kullanılan Azure OpenAI kaynağını belirtir. |
|
Knowledge |
Bilgi kaynakları için tüm genel alım ayarlarını birleştirir. |
|
Knowledge |
Belge içeriğiyle birlikte alınacak izin türleri. |
|
Knowledge |
Bilgi kaynağının türü. |
|
Knowledge |
Bilgi kaynağı alımı için ağ erişim modunu belirler. Varsayılan 'kamu'dur. |
|
Search |
Veri kaynağının kimlik özelliğini temizler. |
|
Search |
Kullanılacak veri kaynağının kimliğini belirtir. |
|
Search |
Arama dizini için alan referansı. |
|
Search |
Bir arama dizinini hedefleyen Bilgi Kaynağı. |
|
Search |
Arama dizini bilgi kaynağı için parametreler. |
|
Search |
Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir. |
|
Vector |
Sorgu sırasında kullanılacak vektörleştirme yöntemi. |
|
Web |
Web sonuçlarını hedefleyen Bilgi Kaynağı. |
|
Web |
Web bilgi kaynağı etki alanı için yapılandırma. |
|
Web |
Web bilgi kaynağı için etki alanı izin verme/engelleme yapılandırması. |
|
Web |
Web bilgi kaynağı için parametreler. |
Accept
Accept başlığı.
| Değer | Description |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Yapay Zeka Hizmetleri için Parametreler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| apiKey |
string |
AI Hizmetlerine erişim için API anahtarı. |
| uri |
string (uri) |
AI Hizmetleri uç noktasının URI'si. |
AzureBlobKnowledgeSource
Azure Blob Depolama bilgi kaynağı yapılandırması.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| azureBlobParameters |
Bilgi kaynağının türü. |
|
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| kind |
string:
azure |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
AzureBlobKnowledgeSourceParameters
Azure Blob Depolama bilgi kaynağı için parametreler.
| Veri Akışı Adı | Tür | Default value | Description |
|---|---|---|---|
| connectionString |
string |
Anahtar tabanlı bağlantı dizesi veya yönetilen kimlik kullanılıyorsa ResourceId biçimi. |
|
| containerName |
string |
Blob depolama kapsayıcısının adı. |
|
| createdResources |
object |
Bilgi kaynağı tarafından oluşturulan kaynaklar. |
|
| folderPath |
string |
Kapsayıcı içindeki isteğe bağlı klasör yolu. |
|
| ingestionParameters |
Tüm genel alım ayarlarını birleştirir. |
||
| isADLSGen2 |
boolean |
False |
ADLS Gen2 depolama hesabına bağlanıyorsanız true olarak ayarlayın. Varsayılan değer false'tur. |
AzureOpenAIModelName
Çağrılacak Azure Open AI model adı.
| Değer | Description |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 modeli. |
| text-embedding-3-large |
TextEmbedding3Large modeli. |
| text-embedding-3-small |
TextEmbedding3Small modeli. |
| gpt-5-mini |
Gpt5Mini modeli. |
| gpt-5-nano |
Gpt5Nano modeli. |
| gpt-5.4 |
Gpt54 modeli. |
| gpt-5.4-mini |
Gpt54Mini modeli. |
| gpt-5.4-nano |
Gpt54Nano modeli. |
| gpt-5.5 |
Gpt55 modeli. |
| gpt-5.6-sol |
Gpt56Sol modeli. |
| gpt-5.6-terra |
Gpt56Terra modeli. |
| gpt-5.6-luna |
Gpt56Luna modeli. |
AzureOpenAIVectorizerParameters
Azure OpenAI kaynağına bağlanmak için parametreleri belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| apiKey |
string |
Belirlenen Azure OpenAI kaynağının API anahtarı. |
| authIdentity | SearchIndexerDataIdentity: |
Giden bağlantılar için kullanılan kullanıcı tarafından atanan yönetilen kimlik. |
| deploymentId |
string |
Belirlenen kaynakta Azure OpenAI modeli dağıtımının kimliği. |
| modelName |
Sağlanan deploymentId yolunda dağıtılan ekleme modelinin adı. |
|
| resourceUri |
string (uri) |
Azure OpenAI kaynağının kaynak URI'si. |
ContentColumnMapping
Bir SQL sütununu arama indeks alanına eşler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| name |
string |
Hedef indeks alanı adı. |
| searchFieldType |
string |
Azure Yapay Zeka Arama alan tipi (örneğin, Edm.String, Edm.Int32). |
| sourceField |
string |
SQL sütun adı. |
CorsOptions
Dizin için Çıkış Noktaları Arası Kaynak Paylaşımını (CORS) denetleme seçeneklerini tanımlar.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| allowedOrigins |
string[] |
JavaScript koduna dizininize erişim izni verilecek kaynakların listesi. {protocol}://{fully-qualified-domain-name}[:{port#}] biçimindeki ana bilgisayarların bir listesini veya tüm çıkış noktalarına izin vermek için tek bir '*' içerebilir (önerilmez). |
| maxAgeInSeconds |
integer (int64) |
Tarayıcıların CORS ön kontrol yanıtlarını önbelleğe alması gereken süre. Varsayılan olarak 5 dakikadır. |
EmbeddingColumnMapping
Bir SQL sütununu gömmek için bir vektör alanına eşler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| name |
string |
Arama indeksinde hedef vektör alanı adı. |
| sourceField |
string |
Gömülü oluşturma için giriş olarak kullanılan SQL sütunu. |
ErrorAdditionalInfo
Kaynak yönetimi hatasına ilişkin ek bilgiler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| info |
Ek bilgiler. |
|
| type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| additionalInfo |
Hata ek bilgisi. |
|
| code |
string |
Hata kodu. |
| details |
Hata ayrıntıları. |
|
| message |
string |
Hata iletisi. |
| target |
string |
Hata hedefi |
ErrorResponse
Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| error |
Hata nesnesi. |
FileKnowledgeSource
Dosya bilgi kaynağının doğrudan dosya yükleme ve indekslemesini destekleyen yapılandırma.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| corsOptions |
Dosya bilgi kaynağının dosya uç noktaları için Çapraz Kaynak Paylaşımı (CORS) kontrol seçenekleri (yükleme, liste, güncelleme, sil). |
|
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| fileParameters |
Dosya bilgi kaynağı parametreleri. |
|
| kind |
string:
file |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
FileKnowledgeSourceParameters
Dosya bilgi kaynağı için parametreler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| createdResources |
object |
Dosya bilgi kaynağı tarafından oluşturulan kaynaklar. |
| ingestionParameters |
Dosya bilgi kaynağı için tüm genel alım ayarlarını, içerik çıkarma modu ve isteğe bağlı embeddingModel dahil olmak üzere, birleştirir. |
IndexedOneLakeKnowledgeSource
OneLake bilgi kaynağı için yapılandırma.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| indexedOneLakeParameters |
Bilgi kaynağı için parametreler. |
|
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
IndexedOneLakeKnowledgeSourceParameters
OneLake bilgi kaynağı için parametreler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| createdResources |
object |
Bilgi kaynağı tarafından oluşturulan kaynaklar. |
| fabricWorkspaceId |
string |
OneLake çalışma alanı kimliği. |
| ingestionParameters |
Tüm genel alım ayarlarını birleştirir. |
|
| lakehouseId |
string |
Hangi OneLake göl evine erişileceğini belirtir. |
| targetPath |
string |
OneLake içeriğini filtrelemek için isteğe bağlı OneLakehouse klasörü veya kısayolu. |
IndexedSharePointContainerName
Hangi SharePoint kitaplıklarına erişileceğini belirtir.
| Değer | Description |
|---|---|
| defaultSiteLibrary |
Sitenin varsayılan belge kitaplığından içeriği dizine ekleyin. |
| allSiteLibraries |
Sitedeki her belge kitaplığından içeriği dizinleyin. |
| useQuery |
SharePoint içeriğini filtrelemek için bir sorgu kullanın. |
| allSiteLists |
Sitedeki her listeden içeriği indeksleyin. |
| allSitePages |
Sitedeki her sayfadan içeriği indeksleyin. |
| allSiteContent |
Sitedeki tüm desteklenen kütüphanelerden, listelerden ve sayfalardan içerik dizinleyin. |
IndexedSharePointKnowledgeSource
SharePoint bilgi kaynağı yapılandırması.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| indexedSharePointParameters |
Bilgi kaynağı için parametreler. |
|
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
IndexedSharePointKnowledgeSourceParameters
SharePoint bilgi kaynağı parametreleri.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| connectionString |
string |
Biçime sahip SharePoint bağlantı dizesi: SharePointOnlineEndpoint=[SharePoint site url'si]; ApplicationId=[Azure AD Uygulama Kimliği]; ApplicationSecret=[Azure AD Uygulama istemci gizli dizisi]; TenantId=[SharePoint sitesi kiracı kimliği] |
| containerName |
Hangi SharePoint kitaplıklarına erişileceğini belirtir. |
|
| createdResources |
object |
Bilgi kaynağı tarafından oluşturulan kaynaklar. |
| ingestionParameters |
Tüm genel alım ayarlarını birleştirir. |
|
| query |
string |
SharePoint içeriğini filtrelemek için isteğe bağlı sorgu. |
IndexedSqlKnowledgeSource
Indeksli SQL bilgi kaynağı için yapılandırma.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| indexedSqlParameters |
SQL bilgi kaynağı için parametreler. |
|
| kind |
string:
indexed |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
IndexedSqlKnowledgeSourceParameters
İndekslenmiş SQL bilgi kaynağı parametreleri.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| connectionString |
string |
Azure SQL Veritabanı veya SQL Yönetilen Örneği için bağlantı dizesi. |
| contentColumns |
İçerik alanları için isteğe bağlı sütun eşlemeleri. Eğer atlanırsa, tüm sütunlar otomatik olarak keşfedilir. |
|
| createdResources |
object |
Bilgi kaynağı tarafından oluşturulan kaynaklar. |
| embeddingColumns |
Vektör alanlarını gömmek için isteğe bağlı sütun eşlemeleri. Eğer çıkarılırsa, vektör alanı oluşturulmaz. |
|
| highWaterMarkColumnName |
string |
Yüksek su işareti değişimi tespiti için isteğe bağlı sütun adı. Sağlanırsa, HighWaterMarkChangeDetectionPolicy kullanır. |
| ingestionParameters |
Gömü modeli, zamanlama ve kimlik dahil tüm genel alım ayarlarını birleştirir. |
|
| tableOrView |
string |
Indekslenecek tablo veya görünüm adı. Şema nitelikli olabilir (örneğin, 'dbo. MyTable'). |
IndexingSchedule
Dizin oluşturucu yürütme zamanlamasını temsil eder.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| interval |
string (duration) |
Dizin oluşturucu yürütmeleri arasındaki zaman aralığı. |
| startTime |
string (date-time) |
Dizin oluşturucunun çalışmaya başlaması gereken zaman. |
KnowledgeBaseAzureOpenAIModel
Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI parametreleri. |
|
| kind |
string:
azure |
Sorgu planlaması için kullanılacak yapay zeka modeli. |
KnowledgeBaseModelKind
Sorgu planlaması için kullanılacak yapay zeka modeli.
| Değer | Description |
|---|---|
| azureOpenAI |
Sorgu planlaması için Azure Open AI modellerini kullanın. |
KnowledgeSourceAzureOpenAIVectorizer
Bir sorgu dizesini vektörleştirmek için kullanılan Azure OpenAI kaynağını belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI katıştırma vektörleştirmesine özgü parametreleri içerir. |
|
| kind |
string:
azure |
Vektör aramasıyla kullanılmak üzere yapılandırılan vektörleştirme yönteminin adı. |
KnowledgeSourceIngestionParameters
Bilgi kaynakları için tüm genel alım ayarlarını birleştirir.
| Veri Akışı Adı | Tür | Default value | Description |
|---|---|---|---|
| aiServices |
İçerik işleme için isteğe bağlı AI Hizmetleri yapılandırması. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Görüntü sözlüleştirme veya bağlam çıkarma için isteğe bağlı sohbet tamamlama modeli. |
|
| contentExtractionMode |
enum:
|
minimal |
İsteğe bağlı içerik çıkarma modu. Varsayılan değer 'minimal'dir. |
| disableImageVerbalization |
boolean |
False |
Görüntü sözlülüğünün devre dışı bırakılması gerekip gerekmediğini belirtir. Varsayılan değer false'tur. |
| embeddingModel | KnowledgeSourceVectorizer: |
İçeriği vektörleştirmek için isteğe bağlı vektörleştirici yapılandırması. |
|
| identity | SearchIndexerDataIdentity: |
Bu bilgi kaynağı için kullanılacak açık bir kimlik. |
|
| ingestionPermissionOptions |
Belge içeriğiyle birlikte alınacak izin türlerinin isteğe bağlı listesi. Belirtilirse, veri kaynağı için dizin oluşturucu izin seçeneklerini ayarlar. |
||
| ingestionSchedule |
Veri alımı için isteğe bağlı zamanlama. |
||
| networkAccessMode | public |
Tüketim için isteğe bağlı ağ erişim modu. Özel bir uygulama ortamında alım çalıştırmak için 'özel' olarak ayarlanır ve bu ortamda veri kaynakları ve bağımlılıklar özel bir ağ üzerinden ulaşılabilir. Varsayılan 'kamu'dur. Bu, bir yaratma zamanı ayarıdır ve bilgi kaynağı oluşturulduktan sonra değiştirilemez. |
KnowledgeSourceIngestionPermissionOption
Belge içeriğiyle birlikte alınacak izin türleri.
| Değer | Description |
|---|---|
| userIds |
Belge içeriğinin yanı sıra açık kullanıcı tanımlayıcılarını alın. |
| groupIds |
Belge içeriğinin yanı sıra grup tanımlayıcılarını da alın. |
| rbacScope |
Belge içeriğinin yanı sıra RBAC kapsam bilgilerini de alın. |
KnowledgeSourceKind
Bilgi kaynağının türü.
| Değer | Description |
|---|---|
| searchIndex |
Bir Arama Dizini'nden veri okuyan bir bilgi kaynağı. |
| azureBlob |
Azure Blob Depolama'dan bir Arama Dizini'ne veri okuyan ve alan bir bilgi kaynağı. |
| indexedSharePoint |
Indekslenmiş SharePoint'ten veri okuyan bir bilgi kaynağı. |
| indexedOneLake |
Indekslenmiş OneLake'den veri okuyan bir bilgi kaynağı. |
| indexedSql |
Azure SQL Veritabanı veya SQL Yönetilen Örneği'dan bir Arama İndeksine veri alan ve alan bir bilgi kaynağı. |
| web |
Web'den veri okuyan bir bilgi kaynağı. |
| file |
Doğrudan dosya yükleme ve indekslemeyi destekleyen bir bilgi kaynağı. |
KnowledgeSourceNetworkAccessMode
Bilgi kaynağı alımı için ağ erişim modunu belirler. Varsayılan 'kamu'dur.
| Değer | Description |
|---|---|
| public |
Alım, standart, halka açık yürütme ortamında çalışır. Bu varsayılan seçenektir. |
| private |
Alım, özel bir yürütme ortamında çalışır, böylece veri kaynaklarına ve bağımlılıklara özel ağ üzerinden (özel uç nokta / paylaşılan özel bağlantı) ulaşabilir. |
SearchIndexerDataNoneIdentity
Veri kaynağının kimlik özelliğini temizler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Kimlik türünü belirten bir URI parçası. |
SearchIndexerDataUserAssignedIdentity
Kullanılacak veri kaynağının kimliğini belirtir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Kimlik türünü belirten bir URI parçası. |
| federatedIdentityClientId |
string |
Çok kiracılı User-Assigned Yönetilen Kimlik Desteği: Kullanıcı tarafından atanan yönetilen kimlik ile federasyon yapacak şekilde yapılandırılmış çoklu uygulamanın istemci kimliği. |
| userAssignedIdentity |
string |
Kullanıcı tarafından atanan yönetilen kimliğin tam Azure kaynak kimliği genellikle arama hizmetine atanması gereken "/subscriptions/12345678-1234-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" biçimindedir. |
SearchIndexFieldReference
Arama dizini için alan referansı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| name |
string |
Alanın adı. |
SearchIndexKnowledgeSource
Bir arama dizinini hedefleyen Bilgi Kaynağı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| kind |
string:
search |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
| searchIndexParameters |
Bilgi kaynağı için parametreler. |
SearchIndexKnowledgeSourceParameters
Arama dizini bilgi kaynağı için parametreler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| baseFilter |
string |
Erişim zamanında indekse uygulanan varsayılan bir filtre koşulu (örneğin, 'Durum eq' VA'). Bilgi kaynağı çalışma zamanı parametreleriyle sorgu zamanında geçersiz kılılabilir. |
| searchFields |
Arama dizininde hangi alanların aranacağını kısıtlamak için kullanılır. |
|
| searchIndexName |
string |
Arama dizininin adı. |
| semanticConfigurationName |
string |
Hedef arama dizininde varsayılandan farklı bir anlamsal yapılandırma belirtmek için kullanılır. |
| sourceDataFields |
Başvurulan kaynak veriler için ek alanlar istemek için kullanılır. |
SearchResourceEncryptionKey
Azure Key Vault'ta müşteri tarafından yönetilen bir şifreleme anahtarı. Oluşturduğunuz ve yönettiğiniz anahtarlar, dizinler ve eş anlamlı eşlemeler gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| accessCredentials.applicationId |
string |
Bekleyen verilerinizi şifrelerken kullanılacak Azure Key Vault'a gerekli erişim izinleri verilmiş bir AAD Uygulama Kimliği. Uygulama Kimliği, AAD Uygulamanızın Nesne Kimliği ile karıştırılmamalıdır. |
| accessCredentials.applicationSecret |
string |
Belirtilen AAD uygulamasının kimlik doğrulama anahtarı. |
| identity | SearchIndexerDataIdentity: |
Bu şifreleme anahtarı için kullanılacak açık bir yönetilen kimlik. Belirtilmezse ve erişim kimlik bilgileri özelliği null ise, sistem tarafından atanan yönetilen kimlik kullanılır. Kaynağa güncelleştirildiğinde, açık kimlik belirtilmezse değişmeden kalır. "Hiçbiri" belirtilirse, bu özelliğin değeri temizlenir. |
| keyVaultKeyName |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın adı. |
| keyVaultKeyVersion |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak Azure Key Vault anahtarınızın sürümü. |
| keyVaultUri |
string |
Bekleyen verilerinizi şifrelemek için kullanılacak anahtarı içeren, DNS adı olarak da adlandırılan Azure Key Vault URI'sidir. Örnek bir URI |
VectorSearchVectorizerKind
Sorgu sırasında kullanılacak vektörleştirme yöntemi.
| Değer | Description |
|---|---|
| azureOpenAI |
Sorgu zamanında bir Azure OpenAI kaynağı kullanarak eklemeler oluşturun. |
| customWebApi |
Sorgu zamanında özel bir web uç noktası kullanarak eklemeler oluşturun. |
| aiServicesVision |
Azure AI Services Vision Vectorize API'sini kullanarak sorgu zamanında bir görüntü veya metin girişi için eklemeler oluşturun. |
| aml |
Sorgu zamanında Azure Yapay Zeka Atölyesi Model Kataloğu aracılığıyla dağıtılan bir Azure Machine Learning uç noktası kullanarak eklemeler oluşturun. |
WebKnowledgeSource
Web sonuçlarını hedefleyen Bilgi Kaynağı.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| @odata.etag |
string |
Bilgi kaynağının ETag'ı. |
| description |
string |
İsteğe bağlı kullanıcı tanımlı açıklama. |
| encryptionKey |
Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, bilgi kaynağı tanımınız için ek bir şifreleme seviyesi sağlamak için kullanılır; çünkü kimsenin, hatta Microsoft'un bile şifrelerini çözemeyeceğine tam güven vermek istersiniz. Bilgi kaynağı tanımınızı şifreledikten sonra, her zaman şifreli kalır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek isterseniz bu özelliği gerektiğinde değiştirebilirsiniz; Bilgi kaynağı tanımınız değişmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetlerinde kullanılamaz ve yalnızca 1 Ocak 2019 veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir. |
|
| kind |
string:
web |
Bilgi kaynağının türü. |
| name |
string |
Bilgi kaynağının adı. |
| webParameters |
Web bilgi kaynağı için parametreler. |
WebKnowledgeSourceDomain
Web bilgi kaynağı etki alanı için yapılandırma.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| address |
string |
Etki alanının adresi. |
| includeSubpages |
boolean |
Bu etki alanından alt sayfaların dahil edilip edilmeyeceği. |
WebKnowledgeSourceDomains
Web bilgi kaynağı için etki alanı izin verme/engelleme yapılandırması.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| allowedDomains |
Web sonuçları için izin verilen alan adları. |
|
| blockedDomains |
Web sonuçlarından engellenen alan adları. |
WebKnowledgeSourceParameters
Web bilgi kaynağı için parametreler.
| Veri Akışı Adı | Tür | Description |
|---|---|---|
| count |
integer (int32) |
Geri dönecek varsayılan web sonuç sayısı. Bilgi kaynağı çalışma zamanı parametreleriyle sorgu zamanında geçersiz kılılabilir. |
| domains |
Web sonuçları için etki alanı izin verme/engelleme yapılandırması. |
|
| freshness |
string |
Web sonuçları için varsayılan tazelik filtresi. Bilgi kaynağı çalışma zamanı parametreleriyle sorgu zamanında geçersiz kılılabilir. |
| language |
string |
Web sonuçları için varsayılan dil. Bilgi kaynağı çalışma zamanı parametreleriyle sorgu zamanında geçersiz kılılabilir. |
| market |
string |
Web sonuçları için varsayılan pazar. Bilgi kaynağı çalışma zamanı parametreleriyle sorgu zamanında geçersiz kılılabilir. |