Skapa indexerare (REST API för Azure AI Search)

En indexerare automatiserar indexering från Azure-datakällor som stöds, till exempel Azure Storage, Azure SQL Database och Azure Cosmos DB för att nämna några. Indexerare använder en fördefinierad datakälla och ett index för att upprätta en indexeringspipeline som extraherar och serialiserar källdata och skickar dem till en söktjänst för datainmatning. För AI-berikning av bild och ostrukturerad text kan indexerare också acceptera en kompetensuppsättning som definierar AI-bearbetning.

När du skapar en indexerare läggs den till i söktjänsten och den körs. Om begäran lyckas fylls indexet i med sökbart innehåll från datakällan.

Du kan använda POST eller PUT på begäran. För någon av dem innehåller JSON-dokumentet i begärandetexten objektdefinitionen.

POST https://[service name].search.windows.net/indexers?api-version=[api-version]
    Content-Type: application/json  
    api-key: [admin key]  

Du kan också använda PUT och ange indexerarens namn på URI:n.

PUT https://[service name].search.windows.net/indexers/[indexer name]?api-version=[api-version]
    Content-Type: application/json  
    api-key: [admin key]    

HTTPS krävs för alla tjänstbegäranden. Om indexeraren inte finns skapas den. Om den redan finns uppdateras den till den nya definitionen, men du måste utfärda en Run Indexer-begäran om du vill köra indexeraren.

Indexerarens konfiguration varierar beroende på typen av datakälla. För dataplattformsspecifik vägledning om hur du skapar indexerare börjar du med Indexerare-översikten, som innehåller den fullständiga listan över relaterade artiklar.

URI-parametrar

Rubriker för begäran

I följande tabell beskrivs nödvändiga och valfria begärandehuvuden.

Begärandetext

En datakälla, ett index och en kompetensuppsättning ingår i en indexerares definition, men var och en är en oberoende komponent som kan användas i olika kombinationer. Du kan till exempel använda samma datakälla med flera indexerare eller samma index med flera indexerare eller flera indexerare som skriver till ett enda index.

Följande JSON är en övergripande representation av definitionens huvuddelar.

{   
    "name" : (optional on PUT; required on POST) "Name of the indexer",  
    "description" : (optional) "Anything you want, or nothing at all", 
    "dataSourceName" : (required) "Name of an existing data source",  
    "targetIndexName" : (required) "Name of an existing index",  
    "skillsetName" : (required for AI enrichment) "Name of an existing skillset",
    "disabled" : (optional) Boolean value indicating whether the indexer is disabled. False by default,
    "schedule" : (optional but runs once immediately if unspecified) { ... },  
    "parameters": { (optional)
       "batchSize": null,
       "maxFailedItems": 0,
       "maxFailedItemsPerBatch": 0,
       "base64EncodeKeys": null,
       "configuration": { (optional, mostly specific to the data source)
            "executionEnvironment": null
        }
      }, 
    "fieldMappings" : (optional) { ... },
    "outputFieldMappings" : (required for AI enrichment) { ... },
    "encryptionKey":(optional) { }
} 

Begäran innehåller följande egenskaper:

Blobkonfigurationsparametrar

Flera parametrar är exklusiva för en viss indexerare, till exempel Azure Blob Indexing.

Konfigurationsparametrar för Azure Cosmos DB

Följande parametrar är specifika för Cosmos DB-indexerare.

Azure SQL konfigurationsparametrar

Följande parametrar är specifika för Azure SQL Database.

Svarsåtgärder

201 Skapades för en lyckad begäran.

Exempel

Exempel: Indexerare med schema och allmänna parametrar

Skapar en indexerare som kopierar data från tabellen som datakällan refererar ordersds till till indexet enligt ett schema som startar den orders 1 januari 2021 UTC och körs varje timme. Varje anrop av indexerare lyckas om högst 5 objekt inte kan indexeras i varje batch och högst 10 objekt inte kan indexeras totalt.

{
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2021-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5 }  
}

Exempel: Indexerare med blobparametrar

