Knowledge Bases - Create

Hizmet:: Search Service

API Sürümü:: 2025-11-01-preview

Yeni bir bilgi tabanı oluşturur.

POST {endpoint}/knowledgebases?api-version=2025-11-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Arama hizmetinin uç nokta URL'si.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
Accept		Accept	Kabul Et başlığı.
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ı.

İstek Gövdesi

Name	Gerekli	Tür	Description
knowledgeSources	True	KnowledgeSourceReference[]	Bu bilgi tabanında referans verilen bilgi kaynakları.
name	True	string	Bilgi bankasının adı.
@odata.etag		string	Bilgi tabanının ETag'i.
answerInstructions		string	Bilgi tabanı tarafından cevaplar oluşturulurken dikkate alınan talimatlar.
description		string	Bilgi tabanının açıklaması.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması.
models		KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Yapay zeka modellerine nasıl bağlanılacağına ilişkin yapılandırma seçeneklerini içerir.
outputMode		KnowledgeRetrievalOutputMode	Bilgi tabanı için çıkış modu.
retrievalInstructions		string	Bilgi tabanı tarafından sorgu planı geliştirilirken dikkate alınan talimatlar.
retrievalReasoningEffort		KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Geri getirme amaç yürütme çabası yapılandırması.

Yanıtlar

Name	Tür	Description
201 Created	KnowledgeBase	İstek başarılı oldu ve sonuç olarak yeni bir kaynak oluşturuldu.
Other Status Codes	ErrorResponse	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

Name	Description
https://search.azure.com/.default

Örnekler

SearchServiceCreateKnowledgeBase

Örnek isteği

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases?api-version=2025-11-01-preview


{
  "name": "base-preview-test",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      },
      "kind": "azureOpenAI"
    }
  ],
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "outputMode": "extractiveData",
  "@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>"
    }
  },
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis."
}

Örnek yanıt

Durum kodu:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4.1-nano"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  }
}

Tanımlar

Name	Description
Accept	Kabul Et başlığı.
AzureOpenAIModelName	Çağrılacak Azure Open AI model adı.
AzureOpenAIVectorizerParameters	Azure OpenAI kaynağına bağlanmak için parametreleri belirtir.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
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.).
KnowledgeBase	Bir bilgi tabanı tanımını temsil eder.
KnowledgeBaseAzureOpenAIModel	Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir.
KnowledgeBaseModelKind	Sorgu planlaması için kullanılacak yapay zeka modeli.
KnowledgeRetrievalLowReasoningEffort	Düşük muhakeme çabasıyla bilgi alımını çalıştırın.
KnowledgeRetrievalMediumReasoningEffort	Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın.
KnowledgeRetrievalMinimalReasoningEffort	Minimum muhakeme çabasıyla bilgi alımını çalıştırın.
KnowledgeRetrievalOutputMode	Bu alma için çıkış yapılandırması.
KnowledgeRetrievalReasoningEffortKind	Alma sırasında kullanılacak çaba miktarı.
KnowledgeSourceReference	Bilgi kaynağına referans.
SearchIndexerDataNoneIdentity	Veri kaynağının kimlik özelliğini temizler.
SearchIndexerDataUserAssignedIdentity	Kullanılacak veri kaynağının kimliğini belirtir.
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.

Accept

Numaralandırma

Kabul Et başlığı.

Değer	Description
application/json;odata.metadata=minimal

AzureOpenAIModelName

Numaralandırma

Ç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-4o	Gpt4o modeli.
gpt-4o-mini	Gpt4oMini modeli.
gpt-4.1	Gpt41 modeli.
gpt-4.1-mini	Gpt41Mini modeli.
gpt-4.1-nano	Gpt41Nano modeli.
gpt-5	Gpt5 modeli.
gpt-5-mini	Gpt5Mini modeli.
gpt-5-nano	Gpt5Nano modeli.

AzureOpenAIVectorizerParameters

Nesne

Azure OpenAI kaynağına bağlanmak için parametreleri belirtir.

