Indexers - Get

Referentie

Service:: Search Service

API-versie:: 2024-07-01

Hiermee haalt u een indexeerfunctiedefinitie op.

GET {endpoint}/indexers('{indexerName}')?api-version=2024-07-01

URI-parameters

Name	In	Vereist	Type	Description
endpoint	path	True	string	De eindpunt-URL van de zoekservice.
indexerName	path	True	string	De naam van de indexeerfunctie die moet worden opgehaald.
api-version	query	True	string	Client-API-versie.

Aanvraagkoptekst

Name	Vereist	Type	Description
x-ms-client-request-id		string uuid	De tracerings-id die is verzonden met de aanvraag om hulp te bieden bij foutopsporing.

Antwoorden

Name	Type	Description
200 OK	SearchIndexer
Other Status Codes	ErrorResponse	Foutreactie.

Voorbeelden

SearchServiceGetIndexer

Voorbeeldaanvraag

HTTP

GET https://myservice.search.windows.net/indexers('myindexer')?api-version=2024-07-01

Voorbeeldrespons

Statuscode:: 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": "myKeyName",
    "keyVaultKeyVersion": "myKeyVersion",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": null
    }
  }
}

Definities

Name	Description
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.
BlobIndexerDataToExtract	Hiermee geeft u de gegevens op die moeten worden geëxtraheerd uit Azure Blob Storage 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 andere toepassing, of afbeeldingsbestanden zoals .jpg en .png, in Azure-blobs.
BlobIndexerImageAction	Bepaalt hoe u ingesloten afbeeldingen en afbeeldingsbestanden 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.
BlobIndexerParsingMode	Vertegenwoordigt de parseermodus voor indexering vanuit een Azure Blob-gegevensbron.
BlobIndexerPDFTextRotationAlgorithm	Bepaalt het algoritme voor tekstextractie van PDF-bestanden in Azure Blob Storage.
ErrorAdditionalInfo	Aanvullende informatie over de resourcebeheerfout.
ErrorDetail	De foutdetails.
ErrorResponse	Foutreactie
FieldMapping	Definieert een toewijzing tussen een veld in een gegevensbron en een doelveld in een index.
FieldMappingFunction	Vertegenwoordigt een functie die een waarde transformeert uit een gegevensbron voordat u indexeert.
IndexerExecutionEnvironment	Hiermee geeft u de omgeving waarin de indexeerfunctie moet worden uitgevoerd.
IndexingParameters	Vertegenwoordigt parameters voor de uitvoering van de indexeerfunctie.
IndexingParametersConfiguration	Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor een indexeerfunctie. Elke naam is de naam van een specifieke eigenschap. Elke waarde moet van een primitief type zijn.
IndexingSchedule	Vertegenwoordigt een schema voor de uitvoering van de indexeerfunctie.
SearchIndexer	Vertegenwoordigt een indexeerfunctie.
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, 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 mag 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 moeten worden geëxtraheerd uit Azure Blob Storage 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 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 inhoudstypespecifieke metagegevens (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 standaardblobeigenschappen en door de gebruiker opgegeven metagegevens.

BlobIndexerImageAction

Bepaalt hoe u ingesloten afbeeldingen en afbeeldingsbestanden 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 in dat elke pagina wordt weergegeven als een afbeelding en dienovereenkomstig genormaliseerd, in plaats van ingesloten afbeeldingen te extraheren. Niet-PDF-bestandstypen worden hetzelfde behandeld als 'generateNormalizedImages' is ingesteld.
generateNormalizedImages	string	Extraheert tekst uit afbeeldingen (bijvoorbeeld het woord 'STOP' van een verkeersstopteken) en sluit deze in het inhoudsveld in. Deze actie vereist dat dataToExtract is ingesteld op 'contentAndMetadata'. Een genormaliseerde afbeelding verwijst naar extra verwerking die resulteert in uniforme afbeeldingsuitvoer, grootte en gedraaid om consistente rendering te bevorderen wanneer u afbeeldingen in visuele zoekresultaten opneemt. Deze informatie wordt gegenereerd voor elke afbeelding wanneer u deze optie gebruikt.
none	string	Hiermee worden ingesloten afbeeldingen of afbeeldingsbestanden in de gegevensset genegeerd. Dit is de standaardwaarde.

BlobIndexerParsingMode

Vertegenwoordigt de parseermodus voor indexering vanuit een Azure Blob-gegevensbron.

Name	Type	Description
default	string	Ingesteld op standaard voor normale bestandsverwerking.
delimitedText	string	Ingesteld op delimitedText wanneer blobs gewone CSV-bestanden zijn.
json	string	Ingesteld op json om gestructureerde inhoud uit JSON-bestanden te extraheren.
jsonArray	string	Ingesteld op jsonArray om afzonderlijke elementen van een JSON-matrix als afzonderlijke documenten te extraheren.
jsonLines	string	Stel deze optie in op jsonLines om afzonderlijke JSON-entiteiten te extraheren, gescheiden door een nieuwe regel, als afzonderlijke documenten.
text	string	Ingesteld op tekst om de indexeringsprestaties voor tekstbestanden zonder opmaak in blobopslag te verbeteren.

BlobIndexerPDFTextRotationAlgorithm

Bepaalt het algoritme voor tekstextractie van PDF-bestanden in Azure Blob Storage.

Name	Type	Description
detectAngles	string	Kan betere en beter leesbare tekstextractie produceren uit PDF-bestanden die tekst erin hebben gedraaid. Houd er rekening mee dat er mogelijk een kleine invloed op de prestatiesnelheid is 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 standaardwaarde.

ErrorAdditionalInfo

Aanvullende informatie over de resourcebeheerfout.

Name	Type	Description
info	object	De aanvullende informatie.
type	string	Het extra informatietype.

ErrorDetail

De foutdetails.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	De fout bevat aanvullende informatie.
code	string	De foutcode.
details	ErrorDetail[]	De foutdetails.
message	string	Het foutbericht.
target	string	Het foutdoel.

ErrorResponse

Foutreactie

Name	Type	Description
error	ErrorDetail	Het foutobject.

FieldMapping

Definieert een toewijzing tussen een veld in een gegevensbron en een doelveld in een index.

Name	Type	Description
mappingFunction	FieldMappingFunction	Een functie die moet worden toegepast op elke waarde van het bronveld voordat u indexeert.
sourceFieldName	string	De naam van het veld in de gegevensbron.
targetFieldName	string	De naam van het doelveld in de index. Hetzelfde als de naam van het bronveld.

FieldMappingFunction

Vertegenwoordigt een functie die een waarde transformeert uit een gegevensbron voordat u indexeert.

Name	Type	Description
name	string	De naam van de veldtoewijzingsfunctie.
parameters	object	Een woordenlijst met parameternaam/waardeparen die aan de functie moeten worden doorgegeven. 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 nodig heeft tot resources via gedeelde private link-resources.
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 de aanbevolen waarde is.

IndexingParameters

Vertegenwoordigt parameters voor de uitvoering van de indexeerfunctie.

Name	Type	Default value	Description
batchSize	integer		Het aantal items dat uit de gegevensbron wordt gelezen en geïndexeerd als één batch om de prestaties te verbeteren. De standaardwaarde is afhankelijk van het gegevensbrontype.
configuration	IndexingParametersConfiguration		Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor een 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 voor de uitvoering van de indexeerfunctie, wordt nog steeds beschouwd als geslaagd. -1 betekent geen limiet. De standaardwaarde is 0.
maxFailedItemsPerBatch	integer	0	Het maximum aantal items in één batch dat kan mislukken bij het indexeren van de batch, wordt nog steeds beschouwd als geslaagd. -1 betekent geen limiet. De standaardwaarde is 0.

IndexingParametersConfiguration

Een woordenlijst met configuratie-eigenschappen die specifiek zijn voor een indexeerfunctie. Elke naam is de naam van een specifieke eigenschap. Elke waarde moet van een primitief type zijn.

Name	Type	Default value	Description
allowSkillsetToReadFileData	boolean	False	Als waar is, maakt u een pad //document//file_data 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 in de verrijkingspijplijn of aan de vaardigheid Documentextractie.
dataToExtract	BlobIndexerDataToExtract	contentAndMetadata	Hiermee geeft u de gegevens op die moeten worden geëxtraheerd uit Azure Blob Storage 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 andere toepassing, of afbeeldingsbestanden zoals .jpg en .png, in Azure-blobs.
delimitedTextDelimiter	string		Voor CSV-blobs geeft u het scheidingsteken met één teken op voor CSV-bestanden waarop 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, op basis van een gestructureerd of semi-gestructureerd document, kunt u 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 verwerking vanuit Azure Blob Storage. U kunt bijvoorbeeld '.png, .mp4' uitsluiten om deze bestanden over te slaan tijdens het indexeren.
executionEnvironment	IndexerExecutionEnvironment	standard	Hiermee geeft u de omgeving waarin de indexeerfunctie moet worden uitgevoerd.
failOnUnprocessableDocument	boolean	False	Stel voor Azure-blobs in op false als u wilt doorgaan met indexeren als het indexeren van een document mislukt.
failOnUnsupportedContentType	boolean	False	Stel voor Azure-blobs in op onwaar als u wilt doorgaan met indexeren wanneer er een niet-ondersteund inhoudstype wordt aangetroffen en u niet alle inhoudstypen (bestandsextensies) van tevoren weet.
firstLineContainsHeaders	boolean	True	Voor CSV-blobs geeft u aan dat de eerste (niet-lege) regel van elke blob headers bevat.
imageAction	BlobIndexerImageAction	none	Bepaalt hoe u ingesloten afbeeldingen en afbeeldingsbestanden 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 blob-inhoud die te groot is om te verwerken. Oversized blobs worden standaard behandeld als fouten. Zie https://learn.microsoft.com/azure/search/search-limits-quotas-capacityvoor limieten voor de blobgrootte.
indexedFileNameExtensions	string		Door komma's gescheiden lijst met bestandsnaamextensies die moeten worden geselecteerd bij verwerking in Azure Blob Storage. U kunt zich bijvoorbeeld richten op indexering op specifieke toepassingsbestanden '.docx, .pptx, .msg' om specifiek deze bestandstypen op te nemen.
parsingMode	BlobIndexerParsingMode	default	Vertegenwoordigt de parseermodus voor indexering vanuit een Azure Blob-gegevensbron.
pdfTextRotationAlgorithm	BlobIndexerPDFTextRotationAlgorithm	none	Bepaalt het algoritme voor tekstextractie van PDF-bestanden in Azure Blob Storage.
queryTimeout	string	00:05:00	Hiermee wordt de time-out hoger dan de standaardwaarde van 5 minuten voor Azure SQL-databasegegevensbronnen, die zijn opgegeven in de indeling 'uu:mm:ss'.

IndexingSchedule

Vertegenwoordigt een schema voor de uitvoering van de indexeerfunctie.

Name	Type	Description
interval	string	Het tijdsinterval tussen uitvoeringen van de indexeerfunctie.
startTime	string	Het tijdstip waarop een indexeerfunctie moet worden uitgevoerd.

SearchIndexer

Vertegenwoordigt een indexeerfunctie.

Name	Type	Default value	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 standaardwaarde is onwaar.
encryptionKey	SearchResourceEncryptionKey		Een beschrijving van een versleutelingssleutel die u in Azure Key Vault maakt. Deze sleutel wordt gebruikt om een extra versleutelings-at-rest-niveau te bieden voor de definitie van uw indexeerfunctie (evenals de uitvoeringsstatus van de indexeerfunctie) als u volledige zekerheid wilt dat niemand, zelfs Microsoft, deze 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 draaien; 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	FieldMapping[]		Definieert toewijzingen tussen velden in de gegevensbron en bijbehorende doelvelden in de index.
name	string		De naam van de indexeerfunctie.
outputFieldMappings	FieldMapping[]		Uitvoerveldtoewijzingen worden toegepast na verrijking en direct voor indexering.
parameters	IndexingParameters		Parameters voor de uitvoering van de indexeerfunctie.
schedule	IndexingSchedule		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, zoals indexen en synoniemenkaarten.

Name	Type	Description
accessCredentials	AzureActiveDirectoryApplicationCredentials	Optionele Azure Active Directory-referenties die worden gebruikt voor toegang tot uw Azure Key Vault. Niet vereist als u in plaats daarvan 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 om uw data-at-rest te versleutelen.
keyVaultUri	string	De URI van uw Azure Key Vault, ook wel DNS-naam genoemd, die de sleutel bevat die moet worden gebruikt voor het versleutelen van uw data-at-rest. Een voorbeeld van een URI kan `https://my-keyvault-name.vault.azure.net`zijn.

Delen via