Indexers - Create

Referencia

Szolgáltatás:: Search Service

API-verzió:: 2024-07-01

Új indexelőt hoz létre.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
endpoint	path	True	string	A keresési szolgáltatás végponti URL-címe.
api-version	query	True	string	Ügyfél API-verziója.

Kérelem fejléce

Name	Kötelező	Típus	Description
x-ms-client-request-id		string uuid	A kéréssel együtt küldött nyomkövetési azonosító, amely segít a hibakeresésben.

Kérelem törzse

Name	Kötelező	Típus	Description
dataSourceName	True	string	Annak az adatforrásnak a neve, amelyből az indexelő adatokat olvas be.
name	True	string	Az indexelő neve.
targetIndexName	True	string	Annak az indexnek a neve, amelyre az indexelő adatokat ír.
@odata.etag		string	Az indexelő ETagje.
description		string	Az indexelő leírása.
disabled		boolean	Érték, amely jelzi, hogy az indexelő le van-e tiltva. Az alapértelmezett érték hamis.
encryptionKey		SearchResourceEncryptionKey	Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ez a kulcs további inaktív titkosítási szintet biztosít az indexelő definíciójához (valamint az indexelő végrehajtási állapotához), ha teljes bizonyosságot szeretne arról, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az indexelő definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az indexelő definíciója (és az indexelő végrehajtási állapota) nem lesz hatással. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.
fieldMappings		FieldMapping[]	Az adatforrás mezői és az index megfelelő célmezői közötti leképezéseket határozza meg.
outputFieldMappings		FieldMapping[]	A kimeneti mezőleképezések a bővítés után és közvetlenül az indexelés előtt lesznek alkalmazva.
parameters		IndexingParameters	Az indexelő végrehajtásának paraméterei.
schedule		IndexingSchedule	Az indexelő ütemezése.
skillsetName		string	Az indexelővel végrehajtó képességkészlet neve.

Válaszok

Name	Típus	Description
201 Created	SearchIndexer
Other Status Codes	ErrorResponse	Hibaválasz.

Példák

SearchServiceCreateIndexer

Mintakérelem

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>"
    }
  }
}

Mintaválasz

Állapotkód:: 201

{
  "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
    }
  }
}

Definíciók

Name	Description
AzureActiveDirectoryApplicationCredentials	A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.
BlobIndexerDataToExtract	Megadja az Azure Blob Storage-ból kinyerni kívánt adatokat, és közli az indexelővel, hogy mely adatokat kell kinyerni a képtartalomból, ha az "imageAction" értéke nem "none". Ez egy .PDF vagy más alkalmazás beágyazott képtartalmaira, illetve az Azure-blobokban lévő képfájlokra, például .jpg és .pngvonatkozik.
BlobIndexerImageAction	Meghatározza, hogyan dolgozhatja fel a beágyazott képeket és képfájlokat az Azure Blob Storage-ban. Ha az "imageAction" konfigurációt a "none" értéken kívül más értékre állítja be, egy képességkészletet is hozzá kell csatolni az indexelőhöz.
BlobIndexerParsingMode	Az Azure Blob-adatforrásból történő indexelés elemzési módját jelöli.
BlobIndexerPDFTextRotationAlgorithm	Meghatározza az Azure Blob Storage-beli PDF-fájlokból való szövegkivétel algoritmusát.
ErrorAdditionalInfo	Az erőforrás-kezelési hiba további információi.
ErrorDetail	A hiba részletei.
ErrorResponse	Hibaválasz
FieldMapping	Egy adatforrás mezője és egy index célmezője közötti leképezést definiál.
FieldMappingFunction	Olyan függvényt jelöl, amely az indexelés előtt átalakít egy értéket egy adatforrásból.
IndexerExecutionEnvironment	Azt a környezetet adja meg, amelyben az indexelőnek végre kell hajtania.
IndexingParameters	Az indexelő végrehajtásának paramétereit jelöli.
IndexingParametersConfiguration	Indexelőspecifikus konfigurációs tulajdonságok szótára. Minden név egy adott tulajdonság neve. Minden értéknek primitív típusúnak kell lennie.
IndexingSchedule	Az indexelő végrehajtásának ütemezését jelöli.
SearchIndexer	Indexelőt jelöl.
SearchResourceEncryptionKey	Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti az inaktív adatokat, például indexeket és szinonimatérképeket.

