Knowledge Sources - Create

Hizmet:: Search Service

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

Yeni bir bilgi kaynağı oluşturur.

POST {endpoint}/knowledgesources?api-version=2025-08-01-preview

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Arama hizmetinin uç nokta URL'si.
api-version	query	True	string	İstemci API sürümü.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string (uuid)	Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği.

İstek Gövdesi

İstek gövdesi şunlardan biri olabilir:

Name	Description
AzureBlobKnowledgeSource	Azure Blob Depolama bilgi kaynağı yapılandırması.
SearchIndexKnowledgeSource	Bir arama dizinini hedefleyen Bilgi Kaynağı.

AzureBlobKnowledgeSource

Azure Blob Depolama bilgi kaynağı yapılandırması.

Name	Gerekli	Tür	Description
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	Bilgi kaynağının türü.
kind	True	string: azureBlob	Bilgi kaynağının türü.
name	True	string	Bilgi kaynağının adı.
@odata.etag		string	Aracının ETag'i.
description		string	İsteğe bağlı kullanıcı tanımlı açıklama.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, aracı tanımınız için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Aracı tanımınızı şifreledikten sonra, her zaman şifreli kalacaktır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Temsilci tanımınız etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.

SearchIndexKnowledgeSource

Bir arama dizinini hedefleyen Bilgi Kaynağı.

Name	Gerekli	Tür	Description
kind	True	string: searchIndex	Bilgi kaynağının türü.
name	True	string	Bilgi kaynağının adı.
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	Bilgi kaynağı için parametreler.
@odata.etag		string	Aracının ETag'i.
description		string	İsteğe bağlı kullanıcı tanımlı açıklama.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, aracı tanımınız için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Aracı tanımınızı şifreledikten sonra, her zaman şifreli kalacaktır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Temsilci tanımınız etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.

Yanıtlar

Name	Tür	Description
201 Created	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource	Başarıyla bir bilgi kaynağı oluşturuldu
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchServiceCreateKnowledgeSource

SearchServiceCreateKnowledgeSourceAzureBlob

SearchServiceCreateKnowledgeSource

Örnek isteği

HTTP

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


{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataSelect": "description,category"
  },
  "name": "ks-preview-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>"
    }
  }
}

Örnek yanıt

Durum kodu:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-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": "preview-test",
    "sourceDataSelect": "description,category"
  }
}

SearchServiceCreateKnowledgeSourceAzureBlob

Örnek isteği

HTTP

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


{
  "azureBlobParameters": {
    "identity": {
      "userAssignedIdentity": "/my/userassigned/id",
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
    },
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "embeddingModel": {
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "model",
        "apiKey": "api-key",
        "modelName": "text-embedding-3-large"
      },
      "name": "openai",
      "kind": "azureOpenAI"
    },
    "chatCompletionModel": {
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4o-mini"
      },
      "kind": "azureOpenAI"
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2025-01-07T19:30:00Z"
    },
    "disableImageVerbalization": false
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

Örnek yanıt

Durum kodu:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "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",
    "disableImageVerbalization": false,
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "model",
        "apiKey": "api-key",
        "modelName": "text-embedding-3-large"
      }
    },
    "chatCompletionModel": {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4o-mini"
      }
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2024-06-06T00:01:50.265Z"
    }
  }
}

Tanımlar

