SearchIndexerClient class

Pakket:

@azure/search-documents

Klasse voor het uitvoeren van bewerkingen voor het beheren (maken, bijwerken, weergeven/verwijderen) van indexeerfuncties, gegevensbronnen & vaardighedensets.

Constructors

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Hiermee maakt u een exemplaar van SearchIndexerClient. Voorbeeldgebruik: const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexerClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Eigenschappen

apiVersion	De API-versie die moet worden gebruikt bij het communiceren met de service.
endpoint	Het eindpunt van de zoekservice
serviceVersion	De API-versie die moet worden gebruikt bij het communiceren met de service.

Methoden

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)	Hiermee maakt u een nieuwe dataSource in een zoekservice.
createIndexer(SearchIndexer, OperationOptions)	Hiermee maakt u een nieuwe indexeerfunctie in een zoekservice.
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)	Hiermee maakt u een nieuwe gegevensbron of wijzigt u een bestaande.
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)	Hiermee maakt u een nieuwe indexeerfunctie of wijzigt u een bestaande indexeerfunctie.
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)	Hiermee maakt u een nieuwe vaardighedenset of wijzigt u een bestaande vaardighedenset.
createSkillset(SearchIndexerSkillset, OperationOptions)	Hiermee maakt u een nieuwe vaardighedenset in een zoekservice.
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)	Hiermee verwijdert u een bestaande gegevensbron.
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)	Hiermee verwijdert u een bestaande indexeerfunctie.
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)	Hiermee verwijdert u een bestaande vaardighedenset.
getDataSourceConnection(string, OperationOptions)	Haalt informatie over een datasource op
getIndexer(string, OperationOptions)	Haalt informatie over een indexeerfunctie op.
getIndexerStatus(string, OperationOptions)	Retourneert de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.
getSkillset(string, OperationOptions)	Hiermee haalt u informatie over een vaardighedenset op.
listDataSourceConnections(OperationOptions)	Hiermee haalt u een lijst met bestaande gegevensbronnen in de service op.
listDataSourceConnectionsNames(OperationOptions)	Hiermee haalt u een lijst met namen van bestaande gegevensbronnen in de service op.
listIndexers(OperationOptions)	Hiermee haalt u een lijst met bestaande indexeerfuncties in de service op.
listIndexersNames(OperationOptions)	Hiermee haalt u een lijst met namen van bestaande indexeerfuncties in de service op.
listSkillsets(OperationOptions)	Hiermee haalt u een lijst met bestaande vaardighedensets in de service op.
listSkillsetsNames(OperationOptions)	Hiermee haalt u een lijst met namen van bestaande vaardighedensets in de service op.
resetIndexer(string, OperationOptions)	Hiermee stelt u de status van het bijhouden van wijzigingen opnieuw in die is gekoppeld aan een indexeerfunctie.
runIndexer(string, OperationOptions)	Voert een indexeerfunctie op aanvraag uit.

Constructordetails

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Hiermee maakt u een exemplaar van SearchIndexerClient.

Voorbeeldgebruik:

const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");

const client = new SearchIndexerClient(
  "<endpoint>",
  new AzureKeyCredential("<Admin Key>");
);

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

Parameters

endpoint

string

Het eindpunt van de zoekservice

credential

KeyCredential | TokenCredential

Wordt gebruikt voor het verifiëren van aanvragen voor de service.

options

SearchIndexerClientOptions

Wordt gebruikt om de zoekclient te configureren.

Eigenschapdetails

apiVersion

Waarschuwing

Deze API is nu afgeschaft.

use {@Link serviceVersion} instead

De API-versie die moet worden gebruikt bij het communiceren met de service.

apiVersion: string

Waarde van eigenschap

string

endpoint

Het eindpunt van de zoekservice

endpoint: string

Waarde van eigenschap

string

serviceVersion

De API-versie die moet worden gebruikt bij het communiceren met de service.

serviceVersion: string

Waarde van eigenschap

string

Methodedetails

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Hiermee maakt u een nieuwe dataSource in een zoekservice.

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

Parameters

dataSourceConnection

SearchIndexerDataSourceConnection

De definitie van dataSource die moet worden gemaakt in een zoekservice.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerDataSourceConnection>

createIndexer(SearchIndexer, OperationOptions)

Hiermee maakt u een nieuwe indexeerfunctie in een zoekservice.

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

Parameters

indexer

SearchIndexer

