Indexers - List

Služba:: Search Service

Verze rozhraní API:: 2023-11-01

Zobrazí seznam všech indexerů dostupných pro vyhledávací službu.

GET {endpoint}/indexers?api-version=2023-11-01

S volitelnými parametry:

GET {endpoint}/indexers?$select={$select}&api-version=2023-11-01

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
api-version	query	True	string	Verze rozhraní API klienta.
$select	query		string	Vybere, které vlastnosti nejvyšší úrovně indexerů se mají načíst. Zadaný jako čárkami oddělený seznam názvů vlastností JSON nebo `*` pro všechny vlastnosti. Výchozí hodnota je všechny vlastnosti.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	ID sledování odeslané s požadavkem, které vám pomůže s laděním.

Odpovědi

Name	Typ	Description
200 OK	ListIndexersResult
Other Status Codes	SearchError	Chybová odpověď.

Příklady

SearchServiceListIndexers

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/indexers?$select=*&api-version=2023-11-01

Ukázková odpověď

Stavový kód:: 200

{
  "value": [
    {
      "name": "myindexer",
      "description": "a cool indexer",
      "dataSourceName": "mydocdbdatasource",
      "targetIndexName": "orders",
      "schedule": {
        "interval": "PT1H",
        "startTime": "2015-01-01T00:00:00Z"
      },
      "parameters": {
        "maxFailedItems": 10,
        "maxFailedItemsPerBatch": 5
      },
      "fieldMappings": [],
      "disabled": false
    },
    {
      "name": "myotherindexer",
      "description": "another cool indexer",
      "dataSourceName": "myblobdatasource",
      "targetIndexName": "orders",
      "parameters": {
        "maxFailedItems": 10,
        "maxFailedItemsPerBatch": 5,
        "batchSize": 15
      },
      "fieldMappings": [
        {
          "sourceFieldName": "PersonName",
          "targetFieldName": "FirstName",
          "mappingFunction": {
            "name": "extractTokenAtPosition",
            "parameters": {
              "delimiter": " ",
              "position": 0
            }
          }
        },
        {
          "sourceFieldName": "PersonName",
          "targetFieldName": "LastName",
          "mappingFunction": {
            "name": "extractTokenAtPosition",
            "parameters": {
              "delimiter": " ",
              "position": 1
            }
          }
        }
      ],
      "disabled": false,
      "encryptionKey": {
        "keyVaultKeyName": "myKeyName",
        "keyVaultKeyVersion": "myKeyVersion",
        "keyVaultUri": "https://myKeyVault.vault.azure.net",
        "accessCredentials": {
          "applicationId": "00000000-0000-0000-0000-000000000000",
          "applicationSecret": null
        }
      }
    }
  ]
}

Definice

Name	Description
AzureActiveDirectoryApplicationCredentials	Přihlašovací údaje registrované aplikace vytvořené pro vaši vyhledávací službu, které slouží k ověřenému přístupu k šifrovacím klíčům uloženým ve službě 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 vlastnost imageAction nastavená na jinou hodnotu než žádná. To platí pro vložený obsah obrázku 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ů v Úložišti objektů blob v Azure. Nastavení konfigurace imageAction na jinou hodnotu než žádná vyžaduje, aby byla k sadě dovedností připojena také tato sada dovedností.
BlobIndexerParsingMode	Představuje režim analýzy indexování ze zdroje dat objektů blob Azure.
BlobIndexerPDFTextRotationAlgorithm	Určuje algoritmus extrakce textu ze souborů PDF v úložišti objektů blob v Azure.
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 má indexer provést.
IndexingParameters	Představuje parametry pro spuštění indexeru.
IndexingParametersConfiguration	Slovník vlastností konfigurace specifické 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.
ListIndexersResult	Odpověď z požadavku Indexerů seznamu V případě úspěchu zahrnuje úplné definice všech indexerů.
SearchError	Popisuje chybový stav rozhraní API.
SearchIndexer	Představuje indexer.
SearchResourceEncryptionKey	Šifrovací klíč spravovaný zákazníkem ve službě 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 ve vyhledávací službě, jako jsou indexy a mapy synonym.

AzureActiveDirectoryApplicationCredentials

Objekt

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

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

BlobIndexerDataToExtract

Výčet

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 vlastnost imageAction nastavená na jinou hodnotu než žádná. To platí pro vložený obsah obrázku v .PDF nebo jiné aplikaci nebo soubory obrázků, jako jsou .jpg a .png, v objektech blob Azure.

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

BlobIndexerImageAction

Výčet