Name	Description
AIFoundryModelCatalogName	Azure AI Foundry Kataloğu'ndan çağrılacak ekleme modelinin adı.
AIServicesVisionParameters	Bir sorguyu, görüntüyü veya metni vektörleştirmek için AI Services Vision parametrelerini belirtir.
AIServicesVisionVectorizer	Bir sorguyu, görüntüyü veya metni vektörleştirmek için AI Services Vision parametrelerini belirtir.
AMLParameters	Bir AML vektörleştiricisine bağlanmak için özellikleri belirtir.
AMLVectorizer	Bir sorgu dizesinin vektör eklemesini oluşturmak için Azure AI Foundry Model Kataloğu aracılığıyla dağıtılan bir Azure Machine Learning uç noktasını belirtir.
AzureActiveDirectoryApplicationCredentials	Arama hizmetiniz için oluşturulan ve Azure Key Vault'ta depolanan şifreleme anahtarlarına kimliği doğrulanmış erişim için kullanılan kayıtlı bir uygulamanın kimlik bilgileri.
AzureBlobKnowledgeSource	Azure Blob Depolama bilgi kaynağı yapılandırması.
AzureBlobKnowledgeSourceParameters	Azure Blob Depolama bilgi kaynağı için parametreler.
AzureOpenAIEmbeddingSkill	Azure OpenAI kaynağını kullanarak belirli bir metin girişi için bir vektör eklemesi oluşturmanıza olanak tanır.
AzureOpenAIModelName	Çağrılacak Azure Open AI model adı.
AzureOpenAIParameters	Azure OpenAI kaynağına bağlanmak için parametreleri belirtir.
AzureOpenAIVectorizer	Bir sorgu dizesini vektörleştirmek için kullanılan Azure OpenAI kaynağını belirtir.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
IndexingSchedule	Dizin oluşturucu yürütmesi için bir zamanlamayı temsil eder.
InputFieldMappingEntry	Bir beceri için giriş alanı eşlemesi.
KnowledgeAgentAzureOpenAIModel	Sorgu planlaması yapmak için kullanılan Azure OpenAI kaynağını belirtir.
KnowledgeAgentModelKind	Sorgu planlaması için kullanılacak yapay zeka modeli.
KnowledgeSourceKind	Bilgi kaynağının türü.
OutputFieldMappingEntry	Bir beceri için çıktı alanı eşlemesi.
SearchIndexerDataNoneIdentity	Bir veri kaynağının kimlik özelliğini temizler.
SearchIndexerDataUserAssignedIdentity	Kullanılacak veri kaynağının kimliğini belirtir.
SearchIndexKnowledgeSource	Bir arama dizinini hedefleyen Bilgi Kaynağı.
SearchIndexKnowledgeSourceParameters	Arama dizini bilgi kaynağı için parametreler.
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.
VectorSearchVectorizerKind	Sorgu sırasında kullanılacak vektörleştirme yöntemi.
WebApiParameters	Kullanıcı tanımlı bir vektörleştiriciye bağlanmak için özellikleri belirtir.
WebApiVectorizer	Bir sorgu dizesinin vektör katıştırmasını oluşturmak için kullanıcı tanımlı bir vektörleştirici belirtir. Harici bir vektörleştiricinin entegrasyonu, bir beceri kümesinin özel Web API arabirimi kullanılarak gerçekleştirilir.

AIFoundryModelCatalogName

Numaralandırma

Azure AI Foundry Kataloğu'ndan çağrılacak ekleme modelinin adı.

Değer	Description
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english
Cohere-embed-v3-multilingual
Cohere-embed-v4	Hem metinden hem de görüntülerden gömmeler oluşturmak için Cohere gömme v4 modeli.

AIServicesVisionParameters

Nesne

Bir sorguyu, görüntüyü veya metni vektörleştirmek için AI Services Vision parametrelerini belirtir.

Name	Tür	Description
apiKey	string	Belirlenen AI Hizmetleri 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. Bir authResourceId sağlanırsa ve belirtilmezse, sistem tarafından atanan yönetilen kimlik kullanılır. Dizinde yapılan güncelleştirmelerde, kimlik belirtilmemişse değer değişmeden kalır. "Yok" olarak ayarlanırsa, bu özelliğin değeri temizlenir.
modelVersion	string	AI Hizmetleri Görüntü İşleme hizmetini çağırırken kullanılacak modelin sürümü. Belirtilmediğinde varsayılan olarak mevcut olan en son sürüme ayarlanır.
resourceUri	string (uri)	AI Hizmetleri kaynağının kaynak URI'si.

AIServicesVisionVectorizer

Nesne

Bir sorguyu, görüntüyü veya metni vektörleştirmek için AI Services Vision parametrelerini belirtir.

Name	Tür	Description
aiServicesVisionParameters	AIServicesVisionParameters	AI Services Vision katıştırma vektörleştirmesine özgü parametreleri içerir.
kind	string: aiServicesVision	Vektör aramasıyla kullanılmak üzere yapılandırılan vektörleştirme yönteminin adı.
name	string	Bu özel vektörleştirme yöntemiyle ilişkilendirilecek ad.

