Indexers - Create

Başvuru

Hizmet:: Search Service

API Sürümü:: 2024-07-01

Yeni bir dizin oluşturucu oluşturur.

HTTP

POST {endpoint}/indexers?api-version=2024-07-01

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

Name	Gerekli	Tür	Description
dataSourceName	True	string	Bu dizin oluşturucunun verileri okuduğu veri kaynağının adı.
name	True	string	Dizin oluşturucunun adı.
targetIndexName	True	string	Bu dizin oluşturucunun veri yazdığı dizinin adı.
@odata.etag		string	Dizin oluşturucunun ETag'i.
description		string	Dizin oluşturucunun açıklaması.
disabled		boolean	Dizin oluşturucunun devre dışı bırakılıp bırakılmadığını gösteren değer. Varsayılan değer false'tur.
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, dizin oluşturucu tanımınız (dizin oluşturucu yürütme durumunun yanı sıra) microsoft bile dahil olmak üzere kimsenin şifresini çözemediğini tam olarak güvenceye almak istediğinizde, bekleyen ek bir şifreleme düzeyi sağlamak için kullanılır. Dizin oluşturucu tanımınızı şifreledikten sonra her zaman şifrelenmiş olarak kalı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; Dizin oluşturucu tanımınız (ve dizin oluşturucu yürütme durumunuz) etkilenmez. 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.
fieldMappings		FieldMapping[]	Veri kaynağındaki alanlar ile dizindeki karşılık gelen hedef alanlar arasındaki eşlemeleri tanımlar.
outputFieldMappings		FieldMapping[]	Çıktı alanı eşlemeleri zenginleştirmeden sonra ve dizin oluşturmadan hemen önce uygulanır.
parameters		IndexingParameters	Dizin oluşturucu yürütme parametreleri.
schedule		IndexingSchedule	Bu dizin oluşturucunun zamanlaması.
skillsetName		string	Bu dizin oluşturucuyla yürütülen beceri kümesinin adı.

Yanıtlar

Name	Tür	Description
201 Created	SearchIndexer
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchServiceCreateIndexer

Örnek isteği

HTTP

HTTP

POST https://myservice.search.windows.net/indexers?api-version=2024-07-01

