Indexers - Create Or Update

Reference

Service:: Search Service

API Version:: 2023-10-01-Preview

Vytvoří nový indexer nebo aktualizuje indexer, pokud už existuje.

PUT {endpoint}/indexers('{indexerName}')?api-version=2023-10-01-Preview

With optional parameters:

PUT {endpoint}/indexers('{indexerName}')?api-version=2023-10-01-Preview&ignoreResetRequirements={ignoreResetRequirements}&disableCacheReprocessingChangeDetection={disableCacheReprocessingChangeDetection}

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexerName	path	True	string	Název indexeru, který chcete vytvořit nebo aktualizovat.
api-version	query	True	string	Verze rozhraní API klienta.
disableCacheReprocessingChangeDetection	query		boolean	Zakáže detekci změn při opětovném zpracování mezipaměti.
ignoreResetRequirements	query		boolean	Ignoruje požadavky na resetování mezipaměti.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.
If-Match		string	Definuje podmínku If-Match. Operace se provede pouze v případě, že značka ETag na serveru odpovídá této hodnotě.
If-None-Match		string	Definuje podmínku If-None-Match. Operace se provede pouze v případě, že značka ETag na serveru neodpovídá této hodnotě.
Prefer	True	string	V případě požadavků HTTP PUT dává službě pokyn, aby v případě úspěchu vrátila vytvořený nebo aktualizovaný prostředek.

Text požadavku

Name	Vyžadováno	Typ	Description
dataSourceName	True	string	Název zdroje dat, ze kterého tento indexer čte data.
name	True	string	Název indexeru.
targetIndexName	True	string	Název indexu, do kterého tento indexer zapisuje data.
@odata.etag		string	Značka ETag indexeru.
cache		SearchIndexerCache	Přidá ukládání do mezipaměti do kanálu rozšiřování, aby bylo možné provádět kroky přírůstkových úprav, aniž byste museli index pokaždé znovu sestavit.
description		string	Popis indexeru.
disabled		boolean	Hodnota označující, zda je indexer zakázán. Výchozí hodnota je false.
encryptionKey		SearchResourceEncryptionKey	Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici indexeru (stejně jako stav spuštění indexeru), pokud chcete mít plnou jistotu, že je nikdo, dokonce ani Microsoft, nemůže dešifrovat. Jakmile zašifrujete definici indexeru, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Definice indexeru (a stav spuštění indexeru) nebudou ovlivněny. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
fieldMappings		FieldMapping[]	Definuje mapování mezi poli ve zdroji dat a odpovídajícími cílovými poli v indexu.
outputFieldMappings		FieldMapping[]	Mapování výstupních polí se použijí po rozšíření a bezprostředně před indexováním.
parameters		IndexingParameters	Parametry pro provádění indexeru.
schedule		IndexingSchedule	Plán pro tento indexer.
skillsetName		string	Název sady dovedností spouštěné pomocí tohoto indexeru.

Odpovědi

Name	Typ	Description
200 OK	SearchIndexer
201 Created	SearchIndexer
Other Status Codes	SearchError	Odpověď na chybu.

Příklady

SearchServiceCreateOrUpdateIndexer

Sample Request

HTTP

PUT https://myservice.search.windows.net/indexers('myindexer')?api-version=2023-10-01-Preview


{
  "name": "myindexer",
  "description": "a cool 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": null
  }
}

Sample Response

Status code:: 200

{
  "name": "myindexer",
  "description": "a cool 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": null
  }
}

Status code:: 201