AMLParameters

Nesne

Bir AML vektörleştiricisine bağlanmak için özellikleri belirtir.

Name	Tür	Description
key	string	(Anahtar kimlik doğrulaması için gereklidir) AML hizmetinin anahtarı.
modelName	AIFoundryModelCatalogName	Sağlanan uç noktada dağıtılan Azure AI Foundry Kataloğu'ndan ekleme modelinin adı.
region	string	(Belirteç kimlik doğrulaması için isteğe bağlı). AML hizmetinin dağıtıldığı bölge.
resourceId	string	(Belirteç kimlik doğrulaması için gereklidir). AML hizmetinin Azure Resource Manager kaynak kimliği. subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name} biçiminde olmalıdır.
timeout	string (duration)	(İsteğe bağlı) Belirtildiğinde, API çağrısını yapan http istemcisinin zaman aşımını gösterir.
uri	string (uri)	(Kimlik doğrulaması veya anahtar kimlik doğrulaması için gereklidir) JSON yükünün gönderileceği AML hizmetinin puanlama URI'si. Yalnızca https URI şemasına izin verilir.

AMLVectorizer

Nesne

Bir sorgu dizesinin vektör eklemesini oluşturmak için Azure AI Foundry Model Kataloğu aracılığıyla dağıtılan bir Azure Machine Learning uç noktasını belirtir.

Name	Tür	Description
amlParameters	AMLParameters	AML vektörleştiricisinin özelliklerini belirtir.
kind	string: aml	Vektör aramasıyla kullanılmak üzere yapılandırılan vektörleştirme yönteminin adı.
name	string	Bu özel vektörleştirme yöntemiyle ilişkilendirilecek ad.

AzureActiveDirectoryApplicationCredentials

Nesne

Arama hizmetiniz için oluşturulan ve Azure Key Vault'ta depolanan şifreleme anahtarlarına kimliği doğrulanmış erişim için kullanılan kayıtlı bir uygulamanın kimlik bilgileri.

Name	Tür	Description
applicationId	string	Bekleyen verilerinizi şifrelerken kullanılacak Azure Key Vault için 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.
applicationSecret	string	Belirtilen AAD uygulamasının kimlik doğrulama anahtarı.

AzureBlobKnowledgeSource

Nesne

Azure Blob Depolama bilgi kaynağı yapılandırması.

Name	Tür	Description
@odata.etag	string	Aracının ETag'i.
azureBlobParameters	AzureBlobKnowledgeSourceParameters	Bilgi kaynağının türü.
description	string	İsteğe bağlı kullanıcı tanımlı açıklama.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, aracı tanımınız için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Aracı tanımınızı şifreledikten sonra, her zaman şifreli kalacaktır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Temsilci tanımınız etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.
kind	string: azureBlob	Bilgi kaynağının türü.
name	string	Bilgi kaynağının adı.

AzureBlobKnowledgeSourceParameters

Nesne

Azure Blob Depolama bilgi kaynağı için parametreler.

Name	Tür	Description
chatCompletionModel	KnowledgeAgentModel: KnowledgeAgentAzureOpenAIModel	Görüntü sözlüleştirme veya bağlam çıkarma için isteğe bağlı sohbet tamamlama modeli.
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.
disableImageVerbalization	boolean	Görüntü sözlülüğünün devre dışı bırakılması gerekip gerekmediğini belirtir.
embeddingModel	VectorSearchVectorizer: AIServicesVisionVectorizer AMLVectorizer AzureOpenAIVectorizer WebApiVectorizer	İçeriği vektörleştirmek için isteğe bağlı vektörleştirici yapılandırması.
folderPath	string	Kapsayıcı içindeki isteğe bağlı klasör yolu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Bu bilgi kaynağı için kullanılacak açık bir kimlik.
ingestionSchedule	IndexingSchedule	Veri alımı için isteğe bağlı zamanlama.

AzureOpenAIEmbeddingSkill

Nesne

Azure OpenAI kaynağını kullanarak belirli bir metin girişi için bir vektör eklemesi oluşturmanıza olanak tanır.

