Indexers - Create Or Update
Skapar en ny indexerare eller uppdaterar en indexerare om den redan finns.
PUT {endpoint}/indexers('{indexerName}')?api-version=2024-09-01-preview
PUT {endpoint}/indexers('{indexerName}')?api-version=2024-09-01-preview&ignoreResetRequirements={ignoreResetRequirements}&disableCacheReprocessingChangeDetection={disableCacheReprocessingChangeDetection}
| Name | I | Obligatorisk | Typ | Description |
|---|---|---|---|---|
|
endpoint
|
path | True |
string |
Slutpunkts-URL:en för söktjänsten. |
|
indexer
|
path | True |
string |
Namnet på indexeraren som ska skapas eller uppdateras. |
|
api-version
|
query | True |
string |
Klient-API-version. |
|
disable
|
query |
boolean |
Inaktiverar cachebearbetning av ändringsidentifiering. |
|
|
ignore
|
query |
boolean |
Ignorerar krav på cacheåterställning. |
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| x-ms-client-request-id |
string (uuid) |
Spårnings-ID:t som skickas med begäran för att hjälpa till med felsökning. |
|
| If-Match |
string |
Definierar villkoret If-Match. Åtgärden utförs endast om ETag på servern matchar det här värdet. |
|
| If-None-Match |
string |
Definierar villkoret If-None-Match. Åtgärden utförs endast om ETag på servern inte matchar det här värdet. |
|
| Prefer | True |
string |
För HTTP PUT-begäranden instruerar du tjänsten att returnera den skapade/uppdaterade resursen när den lyckas. |
| Name | Obligatorisk | Typ | Description |
|---|---|---|---|
| dataSourceName | True |
string |
Namnet på den datakälla som indexeraren läser data från. |
| name | True |
string |
Indexerarens namn. |
| targetIndexName | True |
string |
Namnet på indexet som indexeraren skriver data till. |
| @odata.etag |
string |
Indexerarens ETag. |
|
| cache |
Lägger till cachelagring i en berikningspipeline för att möjliggöra stegvisa ändringssteg utan att behöva återskapa indexet varje gång. |
||
| description |
string |
Beskrivningen av indexeraren. |
|
| disabled |
boolean |
Ett värde som anger om indexeraren är inaktiverad. Standardvärdet är falskt. |
|
| encryptionKey |
En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge en ytterligare nivå av kryptering i vila för indexerarens definition (samt indexerarens körningsstatus) när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat indexerarens definition förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Indexerarens definition (och indexerarens körningsstatus) påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare. |
||
| fieldMappings |
Definierar mappningar mellan fält i datakällan och motsvarande målfält i indexet. |
||
| outputFieldMappings |
Utdatafältmappningar tillämpas efter berikning och omedelbart före indexering. |
||
| parameters |
Parametrar för indexeringskörning. |
||
| schedule |
Schemat för den här indexeraren. |
||
| skillsetName |
string |
Namnet på kompetensuppsättningen som körs med den här indexeraren. |
| Name | Typ | Description |
|---|---|---|
| 200 OK | ||
| 201 Created | ||
| Other Status Codes |
Felsvar. |
Exempelbegäran
PUT https://previewexampleservice.search.windows.net/indexers('myindexer')?api-version=2024-09-01-preview&ignoreResetRequirements=&disableCacheReprocessingChangeDetection=
{
"name": "myindexer",
"description": "Description of the indexer",
"dataSourceName": "mydocdbdatasource",
"skillsetName": "myskillset",
"targetIndexName": "preview-test",
"schedule": {
"interval": "P1D"
},
"parameters": {
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5
},
"fieldMappings": [],
"outputFieldMappings": [],
"disabled": false,
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Exempelsvar
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "myindexer",
"description": "Description of the indexer",
"dataSourceName": "mydocdbdatasource",
"skillsetName": "myskillset",
"targetIndexName": "preview-test",
"disabled": false,
"schedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"parameters": {
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5,
"configuration": {}
},
"fieldMappings": [],
"outputFieldMappings": [],
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "myindexer",
"description": "Description of the indexer",
"dataSourceName": "mydocdbdatasource",
"skillsetName": "myskillset",
"targetIndexName": "preview-test",
"disabled": false,
"schedule": {
"interval": "P1D",
"startTime": "2024-06-06T00:01:50.265Z"
},
"parameters": {
"maxFailedItems": 10,
"maxFailedItemsPerBatch": 5,
"configuration": {}
},
"fieldMappings": [],
"outputFieldMappings": [],
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
| Name | Description |
|---|---|
|
Azure |
Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault. |
|
Blob |
Anger vilka data som ska extraheras från Azure Blob Storage och talar om för indexeraren vilka data som ska extraheras från bildinnehåll när "imageAction" är inställt på ett annat värde än "ingen". Detta gäller inbäddat bildinnehåll i ett .PDF eller annat program, eller bildfiler som .jpg och .pngi Azure-blobar. |
|
Blob |
Avgör hur du bearbetar inbäddade avbildningar och avbildningsfiler i Azure Blob Storage. Om du ställer in konfigurationen "imageAction" på något annat värde än "ingen" krävs att en kompetensuppsättning också är kopplad till indexeraren. |
|
Blob |
Representerar parsningsläget för indexering från en Azure-blobdatakälla. |
|
Blob |
Avgör algoritmen för textextrahering från PDF-filer i Azure Blob Storage. |
|
Error |
Ytterligare information om resurshanteringsfelet. |
|
Error |
Felinformationen. |
|
Error |
Felsvar |
|
Field |
Definierar en mappning mellan ett fält i en datakälla och ett målfält i ett index. |
|
Field |
Representerar en funktion som omvandlar ett värde från en datakälla före indexering. |
|
Indexer |
Anger i vilken miljö indexeraren ska köras. |
|
Indexing |
Representerar parametrar för indexeringskörning. |
|
Indexing |
En ordlista med indexerarspecifika konfigurationsegenskaper. Varje namn är namnet på en specifik egenskap. Varje värde måste vara av en primitiv typ. |
|
Indexing |
Representerar ett schema för indexeringskörning. |
|
Search |
Representerar en indexerare. |
|
Search |
|
|
Search |
Rensar identitetsegenskapen för en datakälla. |
|
Search |
Anger identiteten för en datakälla som ska användas. |
|
Search |
En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymkartor. |
Autentiseringsuppgifter för ett registrerat program som skapats för din söktjänst och som används för autentiserad åtkomst till krypteringsnycklarna som lagras i Azure Key Vault.
| Name | Typ | Description |
|---|---|---|
| applicationId |
string |
Ett AAD-program-ID som har beviljats nödvändiga åtkomstbehörigheter till Azure Key Vault som ska användas när du krypterar dina data i vila. Program-ID:t bör inte förväxlas med objekt-ID:t för ditt AAD-program. |
| applicationSecret |
string |
Autentiseringsnyckeln för det angivna AAD-programmet. |
Anger vilka data som ska extraheras från Azure Blob Storage och talar om för indexeraren vilka data som ska extraheras från bildinnehåll när "imageAction" är inställt på ett annat värde än "ingen". Detta gäller inbäddat bildinnehåll i ett .PDF eller annat program, eller bildfiler som .jpg och .pngi Azure-blobar.
| Värde | Description |
|---|---|
| storageMetadata |
Indexerar bara standardblobegenskaperna och användardefinierade metadata. |
| allMetadata |
Extraherar metadata som tillhandahålls av Azure Blob Storage-undersystemet och innehållstypspecifika metadata (till exempel metadata som är unika för bara .png filer indexeras). |
| contentAndMetadata |
Extraherar alla metadata och textinnehåll från varje blob. |
Avgör hur du bearbetar inbäddade avbildningar och avbildningsfiler i Azure Blob Storage. Om du ställer in konfigurationen "imageAction" på något annat värde än "ingen" krävs att en kompetensuppsättning också är kopplad till indexeraren.
| Värde | Description |
|---|---|
| none |
Ignorerar inbäddade bilder eller bildfiler i datauppsättningen. Det här är standardinställningen. |
| generateNormalizedImages |
Extraherar text från bilder (till exempel ordet "STOP" från en trafikstoppsskylt) och bäddar in den i innehållsfältet. Den här åtgärden kräver att "dataToExtract" är inställt på "contentAndMetadata". En normaliserad bild refererar till ytterligare bearbetning som resulterar i enhetlig bildutdata, storlek och roterad för att främja konsekvent återgivning när du inkluderar bilder i visuella sökresultat. Den här informationen genereras för varje bild när du använder det här alternativet. |
| generateNormalizedImagePerPage |
Extraherar text från bilder (till exempel ordet "STOP" från en trafikstoppsskylt) och bäddar in den i innehållsfältet, men behandlar PDF-filer på olika sätt på så sätt att varje sida återges som en bild och normaliseras därefter, i stället för att extrahera inbäddade bilder. Filtyper som inte är PDF-filer behandlas på samma sätt som om "generateNormalizedImages" angavs. |
Representerar parsningsläget för indexering från en Azure-blobdatakälla.
| Värde | Description |
|---|---|
| default |
Ange som standard för normal filbearbetning. |
| text |
Ange till text för att förbättra indexeringsprestanda för oformaterade textfiler i Blob Storage. |
| delimitedText |
Ange till avgränsadtext när blobar är vanliga CSV-filer. |
| json |
Ange till json för att extrahera strukturerat innehåll från JSON-filer. |
| jsonArray |
Ange till jsonArray för att extrahera enskilda element i en JSON-matris som separata dokument. |
| jsonLines |
Ange till jsonLines för att extrahera enskilda JSON-entiteter, avgränsade med en ny rad, som separata dokument. |
Avgör algoritmen för textextrahering från PDF-filer i Azure Blob Storage.
| Värde | Description |
|---|---|
| none |
Utnyttjar normal textextrahering. Det här är standardinställningen. |
| detectAngles |
Kan ge bättre och mer läsbar textextrahering från PDF-filer som har roterat text i dem. Observera att det kan uppstå en liten inverkan på prestandahastigheten när den här parametern används. Den här parametern gäller endast PDF-filer och endast pdf-filer med inbäddad text. Om den roterade texten visas i en inbäddad bild i PDF-filen gäller inte den här parametern. |
Ytterligare information om resurshanteringsfelet.
| Name | Typ | Description |
|---|---|---|
| info |
object |
Ytterligare information. |
| type |
string |
Ytterligare informationstyp. |
Felinformationen.
| Name | Typ | Description |
|---|---|---|
| additionalInfo |
Ytterligare information om felet. |
|
| code |
string |
Felkoden. |
| details |
Felinformationen. |
|
| message |
string |
Felmeddelandet. |
| target |
string |
Felmålet. |
Felsvar
| Name | Typ | Description |
|---|---|---|
| error |
Felobjektet. |
Definierar en mappning mellan ett fält i en datakälla och ett målfält i ett index.
| Name | Typ | Description |
|---|---|---|
| mappingFunction |
En funktion som ska tillämpas på varje källfältvärde före indexering. |
|
| sourceFieldName |
string |
Namnet på fältet i datakällan. |
| targetFieldName |
string |
Namnet på målfältet i indexet. Samma som källfältnamnet som standard. |
Representerar en funktion som omvandlar ett värde från en datakälla före indexering.
| Name | Typ | Description |
|---|---|---|
| name |
string |
Namnet på fältmappningsfunktionen. |
| parameters |
object |
En ordlista med parameternamn/värdepar som ska skickas till funktionen. Varje värde måste vara av en primitiv typ. |
Anger i vilken miljö indexeraren ska köras.
| Värde | Description |
|---|---|
| standard |
Anger att söktjänsten kan avgöra var indexeraren ska köras. Det här är standardmiljön när inget har angetts och är det rekommenderade värdet. |
| private |
Anger att indexeraren ska köras med den miljö som är etablerad specifikt för söktjänsten. Detta bör endast anges som körningsmiljö om indexeraren behöver komma åt resurser på ett säkert sätt via delade privata länkresurser. |
Representerar parametrar för indexeringskörning.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| batchSize |
integer (int32) |
Antalet objekt som läss från datakällan och indexeras som en enda batch för att förbättra prestandan. Standardvärdet beror på datakälltypen. |
|
| configuration |
En ordlista med indexerarspecifika konfigurationsegenskaper. Varje namn är namnet på en specifik egenskap. Varje värde måste vara av en primitiv typ. |
||
| maxFailedItems |
integer (int32) |
0 |
Det maximala antalet objekt som inte kan indexeras för att indexeringskörningen fortfarande ska anses vara lyckad. -1 betyder ingen gräns. Standardvärdet är 0. |
| maxFailedItemsPerBatch |
integer (int32) |
0 |
Det maximala antalet objekt i en enda batch som kan misslyckas med indexering för att batchen fortfarande ska anses vara lyckad. -1 betyder ingen gräns. Standardvärdet är 0. |
En ordlista med indexerarspecifika konfigurationsegenskaper. Varje namn är namnet på en specifik egenskap. Varje värde måste vara av en primitiv typ.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| allowSkillsetToReadFileData |
boolean |
False |
Om det är sant skapar du en sökväg //document///file_data som är ett objekt som representerar de ursprungliga fildata som laddats ned från blobdatakällan. På så sätt kan du skicka ursprungliga fildata till en anpassad färdighet för bearbetning i berikningspipelinen, eller till skickligheten för dokumentextrahering. |
| dataToExtract | contentAndMetadata |
Anger vilka data som ska extraheras från Azure Blob Storage och talar om för indexeraren vilka data som ska extraheras från bildinnehåll när "imageAction" är inställt på ett annat värde än "ingen". Detta gäller inbäddat bildinnehåll i ett .PDF eller annat program, eller bildfiler som .jpg och .pngi Azure-blobar. |
|
| delimitedTextDelimiter |
string |
För CSV-blobar anger du avgränsare för enskilda tecken i slutet av rad för CSV-filer där varje rad startar ett nytt dokument (till exempel |"). |
|
| delimitedTextHeaders |
string |
För CSV-blobar anger en kommaavgränsad lista med kolumnrubriker, som är användbar för att mappa källfält till målfält i ett index. |
|
| documentRoot |
string |
För JSON-matriser, med ett strukturerat eller halvstrukturerat dokument, kan du ange en sökväg till matrisen med hjälp av den här egenskapen. |
|
| excludedFileNameExtensions |
string |
Kommaavgränsad lista över filnamnstillägg som ska ignoreras vid bearbetning från Azure Blob Storage. Du kan till exempel exkludera ".png, .mp4" för att hoppa över dessa filer under indexeringen. |
|
| executionEnvironment | standard |
Anger i vilken miljö indexeraren ska köras. |
|
| failOnUnprocessableDocument |
boolean |
False |
För Azure-blobar anger du till false om du vill fortsätta indexeringen om ett dokument inte indexerar. |
| failOnUnsupportedContentType |
boolean |
False |
För Azure-blobbar anger du till false om du vill fortsätta indexeringen när en innehållstyp som inte stöds påträffas och du inte känner till alla innehållstyper (filtillägg) i förväg. |
| firstLineContainsHeaders |
boolean |
True |
För CSV-blobar anger att den första raden (icke-tom) för varje blob innehåller rubriker. |
| imageAction | none |
Avgör hur du bearbetar inbäddade avbildningar och avbildningsfiler i Azure Blob Storage. Om du ställer in konfigurationen "imageAction" på något annat värde än "ingen" krävs att en kompetensuppsättning också är kopplad till indexeraren. |
|
| indexStorageMetadataOnlyForOversizedDocuments |
boolean |
False |
För Azure-blobar anger du den här egenskapen till true för att fortfarande indexeras lagringsmetadata för blobinnehåll som är för stort för att bearbetas. Överdimensionerade blobar behandlas som fel som standard. Begränsningar för blobstorlek finns i https://learn.microsoft.com/azure/search/search-limits-quotas-capacity. |
| indexedFileNameExtensions |
string |
Kommaavgränsad lista över filnamnstillägg som ska väljas vid bearbetning från Azure Blob Storage. Du kan till exempel fokusera indexering på specifika programfiler ".docx, .pptx, .msg" för att specifikt inkludera dessa filtyper. |
|
| parsingMode | default |
Representerar parsningsläget för indexering från en Azure-blobdatakälla. |
|
| pdfTextRotationAlgorithm | none |
Avgör algoritmen för textextrahering från PDF-filer i Azure Blob Storage. |
|
| queryTimeout |
string |
00:05:00 |
Ökar tidsgränsen utöver standardvärdet på 5 minuter för Azure SQL-databasdatakällor, som anges i formatet "hh:mm:ss". |
Representerar ett schema för indexeringskörning.
| Name | Typ | Description |
|---|---|---|
| interval |
string (duration) |
Tidsintervallet mellan indexerarens körningar. |
| startTime |
string (date-time) |
Den tid då en indexerare ska börja köras. |
Representerar en indexerare.
| Name | Typ | Standardvärde | Description |
|---|---|---|---|
| @odata.etag |
string |
Indexerarens ETag. |
|
| cache |
Lägger till cachelagring i en berikningspipeline för att möjliggöra stegvisa ändringssteg utan att behöva återskapa indexet varje gång. |
||
| dataSourceName |
string |
Namnet på den datakälla som indexeraren läser data från. |
|
| description |
string |
Beskrivningen av indexeraren. |
|
| disabled |
boolean |
False |
Ett värde som anger om indexeraren är inaktiverad. Standardvärdet är falskt. |
| encryptionKey |
En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att ge en ytterligare nivå av kryptering i vila för indexerarens definition (samt indexerarens körningsstatus) när du vill ha fullständig försäkran om att ingen, inte ens Microsoft, kan dekryptera dem. När du har krypterat indexerarens definition förblir den alltid krypterad. Söktjänsten ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Indexerarens definition (och indexerarens körningsstatus) påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare. |
||
| fieldMappings |
Definierar mappningar mellan fält i datakällan och motsvarande målfält i indexet. |
||
| name |
string |
Indexerarens namn. |
|
| outputFieldMappings |
Utdatafältmappningar tillämpas efter berikning och omedelbart före indexering. |
||
| parameters |
Parametrar för indexeringskörning. |
||
| schedule |
Schemat för den här indexeraren. |
||
| skillsetName |
string |
Namnet på kompetensuppsättningen som körs med den här indexeraren. |
|
| targetIndexName |
string |
Namnet på indexet som indexeraren skriver data till. |
| Name | Typ | Description |
|---|---|---|
| enableReprocessing |
boolean |
Anger om inkrementell ombearbetning är aktiverat. |
| identity | SearchIndexerDataIdentity: |
Den användartilldelade hanterade identiteten som används för anslutningar till berikningscacheminnet. Om anslutningssträngen anger en identitet (ResourceId) och den inte har angetts används den systemtilldelade hanterade identiteten. Vid uppdateringar av indexeraren, om identiteten är ospecificerad, förblir värdet oförändrat. Om värdet är "none" rensas värdet för den här egenskapen. |
| storageConnectionString |
string |
Anslutningssträngen till lagringskontot där cachedata ska sparas. |
Rensar identitetsegenskapen för en datakälla.
| Name | Typ | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ett URI-fragment som anger typen av identitet. |
Anger identiteten för en datakälla som ska användas.
| Name | Typ | Description |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Ett URI-fragment som anger typen av identitet. |
| userAssignedIdentity |
string |
Det fullständigt kvalificerade Azure-resurs-ID:t för en användartilldelad hanterad identitet, vanligtvis i formuläret "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" som borde ha tilldelats söktjänsten. |
En kundhanterad krypteringsnyckel i Azure Key Vault. Nycklar som du skapar och hanterar kan användas för att kryptera eller dekryptera vilande data, till exempel index och synonymkartor.
| Name | Typ | Description |
|---|---|---|
| accessCredentials |
Valfria Azure Active Directory-autentiseringsuppgifter som används för att komma åt ditt Azure Key Vault. Krävs inte om du använder hanterad identitet i stället. |
|
| identity | SearchIndexerDataIdentity: |
En explicit hanterad identitet som ska användas för den här krypteringsnyckeln. Om det inte anges och egenskapen för åtkomstautentiseringsuppgifter är null används den systemtilldelade hanterade identiteten. Om den explicita identiteten är ospecificerad vid uppdatering av resursen förblir den oförändrad. Om "ingen" anges rensas värdet för den här egenskapen. |
| keyVaultKeyName |
string |
Namnet på din Azure Key Vault-nyckel som ska användas för att kryptera dina vilande data. |
| keyVaultKeyVersion |
string |
Den version av Azure Key Vault-nyckeln som ska användas för att kryptera dina vilande data. |
| keyVaultUri |
string |
URI:n för ditt Azure Key Vault, även kallat DNS-namn, som innehåller nyckeln som ska användas för att kryptera dina data i vila. Ett exempel på en URI kan vara |