SearchIndexerClient class

Osztály az indexelők, adatforrások & képességkészletek kezeléséhez (létrehozás, frissítés, lista/törlés) szükséges műveletek végrehajtásához.

Konstruktorok

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Létrehozza a SearchIndexerClient egy példányát.

Példahasználat:

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

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

Tulajdonságok

apiVersion

A szolgáltatással való kommunikációhoz használandó API-verzió.

endpoint

A keresési szolgáltatás végpontja

pipeline

Hivatkozás a belső HTTP-folyamatra a nyers kérésekkel való használathoz

serviceVersion

A szolgáltatással való kommunikációhoz használandó API-verzió.

Metódusok

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Létrehoz egy új adatforrást egy keresési szolgáltatásban.

createIndexer(SearchIndexer, OperationOptions)

Új indexelőt hoz létre egy keresési szolgáltatásban.

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Létrehoz egy új adatforrást, vagy módosít egy meglévőt.

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Létrehoz egy új indexelőt, vagy módosít egy meglévőt.

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Létrehoz egy új készségkészletet, vagy módosít egy meglévőt.

createSkillset(SearchIndexerSkillset, OperationOptions)

Új készségkészletet hoz létre egy keresési szolgáltatásban.

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Töröl egy meglévő adatforrást.

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Egy meglévő indexelő törlése.

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Egy meglévő skillset töröl.

getDataSourceConnection(string, OperationOptions)

Adatforrással kapcsolatos információk lekérése

getIndexer(string, OperationOptions)

Adatokat kér le egy indexelőről.

getIndexerStatus(string, OperationOptions)

Egy indexelőzmény aktuális állapotát és végrehajtási előzményeit adja vissza.

getSkillset(string, OperationOptions)

Beolvassa a skillset-ről szóló információkat.

listDataSourceConnections(OperationOptions)

Lekéri a szolgáltatásban lévő meglévő adatforrások listáját.

listDataSourceConnectionsNames(OperationOptions)

Lekéri a szolgáltatásban lévő meglévő adatforrások nevének listáját.

listIndexers(OperationOptions)

Lekéri a szolgáltatás meglévő indexelőinek listáját.

listIndexersNames(OperationOptions)

Lekéri a szolgáltatásban meglévő indexelők nevének listáját.

listSkillsets(OperationOptions)

Lekéri a szolgáltatásban meglévő készségek listáját.

listSkillsetsNames(OperationOptions)

Lekéri a szolgáltatásban meglévő képességkészletek nevének listáját.

resetIndexer(string, OperationOptions)

Alaphelyzetbe állítja az indexelőhöz társított változáskövetési állapotot.

runIndexer(string, OperationOptions)

Igény szerinti indexelőt futtat.

Konstruktor adatai

SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)

Létrehozza a SearchIndexerClient egy példányát.

Példahasználat:

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

const indexerClient = new SearchIndexerClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)

Paraméterek

endpoint

string

A keresési szolgáltatás végpontja

credential

KeyCredential | TokenCredential

A szolgáltatáshoz érkező kérések hitelesítésére szolgál.

options
SearchIndexerClientOptions

A Search-ügyfél konfigurálására szolgál.

Tulajdonság adatai

apiVersion

Figyelmeztetés

Ez az API már elavult.

use {@Link serviceVersion} instead

A szolgáltatással való kommunikációhoz használandó API-verzió.

apiVersion: string

Tulajdonság értéke

string

endpoint

A keresési szolgáltatás végpontja

endpoint: string

Tulajdonság értéke

string

pipeline

Hivatkozás a belső HTTP-folyamatra a nyers kérésekkel való használathoz

pipeline: Pipeline

Tulajdonság értéke

serviceVersion

A szolgáltatással való kommunikációhoz használandó API-verzió.

serviceVersion: string

Tulajdonság értéke

string

Metódus adatai

createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)

Létrehoz egy új adatforrást egy keresési szolgáltatásban.

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

Paraméterek

dataSourceConnection
SearchIndexerDataSourceConnection

A keresési szolgáltatásban létrehozandó dataSource-definíció.

options
OperationOptions

További választható argumentumok.

Válaszok

createIndexer(SearchIndexer, OperationOptions)

Új indexelőt hoz létre egy keresési szolgáltatásban.

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

Paraméterek

indexer
SearchIndexer

A keresési szolgáltatásban létrehozandó indexelődefiníció.

options
OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndexer>

createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)

Létrehoz egy új adatforrást, vagy módosít egy meglévőt.

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

Paraméterek

dataSourceConnection
SearchIndexerDataSourceConnection