Name	Tür	Description
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	Beceri türünü belirten bir URI parçası.
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.
context	string	Belge kökü veya belge içeriği (örneğin, /document veya /document/content) gibi işlemlerin gerçekleştiği düzeyi temsil eder. Varsayılan değer /document'dir.
deploymentId	string	Belirlenen kaynakta Azure OpenAI modeli dağıtımının kimliği.
description	string	Becerinin girdilerini, çıktılarını ve kullanımını açıklayan becerinin açıklaması.
dimensions	integer (int32)	Sonuçta elde edilen çıktı eklemelerinin sahip olması gereken boyut sayısı. Yalnızca text-embedding-3 ve sonraki modellerde desteklenir.
inputs	InputFieldMappingEntry[]	Becerilerin girişleri, kaynak veri kümesindeki bir sütun veya yukarı akış becerisinin çıktısı olabilir.
modelName	AzureOpenAIModelName	Sağlanan deploymentId yolunda dağıtılan katıştırma modelinin adı.
name	string	Becerinin, onu beceri kümesi içinde benzersiz bir şekilde tanımlayan adı. Adı tanımlanmamış bir beceriye, beceriler dizisindeki 1 tabanlı dizininin varsayılan adı verilir ve önüne '#' karakteri eklenir.
outputs	OutputFieldMappingEntry[]	Bir becerinin çıktısı, arama dizinindeki bir alan veya başka bir beceri tarafından girdi olarak kullanılabilecek bir değerdir.
resourceUri	string (uri)	Azure OpenAI kaynağının kaynak URI'si.

AzureOpenAIModelName

Numaralandırma

Çağrılacak Azure Open AI model adı.

Değer	Description
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAIParameters

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 katıştırma modelinin adı.
resourceUri	string (uri)	Azure OpenAI kaynağının kaynak URI'si.

AzureOpenAIVectorizer

Nesne

Bir sorgu dizesini vektörleştirmek için kullanılan Azure OpenAI kaynağını belirtir.

Name	Tür	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Azure OpenAI katıştırma vektörleştirmesine özgü parametreleri içerir.
kind	string: azureOpenAI	Vektör aramasıyla kullanılmak üzere yapılandırılan vektörleştirme yönteminin adı.
name	string	Bu özel vektörleştirme yöntemiyle ilişkilendirilecek ad.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	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

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

IndexingSchedule

Nesne

Dizin oluşturucu yürütmesi için bir zamanlamayı temsil eder.

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

InputFieldMappingEntry

Nesne

Bir beceri için giriş alanı eşlemesi.

Name	Tür	Description
inputs	InputFieldMappingEntry[]	Karmaşık bir tür oluştururken kullanılan özyinelemeli girişler.
name	string	Girişin adı.
source	string	Girişin kaynağı.
sourceContext	string	Özyinelemeli girişleri seçmek için kullanılan kaynak bağlamı.

KnowledgeAgentAzureOpenAIModel

Nesne

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

Name	Tür	Description
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Azure OpenAI model uç noktasına özgü parametreleri içerir.
kind	string: azureOpenAI	Yapay zeka modelinin türü.

KnowledgeAgentModelKind

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.

KnowledgeSourceKind

Numaralandırma

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ğı.

OutputFieldMappingEntry

Nesne

Bir beceri için çıktı alanı eşlemesi.

Name	Tür	Description
name	string	Beceri tarafından tanımlanan çıktının adı.
targetName	string	Çıktının hedef adı. İsteğe bağlıdır ve varsayılan olarak adlandırılır.

SearchIndexerDataNoneIdentity

Nesne

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

SearchIndexKnowledgeSource

Nesne

Bir arama dizinini hedefleyen Bilgi Kaynağı.

