SearchIndexClient class

Csomag:

@azure/search-documents

Osztály, amely műveleteket hajt végre az indexek kezeléséhez (létrehozás, frissítés, lista/törlés) & szinonimaképek kezeléséhez.

Konstruktorok

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Létrehoz egy SearchIndexClient-példányt. Példahasználat: import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents"; const indexClient = new SearchIndexClient("<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

analyzeText(string, AnalyzeTextOptions)	A megadott szövegen manuálisan meghív egy elemzőt vagy jogkivonat-kezelőt.
createAlias(SearchAlias, OperationOptions)	Új keresési aliast hoz létre.
createIndex(SearchIndex, OperationOptions)	Új indexet hoz létre.
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)	Új tudásbázist teremt.
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)	Új tudásforrást hoz létre.
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)	Létrehoz egy új keresési aliast, vagy frissíti az aliast, ha már létezik.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Létrehoz egy új indexet, vagy módosít egy meglévőt.
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)	Új tudásbázist hoz létre vagy frissít, ha már létezik.
createOrUpdateKnowledgeSource(KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Létrehoz egy új szinonimaképet, vagy módosít egy meglévőt.
createSynonymMap(SynonymMap, OperationOptions)	Létrehoz egy új szinonimaképet egy keresési szolgáltatásban.
deleteAlias(SearchAlias, DeleteAliasOptions)	Törli a keresési aliast és annak indexhez társított leképezését. Ez a művelet végleges, helyreállítási lehetőség nélkül. A leképezett indexet ez a művelet érintetlenül hagyta.
deleteAlias(string, DeleteAliasOptions)	Törli a keresési aliast és annak indexhez társított leképezését. Ez a művelet végleges, helyreállítási lehetőség nélkül. A leképezett indexet ez a művelet érintetlenül hagyta.
deleteIndex(SearchIndex, DeleteIndexOptions)	Egy meglévő index törlése.
deleteIndex(string, DeleteIndexOptions)	Egy meglévő index törlése.
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)	Töröl egy meglévő tudásbázist.
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)	Töröl egy meglévő tudásbázist.
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)	Töröl egy meglévő forrást.
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)	Töröl egy meglévő forrást.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Egy meglévő szinonimakép törlése.
getAlias(string, OperationOptions)	Aliasdefiníciót kér le.
getIndex(string, OperationOptions)	Egy index adatainak lekérése.
getIndexStatistics(string, OperationOptions)	Lekéri az index statisztikáit, például a dokumentumok számát és az indextároló méretét.
getKnowledgeBase(string, GetKnowledgeBaseOptions)	Előveszi a tudásbázis definícióját.
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)	Lekéri a SearchIndexClientnek megfelelő KnowledgeRetrievalClient
getKnowledgeSource(string, GetKnowledgeSourceOptions)	Lekéri a tudásforrás definícióját.
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)	Egy tudásforrás aktuális állapotát és szinkronizálási előzményeit adja vissza.
getSearchClient<TModel>(string, SearchClientOptions)	A SearchIndexClientnek megfelelő SearchClient lekérése
getServiceStatistics(OperationOptions)	Lekéri a szolgáltatásra vonatkozó statisztikákat, például a dokumentumok számát, az indexet stb.
getSynonymMap(string, OperationOptions)	A szinonimatérkép adatainak lekérése.
listAliases(OperationOptions)	A keresési szolgáltatáshoz elérhető összes alias listája.
listIndexes(OperationOptions)	Lekéri a szolgáltatásban lévő meglévő indexek listáját.
listIndexesNames(OperationOptions)	Lekéri a szolgáltatásban lévő meglévő indexek nevének listáját.
listKnowledgeBases(ListKnowledgeBasesOptions)	Lekéri a szolgáltatásban meglévő KnowledgeBase-ek listáját.
listKnowledgeSources(ListKnowledgeSourcesOptions)	Lekéri a szolgáltatásban meglévő tudásforrások listáját.
listSynonymMaps(OperationOptions)	Lekéri a szolgáltatás meglévő szinonimatérképeinek listáját.
listSynonymMapsNames(OperationOptions)	Lekéri a szolgáltatásban meglévő szinonimaképek nevének listáját.

Konstruktor adatai

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

Létrehoz egy SearchIndexClient-példányt.

Példahasználat:

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

const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));

new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)

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

SearchIndexClientOptions

A Keresési index ü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

Pipeline

serviceVersion

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

serviceVersion: string

Tulajdonság értéke

string

Metódus adatai

analyzeText(string, AnalyzeTextOptions)