A létrehozandó/frissítendő adatforrást leíró információk.

options
CreateorUpdateDataSourceConnectionOptions

További választható argumentumok.

Válaszok

createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)

Létrehoz egy új indexelőt, vagy módosít egy meglévőt.

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

Paraméterek

indexer
SearchIndexer

A létrehozandó/frissítendő indexelőt leíró információk.

options
CreateorUpdateIndexerOptions

További választható argumentumok.

Válaszok

Promise<SearchIndexer>

createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)

Létrehoz egy új készségkészletet, vagy módosít egy meglévőt.

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

Paraméterek

skillset
SearchIndexerSkillset

A létrehozandó indexet leíró információk.

options
CreateOrUpdateSkillsetOptions

További választható argumentumok.

Válaszok

createSkillset(SearchIndexerSkillset, OperationOptions)

Új készségkészletet hoz létre egy keresési szolgáltatásban.

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

Paraméterek

skillset
SearchIndexerSkillset

A keresési szolgáltatásban létrehozandó egy vagy több készséget tartalmazó készségkészlet.

options
OperationOptions

További választható argumentumok.

Válaszok

deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)

Töröl egy meglévő adatforrást.

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

Paraméterek

dataSourceConnection

string | SearchIndexerDataSourceConnection

options
DeleteDataSourceConnectionOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)

Egy meglévő indexelő törlése.

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

Paraméterek

indexer

string | SearchIndexer

Indexelő/A törölni kívánt indexelő neve.

options
DeleteIndexerOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)

Egy meglévő skillset töröl.

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

Paraméterek

skillset

string | SearchIndexerSkillset

A törölni kívánt skillset/Skillset neve.

options
DeleteSkillsetOptions

További választható argumentumok.

Válaszok

Promise<void>

getDataSourceConnection(string, OperationOptions)

Adatforrással kapcsolatos információk lekérése

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

Paraméterek

dataSourceConnectionName

string

options
OperationOptions

További választható argumentumok

Válaszok

getIndexer(string, OperationOptions)

Adatokat kér le egy indexelőről.

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

Paraméterek

indexerName

string

Az Indexelő neve.

options
OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndexer>

getIndexerStatus(string, OperationOptions)

Egy indexelőzmény aktuális állapotát és végrehajtási előzményeit adja vissza.

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

Paraméterek

indexerName

string

Az indexelő neve.

options
OperationOptions

További választható argumentumok.

Válaszok

getSkillset(string, OperationOptions)

Beolvassa a skillset-ről szóló információkat.

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

Paraméterek

skillsetName

string

options
OperationOptions

További választható argumentumok.

Válaszok

listDataSourceConnections(OperationOptions)

Lekéri a szolgáltatásban lévő meglévő adatforrások listáját.

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

Paraméterek

options
OperationOptions

A listaindexelők műveletének beállításai.

Válaszok

listDataSourceConnectionsNames(OperationOptions)

Lekéri a szolgáltatásban lévő meglévő adatforrások nevének listáját.

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

Paraméterek

options
OperationOptions

A listaindexelők műveletének beállításai.

Válaszok

Promise<string[]>

listIndexers(OperationOptions)

Lekéri a szolgáltatás meglévő indexelőinek listáját.

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

Paraméterek

options
OperationOptions

A listaindexelők műveletének beállításai.

Válaszok

Promise<SearchIndexer[]>

listIndexersNames(OperationOptions)

Lekéri a szolgáltatásban meglévő indexelők nevének listáját.

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

Paraméterek

options
OperationOptions

A listaindexelők műveletének beállításai.

Válaszok

Promise<string[]>

listSkillsets(OperationOptions)

Lekéri a szolgáltatásban meglévő készségek listáját.

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

Paraméterek

options
OperationOptions

A Készségkészletek listaművelet beállításai.

Válaszok

listSkillsetsNames(OperationOptions)

Lekéri a szolgáltatásban meglévő képességkészletek nevének listáját.

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

Paraméterek

options
OperationOptions

A Készségkészletek listaművelet beállításai.

Válaszok

Promise<string[]>

resetIndexer(string, OperationOptions)

Alaphelyzetbe állítja az indexelőhöz társított változáskövetési állapotot.

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

Paraméterek

indexerName

string

Az alaphelyzetbe állítani kívánt indexelő neve.

options
OperationOptions

További választható argumentumok.

Válaszok

Promise<void>

runIndexer(string, OperationOptions)

Igény szerinti indexelőt futtat.

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

Paraméterek

indexerName

string

A futtatni kívánt indexelő neve.

options
OperationOptions

További választható argumentumok.

Válaszok

Promise<void>