Indexers - Create Or Update
Hiermee maakt u een nieuwe indexeerfunctie of werkt u een indexeerfunctie bij als deze al bestaat.
PUT {endpoint}/indexers('{indexerName}')?api-version=2023-11-01
URI-parameters
Name | In | Vereist | Type | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
De eindpunt-URL van de zoekservice. |
indexer
|
path | True |
string |
De naam van de indexeerfunctie die moet worden gemaakt of bijgewerkt. |
api-version
|
query | True |
string |
Client-API-versie. |
Aanvraagkoptekst
Name | Vereist | Type | Description |
---|---|---|---|
x-ms-client-request-id |
string uuid |
De tracerings-id die met de aanvraag wordt verzonden om te helpen bij foutopsporing. |
|
If-Match |
string |
Definieert de If-Match voorwaarde. De bewerking wordt alleen uitgevoerd als de ETag op de server overeenkomt met deze waarde. |
|
If-None-Match |
string |
Definieert de voorwaarde If-None-Match. De bewerking wordt alleen uitgevoerd als de ETag op de server niet overeenkomt met deze waarde. |
|
Prefer | True |
string |
Voor HTTP PUT-aanvragen geeft de service de opdracht om de gemaakte/bijgewerkte resource te retourneren wanneer deze is voltooid. |
Aanvraagbody
Name | Vereist | Type | Description |
---|---|---|---|
dataSourceName | True |
string |
De naam van de gegevensbron waaruit deze indexeerfunctie gegevens leest. |
name | True |
string |
De naam van de indexeerfunctie. |
targetIndexName | True |
string |
De naam van de index waarnaar deze indexeerfunctie gegevens schrijft. |
@odata.etag |
string |
De ETag van de indexeerfunctie. |
|
description |
string |
De beschrijving van de indexeerfunctie. |
|
disabled |
boolean |
Een waarde die aangeeft of de indexeerfunctie is uitgeschakeld. De standaardinstelling is onwaar. |
|
encryptionKey |
Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor de definitie van uw indexeerfunctie (evenals de uitvoeringsstatus van de indexeerfunctie) wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, ze niet kan ontsleutelen. Zodra u de definitie van de indexeerfunctie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; De definitie van de indexeerfunctie (en de uitvoeringsstatus van de indexeerfunctie) wordt niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019. |
||
fieldMappings |
Hiermee definieert u toewijzingen tussen velden in de gegevensbron en de bijbehorende doelvelden in de index. |
||
outputFieldMappings |
Toewijzingen van uitvoervelden worden toegepast na verrijking en direct voor indexering. |
||
parameters |
Parameters voor het uitvoeren van de indexeerfunctie. |
||
schedule |
Het schema voor deze indexeerfunctie. |
||
skillsetName |
string |
De naam van de vaardighedenset die wordt uitgevoerd met deze indexeerfunctie. |
Antwoorden
Name | Type | Description |
---|---|---|
200 OK | ||
201 Created | ||
Other Status Codes |
Foutreactie. |
Voorbeelden
SearchServiceCreateOrUpdateIndexer
Sample Request
PUT https://myservice.search.windows.net/indexers('myindexer')?api-version=2023-11-01
{
"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
{
"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
}
}
{
"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
}
}
Definities
Name | Description |
---|---|
Azure |
Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault. |
Blob |
Hiermee geeft u de gegevens op die uit Azure Blob Storage moeten worden geëxtraheerd en wordt aan de indexeerfunctie aangegeven welke gegevens moeten worden geëxtraheerd uit afbeeldingsinhoud wanneer 'imageAction' is ingesteld op een andere waarde dan 'geen'. Dit geldt voor ingesloten afbeeldingsinhoud in een .PDF of een andere toepassing, of afbeeldingsbestanden zoals .jpg en .png, in Azure-blobs. |
Blob |
Bepaalt hoe ingesloten afbeeldingen en afbeeldingsbestanden moeten worden verwerkt in Azure Blob Storage. Als u de configuratie 'imageAction' instelt op een andere waarde dan 'geen', moet er ook een vaardighedenset aan die indexeerfunctie worden gekoppeld. |
Blob |
Vertegenwoordigt de parseermodus voor indexering vanuit een Azure-blobgegevensbron. |
Blob |
Bepaalt het algoritme voor tekstextractie uit PDF-bestanden in Azure Blob Storage. |
Field |
Hiermee definieert u een toewijzing tussen een veld in een gegevensbron en een doelveld in een index. |
Field |
Vertegenwoordigt een functie die een waarde uit een gegevensbron transformeert vóór het indexeren. |
Indexer |
Hiermee geeft u de omgeving waarin de indexeerfunctie moet worden uitgevoerd. |
Indexing |
Vertegenwoordigt parameters voor de uitvoering van de indexeerfunctie. |
Indexing |
Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor de indexeerfunctie. Elke naam is de naam van een specifieke eigenschap. Elke waarde moet van een primitief type zijn. |
Indexing |
Vertegenwoordigt een schema voor het uitvoeren van de indexeerfunctie. |
Search |
Beschrijft een foutvoorwaarde voor de API. |
Search |
Vertegenwoordigt een indexeerfunctie. |
Search |
Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest in uw zoekservice, zoals indexen en synoniemenkaarten. |
AzureActiveDirectoryApplicationCredentials
Referenties van een geregistreerde toepassing die is gemaakt voor uw zoekservice, die wordt gebruikt voor geverifieerde toegang tot de versleutelingssleutels die zijn opgeslagen in Azure Key Vault.
Name | Type | Description |
---|---|---|
applicationId |
string |
Een AAD-toepassings-id waaraan de vereiste toegangsmachtigingen zijn verleend voor de Azure Key Vault die moet worden gebruikt bij het versleutelen van uw data-at-rest. De toepassings-id moet niet worden verward met de object-id voor uw AAD-toepassing. |
applicationSecret |
string |
De verificatiesleutel van de opgegeven AAD-toepassing. |
BlobIndexerDataToExtract
Hiermee geeft u de gegevens op die uit Azure Blob Storage moeten worden geëxtraheerd en wordt aan de indexeerfunctie aangegeven welke gegevens moeten worden geëxtraheerd uit afbeeldingsinhoud wanneer 'imageAction' is ingesteld op een andere waarde dan 'geen'. Dit geldt voor ingesloten afbeeldingsinhoud in een .PDF of een andere toepassing, of afbeeldingsbestanden zoals .jpg en .png, in Azure-blobs.
Name | Type | Description |
---|---|---|
allMetadata |
string |
Extraheert metagegevens die worden geleverd door het Azure Blob Storage-subsysteem en de specifieke metagegevens van het inhoudstype (bijvoorbeeld metagegevens die uniek zijn voor alleen .png bestanden worden geïndexeerd). |
contentAndMetadata |
string |
Hiermee worden alle metagegevens en tekstuele inhoud uit elke blob geëxtraheerd. |
storageMetadata |
string |
Indexeert alleen de standaard blobeigenschappen en door de gebruiker opgegeven metagegevens. |
BlobIndexerImageAction
Bepaalt hoe ingesloten afbeeldingen en afbeeldingsbestanden moeten worden verwerkt in Azure Blob Storage. Als u de configuratie 'imageAction' instelt op een andere waarde dan 'geen', moet er ook een vaardighedenset aan die indexeerfunctie worden gekoppeld.
Name | Type | Description |
---|---|---|
generateNormalizedImagePerPage |
string |
Extraheert tekst uit afbeeldingen (bijvoorbeeld het woord 'STOP' van een verkeersstopteken) en sluit deze in het inhoudsveld in, maar behandelt PDF-bestanden anders omdat elke pagina wordt weergegeven als een afbeelding en dienovereenkomstig wordt genormaliseerd, in plaats van ingesloten afbeeldingen te extraheren. Niet-PDF-bestandstypen worden hetzelfde behandeld als wanneer 'generateNormalizedImages' is ingesteld. |
generateNormalizedImages |
string |
Extraheert tekst uit afbeeldingen (bijvoorbeeld het woord 'STOP' van een verkeersstopbord) en sluit deze in het inhoudsveld in. Deze actie vereist dat 'dataToExtract' is ingesteld op 'contentAndMetadata'. Een genormaliseerde afbeelding verwijst naar extra verwerking, wat resulteert in uniforme afbeeldingsuitvoer, die wordt aangepast en gedraaid om een consistente weergave te bevorderen wanneer u afbeeldingen opneemt in visuele zoekresultaten. Deze informatie wordt gegenereerd voor elke afbeelding wanneer u deze optie gebruikt. |
none |
string |
Ingesloten afbeeldingen of afbeeldingsbestanden in de gegevensset worden genegeerd. Dit is de standaardinstelling. |
BlobIndexerParsingMode
Vertegenwoordigt de parseermodus voor indexering vanuit een Azure-blobgegevensbron.
Name | Type | Description |
---|---|---|
default |
string |
Ingesteld op standaard voor normale bestandsverwerking. |
delimitedText |
string |
Ingesteld op delimitedText wanneer blobs gewone CSV-bestanden zijn. |
json |
string |
Stel in op json om gestructureerde inhoud uit JSON-bestanden te extraheren. |
jsonArray |
string |
Stel in op jsonArray om afzonderlijke elementen van een JSON-matrix als afzonderlijke documenten te extraheren. |
jsonLines |
string |
Stel in op jsonLines om afzonderlijke JSON-entiteiten, gescheiden door een nieuwe regel, als afzonderlijke documenten te extraheren. |
text |
string |
Ingesteld op tekst om de indexeringsprestaties voor tekstbestanden zonder opmaak in blobopslag te verbeteren. |
BlobIndexerPDFTextRotationAlgorithm
Bepaalt het algoritme voor tekstextractie uit PDF-bestanden in Azure Blob Storage.
Name | Type | Description |
---|---|---|
detectAngles |
string |
Kan betere en beter leesbare tekstextractie produceren uit PDF-bestanden met gedraaide tekst erin. Houd er rekening mee dat er een kleine invloed kan zijn op de snelheid van de prestaties wanneer deze parameter wordt gebruikt. Deze parameter is alleen van toepassing op PDF-bestanden en alleen op PDF-bestanden met ingesloten tekst. Als de gedraaide tekst wordt weergegeven in een ingesloten afbeelding in het PDF-bestand, is deze parameter niet van toepassing. |
none |
string |
Maakt gebruik van normale tekstextractie. Dit is de standaardinstelling. |
FieldMapping
Hiermee definieert u een toewijzing tussen een veld in een gegevensbron en een doelveld in een index.
Name | Type | Description |
---|---|---|
mappingFunction |
Een functie die moet worden toegepast op elke waarde van het bronveld vóór het indexeren. |
|
sourceFieldName |
string |
De naam van het veld in de gegevensbron. |
targetFieldName |
string |
De naam van het doelveld in de index. Standaard hetzelfde als de naam van het bronveld. |
FieldMappingFunction
Vertegenwoordigt een functie die een waarde uit een gegevensbron transformeert vóór het indexeren.
Name | Type | Description |
---|---|---|
name |
string |
De naam van de veldtoewijzingsfunctie. |
parameters |
object |
Een woordenlijst met parameternaam/waardeparen die moeten worden doorgegeven aan de functie. Elke waarde moet van een primitief type zijn. |
IndexerExecutionEnvironment
Hiermee geeft u de omgeving waarin de indexeerfunctie moet worden uitgevoerd.
Name | Type | Description |
---|---|---|
private |
string |
Geeft aan dat de indexeerfunctie moet worden uitgevoerd met de omgeving die specifiek is ingericht voor de zoekservice. Dit moet alleen worden opgegeven als de uitvoeringsomgeving als de indexeerfunctie veilig toegang moet hebben tot resources via gedeelde privékoppelingsresources. |
standard |
string |
Geeft aan dat de zoekservice kan bepalen waar de indexeerfunctie moet worden uitgevoerd. Dit is de standaardomgeving wanneer er niets is opgegeven en is de aanbevolen waarde. |
IndexingParameters
Vertegenwoordigt parameters voor de uitvoering van de indexeerfunctie.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
batchSize |
integer |
Het aantal items dat wordt gelezen uit de gegevensbron en geïndexeerd als één batch om de prestaties te verbeteren. De standaardwaarde is afhankelijk van het gegevensbrontype. |
|
configuration |
Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor de indexeerfunctie. Elke naam is de naam van een specifieke eigenschap. Elke waarde moet van een primitief type zijn. |
||
maxFailedItems |
integer |
0 |
Het maximum aantal items dat kan mislukken bij het indexeren, zodat de uitvoering van de indexeerfunctie nog steeds als geslaagd wordt beschouwd. -1 betekent geen limiet. De standaardwaarde is 0. |
maxFailedItemsPerBatch |
integer |
0 |
Het maximum aantal items in één batch dat niet kan worden geïndexeerd, zodat de batch nog steeds als geslaagd wordt beschouwd. -1 betekent geen limiet. De standaardwaarde is 0. |
IndexingParametersConfiguration
Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor de indexeerfunctie. Elke naam is de naam van een specifieke eigenschap. Elke waarde moet van een primitief type zijn.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
allowSkillsetToReadFileData |
boolean |
False |
Indien waar, wordt een pad //document//file_data gemaakt dat een object is dat de oorspronkelijke bestandsgegevens vertegenwoordigt die zijn gedownload uit uw blobgegevensbron. Hiermee kunt u de oorspronkelijke bestandsgegevens doorgeven aan een aangepaste vaardigheid voor verwerking binnen de verrijkingspijplijn of aan de vaardigheid Documentextractie. |
dataToExtract | contentAndMetadata |
Hiermee geeft u de gegevens op die uit Azure Blob Storage moeten worden geëxtraheerd en wordt aan de indexeerfunctie aangegeven welke gegevens moeten worden geëxtraheerd uit afbeeldingsinhoud wanneer 'imageAction' is ingesteld op een andere waarde dan 'geen'. Dit geldt voor ingesloten afbeeldingsinhoud in een .PDF of een andere toepassing, of afbeeldingsbestanden zoals .jpg en .png, in Azure-blobs. |
|
delimitedTextDelimiter |
string |
Voor CSV-blobs geeft u het scheidingsteken voor het einde van regel met één teken op voor CSV-bestanden waarbij elke regel een nieuw document start (bijvoorbeeld |). |
|
delimitedTextHeaders |
string |
Voor CSV-blobs geeft u een door komma's gescheiden lijst met kolomkoppen op, handig voor het toewijzen van bronvelden aan doelvelden in een index. |
|
documentRoot |
string |
Voor JSON-matrices kunt u op basis van een gestructureerd of semi-gestructureerd document een pad naar de matrix opgeven met behulp van deze eigenschap. |
|
excludedFileNameExtensions |
string |
Door komma's gescheiden lijst met bestandsnaamextensies die moeten worden genegeerd bij het verwerken vanuit Azure Blob Storage. U kunt bijvoorbeeld '.png, .mp4' uitsluiten om deze bestanden over te slaan tijdens het indexeren. |
|
executionEnvironment | standard |
Hiermee geeft u de omgeving op waarin de indexeerfunctie moet worden uitgevoerd. |
|
failOnUnprocessableDocument |
boolean |
False |
Voor Azure-blobs stelt u in op false als u wilt doorgaan met indexeren als het indexeren van een document mislukt. |
failOnUnsupportedContentType |
boolean |
False |
Voor Azure-blobs stelt u in op false als u wilt doorgaan met indexeren wanneer er een niet-ondersteund inhoudstype wordt aangetroffen en u niet alle inhoudstypen (bestandsextensies) van tevoren kent. |
firstLineContainsHeaders |
boolean |
True |
Voor CSV-blobs geeft aan dat de eerste (niet-lege) regel van elke blob headers bevat. |
imageAction | none |
Bepaalt hoe ingesloten afbeeldingen en afbeeldingsbestanden moeten worden verwerkt in Azure Blob Storage. Als u de configuratie 'imageAction' instelt op een andere waarde dan 'geen', moet er ook een vaardighedenset aan die indexeerfunctie worden gekoppeld. |
|
indexStorageMetadataOnlyForOversizedDocuments |
boolean |
False |
Voor Azure-blobs stelt u deze eigenschap in op True om nog steeds opslagmetagegevens te indexeren voor blobinhoud die te groot is om te verwerken. Te grote blobs worden standaard behandeld als fouten. Zie voor limieten voor blobgrootte https://docs.microsoft.com/azure/search/search-limits-quotas-capacity. |
indexedFileNameExtensions |
string |
Door komma's gescheiden lijst met bestandsnaamextensies die moeten worden geselecteerd bij het verwerken vanuit Azure Blob Storage. U kunt het indexeren bijvoorbeeld richten op specifieke toepassingsbestanden '.docx, .pptx .msg' om deze bestandstypen specifiek op te nemen. |
|
parsingMode | default |
Vertegenwoordigt de parseermodus voor indexering vanuit een Azure-blobgegevensbron. |
|
pdfTextRotationAlgorithm | none |
Bepaalt het algoritme voor tekstextractie uit PDF-bestanden in Azure Blob Storage. |
|
queryTimeout |
string |
00:05:00 |
Hiermee wordt de time-out groter dan de standaardwaarde van 5 minuten voor Azure SQL databasegegevensbronnen, opgegeven in de indeling 'uu:mm:ss'. |
IndexingSchedule
Vertegenwoordigt een schema voor het uitvoeren van de indexeerfunctie.
Name | Type | Description |
---|---|---|
interval |
string |
Het tijdsinterval tussen de uitvoeringen van de indexeerfunctie. |
startTime |
string |
Het tijdstip waarop een indexeerfunctie moet worden uitgevoerd. |
SearchError
Beschrijft een foutvoorwaarde voor de API.
Name | Type | Description |
---|---|---|
code |
string |
Een van een door de server gedefinieerde set foutcodes. |
details |
Een matrix met details over specifieke fouten die tot deze gerapporteerde fout hebben geleid. |
|
message |
string |
Een door mensen leesbare weergave van de fout. |
SearchIndexer
Vertegenwoordigt een indexeerfunctie.
Name | Type | Standaardwaarde | Description |
---|---|---|---|
@odata.etag |
string |
De ETag van de indexeerfunctie. |
|
dataSourceName |
string |
De naam van de gegevensbron waaruit deze indexeerfunctie gegevens leest. |
|
description |
string |
De beschrijving van de indexeerfunctie. |
|
disabled |
boolean |
False |
Een waarde die aangeeft of de indexeerfunctie is uitgeschakeld. De standaardinstelling is onwaar. |
encryptionKey |
Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra niveau van versleuteling-at-rest te bieden voor de definitie van uw indexeerfunctie (evenals de uitvoeringsstatus van de indexeerfunctie) als u volledige zekerheid wilt dat niemand, zelfs Microsoft, ze niet kan ontsleutelen. Nadat u de definitie van uw indexeerfunctie hebt versleuteld, blijft deze altijd versleuteld. De zoekservice negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; De definitie van de indexeerfunctie (en de uitvoeringsstatus van de indexeerfunctie) blijft ongewijzigd. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019. |
||
fieldMappings |
Hiermee definieert u toewijzingen tussen velden in de gegevensbron en de bijbehorende doelvelden in de index. |
||
name |
string |
De naam van de indexeerfunctie. |
|
outputFieldMappings |
Toewijzingen van uitvoervelden worden toegepast na verrijking en direct vóór indexering. |
||
parameters |
Parameters voor het uitvoeren van de indexeerfunctie. |
||
schedule |
Het schema voor deze indexeerfunctie. |
||
skillsetName |
string |
De naam van de vaardighedenset die wordt uitgevoerd met deze indexeerfunctie. |
|
targetIndexName |
string |
De naam van de index waarnaar deze indexeerfunctie gegevens schrijft. |
SearchResourceEncryptionKey
Een door de klant beheerde versleutelingssleutel in Azure Key Vault. Sleutels die u maakt en beheert, kunnen worden gebruikt voor het versleutelen of ontsleutelen van data-at-rest in uw zoekservice, zoals indexen en synoniemenkaarten.
Name | Type | Description |
---|---|---|
accessCredentials |
Optionele Azure Active Directory-referenties die worden gebruikt voor toegang tot uw Azure Key Vault. Niet vereist als u in plaats daarvan een beheerde identiteit gebruikt. |
|
keyVaultKeyName |
string |
De naam van uw Azure Key Vault sleutel die moet worden gebruikt om uw data-at-rest te versleutelen. |
keyVaultKeyVersion |
string |
De versie van uw Azure Key Vault sleutel die moet worden gebruikt voor het versleutelen van uw data-at-rest. |
keyVaultUri |
string |
De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt om uw data-at-rest te versleutelen. Een voorbeeld van een URI kan zijn |