A megadott szövegen manuálisan meghív egy elemzőt vagy jogkivonat-kezelőt.

function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>

Paraméterek

indexName

string

Az elemezni kívánt mezőt tartalmazó index neve

options

AnalyzeTextOptions

További argumentumok

Válaszok

Promise<AnalyzeResult>

createAlias(SearchAlias, OperationOptions)

Új keresési aliast hoz létre.

function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>

Paraméterek

alias

SearchAlias

A létrehozandó alias definíciója.

options

OperationOptions

A beállítások paraméterei.

Válaszok

Promise<SearchAlias>

createIndex(SearchIndex, OperationOptions)

Új indexet hoz létre.

function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>

Paraméterek

index

SearchIndex

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

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)

Új tudásbázist teremt.

function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>

Paraméterek

knowledgeBase

KnowledgeBase

A tudásbázis meghatározása, amit létre kell hozni.

options

CreateKnowledgeBaseOptions

opciók paraméterei.

Válaszok

Promise<KnowledgeBase>

createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)

Új tudásforrást hoz létre.

function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>

Paraméterek

knowledgeSource

KnowledgeSource

A létrehozandó tudásforrás definíciója.

options

CreateKnowledgeSourceOptions

A beállítások paraméterei.

Válaszok

Promise<KnowledgeSource>

createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)

Létrehoz egy új keresési aliast, vagy frissíti az aliast, ha már létezik.

function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>

Paraméterek

alias

SearchAlias

A létrehozni vagy frissíteni kívánt alias definíciója.

options

CreateOrUpdateAliasOptions

A beállítások paraméterei.

Válaszok

Promise<SearchAlias>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

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

function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>

Paraméterek

index

SearchIndex

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

options

CreateOrUpdateIndexOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)

Új tudásbázist hoz létre vagy frissít, ha már létezik.

function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>

Paraméterek

knowledgeBaseName

string

A tudásbázis neve, amelyet létre kell hozni vagy frissíteni.

knowledgeBase

KnowledgeBase

a tudásbázis meghatározása, amelyet létre kell hozni vagy frissíteni.

options

CreateOrUpdateKnowledgeBaseOptions

opciók paraméterei.

Válaszok

Promise<KnowledgeBase>

createOrUpdateKnowledgeSource(KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)

function createOrUpdateKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>

Paraméterek

knowledgeSource

KnowledgeSource

options

CreateOrUpdateKnowledgeSourceOptions

Válaszok

Promise<KnowledgeSource>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

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

function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>

Paraméterek

synonymMap

SynonymMap

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

options

CreateOrUpdateSynonymMapOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Létrehoz egy új szinonimaképet egy keresési szolgáltatásban.

function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>

Paraméterek

synonymMap

SynonymMap

A keresőszolgáltatásban létrehozandó szinonimatérkép-definíció.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

deleteAlias(SearchAlias, DeleteAliasOptions)

Törli a keresési aliast és annak indexhez társított leképezését. Ez a művelet végleges, helyreállítási lehetőség nélkül. A leképezett indexet ez a művelet érintetlenül hagyta.

function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>

Paraméterek

alias

SearchAlias

A törölni kívánt alias.

options

DeleteAliasOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteAlias(string, DeleteAliasOptions)

Törli a keresési aliast és annak indexhez társított leképezését. Ez a művelet végleges, helyreállítási lehetőség nélkül. A leképezett indexet ez a művelet érintetlenül hagyta.

function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>

Paraméterek

aliasName

string

A törölni kívánt alias neve.

options

DeleteAliasOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteIndex(SearchIndex, DeleteIndexOptions)

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

function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>

Paraméterek

index

SearchIndex

A törölni kívánt index.

options

DeleteIndexOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteIndex(string, DeleteIndexOptions)

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

function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>

Paraméterek

indexName

string

A törölni kívánt index neve.

options

DeleteIndexOptions

További választható argumentumok.

Válaszok

Promise<void>

deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)

Töröl egy meglévő tudásbázist.

function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>

Paraméterek

knowledgeBase

KnowledgeBase

a tudásbázist, amit törölni kell.

options

DeleteKnowledgeBaseOptions

opciók paraméterei.

Válaszok

Promise<void>

deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)

Töröl egy meglévő tudásbázist.

function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>

Paraméterek

knowledgeBaseName

string

A törölendő tudásbázis neve.

options

DeleteKnowledgeBaseOptions

opciók paraméterei.

Válaszok

Promise<void>

deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)

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

function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>

Paraméterek

source

KnowledgeSource

a törölni kívánt tudásforrást.