Určuje, jak zpracovávat vložené obrázky a soubory obrázků v Úložišti objektů blob v Azure. Nastavení konfigurace imageAction na jinou hodnotu než žádná vyžaduje, aby byla k sadě dovedností připojena také tato sada dovedností.

Hodnota	Description
none	Ignoruje vložené obrázky nebo soubory obrázků v sadě dat. Toto je výchozí hodnota.
generateNormalizedImages	Extrahuje text z obrázků (například slovo "STOP" z znaménka zastavení provozu) a vloží ho do pole obsahu. Tato akce vyžaduje, aby vlastnost dataToExtract byla nastavena na contentAndMetadata. Normalizovaný obrázek odkazuje na další zpracování, které vede k jednotnému výstupu obrázku, velikosti a otočení, aby se při zahrnutí obrázků do výsledků vizuálního hledání podporoval konzistentní vykreslování. Tyto informace se generují pro každou image při použití této možnosti.
generateNormalizedImagePerPage	Extrahuje text z obrázků (například slovo "STOP" z znaménka 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ů. Typy souborů, které nejsou pdf, budou považovány za stejné, jako kdyby bylo nastaveno "generateNormalizedImages".

BlobIndexerParsingMode

Výčet

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

Hodnota	Description
default	Nastavte na výchozí hodnotu pro normální zpracování souborů.
text	Nastavte na text, aby se zlepšil výkon indexování u souborů ve formátu prostého textu v úložišti objektů blob.
delimitedText	Nastavte na oddělovačText, pokud jsou objekty blob prostými soubory CSV.
json	Nastavte na json a extrahujte strukturovaný obsah ze souborů JSON.
jsonArray	Nastavte na jsonArray a extrahujte jednotlivé prvky pole JSON jako samostatné dokumenty.
jsonLines	Nastavte na jsonLines a extrahujte jednotlivé entity JSON oddělené novým řádkem jako samostatné dokumenty.

BlobIndexerPDFTextRotationAlgorithm

Výčet

Určuje algoritmus extrakce textu ze souborů PDF v úložišti objektů blob v Azure.

Hodnota	Description
none	Využívá normální extrakci textu. Toto je výchozí hodnota.
detectAngles	Může generovat lepší a čitelnější extrakci textu ze souborů PDF, které v nich otočily text. 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 se vztahuje pouze na soubory PDF a pouze na soubory PDF s vloženým textem. Pokud se otočený text zobrazí v vloženém obrázku v PDF, tento parametr se nepoužije.

FieldMapping

Objekt

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. Stejné jako název zdrojového pole ve výchozím nastavení.

FieldMappingFunction

Objekt

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 předávají funkci. Každá hodnota musí být primitivního typu.

IndexerExecutionEnvironment

Výčet

Určuje prostředí, ve kterém má indexer provést.

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

IndexingParameters

Objekt

Představuje parametry pro spuštění indexeru.

Name	Typ	Default value	Description
batchSize	integer (int32)		Počet položek, které se čtou ze zdroje dat a indexují se 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é pro indexer. Každý název je název konkrétní vlastnosti. Každá hodnota musí být primitivního typu.
maxFailedItems	integer (int32)	0	Maximální počet položek, které můžou selhat indexování pro provádění indexeru, se stále považuje za úspěšné. -1 znamená žádný limit. Výchozí hodnota je 0.
maxFailedItemsPerBatch	integer (int32)	0	Maximální počet položek v jedné dávce, které můžou selhat indexování dávky, aby byla stále považována za úspěšnou. -1 znamená žádný limit. Výchozí hodnota je 0.

IndexingParametersConfiguration

Objekt

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

Name	Typ	Default value	Description
allowSkillsetToReadFileData	boolean	False	Pokud je hodnota true, vytvoří se cesta //document//file_data, která představuje původní data souboru stažená z vašeho zdroje dat objektu 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 do 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 vlastnost imageAction nastavená na jinou hodnotu než žádná. To platí pro vložený obsah obrázku v .PDF nebo jiné aplikaci nebo soubory obrázků, jako jsou .jpg a .png, v objektech blob Azure.
delimitedTextDelimiter	string		U objektů blob sdíleného svazku clusteru určuje oddělovač jednoho řádku pro soubory CSV, kde každý řádek začíná novým dokumentem (například \|).
delimitedTextHeaders	string		Pro objekty blob sdíleného svazku clusteru určuje čárkami oddělený seznam záhlaví sloupců, který je užitečný pro mapování zdrojových polí na cílová pole v indexu.
documentRoot	string		Pro pole JSON, vzhledem k strukturovanému nebo částečně strukturovanému dokumentu, můžete zadat cestu k poli pomocí této vlastnosti.
excludedFileNameExtensions	string		Čárkami oddělený seznam přípon souborů, které se při zpracování z Úložiště objektů blob v Azure ignorují. Můžete například vyloučit ".png, .mp4" a přeskočit tyto soubory během indexování.
executionEnvironment	IndexerExecutionEnvironment	standard	Určuje prostředí, ve kterém má indexer provést.
failOnUnprocessableDocument	boolean	False	U objektů blob Azure nastavte hodnotu false, pokud chcete pokračovat v indexování, pokud se indexování dokumentu nezdaří.
failOnUnsupportedContentType	boolean	False	U objektů blob Azure nastavte hodnotu false, pokud chcete pokračovat v indexování, pokud je zjištěn nepodporovaný typ obsahu a neznáte všechny typy obsahu (přípony souborů) předem.
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ů v Úložišti objektů blob v Azure. Nastavení konfigurace imageAction na jinou hodnotu než žádná vyžaduje, aby byla k sadě dovedností připojena také tato sada dovedností.
indexStorageMetadataOnlyForOversizedDocuments	boolean	False	U 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í. Nadlimitní objekty blob se ve výchozím nastavení považují za chyby. Omezení velikosti objektu blob najdete v tématu https://docs.microsoft.com/azure/search/search-limits-quotas-capacity.
indexedFileNameExtensions	string		Seznam přípon souborů oddělených čárkami, které se mají vybrat při zpracování ze služby Azure Blob Storage. Můžete se například zaměřit na indexování na konkrétní soubory aplikace ".docx, .pptx, .msg" tak, aby byly tyto typy souborů konkrétně zahrnuty.
parsingMode	BlobIndexerParsingMode	default	Představuje režim analýzy indexování ze zdroje dat objektů blob Azure.
pdfTextRotationAlgorithm	BlobIndexerPDFTextRotationAlgorithm	none	Určuje algoritmus extrakce textu ze souborů PDF v úložišti objektů blob v Azure.
queryTimeout	string	00:05:00	Zvýší časový limit nad rámec 5minutového výchozího nastavení pro zdroje dat databáze Azure SQL, který je zadaný ve formátu hh:mm:ss.

IndexingSchedule

Objekt

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

Name	Typ	Description
interval	string (duration)	Interval času mezi spuštěními indexeru.
startTime	string (date-time)	Čas spuštění indexeru.

ListIndexersResult

Objekt

Odpověď z požadavku Indexerů seznamu V případě úspěchu zahrnuje úplné definice všech indexerů.

Name	Typ	Description
value	SearchIndexer[]	Indexery ve vyhledávací službě.

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Name	Typ	Description
code	string	Jedna ze serverově definovaných kódů chyb.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Čitelné znázornění chyby člověkem.

SearchIndexer

Objekt

Představuje indexer.

Name	Typ	Default value	Description
@odata.etag	string		ETag indexeru.
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 ve službě Azure Key Vault. Tento klíč se používá k zajištění další úrovně neaktivních uložených šifrování pro definici indexeru (stejně jako stav spuštění indexeru), pokud chcete mít plnou jistotu, že je nikdo, ani Microsoft, můž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. Tuto vlastnost můžete podle potřeby změnit, pokud chcete šifrovací klíč otočit; Definice indexeru (a stav spuštění indexeru) nebude mít vliv. Š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 po 1. lednu 2019.
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íchpolích
parameters	IndexingParameters		Parametry pro spuštění indexeru
schedule	IndexingSchedule		Plán pro tento indexer.
skillsetName	string		Název sady dovedností, která se spouští s tímto indexerem.
targetIndexName	string		Název indexu, do kterého tento indexer zapisuje data.

SearchResourceEncryptionKey

Objekt

Šifrovací klíč spravovaný zákazníkem ve službě 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 ve vyhledávací službě, jako jsou indexy a mapy synonym.

Name	Typ	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Volitelné přihlašovací údaje Azure Active Directory používané pro přístup ke službě Azure Key Vault. Nevyžaduje se, pokud místo toho používáte spravovanou identitu.
keyVaultKeyName	string	Název klíče služby Azure Key Vault, který se má použít k šifrování neaktivních uložených dat.
keyVaultKeyVersion	string	Verze klíče služby Azure Key Vault, která se má použít k šifrování neaktivních uložených dat.
keyVaultUri	string	Identifikátor URI služby Azure Key Vault, 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`.