De definitie van de indexeerfunctie die moet worden gemaakt in een zoekservice.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Hiermee maakt u een nieuwe gegevensbron of wijzigt u een bestaande.

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

Parameters

dataSourceConnection

SearchIndexerDataSourceConnection

De informatie die de gegevensbron beschrijft die moet worden gemaakt/bijgewerkt.

options

CreateorUpdateDataSourceConnectionOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerDataSourceConnection>

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Hiermee maakt u een nieuwe indexeerfunctie of wijzigt u een bestaande indexeerfunctie.

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

Parameters

indexer

SearchIndexer

De informatie die de indexeerfunctie beschrijft die moet worden gemaakt/bijgewerkt.

options

CreateorUpdateIndexerOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Hiermee maakt u een nieuwe vaardighedenset of wijzigt u een bestaande vaardighedenset.

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

Parameters

skillset

SearchIndexerSkillset

De informatie die de index beschrijft die moet worden gemaakt.

options

CreateOrUpdateSkillsetOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerSkillset>

createSkillset(SearchIndexerSkillset, OperationOptions)

Hiermee maakt u een nieuwe vaardighedenset in een zoekservice.

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

Parameters

skillset

SearchIndexerSkillset

De vaardighedenset met een of meer vaardigheden die u in een zoekservice kunt maken.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerSkillset>

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Hiermee verwijdert u een bestaande gegevensbron.

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

Parameters

dataSourceConnection

string | SearchIndexerDataSourceConnection

options

DeleteDataSourceConnectionOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Hiermee verwijdert u een bestaande indexeerfunctie.

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

Parameters

indexer

string | SearchIndexer

Indexeerfunctie/naam van de indexeerfunctie die moet worden verwijderd.

options

DeleteIndexerOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Hiermee verwijdert u een bestaande vaardighedenset.

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

Parameters

skillset

string | SearchIndexerSkillset

Vaardighedenset/naam van de vaardighedenset die u wilt verwijderen.

options

DeleteSkillsetOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

getDataSourceConnection(string, OperationOptions)

Haalt informatie over een datasource op

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

Parameters

dataSourceConnectionName

string

options

OperationOptions

Aanvullende optionele argumenten

Retouren

Promise<SearchIndexerDataSourceConnection>

getIndexer(string, OperationOptions)

Haalt informatie over een indexeerfunctie op.

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

Parameters

indexerName

string

De naam van de indexeerfunctie.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Retourneert de huidige status en uitvoeringsgeschiedenis van een indexeerfunctie.

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

Parameters

indexerName

string

De naam van de indexeerfunctie.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerStatus>

getSkillset(string, OperationOptions)

Hiermee haalt u informatie over een vaardighedenset op.

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

Parameters

skillsetName

string

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<SearchIndexerSkillset>

listDataSourceConnections(OperationOptions)

Hiermee haalt u een lijst met bestaande gegevensbronnen in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking lijstindexeerfuncties.

Retouren

Promise<SearchIndexerDataSourceConnection[]>

listDataSourceConnectionsNames(OperationOptions)

Hiermee haalt u een lijst met namen van bestaande gegevensbronnen in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking lijstindexeerfuncties.

Retouren

Promise<string[]>

listIndexers(OperationOptions)

Hiermee haalt u een lijst met bestaande indexeerfuncties in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking lijstindexeerfuncties.

Retouren

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Hiermee haalt u een lijst met namen van bestaande indexeerfuncties in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking lijstindexeerfuncties.

Retouren

Promise<string[]>

listSkillsets(OperationOptions)

Hiermee haalt u een lijst met bestaande vaardighedensets in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking Vaardighedensets.

Retouren

Promise<SearchIndexerSkillset[]>

listSkillsetsNames(OperationOptions)

Hiermee haalt u een lijst met namen van bestaande vaardighedensets in de service op.

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

Parameters

options

OperationOptions

Opties voor de bewerking Vaardighedensets.

Retouren

Promise<string[]>

resetIndexer(string, OperationOptions)

Hiermee stelt u de status van het bijhouden van wijzigingen opnieuw in die is gekoppeld aan een indexeerfunctie.

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

Parameters

indexerName

string

De naam van de indexeerfunctie die opnieuw moet worden ingesteld.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>

runIndexer(string, OperationOptions)

Voert een indexeerfunctie op aanvraag uit.

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

Parameters

indexerName

string

De naam van de indexeerfunctie die moet worden uitgevoerd.

options

OperationOptions

Aanvullende optionele argumenten.

Retouren

Promise<void>