AzureActiveDirectoryApplicationCredentials

A keresési szolgáltatáshoz létrehozott regisztrált alkalmazás hitelesítő adatai, amelyeket az Azure Key Vaultban tárolt titkosítási kulcsokhoz való hitelesített hozzáféréshez használnak.

Name	Típus	Description
applicationId	string	Egy AAD-alkalmazásazonosító, amely megkapta a szükséges hozzáférési engedélyeket az Azure Key Vaulthoz, amelyet az inaktív adatok titkosításához kell használni. Az alkalmazásazonosító nem tévesztendő össze az AAD-alkalmazás objektumazonosítójával.
applicationSecret	string	A megadott AAD-alkalmazás hitelesítési kulcsa.

BlobIndexerDataToExtract

Megadja az Azure Blob Storage-ból kinyerni kívánt adatokat, és közli az indexelővel, hogy mely adatokat kell kinyerni a képtartalomból, ha az "imageAction" értéke nem "none". Ez egy .PDF vagy más alkalmazás beágyazott képtartalmaira, illetve az Azure-blobokban lévő képfájlokra, például .jpg és .pngvonatkozik.

Name	Típus	Description
allMetadata	string	Kinyeri az Azure Blob Storage alrendszer által biztosított metaadatokat és a tartalomtípus-specifikus metaadatokat (például a csak .png fájlokra jellemző metaadatokat indexeli).
contentAndMetadata	string	Kinyeri az összes metaadatot és szöveges tartalmat az egyes blobokból.
storageMetadata	string	Csak a standard blobtulajdonságokat és a felhasználó által megadott metaadatokat indexeli.

BlobIndexerImageAction

Meghatározza, hogyan dolgozhatja fel a beágyazott képeket és képfájlokat az Azure Blob Storage-ban. Ha az "imageAction" konfigurációt a "none" értéken kívül más értékre állítja be, egy képességkészletet is hozzá kell csatolni az indexelőhöz.

Name	Típus	Description
generateNormalizedImagePerPage	string	Kinyeri a képek szövegét (például a "STOP" szót egy forgalommegállási jelből), és beágyazza a tartalommezőbe, de másképp kezeli a PDF-fájlokat, mivel minden oldal képként jelenik meg, és ennek megfelelően normalizálódik a beágyazott képek kinyerése helyett. A nem PDF-fájltípusok ugyanúgy lesznek kezelve, mintha a "generateNormalizedImages" beállítás lett volna beállítva.
generateNormalizedImages	string	Kinyeri a képek szövegét (például a "STOP" szót egy forgalom-leállítási jelből), és beágyazza a tartalommezőbe. Ehhez a művelethez a "dataToExtract" értéke "contentAndMetadata". A normalizált kép olyan további feldolgozást jelent, amely egységes képkimenetet eredményez, méretezve és elforgatva, hogy elősegítse a következetes renderelést, amikor képeket ad meg a vizuális keresési eredményekben. Ez az információ minden képhez létrejön, amikor ezt a beállítást használja.
none	string	Figyelmen kívül hagyja a beágyazott képeket vagy képfájlokat az adatkészletben. Ez az alapértelmezett érték.

BlobIndexerParsingMode

Az Azure Blob-adatforrásból történő indexelés elemzési módját jelöli.

Name	Típus	Description
default	string	Normál fájlfeldolgozás esetén állítsa be az alapértelmezett értéket.
delimitedText	string	Ha a blobok egyszerű CSV-fájlok, akkor az elhatároltText értékre van állítva.
json	string	A JSON-fájlokból strukturált tartalom kinyeréséhez állítsa be a json értéket.
jsonArray	string	A JSON-tömb egyes elemeinek különálló dokumentumokként való kinyeréséhez állítsa be a jsonArray értéket.
jsonLines	string	A jsonLines értékre állítva az egyes JSON-entitásokat egy új sor választja el egymástól, különálló dokumentumokként.
text	string	A blobtárolóban lévő egyszerű szöveges fájlok indexelési teljesítményének javításához állítsa be a szöveget szövegre.