Name	Tür	Description
@odata.etag	string	Aracının ETag'i.
description	string	İsteğe bağlı kullanıcı tanımlı açıklama.
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, hiç kimsenin, hatta Microsoft'un bile şifresini çözemeyeceğinden tam olarak emin olmak istediğinizde, aracı tanımınız için ek bir bekleyen şifreleme düzeyi sağlamak için kullanılır. Aracı tanımınızı şifreledikten sonra, her zaman şifreli kalacaktır. Arama hizmeti, bu özelliği null olarak ayarlama girişimlerini yoksayar. Şifreleme anahtarınızı döndürmek istiyorsanız bu özelliği gerektiği gibi değiştirebilirsiniz; Temsilci tanımınız etkilenmez. Müşteri tarafından yönetilen anahtarlarla şifreleme, ücretsiz arama hizmetleri için kullanılamaz ve yalnızca 1 Ocak 2019'da veya sonrasında oluşturulan ücretli hizmetler için kullanılabilir.
kind	string: searchIndex	Bilgi kaynağının türü.
name	string	Bilgi kaynağının adı.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Bilgi kaynağı için parametreler.

SearchIndexKnowledgeSourceParameters

Nesne

Arama dizini bilgi kaynağı için parametreler.

Name	Tür	Description
searchIndexName	string	Arama dizininin adı.
sourceDataSelect	string	Başvurulan kaynak veriler için ek alanlar istemek için kullanılır.

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	AzureActiveDirectoryApplicationCredentials	Azure Key Vault erişmek için kullanılan isteğe bağlı Azure Active Directory kimlik bilgileri. Bunun yerine yönetilen kimlik kullanılıyorsa gerekli değildir.
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. Kaynak güncelleştirildiğinde, açık kimlik belirtilmemişse değişmeden kalır. "None" 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	DNS adı olarak da adlandırılan Azure Key Vault URI'si, bekleyen verilerinizi şifrelemek için kullanılacak anahtarı içerir. Örnek bir URI olabilir `https://my-keyvault-name.vault.azure.net`.

VectorSearchVectorizerKind

Numaralandırma

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 AI Foundry Model Kataloğu aracılığıyla dağıtılan bir Azure Machine Learning uç noktası kullanarak eklemeler oluşturun.

WebApiParameters

Nesne

Kullanıcı tanımlı bir vektörleştiriciye bağlanmak için özellikleri belirtir.

Name	Tür	Description
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Giden bağlantılar için kullanılan, kullanıcı tarafından atanan yönetilen kimlik. Bir authResourceId sağlanırsa ve belirtilmezse, sistem tarafından atanan yönetilen kimlik kullanılır. Dizin oluşturucuda yapılan güncelleştirmelerde, kimlik belirtilmemişse değer değişmeden kalır. "Yok" olarak ayarlanırsa, bu özelliğin değeri temizlenir.
authResourceId	string	Bir Azure işlevindeki dış koda veya dönüştürmeleri sağlayan başka bir uygulamaya bağlanan özel uç noktalar için geçerlidir. Bu değer, Azure Active Directory'ye kaydedildiğinde işlev veya uygulama için oluşturulan uygulama kimliği olmalıdır. Belirtildiğinde, vektörleştirme, arama hizmetinin yönetilen kimliğini (sistem veya kullanıcı tarafından atanan) ve işlevin veya uygulamanın erişim belirtecini kullanarak işleve veya uygulamaya bağlanır ve bu değeri erişim belirtecinin kapsamını oluşturmak için kaynak kimliği olarak kullanır.
httpHeaders	object	HTTP isteğinde bulunmak için gereken üst bilgiler.
httpMethod	string	HTTP isteğinin yöntemi.
timeout	string (duration)	İstek için istenen zaman aşımı. Varsayılan değer 30 saniyedir.
uri	string (uri)	Vektörleştiriciyi sağlayan Web API'sinin URI'si.

WebApiVectorizer

Nesne

Bir sorgu dizesinin vektör katıştırmasını oluşturmak için kullanıcı tanımlı bir vektörleştirici belirtir. Harici bir vektörleştiricinin entegrasyonu, bir beceri kümesinin özel Web API arabirimi kullanılarak gerçekleştirilir.

Name	Tür	Description
customWebApiParameters	WebApiParameters	Kullanıcı tanımlı vektörleştiricinin özelliklerini belirtir.
kind	string: customWebApi	Vektör aramasıyla kullanılmak üzere yapılandırılan vektörleştirme yönteminin adı.
name	string	Bu özel vektörleştirme yöntemiyle ilişkilendirilecek ad.