Name	Tür	Description
apiKey	string	Belirlenen Azure OpenAI kaynağının API anahtarı.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	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	AzureOpenAIModelName	Sağlanan deploymentId yolunda dağıtılan ekleme modelinin adı.
resourceUri	string (uri)	Azure OpenAI kaynağının kaynak URI'si.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info		Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Nesne

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

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

KnowledgeBase

Nesne

Bir bilgi tabanı tanımını temsil eder.

Name	Tür	Description
@odata.etag	string	Bilgi tabanının ETag'i.
answerInstructions	string	Bilgi tabanı tarafından cevaplar oluşturulurken dikkate alınan talimatlar.
description	string	Bilgi tabanının açıklaması.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması.
knowledgeSources	KnowledgeSourceReference[]	Bu bilgi tabanında referans verilen bilgi kaynakları.
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	Yapay zeka modellerine nasıl bağlanılacağına ilişkin yapılandırma seçeneklerini içerir.
name	string	Bilgi bankasının adı.
outputMode	KnowledgeRetrievalOutputMode	Bilgi tabanı için çıkış modu.
retrievalInstructions	string	Bilgi tabanı tarafından sorgu planı geliştirilirken dikkate alınan talimatlar.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Geri getirme amaç yürütme çabası yapılandırması.

KnowledgeBaseAzureOpenAIModel

Nesne

Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir.

Name	Tür	Description
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI parametreleri.
kind	string: azureOpenAI	Sorgu planlaması için kullanılacak yapay zeka modeli.

KnowledgeBaseModelKind

Numaralandırma

Sorgu planlaması için kullanılacak yapay zeka modeli.

Değer	Description
azureOpenAI	Sorgu planlaması için Azure Open AI modellerini kullanın.

KnowledgeRetrievalLowReasoningEffort

Nesne

Düşük muhakeme çabasıyla bilgi alımını çalıştırın.

Name	Tür	Description
kind	string: low	Bir tür akıl yürütme çabası.

KnowledgeRetrievalMediumReasoningEffort

Nesne

Orta düzeyde akıl yürütme çabasıyla bilgi erişimini çalıştırın.

Name	Tür	Description
kind	string: medium	Bir tür akıl yürütme çabası.

KnowledgeRetrievalMinimalReasoningEffort

Nesne

Minimum muhakeme çabasıyla bilgi alımını çalıştırın.

Name	Tür	Description
kind	string: minimal	Bir tür akıl yürütme çabası.

KnowledgeRetrievalOutputMode

Numaralandırma

Bu alma için çıkış yapılandırması.

Değer	Description
extractiveData	Üretimsel değişiklik yapmadan doğrudan bilgi kaynaklarından veri döndürün.
answerSynthesis	Yanıt yükü için bir yanıt sentezleyin.

KnowledgeRetrievalReasoningEffortKind

Numaralandırma

Alma sırasında kullanılacak çaba miktarı.

Değer	Description
minimal	Herhangi bir kaynak seçimi, sorgu planlaması veya yinelemeli arama gerçekleştirmez.
low	Geri alma sırasında düşük akıl yürütme kullanın.
medium	Geri alma sırasında makul miktarda akıl yürütme kullanın.

KnowledgeSourceReference

Nesne

Bilgi kaynağına referans.

Name	Tür	Description
name	string	Bilgi kaynağının adı.

SearchIndexerDataNoneIdentity

Nesne

Veri kaynağının kimlik özelliğini temizler.

Name	Tür	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Kimlik türünü belirten bir URI parçası.

SearchIndexerDataUserAssignedIdentity

Nesne

Kullanılacak veri kaynağının kimliğini belirtir.

Name	Tür	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Kimlik türünü belirten bir URI parçası.
userAssignedIdentity	string	Genellikle "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" biçiminde yönetilen kimlik atanan bir kullanıcının tam Azure kaynak kimliği.

SearchResourceEncryptionKey

Nesne

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.

Name	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: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	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 `https://my-keyvault-name.vault.azure.net`olabilir.