BlobIndexerPDFTextRotationAlgorithm

Meghatározza az Azure Blob Storage-beli PDF-fájlokból való szövegkivétel algoritmusát.

Name	Típus	Description
detectAngles	string	Jobb és olvashatóbb szövegkinyeréseket eredményezhet olyan PDF-fájlokból, amelyekben elforgatott szöveg található. Vegye figyelembe, hogy ennek a paraméternek a használata kis teljesítménysebesség-hatással járhat. Ez a paraméter csak PDF-fájlokra vonatkozik, és csak beágyazott szöveggel rendelkező PDF-fájlokra. Ha az elforgatott szöveg egy beágyazott képben jelenik meg a PDF-ben, ez a paraméter nem érvényes.
none	string	A normál szövegkiemelést használja. Ez az alapértelmezett érték.

ErrorAdditionalInfo

Az erőforrás-kezelési hiba további információi.

Name	Típus	Description
info	object	A további információk.
type	string	A további információtípus.

ErrorDetail

A hiba részletei.

Name	Típus	Description
additionalInfo	ErrorAdditionalInfo[]	A hiba további információi.
code	string	A hibakód.
details	ErrorDetail[]	A hiba részletei.
message	string	A hibaüzenet.
target	string	A hibacél.

ErrorResponse

Hibaválasz

Name	Típus	Description
error	ErrorDetail	A hibaobjektum.

FieldMapping

Egy adatforrás mezője és egy index célmezője közötti leképezést definiál.

Name	Típus	Description
mappingFunction	FieldMappingFunction	Az indexelés előtt az egyes forrásmezőértékekre alkalmazandó függvény.
sourceFieldName	string	Az adatforrás mezőjének neve.
targetFieldName	string	Az index célmezőjének neve. Alapértelmezés szerint megegyezik a forrásmező nevével.

FieldMappingFunction

Olyan függvényt jelöl, amely az indexelés előtt átalakít egy értéket egy adatforrásból.

Name	Típus	Description
name	string	A mezőleképezési függvény neve.
parameters	object	A függvénynek átadni kívánt paraméternév-érték párok szótára. Minden értéknek primitív típusúnak kell lennie.

IndexerExecutionEnvironment

Azt a környezetet adja meg, amelyben az indexelőnek végre kell hajtania.

Name	Típus	Description
private	string	Azt jelzi, hogy az indexelőnek a kifejezetten a keresési szolgáltatáshoz kiépített környezettel kell futnia. Ez csak akkor adható meg végrehajtási környezetként, ha az indexelőnek biztonságosan kell hozzáférnie az erőforrásokhoz megosztott privát kapcsolati erőforrásokon keresztül.
standard	string	Azt jelzi, hogy a keresési szolgáltatás meghatározhatja, hogy az indexelő hol hajtson végre. Ez az alapértelmezett környezet, ha nincs megadva semmi, és ez az ajánlott érték.

IndexingParameters

Az indexelő végrehajtásának paramétereit jelöli.

Name	Típus	Alapértelmezett érték	Description
batchSize	integer		Az adatforrásból beolvasott és egyetlen kötegként indexelt elemek száma a teljesítmény javítása érdekében. Az alapértelmezett érték az adatforrás típusától függ.
configuration	IndexingParametersConfiguration		Indexelőspecifikus konfigurációs tulajdonságok szótára. Minden név egy adott tulajdonság neve. Minden értéknek primitív típusúnak kell lennie.
maxFailedItems	integer	0	Az indexelő végrehajtásához sikertelen indexelést meghiúsuló elemek maximális száma továbbra is sikeresnek tekinthető. -1 azt jelenti, hogy nincs korlát. Az alapértelmezett érték 0.
maxFailedItemsPerBatch	integer	0	Az egyetlen köteg azon elemeinek maximális száma, amelyek sikertelen indexelést okozhatnak ahhoz, hogy a köteg továbbra is sikeresnek minősüljön. -1 azt jelenti, hogy nincs korlát. Az alapértelmezett érték 0.