options

DeleteKnowledgeSourceOptions

opciók paraméterei.

Válaszok

Promise<void>

deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)

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

function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>

Paraméterek

sourceName

string

a törölni kívánt tudásforrás neve.

options

DeleteKnowledgeSourceOptions

opciók paraméterei.

Válaszok

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Egy meglévő szinonimakép törlése.

function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>

Paraméterek

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

További választható argumentumok.

Válaszok

Promise<void>

getAlias(string, OperationOptions)

Aliasdefiníciót kér le.

function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>

Paraméterek

aliasName

string

A lekérendő alias neve.

options

OperationOptions

A beállítások paraméterei.

Válaszok

Promise<SearchAlias>

getIndex(string, OperationOptions)

Egy index adatainak lekérése.

function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>

Paraméterek

indexName

string

Az index neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

Lekéri az index statisztikáit, például a dokumentumok számát és az indextároló méretét.

function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>

Paraméterek

indexName

string

Az index neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchIndexStatistics>

getKnowledgeBase(string, GetKnowledgeBaseOptions)

Előveszi a tudásbázis definícióját.

function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>

Paraméterek

knowledgeBaseName

string

A tudásbázis neve, amit fel kell szerezni.

options

GetKnowledgeBaseOptions

opciók paraméterei.

Válaszok

Promise<KnowledgeBase>

getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)

Lekéri a SearchIndexClientnek megfelelő KnowledgeRetrievalClient

function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClient

Paraméterek

knowledgeBaseName

string

A tudásbázis neve

options

KnowledgeRetrievalClientOptions

A KnowledgeRetrievalClient beállításai

Válaszok

KnowledgeRetrievalClient

getKnowledgeSource(string, GetKnowledgeSourceOptions)

Lekéri a tudásforrás definícióját.

function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>

Paraméterek

sourceName

string

A lekérni kívánt tudásforrás neve.

options

GetKnowledgeSourceOptions

A beállítások paraméterei.

Válaszok

Promise<KnowledgeSource>

getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)

Egy tudásforrás aktuális állapotát és szinkronizálási előzményeit adja vissza.

function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>

Paraméterek

sourceName

string

Annak a tudásforrásnak a neve, amelynek állapotát le kell kérni.

options

GetKnowledgeSourceStatusOptions

A beállítások paraméterei.

Válaszok

Promise<KnowledgeSourceStatus>

getSearchClient<TModel>(string, SearchClientOptions)

A SearchIndexClientnek megfelelő SearchClient lekérése

function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>

Paraméterek

indexName

string

Az index neve

options

SearchClientOptions

SearchClient-beállítások

Válaszok

SearchClient<TModel>

getServiceStatistics(OperationOptions)

Lekéri a szolgáltatásra vonatkozó statisztikákat, például a dokumentumok számát, az indexet stb.

function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>

Paraméterek

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

A szinonimatérkép adatainak lekérése.

function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>

Paraméterek

synonymMapName

string

A Szinonimakép neve.

options

OperationOptions

További választható argumentumok.

Válaszok

Promise<SynonymMap>

listAliases(OperationOptions)

A keresési szolgáltatáshoz elérhető összes alias listája.

function listAliases(options?: OperationOptions): AliasIterator

Paraméterek

options

OperationOptions

A beállítások paraméterei.

Válaszok

AliasIterator

listIndexes(OperationOptions)

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

function listIndexes(options?: OperationOptions): IndexIterator

Paraméterek

options

OperationOptions

A listaindex-művelet beállításai.

Válaszok

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Paraméterek

options

OperationOptions

A listaindex-művelet beállításai.

Válaszok

IndexNameIterator

listKnowledgeBases(ListKnowledgeBasesOptions)

Lekéri a szolgáltatásban meglévő KnowledgeBase-ek listáját.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Paraméterek

options

ListKnowledgeBasesOptions

Opciók a lista tudásbázisok működéséhez.

Válaszok

KnowledgeBaseIterator

listKnowledgeSources(ListKnowledgeSourcesOptions)

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

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Paraméterek

options

ListKnowledgeSourcesOptions

A tudásforrások listázásának beállításai.

Válaszok

KnowledgeSourceIterator

listSynonymMaps(OperationOptions)

Lekéri a szolgáltatás meglévő szinonimatérképeinek listáját.

function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>

Paraméterek

options

OperationOptions

A Szinonimatérképek listaművelet beállításai.

Válaszok

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Paraméterek

options

OperationOptions

A Szinonimatérképek listaművelet beállításai.

Válaszok

Promise<string[]>