En indexerare kan välja att använda konfigurationsparametrar som ändrar körningsbeteenden. Konfigurationsparametrar avgränsas med kommatecken i indexerarbegäran och är specifika för en datakälla. Följande konfigurationsparametrar innehåller instruktioner som används för att indexa blobar.

  {
    "name" : "my-blob-indexer-for-cognitive-search",
    ... other indexer properties
    "parameters" : 
      { 
      "maxFailedItems" : "15", 
      "batchSize" : "100", 
      "configuration" : 
          { 
          "parsingMode" : "json", 
          "indexedFileNameExtensions" : ".json, .jpg, .png",
          "imageAction" : "generateNormalizedImages",
          "dataToExtract" : "contentAndMetadata" ,
          "executionEnvironment": "Standard"
          } 
      }
  }

Exempel: Indexerare med fältmappningar

Mappa en källtabells fält _id till ett "id" fält i ett sökindex. Azure AI Search tillåter inte att ett fältnamn börjar med ett understreck. En fältmappning kan lösa namnskillnader. Både käll- och målfältnamn är skiftlägesokänsliga. Mer information finns i Fältmappningar och transformeringar.

"fieldMappings" : [
    { "sourceFieldName" : "_id", "targetFieldName" : "id" },
    { "sourceFieldName" : "_timestamp", "targetFieldName" : "timestamp" }
]

Exempel: Indexerare med AI-berikning

Visar en AI-berikning, vilket anges av referensen till en skillset och outputFieldMappings. Kompetensuppsättningar är resurser på hög nivå som definieras separat. Det här exemplet är en förkortning av indexerarens definition i självstudien om AI-berikning.

{
  "name":"demoindexer",	
  "dataSourceName" : "demodata",
  "targetIndexName" : "demoindex",
  "skillsetName" : "demoskillset",
  "fieldMappings" : [
    {
        "sourceFieldName" : "content",
        "targetFieldName" : "content"
    }
   ],
  "outputFieldMappings" : 
  [
    {
        "sourceFieldName" : "/document/organizations", 
        "targetFieldName" : "organizations"
    },
  ],
  "parameters":
  {
  	"maxFailedItems":-1,
  	"configuration": 
    {
    "dataToExtract": "contentAndMetadata",
    "imageAction": "generateNormalizedImages"
    }
  }
}

Exempel: Indexerare med mappningar för kompetensuppsättningar och utdatafält

I AI-berikningsscenarier där en kompetensuppsättning är bunden till en indexerare måste du lägga outputFieldMappings till för att associera utdata från ett berikningssteg som tillhandahåller innehåll till ett sökbart fält i indexet. sourceFieldName är en nod i ett berikande träd. Det kan vara en sammansatt struktur som skapas under berikning från två separata fält i källdokumentet. targetFieldName är ett fält i ett sökindex. Mer information finns i Mappa utdatafält från en kompetensuppsättning.

"outputFieldMappings" : [
      {
        "sourceFieldName" : "/document/organizations", 
        "targetFieldName" : "organizations"
      },
      {
        "sourceFieldName" : "/document/pages/*/keyPhrases/*", 
        "targetFieldName" : "keyphrases"
      },
      {
          "sourceFieldName": "/document/languageCode",
          "targetFieldName": "language",
          "mappingFunction": null
      }      
  ]

Exempel: Krypteringsnycklar

Krypteringsnycklar är kundhanterade nycklar som används för ytterligare kryptering. Mer information finns i Kryptering med kundhanterade nycklar i Azure Key Vault.

{
    "name" : "myindexer",  
    "description" : "a cool indexer",  
    "dataSourceName" : "ordersds",  
    "targetIndexName" : "orders",  
    "schedule" : { "interval" : "PT1H", "startTime" : "2021-01-01T00:00:00Z" },  
    "parameters" : { "maxFailedItems" : 10, "maxFailedItemsPerBatch" : 5 },
    "encryptionKey": (optional) { 
      "keyVaultKeyName": "Name of the Azure Key Vault key used for encryption",
      "keyVaultKeyVersion": "Version of the Azure Key Vault key",
      "keyVaultUri": "URI of Azure Key Vault, also referred to as DNS name, that provides the key. An example URI might be https://my-keyvault-name.vault.azure.net",
      "accessCredentials": (optional, only if not using managed system identity) {
        "applicationId": "Microsoft Entra ID application ID that was granted access permissions to your specified Azure Key Vault",
        "applicationSecret": "Authentication key of the registered application)"}
      }
}

Se även

• Översikt över indexeraren
• Skapa indexerare
• Översikt över AI-berikning
• Snabbstart: Prova AI-berikning i portalen
• Mappa fält (AI-berikning)