{
  "name": "myindexer",
  "description": "a cool 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": null
  }
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým v Azure Key Vault.
BlobIndexerDataToExtract	Určuje data, která se mají extrahovat z úložiště objektů blob v Azure, a řekne indexeru, která data se mají extrahovat z obsahu obrázku, když je imageAction nastavená na jinou hodnotu než "none". To platí pro vložený obsah obrázků v .PDF nebo jiné aplikaci nebo soubory obrázků, jako jsou .jpg a .png, v objektech blob Azure.
BlobIndexerImageAction	Určuje, jak zpracovávat vložené obrázky a soubory obrázků ve službě Azure Blob Storage. Nastavení konfigurace "imageAction" na jinou hodnotu než "none" vyžaduje, aby byla k danému indexeru připojena také sada dovedností.
BlobIndexerParsingMode	Představuje režim analýzy pro indexování ze zdroje dat objektů blob Azure.
BlobIndexerPDFTextRotationAlgorithm	Určuje algoritmus pro extrakci textu ze souborů PDF ve službě Azure Blob Storage.
FieldMapping	Definuje mapování mezi polem ve zdroji dat a cílovým polem v indexu.
FieldMappingFunction	Představuje funkci, která před indexováním transformuje hodnotu ze zdroje dat.
IndexerExecutionEnvironment	Určuje prostředí, ve kterém se má indexer spustit.
IndexingParameters	Představuje parametry pro provádění indexeru.
IndexingParametersConfiguration	Slovník vlastností konfigurace specifických pro indexer. Každý název je název konkrétní vlastnosti. Každá hodnota musí být primitivního typu.
IndexingSchedule	Představuje plán provádění indexeru.
SearchError	Popisuje chybový stav rozhraní API.
SearchIndexer	Představuje indexer.
SearchIndexerCache
SearchIndexerDataNoneIdentity	Vymaže vlastnost identity zdroje dat.
SearchIndexerDataUserAssignedIdentity	Určuje identitu pro zdroj dat, který se má použít.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

AzureActiveDirectoryApplicationCredentials

Přihlašovací údaje zaregistrované aplikace vytvořené pro vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým v Azure Key Vault.

Name	Typ	Description
applicationId	string	ID aplikace AAD, kterému byla udělena požadovaná přístupová oprávnění k azure Key Vault, která se mají použít při šifrování neaktivních uložených dat. ID aplikace by se nemělo zaměňovat s ID objektu vaší aplikace AAD.
applicationSecret	string	Ověřovací klíč zadané aplikace AAD.

BlobIndexerDataToExtract

Určuje data, která se mají extrahovat z úložiště objektů blob v Azure, a řekne indexeru, která data se mají extrahovat z obsahu obrázku, když je imageAction nastavená na jinou hodnotu než "none". To platí pro vložený obsah obrázků v .PDF nebo jiné aplikaci nebo soubory obrázků, jako jsou .jpg a .png, v objektech blob Azure.

Name	Typ	Description
allMetadata	string	Extrahuje metadata poskytovaná subsystémem Úložiště objektů blob v Azure a metadata specifická pro obsah (například metadata jedinečná jenom pro .png soubory se indexují).
contentAndMetadata	string	Extrahuje všechna metadata a textový obsah z každého objektu blob.
storageMetadata	string	Indexuje pouze standardní vlastnosti objektu blob a metadata zadaná uživatelem.

BlobIndexerImageAction

Určuje, jak zpracovávat vložené obrázky a soubory obrázků ve službě Azure Blob Storage. Nastavení konfigurace "imageAction" na jinou hodnotu než "none" vyžaduje, aby byla k danému indexeru připojena také sada dovedností.

Name	Typ	Description
generateNormalizedImagePerPage	string	Extrahuje text z obrázků (například slovo "STOP" ze symbolu zastavení provozu) a vloží ho do pole obsahu, ale zachází se soubory PDF odlišně v tom, že každá stránka se vykresluje jako obrázek a odpovídajícím způsobem normalizuje místo extrahování vložených obrázků. S typy souborů bez PDF se bude zacházet stejně, jako kdyby byla nastavena hodnota generateNormalizedImages.
generateNormalizedImages	string	Extrahuje text z obrázků (například slovo "STOP" ze symbolu zastavení provozu) a vloží ho do pole obsahu. Tato akce vyžaduje, aby hodnota dataToExtract byla nastavena na contentAndMetadata. Normalizovaný obrázek označuje další zpracování, jehož výsledkem je rovnoměrný výstup obrázku, jeho velikost a otočení, aby se při zahrnutí obrázků do vizuálních výsledků hledání podpořilo konzistentní vykreslování. Tyto informace se při použití této možnosti vygenerují pro každou image.
none	string	Ignoruje vložené obrázky nebo soubory obrázků v datové sadě. Tato možnost je výchozí.

BlobIndexerParsingMode