IndexingParametersConfiguration

Indexelőspecifikus konfigurációs tulajdonságok szótára. Minden név egy adott tulajdonság neve. Minden értéknek primitív típusúnak kell lennie.

Name	Típus	Alapértelmezett érték	Description
allowSkillsetToReadFileData	boolean	False	Ha igaz, létrehoz egy elérési utat //document//file_data, amely a blob adatforrásából letöltött eredeti fájladatokat képviselő objektum. Ez lehetővé teszi az eredeti fájladatok átadását egy egyéni képességnek a bővítési folyamaton belüli feldolgozáshoz, vagy a Dokumentumkinyerési képességnek.
dataToExtract	BlobIndexerDataToExtract	contentAndMetadata	Megadja az Azure Blob Storage-ból kinyerni kívánt adatokat, és közli az indexelővel, hogy mely adatokat kell kinyerni a képtartalomból, ha az "imageAction" értéke nem "none". Ez egy .PDF vagy más alkalmazás beágyazott képtartalmaira, illetve az Azure-blobokban lévő képfájlokra, például .jpg és .pngvonatkozik.
delimitedTextDelimiter	string		CSV-blobok esetén az egykarakteres elválasztó karaktert adja meg azokhoz a CSV-fájlokhoz, ahol minden sor új dokumentumot indít el (például "\|").
delimitedTextHeaders	string		CSV-blobok esetén az oszlopfejlécek vesszővel tagolt listáját adja meg, amely hasznos lehet az index célmezőihez való leképezéséhez.
documentRoot	string		JSON-tömbök esetén, strukturált vagy részben strukturált dokumentum esetén a tulajdonság használatával megadhatja a tömb elérési útját.
excludedFileNameExtensions	string		Az Azure Blob Storage-ból történő feldolgozáskor figyelmen kívül hagyandó fájlnévkiterjesztések vesszőkkel tagolt listája. Kizárhatja például a ".png, .mp4" lehetőséget, hogy átugorja ezeket a fájlokat az indexelés során.
executionEnvironment	IndexerExecutionEnvironment	standard	Azt a környezetet adja meg, amelyben az indexelőnek végre kell hajtania.
failOnUnprocessableDocument	boolean	False	Az Azure-blobok esetében állítsa hamis értékre, ha folytatni szeretné az indexelést, ha egy dokumentum indexelése sikertelen.
failOnUnsupportedContentType	boolean	False	Az Azure-blobok esetében állítsa hamis értékre, ha nem támogatott tartalomtípus esetén szeretné folytatni az indexelést, és nem ismeri előre az összes tartalomtípust (fájlkiterjesztést).
firstLineContainsHeaders	boolean	True	CSV-blobok esetén az egyes blobok első (nem üres) sora fejléceket tartalmaz.
imageAction	BlobIndexerImageAction	none	Meghatározza, hogyan dolgozhatja fel a beágyazott képeket és képfájlokat az Azure Blob Storage-ban. Ha az "imageAction" konfigurációt a "none" értéken kívül más értékre állítja be, egy képességkészletet is hozzá kell csatolni az indexelőhöz.
indexStorageMetadataOnlyForOversizedDocuments	boolean	False	Azure-blobok esetén állítsa ezt a tulajdonságot igaz értékre, hogy továbbra is indexelje a tárolási metaadatokat olyan blobtartalmak esetében, amelyek túl nagyok a feldolgozáshoz. A túlméretezett blobokat alapértelmezés szerint hibaként kezeli a rendszer. A blob méretkorlátjaiért lásd: https://learn.microsoft.com/azure/search/search-limits-quotas-capacity.
indexedFileNameExtensions	string		Az Azure Blob Storage-ból történő feldolgozáskor kiválasztandó fájlnévkiterjesztések vesszőkkel tagolt listája. A ".docx, .pptx, .msg" alkalmazásfájlok indexelésével például kifejezetten belefoglalhatja ezeket a fájltípusokat.
parsingMode	BlobIndexerParsingMode	default	Az Azure Blob-adatforrásból történő indexelés elemzési módját jelöli.
pdfTextRotationAlgorithm	BlobIndexerPDFTextRotationAlgorithm	none	Meghatározza az Azure Blob Storage-beli PDF-fájlokból való szövegkivétel algoritmusát.
queryTimeout	string	00:05:00	Növeli az időtúllépést az "hh:mm:ss" formátumban megadott Azure SQL Database-adatforrások esetében az 5 perces alapértelmezettnél.