{
  "name": "myindexer",
  "description": "an indexer",
  "dataSourceName": "mydatasource",
  "targetIndexName": "orders",
  "schedule": {
    "interval": "PT1H",
    "startTime": "2015-01-01T00:00:00Z"
  },
  "parameters": {
    "maxFailedItems": 10,
    "maxFailedItemsPerBatch": 5
  },
  "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

JSON

{
  "name": "myindexer",
  "description": "an indexer",
  "dataSourceName": "mydatasource",
  "targetIndexName": "orders",
  "schedule": {
    "interval": "PT1H",
    "startTime": "2015-01-01T00:00:00Z"
  },
  "parameters": {
    "maxFailedItems": 10,
    "maxFailedItemsPerBatch": 5
  },
  "fieldMappings": [],
  "disabled": false,
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Tanımlar

Name	Description
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.
BlobIndexerDataToExtract	Azure blob depolamadan ayıklanması gereken verileri belirtir ve "imageAction" "none" dışında bir değere ayarlandığında dizin oluşturucuya görüntü içeriğinden ayıklanması gereken verileri bildirir. Bu, .PDF veya başka bir uygulamadaki ekli görüntü içeriği veya Azure bloblarında .jpg ve .pnggibi görüntü dosyaları için geçerlidir.
BlobIndexerImageAction	Azure blob depolamada ekli görüntülerin ve görüntü dosyalarının nasıl işleneceğini belirler. "imageAction" yapılandırmasını "none" dışında bir değere ayarlamak için bir beceri kümesinin de bu dizin oluşturucuya eklenmesi gerekir.
BlobIndexerParsingMode	Azure blob veri kaynağından dizin oluşturma için ayrıştırma modunu temsil eder.
BlobIndexerPDFTextRotationAlgorithm	Azure blob depolamadaki PDF dosyalarından metin ayıklama algoritmasını belirler.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
FieldMapping	Veri kaynağındaki bir alan ile dizindeki hedef alan arasında eşleme tanımlar.
FieldMappingFunction	Dizin oluşturmadan önce veri kaynağından bir değeri dönüştüren bir işlevi temsil eder.
IndexerExecutionEnvironment	Dizin oluşturucunun yürütülmesi gereken ortamı belirtir.
IndexingParameters	Dizin oluşturucu yürütme parametrelerini temsil eder.
IndexingParametersConfiguration	Dizin oluşturucuya özgü yapılandırma özelliklerinin sözlüğü. Her ad belirli bir özelliğin adıdır. Her değer ilkel türde olmalıdır.
IndexingSchedule	Dizin oluşturucu yürütme zamanlamasını temsil eder.
SearchIndexer	Bir dizin oluşturucu temsil eder.
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ı haritalar gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.

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.

Name	Tür	Description
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.
applicationSecret	string	Belirtilen AAD uygulamasının kimlik doğrulama anahtarı.

BlobIndexerDataToExtract

Azure blob depolamadan ayıklanması gereken verileri belirtir ve "imageAction" "none" dışında bir değere ayarlandığında dizin oluşturucuya görüntü içeriğinden ayıklanması gereken verileri bildirir. Bu, .PDF veya başka bir uygulamadaki ekli görüntü içeriği veya Azure bloblarında .jpg ve .pnggibi görüntü dosyaları için geçerlidir.

Name	Tür	Description
allMetadata	string	Azure blob depolama alt sistemi tarafından sağlanan meta verileri ve içerik türüne özgü meta verileri ayıklar (örneğin, yalnızca .png dosyalara özgü meta veriler dizine alınır).
contentAndMetadata	string	Her blobdan tüm meta verileri ve metin içeriğini ayıklar.
storageMetadata	string	Yalnızca standart blob özelliklerini ve kullanıcı tarafından belirtilen meta verileri dizinler.

BlobIndexerImageAction

Azure blob depolamada ekli görüntülerin ve görüntü dosyalarının nasıl işleneceğini belirler. "imageAction" yapılandırmasını "none" dışında bir değere ayarlamak için bir beceri kümesinin de bu dizin oluşturucuya eklenmesi gerekir.

Name	Tür	Description
generateNormalizedImagePerPage	string	Görüntülerden metin ayıklar (örneğin, trafik durdurma işaretinden "DURDUR" sözcüğü) ve bunu içerik alanına ekler, ancak pdf dosyalarına ekli görüntüleri ayıklamak yerine her sayfanın görüntü olarak işlenip buna göre normalleştirileceğinden farklı davranır. PDF olmayan dosya türleri, "generateNormalizedImages" ayarlanmış gibi değerlendirilir.
generateNormalizedImages	string	Görüntülerdeki metinleri (örneğin, trafik durdurma işaretinden "DURDUR" sözcüğü) ayıklar ve içerik alanına ekler. Bu eylem için "dataToExtract" öğesinin "contentAndMetadata" olarak ayarlanması gerekir. Normalleştirilmiş görüntü, görsel arama sonuçlarına görüntü eklediğinizde tutarlı işlemeyi yükseltmek için boyutlandırılmış ve döndürülmüş tekdüzen görüntü çıkışıyla sonuçlanan ek işlemeyi ifade eder. Bu seçenek kullanıldığında her görüntü için bu bilgiler oluşturulur.
none	string	Veri kümesindeki ekli görüntüleri veya görüntü dosyalarını yoksayar. Varsayılan değer budur.

BlobIndexerParsingMode

Azure blob veri kaynağından dizin oluşturma için ayrıştırma modunu temsil eder.

Name	Tür	Description
default	string	Normal dosya işleme için varsayılan olarak ayarlayın.
delimitedText	string	Bloblar düz CSV dosyaları olduğunda delimitedText olarak ayarlayın.
json	string	JSON dosyalarından yapılandırılmış içerik ayıklamak için json olarak ayarlayın.
jsonArray	string	JSON dizisinin tek tek öğelerini ayrı belgeler olarak ayıklamak için jsonArray olarak ayarlayın.
jsonLines	string	Ayrı ayrı JSON varlıklarını ayrı belgeler olarak, yeni bir satırla ayırarak ayıklamak için jsonLines olarak ayarlayın.
text	string	Blob depolamadaki düz metin dosyalarında dizin oluşturma performansını geliştirmek için metne ayarlayın.

BlobIndexerPDFTextRotationAlgorithm

Azure blob depolamadaki PDF dosyalarından metin ayıklama algoritmasını belirler.

Name	Tür	Description
detectAngles	string	İçinde metin döndürülmüş PDF dosyalarından daha iyi ve daha okunabilir metin ayıklaması üretebilir. Bu parametre kullanıldığında küçük bir performans hızı etkisi olabileceğini unutmayın. Bu parametre yalnızca PDF dosyaları için ve yalnızca eklenmiş metin içeren PDF'ler için geçerlidir. Döndürülen metin PDF'deki eklenmiş bir görüntünün içinde görünüyorsa, bu parametre geçerli değildir.
none	string	Normal metin ayıklamadan yararlanıyor. Varsayılan değer budur.

ErrorAdditionalInfo

Kaynak yönetimi hatası ek bilgileri.

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

ErrorDetail

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

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

FieldMapping

Veri kaynağındaki bir alan ile dizindeki hedef alan arasında eşleme tanımlar.

Name	Tür	Description
mappingFunction	FieldMappingFunction	Dizin oluşturmadan önce her kaynak alan değerine uygulanacak bir işlev.
sourceFieldName	string	Veri kaynağındaki alanın adı.
targetFieldName	string	Dizindeki hedef alanın adı. Varsayılan olarak kaynak alan adıyla aynıdır.

FieldMappingFunction

Dizin oluşturmadan önce veri kaynağından bir değeri dönüştüren bir işlevi temsil eder.

Name	Tür	Description
name	string	Alan eşleme işlevinin adı.
parameters	object	İşleve geçirilebilir parametre adı/değer çiftleri sözlüğü. Her değer ilkel türde olmalıdır.

IndexerExecutionEnvironment

Dizin oluşturucunun yürütülmesi gereken ortamı belirtir.

Name	Tür	Description
private	string	Dizin oluşturucunun arama hizmeti için özel olarak sağlanan ortamla çalışması gerektiğini gösterir. Bu, yalnızca dizin oluşturucunun paylaşılan özel bağlantı kaynakları üzerinden kaynaklara güvenli bir şekilde erişmesi gerekiyorsa yürütme ortamı olarak belirtilmelidir.
standard	string	Arama hizmetinin dizin oluşturucunun yürütüleceği yeri belirleyebileceğini gösterir. Bu, hiçbir şey belirtilmediğinde varsayılan ortamdır ve önerilen değerdir.

IndexingParameters

Dizin oluşturucu yürütme parametrelerini temsil eder.

Name	Tür	Default value	Description
batchSize	integer		Performansı geliştirmek için veri kaynağından okunan ve tek bir toplu iş olarak dizine alınan öğelerin sayısı. Varsayılan değer, veri kaynağı türüne bağlıdır.
configuration	IndexingParametersConfiguration		Dizin oluşturucuya özgü yapılandırma özelliklerinin sözlüğü. Her ad belirli bir özelliğin adıdır. Her değer ilkel türde olmalıdır.
maxFailedItems	integer	0	Dizin oluşturucu yürütmesi için dizin oluşturmada başarısız olabilecek en fazla öğe sayısı yine de başarılı olarak kabul edilir. -1, sınır olmadığı anlamına gelir. Varsayılan değer 0'dır.
maxFailedItemsPerBatch	integer	0	Tek bir toplu işlemdeki en fazla öğe sayısı, toplu işlemin başarılı olarak kabul edilmesi için dizin oluşturmada başarısız olabilir. -1, sınır olmadığı anlamına gelir. Varsayılan değer 0'dır.

IndexingParametersConfiguration

Dizin oluşturucuya özgü yapılandırma özelliklerinin sözlüğü. Her ad belirli bir özelliğin adıdır. Her değer ilkel türde olmalıdır.

Name	Tür	Default value	Description
allowSkillsetToReadFileData	boolean	False	True ise, blob veri kaynağınızdan indirilen özgün dosya verilerini temsil eden bir nesne olan bir //document///file_data yolu oluşturur. Bu, özgün dosya verilerini zenginleştirme işlem hattı içinde işlenmek üzere özel bir beceriye veya Belge Ayıklama becerisine geçirmenizi sağlar.
dataToExtract	BlobIndexerDataToExtract	contentAndMetadata	Azure blob depolamadan ayıklanması gereken verileri belirtir ve "imageAction" "none" dışında bir değere ayarlandığında dizin oluşturucuya görüntü içeriğinden ayıklanması gereken verileri bildirir. Bu, .PDF veya başka bir uygulamadaki ekli görüntü içeriği veya Azure bloblarında .jpg ve .pnggibi görüntü dosyaları için geçerlidir.
delimitedTextDelimiter	string		CSV blobları için, her satırın yeni bir belge başlattığı CSV dosyaları için satır sonu tek karakterli sınırlayıcıyı belirtir (örneğin, "\|").
delimitedTextHeaders	string		CSV blobları için, kaynak alanları dizindeki hedef alanlara eşlemek için yararlı olan, virgülle ayrılmış sütun başlıkları listesini belirtir.
documentRoot	string		Yapılandırılmış veya yarı yapılandırılmış bir belge verilen JSON dizileri için bu özelliği kullanarak dizinin yolunu belirtebilirsiniz.
excludedFileNameExtensions	string		Azure blob depolamadan işlenirken yoksayılması gereken dosya adı uzantılarının virgülle ayrılmış listesi. Örneğin, dizin oluşturma sırasında bu dosyaları atlamak için ".png, .mp4" dışlayabilirsiniz.
executionEnvironment	IndexerExecutionEnvironment	standard	Dizin oluşturucunun yürütülmesi gereken ortamı belirtir.
failOnUnprocessableDocument	boolean	False	Azure blobları için, bir belge dizin oluşturmada başarısız olursa dizine almaya devam etmek istiyorsanız false olarak ayarlayın.
failOnUnsupportedContentType	boolean	False	Azure blobları için, desteklenmeyen bir içerik türüyle karşılaşıldığında dizin oluşturma işlemine devam etmek istiyorsanız ve tüm içerik türlerini (dosya uzantıları) önceden bilmiyorsanız false olarak ayarlayın.
firstLineContainsHeaders	boolean	True	CSV blobları için, her blobun ilk (boş olmayan) satırının üst bilgi içerdiğini gösterir.
imageAction	BlobIndexerImageAction	none	Azure blob depolamada ekli görüntülerin ve görüntü dosyalarının nasıl işleneceğini belirler. "imageAction" yapılandırmasını "none" dışında bir değere ayarlamak için bir beceri kümesinin de bu dizin oluşturucuya eklenmesi gerekir.
indexStorageMetadataOnlyForOversizedDocuments	boolean	False	Azure blobları için, işlenmek için çok büyük olan blob içeriğinin depolama meta verilerini dizine almaya devam etmek için bu özelliği true olarak ayarlayın. Büyük büyük bloblar varsayılan olarak hata olarak değerlendirilir. Blob boyutuyla ilgili sınırlar için bkz. https://learn.microsoft.com/azure/search/search-limits-quotas-capacity.
indexedFileNameExtensions	string		Azure blob depolamadan işlenirken seçecek dosya adı uzantılarının virgülle ayrılmış listesi. Örneğin, özellikle bu dosya türlerini eklemek için ".docx, .pptx, .msg" belirli uygulama dosyalarında dizin oluşturmayı odaklayabilirsiniz.
parsingMode	BlobIndexerParsingMode	default	Azure blob veri kaynağından dizin oluşturma için ayrıştırma modunu temsil eder.
pdfTextRotationAlgorithm	BlobIndexerPDFTextRotationAlgorithm	none	Azure blob depolamadaki PDF dosyalarından metin ayıklama algoritmasını belirler.
queryTimeout	string	00:05:00	Azure SQL veritabanı veri kaynakları için "hh:mm:ss" biçiminde belirtilen 5 dakikalık varsayılanın ötesinde zaman aşımını artırır.

IndexingSchedule

Dizin oluşturucu yürütme zamanlamasını temsil eder.

Name	Tür	Description
interval	string	Dizin oluşturucu yürütmeleri arasındaki zaman aralığı.
startTime	string	Dizin oluşturucunun çalışmaya başlaması gereken zaman.

SearchIndexer

Bir dizin oluşturucu temsil eder.

Name	Tür	Default value	Description
@odata.etag	string		Dizin oluşturucunun ETag'i.
dataSourceName	string		Bu dizin oluşturucunun verileri okuduğu veri kaynağının adı.
description	string		Dizin oluşturucunun açıklaması.
disabled	boolean	False	Dizin oluşturucunun devre dışı bırakılıp bırakılmadığını gösteren değer. Varsayılan değer false'tur.
encryptionKey	SearchResourceEncryptionKey		Azure Key Vault'ta oluşturduğunuz bir şifreleme anahtarının açıklaması. Bu anahtar, dizin oluşturucu tanımınız (dizin oluşturucu yürütme durumunun yanı sıra) microsoft bile dahil olmak üzere kimsenin şifresini çözemediğini tam olarak güvenceye almak istediğinizde, bekleyen ek bir şifreleme düzeyi sağlamak için kullanılır. Dizin oluşturucu tanımınızı şifreledikten sonra her zaman şifrelenmiş olarak kalı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; Dizin oluşturucu tanımınız (ve dizin oluşturucu yürütme durumunuz) etkilenmez. 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.
fieldMappings	FieldMapping[]		Veri kaynağındaki alanlar ile dizindeki karşılık gelen hedef alanlar arasındaki eşlemeleri tanımlar.
name	string		Dizin oluşturucunun adı.
outputFieldMappings	FieldMapping[]		Çıktı alanı eşlemeleri zenginleştirmeden sonra ve dizin oluşturmadan hemen önce uygulanır.
parameters	IndexingParameters		Dizin oluşturucu yürütme parametreleri.
schedule	IndexingSchedule		Bu dizin oluşturucunun zamanlaması.
skillsetName	string		Bu dizin oluşturucuyla yürütülen beceri kümesinin adı.
targetIndexName	string		Bu dizin oluşturucunun veri yazdığı dizinin adı.

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ı haritalar gibi bekleyen verileri şifrelemek veya şifresini çözmek için kullanılabilir.

Name	Tür	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault'unuza 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.
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.

Aracılığıyla paylaş