Představuje režim analýzy pro indexování ze zdroje dat objektů blob Azure.

Name	Typ	Description
default	string	Pro normální zpracování souborů nastavte výchozí hodnotu.
delimitedText	string	Pokud jsou objekty blob prostými soubory CSV, nastavte na hodnotu delimitedText.
json	string	Pokud chcete extrahovat strukturovaný obsah ze souborů JSON, nastavte na json.
jsonArray	string	Nastavením na jsonArray extrahujte jednotlivé prvky pole JSON jako samostatné dokumenty.
jsonLines	string	Nastavením na jsonLines extrahujte jednotlivé entity JSON oddělené novým řádkem jako samostatné dokumenty.
text	string	Nastavením na text zlepšíte výkon indexování souborů ve formátu prostého textu v úložišti objektů blob.

BlobIndexerPDFTextRotationAlgorithm

Určuje algoritmus pro extrakci textu ze souborů PDF ve službě Azure Blob Storage.

Name	Typ	Description
detectAngles	string	Může vytvářet lepší a čitelnější extrakci textu ze souborů PDF, které mají otočený text v nich. Všimněte si, že při použití tohoto parametru může dojít k malému dopadu na rychlost výkonu. Tento parametr platí pouze pro soubory PDF a pouze pro soubory PDF s vloženým textem. Pokud se otočený text zobrazí ve vloženém obrázku v PDF, tento parametr se nepoužije.
none	string	Využívá normální extrakci textu. Tato možnost je výchozí.

FieldMapping

Definuje mapování mezi polem ve zdroji dat a cílovým polem v indexu.

Name	Typ	Description
mappingFunction	FieldMappingFunction	Funkce, která se má použít pro každou hodnotu zdrojového pole před indexováním.
sourceFieldName	string	Název pole ve zdroji dat.
targetFieldName	string	Název cílového pole v indexu. Ve výchozím nastavení je stejný jako název zdrojového pole.

FieldMappingFunction

Představuje funkci, která před indexováním transformuje hodnotu ze zdroje dat.

Name	Typ	Description
name	string	Název funkce mapování polí
parameters	object	Slovník párů název/hodnota parametru, které se mají předat funkci. Každá hodnota musí být primitivního typu.

IndexerExecutionEnvironment

Určuje prostředí, ve kterém se má indexer spustit.

Name	Typ	Description
private	string	Označuje, že indexer by měl běžet s prostředím zřízeným speciálně pro vyhledávací službu. To by se mělo zadat jako spouštěcí prostředí pouze v případě, že indexer potřebuje zabezpečený přístup k prostředkům přes prostředky sdíleného privátního propojení.
standard	string	Označuje, že vyhledávací služba může určit, kde se má indexer spustit. Toto je výchozí prostředí, pokud není zadáno nic a jedná se o doporučenou hodnotu.

IndexingParameters

Představuje parametry pro provádění indexeru.

Name	Typ	Výchozí hodnota	Description
batchSize	integer		Počet položek, které jsou načteny ze zdroje dat a indexovány jako jedna dávka, aby se zlepšil výkon. Výchozí nastavení závisí na typu zdroje dat.
configuration	IndexingParametersConfiguration		Slovník vlastností konfigurace specifických pro indexer. Každý název je název konkrétní vlastnosti. Každá hodnota musí být primitivního typu.
maxFailedItems	integer	0	Maximální počet položek, které můžou selhat při indexování, aby bylo provádění indexeru stále považováno za úspěšné. -1 znamená žádné omezení. Výchozí hodnota je 0.
maxFailedItemsPerBatch	integer	0	Maximální počet položek v jedné dávce, u které může selhat indexování, aby byla dávka stále považována za úspěšnou. -1 znamená žádné omezení. Výchozí hodnota je 0.

IndexingParametersConfiguration

Slovník vlastností konfigurace specifických pro indexer. Každý název je název konkrétní vlastnosti. Každá hodnota musí být primitivního typu.