IndexingSchedule

Az indexelő végrehajtásának ütemezését jelöli.

Name	Típus	Description
interval	string	Az indexelő végrehajtásai közötti időintervallum.
startTime	string	Az az idő, amikor egy indexelőnek futnia kell.

SearchIndexer

Indexelőt jelöl.

Name	Típus	Alapértelmezett érték	Description
@odata.etag	string		Az indexelő ETagje.
dataSourceName	string		Annak az adatforrásnak a neve, amelyből az indexelő adatokat olvas be.
description	string		Az indexelő leírása.
disabled	boolean	False	Érték, amely jelzi, hogy az indexelő le van-e tiltva. Az alapértelmezett érték hamis.
encryptionKey	SearchResourceEncryptionKey		Az Azure Key Vaultban létrehozott titkosítási kulcs leírása. Ez a kulcs további inaktív titkosítási szintet biztosít az indexelő definíciójához (valamint az indexelő végrehajtási állapotához), ha teljes bizonyosságot szeretne arról, hogy senki, még a Microsoft sem tudja visszafejteni őket. Miután titkosította az indexelő definícióját, az mindig titkosítva marad. A keresési szolgáltatás figyelmen kívül hagyja a tulajdonság null értékre történő beállítására tett kísérleteket. Szükség szerint módosíthatja ezt a tulajdonságot, ha el szeretné forgatni a titkosítási kulcsot; Az indexelő definíciója (és az indexelő végrehajtási állapota) nem lesz hatással. Az ügyfél által felügyelt kulcsokkal rendelkező titkosítás nem érhető el az ingyenes keresési szolgáltatásokhoz, és csak a 2019. január 1-jén vagy azt követően létrehozott fizetős szolgáltatásokhoz érhető el.
fieldMappings	FieldMapping[]		Az adatforrás mezői és az index megfelelő célmezői közötti leképezéseket határozza meg.
name	string		Az indexelő neve.
outputFieldMappings	FieldMapping[]		A kimeneti mezőleképezések a bővítés után és közvetlenül az indexelés előtt lesznek alkalmazva.
parameters	IndexingParameters		Az indexelő végrehajtásának paraméterei.
schedule	IndexingSchedule		Az indexelő ütemezése.
skillsetName	string		Az indexelővel végrehajtó képességkészlet neve.
targetIndexName	string		Annak az indexnek a neve, amelyre az indexelő adatokat ír.

SearchResourceEncryptionKey

Ügyfél által felügyelt titkosítási kulcs az Azure Key Vaultban. A létrehozott és kezelt kulcsokkal titkosíthatja vagy visszafejtheti az inaktív adatokat, például indexeket és szinonimatérképeket.

Name	Típus	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Az Azure Key Vault eléréséhez használt opcionális Azure Active Directory-hitelesítő adatok. Nem kötelező, ha ehelyett felügyelt identitást használ.
keyVaultKeyName	string	A inaktív adatok titkosításához használandó Azure Key Vault-kulcs neve.
keyVaultKeyVersion	string	Az Azure Key Vault-kulcs inaktív adatok titkosításához használandó verziója.
keyVaultUri	string	Az Azure Key Vault URI-ja, más néven DNS-név, amely tartalmazza az inaktív adatok titkosításához használandó kulcsot. Példa URI lehet `https://my-keyvault-name.vault.azure.net`.

Megosztás a következőn keresztül: