SearchIndexerClient class

Paket:

@azure/search-documents

Klass för att utföra åtgärder för att hantera (skapa, uppdatera, lista/ta bort) indexerare, datakällor & kompetensuppsättningar.

Konstruktorer

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Skapar en instans av SearchIndexerClient. Exempel på användning: import { SearchIndexerClient, AzureKeyCredential } from "@azure/search-documents"; const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

Egenskaper

apiVersion	DEN API-version som ska användas när du kommunicerar med tjänsten.
endpoint	Slutpunkten för söktjänsten
pipeline	En referens till den interna HTTP-pipelinen för användning med rådatabegäranden
serviceVersion	DEN API-version som ska användas när du kommunicerar med tjänsten.

Metoder

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Skapar en ny dataKälla i en söktjänst.
createIndexer(SearchIndexer, OperationOptions)	Skapar en ny indexerare i en söktjänst.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Skapar en ny datakälla eller ändrar en befintlig.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Skapar en ny indexerare eller ändrar en befintlig.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Skapar en ny kompetensuppsättning eller ändrar en befintlig.
createSkillset(SearchIndexerSkillset, OperationOptions)	Skapar en ny kompetensuppsättning i en söktjänst.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Tar bort en befintlig datakälla.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Tar bort en befintlig indexerare.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Tar bort en befintlig kompetensuppsättning.
getDataSourceConnection(string, OperationOptions)	Hämtar information om en DataSource
getIndexer(string, OperationOptions)	Hämtar information om en indexerare.
getIndexerStatus(string, OperationOptions)	Returnerar den aktuella status- och körningshistoriken för en indexerare.
getSkillset(string, OperationOptions)	Hämtar information om en kompetensuppsättning.
listDataSourceConnections(OperationOptions)	Hämtar en lista över befintliga datakällor i tjänsten.
listDataSourceConnectionsNames(OperationOptions)	Hämtar en lista med namn på befintliga datakällor i tjänsten.
listIndexers(OperationOptions)	Hämtar en lista över befintliga indexerare i tjänsten.
listIndexersNames(OperationOptions)	Hämtar en lista med namn på befintliga indexerare i tjänsten.
listSkillsets(OperationOptions)	Hämtar en lista över befintliga kompetensuppsättningar i tjänsten.
listSkillsetsNames(OperationOptions)	Hämtar en lista med namn på befintliga kompetensuppsättningar i tjänsten.
resetDocuments(string, ResetDocumentsOptions)	Återställer specifika dokument i datakällan så att de selektivt matas in av indexeraren.
resetIndexer(string, OperationOptions)	Återställer ändringsspårningstillståndet som är associerat med en indexerare.
resetSkills(string, ResetSkillsOptions)	Återställa en befintlig kompetensuppsättning i en söktjänst.
runIndexer(string, OperationOptions)	Kör en indexerare på begäran.

Konstruktorinformation

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Skapar en instans av SearchIndexerClient.

Exempel på användning:

import { SearchIndexerClient, AzureKeyCredential } from "@azure/search-documents";

const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Parametrar

endpoint

string

Slutpunkten för söktjänsten

credential

KeyCredential | TokenCredential

Används för att autentisera begäranden till tjänsten.

options

SearchIndexerClientOptions

Används för att konfigurera sökklienten.

Egenskapsinformation

apiVersion

Varning

Det här API:et är nu inaktuellt.

use {@Link serviceVersion} instead

DEN API-version som ska användas när du kommunicerar med tjänsten.

apiVersion: string

Egenskapsvärde

string

endpoint

Slutpunkten för söktjänsten

endpoint: string

Egenskapsvärde

string

pipeline

En referens till den interna HTTP-pipelinen för användning med rådatabegäranden

pipeline: Pipeline

Egenskapsvärde

Pipeline

serviceVersion

DEN API-version som ska användas när du kommunicerar med tjänsten.

serviceVersion: string

Egenskapsvärde

string

Metodinformation

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Skapar en ny dataKälla i en söktjänst.

function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametrar

dataSourceConnection

SearchIndexerDataSourceConnection

DataSource-definitionen som ska skapas i en söktjänst.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Skapar en ny indexerare i en söktjänst.

function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>

Parametrar

indexer

SearchIndexer

Indexerarens definition som ska skapas i en söktjänst.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Skapar en ny datakälla eller ändrar en befintlig.

function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>

Parametrar

dataSourceConnection

SearchIndexerDataSourceConnection

Informationen som beskriver den datakälla som ska skapas/uppdateras.

options

CreateorUpdateDataSourceConnectionOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Skapar en ny indexerare eller ändrar en befintlig.

function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>

Parametrar

indexer

SearchIndexer

Informationen som beskriver indexeraren som ska skapas/uppdateras.

options

CreateorUpdateIndexerOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Skapar en ny kompetensuppsättning eller ändrar en befintlig.

function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>

Parametrar

skillset

SearchIndexerSkillset

Den information som beskriver indexet som ska skapas.

options

CreateOrUpdateSkillsetOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Skapar en ny kompetensuppsättning i en söktjänst.

function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametrar

skillset

SearchIndexerSkillset

Kompetensuppsättningen som innehåller en eller flera färdigheter att skapa i en söktjänst.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Tar bort en befintlig datakälla.

function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>

Parametrar

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Tar bort en befintlig indexerare.

function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>

Parametrar

indexer

string | SearchIndexer

Indexerare/Namn på indexeraren som ska tas bort.

options

DeleteIndexerOptions

Ytterligare valfria argument.

Returer

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Tar bort en befintlig kompetensuppsättning.

function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>

Parametrar

skillset

string | SearchIndexerSkillset

Kompetensuppsättning/Namn på kompetensuppsättningen som ska tas bort.

options

DeleteSkillsetOptions

Ytterligare valfria argument.

Returer

Promise<void>

getDataSourceConnection(string, OperationOptions)

Hämtar information om en DataSource

function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>

Parametrar

dataSourceConnectionName

string

options

OperationOptions

Ytterligare valfria argument

Returer

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Hämtar information om en indexerare.

function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>

Parametrar

indexerName

string

Indexerarens namn.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Returnerar den aktuella status- och körningshistoriken för en indexerare.

function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>

Parametrar

indexerName

string

Indexerarens namn.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Hämtar information om en kompetensuppsättning.

function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>

Parametrar

skillsetName

string

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Hämtar en lista över befintliga datakällor i tjänsten.

function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>

Parametrar

options

OperationOptions

Alternativ för listindexeringsåtgärden.

Returer

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Hämtar en lista med namn på befintliga datakällor i tjänsten.

function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>

Parametrar

options

OperationOptions

Alternativ för listindexeringsåtgärden.

Returer

Promise<string[]>

listIndexers(OperationOptions)

Hämtar en lista över befintliga indexerare i tjänsten.

function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>

Parametrar

options

OperationOptions

Alternativ för listindexeringsåtgärden.

Returer

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Hämtar en lista med namn på befintliga indexerare i tjänsten.

function listIndexersNames(options?: OperationOptions): Promise<string[]>

Parametrar

options

OperationOptions

Alternativ för listindexeringsåtgärden.

Returer

Promise<string[]>

listSkillsets(OperationOptions)

Hämtar en lista över befintliga kompetensuppsättningar i tjänsten.

function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>

Parametrar

options

OperationOptions

Alternativ för liståtgärden Kompetensuppsättningar.

Returer

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Hämtar en lista med namn på befintliga kompetensuppsättningar i tjänsten.

function listSkillsetsNames(options?: OperationOptions): Promise<string[]>

Parametrar

options

OperationOptions

Alternativ för liståtgärden Kompetensuppsättningar.

Returer

Promise<string[]>

resetDocuments(string, ResetDocumentsOptions)

Återställer specifika dokument i datakällan så att de selektivt matas in av indexeraren.

function resetDocuments(indexerName: string, options?: ResetDocumentsOptions): Promise<void>

Parametrar

indexerName

string

Namnet på indexeraren som dokument ska återställas för.

options

ResetDocumentsOptions

Ytterligare valfria argument.

Returer

Promise<void>

resetIndexer(string, OperationOptions)

Återställer ändringsspårningstillståndet som är associerat med en indexerare.

function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametrar

indexerName

string

Namnet på indexeraren som ska återställas.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<void>

resetSkills(string, ResetSkillsOptions)

Återställa en befintlig kompetensuppsättning i en söktjänst.

function resetSkills(skillsetName: string, options?: ResetSkillsOptions): Promise<void>

Parametrar

skillsetName

string

Namnet på kompetensuppsättningen som ska återställas.

options

ResetSkillsOptions

Alternativparametrarna.

Returer

Promise<void>

runIndexer(string, OperationOptions)

Kör en indexerare på begäran.

function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>

Parametrar

indexerName

string

Namnet på indexeraren som ska köras.

options

OperationOptions

Ytterligare valfria argument.

Returer

Promise<void>