Name	Typ	Výchozí hodnota	Description
allowSkillsetToReadFileData	boolean	False	Pokud je true, vytvoří cestu //document//file_data, což je objekt představující data původního souboru stažená ze zdroje dat objektů blob. To vám umožní předat původní data souboru vlastní dovednosti pro zpracování v rámci kanálu rozšiřování nebo dovednosti extrakce dokumentů.
dataToExtract	BlobIndexerDataToExtract	contentAndMetadata	Určuje data, která se mají extrahovat z úložiště objektů blob v Azure, a řekne indexeru, která data se mají extrahovat z obsahu obrázku, když je imageAction nastavená na jinou hodnotu než "none". To platí pro vložený obsah obrázků v .PDF nebo jiné aplikaci nebo soubory obrázků, jako jsou .jpg a .png, v objektech blob Azure.
delimitedTextDelimiter	string		Pro objekty blob CSV určuje oddělovač konce řádku pro soubory CSV, kde každý řádek začíná nový dokument (například \|).
delimitedTextHeaders	string		Pro objekty blob CSV určuje seznam záhlaví sloupců oddělených čárkami, který je užitečný pro mapování zdrojových polí na cílová pole v indexu.
documentRoot	string		U polí JSON můžete u strukturovaného nebo částečně strukturovaného dokumentu zadat cestu k poli pomocí této vlastnosti.
excludedFileNameExtensions	string		Seznam přípon názvů souborů oddělených čárkami, které se při zpracování ze služby Azure Blob Storage ignorují. Můžete například vyloučit ".png, .mp4", abyste tyto soubory během indexování přeskočili.
executionEnvironment	IndexerExecutionEnvironment	standard	Určuje prostředí, ve kterém se má indexer spustit.
failOnUnprocessableDocument	boolean	False	V případě objektů blob Azure nastavte hodnotu false, pokud chcete pokračovat v indexování, pokud se indexování dokumentu nezdaří.
failOnUnsupportedContentType	boolean	False	V případě objektů blob Azure nastavte hodnotu false, pokud chcete pokračovat v indexování, když se zjistí nepodporovaný typ obsahu a neznáte předem všechny typy obsahu (přípony souborů).
firstLineContainsHeaders	boolean	True	U objektů blob CSV označuje, že první (neprázdný) řádek každého objektu blob obsahuje hlavičky.
imageAction	BlobIndexerImageAction	none	Určuje, jak zpracovávat vložené obrázky a soubory obrázků ve službě Azure Blob Storage. Nastavení konfigurace "imageAction" na jinou hodnotu než "none" vyžaduje, aby byla k danému indexeru připojena také sada dovedností.
indexStorageMetadataOnlyForOversizedDocuments	boolean	False	V případě objektů blob Azure nastavte tuto vlastnost na true, aby stále indexovat metadata úložiště pro obsah objektů blob, který je příliš velký na zpracování. Objekty blob s naddimenzovanou hodnotou se ve výchozím nastavení považují za chyby. Omezení velikosti objektů blob najdete v tématu https://docs.microsoft.com/azure/search/search-limits-quotas-capacity.
indexedFileNameExtensions	string		Seznam přípon názvů souborů oddělených čárkami, které se mají vybrat při zpracování ze služby Azure Blob Storage. Indexování můžete například zaměřit na konkrétní soubory aplikace ".docx, .pptx .msg", abyste tyto typy souborů konkrétně zahrnuli.
parsingMode	BlobIndexerParsingMode	default	Představuje režim analýzy pro indexování ze zdroje dat objektů blob Azure.
pdfTextRotationAlgorithm	BlobIndexerPDFTextRotationAlgorithm	none	Určuje algoritmus pro extrakci textu ze souborů PDF ve službě Azure Blob Storage.
queryTimeout	string	00:05:00	Zvýší časový limit nad 5minutovou výchozí hodnotu pro zdroje dat Azure SQL databáze zadanou ve formátu hh:mm:ss.

IndexingSchedule

Představuje plán provádění indexeru.

Name	Typ	Description
interval	string	Časový interval mezi spuštěními indexeru.
startTime	string	Čas, kdy by se měl spustit indexer.

SearchError

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definované sady kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

SearchIndexer

Představuje indexer.

Name	Typ	Výchozí hodnota	Description
@odata.etag	string		Značka ETag indexeru.
cache	SearchIndexerCache		Přidá ukládání do mezipaměti do kanálu rozšiřování, aby bylo možné provádět kroky přírůstkových úprav, aniž byste museli index pokaždé znovu sestavit.
dataSourceName	string		Název zdroje dat, ze kterého tento indexer čte data.
description	string		Popis indexeru.
disabled	boolean	False	Hodnota označující, zda je indexer zakázán. Výchozí hodnota je false.
encryptionKey	SearchResourceEncryptionKey		Popis šifrovacího klíče, který vytvoříte v Azure Key Vault. Tento klíč slouží k poskytnutí další úrovně šifrování neaktivních uložených uložených dat pro definici indexeru (stejně jako stav spuštění indexeru), pokud chcete mít plnou jistotu, že je nikdo, dokonce ani Microsoft, nemůže dešifrovat. Jakmile zašifrujete definici indexeru, zůstane vždy zašifrovaná. Vyhledávací služba bude ignorovat pokusy o nastavení této vlastnosti na hodnotu null. Pokud chcete šifrovací klíč obměnit, můžete tuto vlastnost podle potřeby změnit. Definice indexeru (a stav spuštění indexeru) nebudou ovlivněny. Šifrování pomocí klíčů spravovaných zákazníkem není k dispozici pro bezplatné vyhledávací služby a je k dispozici pouze pro placené služby vytvořené 1. ledna 2019 nebo později.
fieldMappings	FieldMapping[]		Definuje mapování mezi poli ve zdroji dat a odpovídajícími cílovými poli v indexu.
name	string		Název indexeru.
outputFieldMappings	FieldMapping[]		Mapování výstupních polí se použijí po rozšíření a bezprostředně před indexováním.
parameters	IndexingParameters		Parametry pro provádění indexeru.
schedule	IndexingSchedule		Plán pro tento indexer.
skillsetName	string		Název sady dovedností spouštěné pomocí tohoto indexeru.
targetIndexName	string		Název indexu, do kterého tento indexer zapisuje data.

SearchIndexerCache

Name	Typ	Description
enableReprocessing	boolean	Určuje, jestli je povolené přírůstkové opětovné zpracování.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Spravovaná identita přiřazená uživatelem používaná pro připojení k mezipaměti rozšiřování. Pokud připojovací řetězec označuje identitu (Id prostředku) a není zadána, použije se spravovaná identita přiřazená systémem. Pokud při aktualizaci indexeru není identita určená, zůstane hodnota beze změny. Pokud je nastavená hodnota "none", hodnota této vlastnosti se vymaže.
storageConnectionString	string	Připojovací řetězec k účtu úložiště, ve kterém budou uložená data mezipaměti.

SearchIndexerDataNoneIdentity

Vymaže vlastnost identity zdroje dat.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Fragment identifikátoru URI určující typ identity.

SearchIndexerDataUserAssignedIdentity

Určuje identitu pro zdroj dat, který se má použít.

Name	Typ	Description
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Fragment identifikátoru URI určující typ identity.
userAssignedIdentity	string	Plně kvalifikované ID prostředku Azure spravované identity přiřazené uživatelem obvykle ve tvaru /subscriptions/12345678-1234-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId, které by mělo být přiřazeno vyhledávací službě.

SearchResourceEncryptionKey

Šifrovací klíč spravovaný zákazníkem v Azure Key Vault. Klíče, které vytvoříte a spravujete, můžete použít k šifrování nebo dešifrování neaktivních uložených dat, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup k Key Vault Azure. Nevyžaduje se, pokud místo toho použijete spravovanou identitu.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Explicitní spravovaná identita, která se má použít pro tento šifrovací klíč. Pokud není zadána a vlastnost přihlašovacích údajů přístupu je null, použije se spravovaná identita přiřazená systémem. Pokud při aktualizaci prostředku není explicitní identita určená, zůstane beze změny. Pokud je zadána hodnota none, hodnota této vlastnosti se vymaže.
keyVaultKeyName	string	Název klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI Key Vault Azure, označovaný také jako název DNS, který obsahuje klíč, který se má použít k šifrování neaktivních uložených dat. Příkladem identifikátoru URI může být `https://my-keyvault-name.vault.azure.net`.

Share via