SearchIndexClient class
Třída pro provádění operací pro správu indexů (vytváření, aktualizace, výpis/odstranění) & synonyma.
Konstruktory
| Search |
Vytvoří instanci SearchIndexClient. Příklad použití: |
Vlastnosti
| api |
Verze rozhraní API, která se má použít při komunikaci se službou. |
| endpoint | Koncový bod vyhledávací služby |
| pipeline | Odkaz na interní kanál HTTP pro použití s nezpracovanými požadavky |
| service |
Verze rozhraní API, která se má použít při komunikaci se službou. |
Metody
| analyze |
Volání analyzátoru nebo tokenizátoru ručně pro zadaný text. |
| create |
Vytvoří nový alias hledání. |
| create |
Vytvoří nový index. |
| create |
Vytváří novou znalostní základnu. |
| create |
Vytvoří nový zdroj znalostí. |
| create |
Vytvoří nový alias vyhledávání nebo aktualizuje alias, pokud už existuje. |
| create |
Vytvoří nový index nebo upraví existující index. |
| create |
Vytváří novou znalostní bázi nebo aktualizuje znalostní bázi, pokud už existuje. |
| create |
|
| create |
Vytvoří novou mapu synonym nebo upraví existující. |
| create |
Vytvoří novou mapu synonym ve vyhledávací službě. |
| delete |
Odstraní alias vyhledávání a jeho přidružené mapování na index. Tato operace je trvalá bez možnosti obnovení. Namapovaný index není touto operací nedotčen. |
| delete |
Odstraní alias vyhledávání a jeho přidružené mapování na index. Tato operace je trvalá bez možnosti obnovení. Namapovaný index není touto operací nedotčen. |
| delete |
Odstraní existující index. |
| delete |
Odstraní existující index. |
| delete |
Odstraní existující znalostní bázi. |
| delete |
Odstraní existující znalostní bázi. |
| delete |
Odstraní existující zdroj. |
| delete |
Odstraní existující zdroj. |
| delete |
Odstraní existující mapu synonym. |
| get |
Načte definici aliasu. |
| get |
Načte informace o indexu. |
| get |
Načte statistiky o indexu, například počet dokumentů a velikost úložiště indexů. |
| get |
Získává definici znalostní báze. |
| get |
Načte KnowledgeRetrievalClient odpovídající tomuto SearchIndexClient |
| get |
Načte definici zdroje znalostí. |
| get |
Vrací aktuální stav a historii synchronizace zdroje znalostí. |
| get |
Načte SearchClient odpovídající tomuto SearchIndexClient. |
| get |
Načte statistiky o službě, například počet dokumentů, index atd. |
| get |
Načte informace o objektu SynonymMap. |
| list |
Zobrazí seznam všech aliasů dostupných pro vyhledávací službu. |
| list |
Načte seznam existujících indexů ve službě. |
| list |
Načte seznam názvů existujících indexů ve službě. |
| list |
Získá seznam existujících KnowledgeBases ve službě. |
| list |
Načte seznam existujících zdrojů znalostí ve službě. |
| list |
Načte seznam existujících synonymMap ve službě. |
| list |
Načte seznam názvů existujících objektů SynonymMap ve službě. |
Podrobnosti konstruktoru
SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)
Vytvoří instanci SearchIndexClient.
Příklad použití:
import { SearchIndexClient, AzureKeyCredential } from "@azure/search-documents";
const indexClient = new SearchIndexClient("<endpoint>", new AzureKeyCredential("<apiKey>"));
new SearchIndexClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexClientOptions)Parametry
- endpoint
-
string
Koncový bod vyhledávací služby
- credential
Používá se k ověřování požadavků na službu.
- options
- SearchIndexClientOptions
Slouží ke konfiguraci klienta indexu vyhledávání.
Podrobnosti vlastnosti
apiVersion
Upozornění
Toto rozhraní API je teď zastaralé.
use {@Link serviceVersion} instead
Verze rozhraní API, která se má použít při komunikaci se službou.
apiVersion: stringHodnota vlastnosti
string
endpoint
Koncový bod vyhledávací služby
endpoint: stringHodnota vlastnosti
string
pipeline
Odkaz na interní kanál HTTP pro použití s nezpracovanými požadavky
pipeline: PipelineHodnota vlastnosti
serviceVersion
Verze rozhraní API, která se má použít při komunikaci se službou.
serviceVersion: stringHodnota vlastnosti
string
Podrobnosti metody
analyzeText(string, AnalyzeTextOptions)
Volání analyzátoru nebo tokenizátoru ručně pro zadaný text.
function analyzeText(indexName: string, options: AnalyzeTextOptions): Promise<AnalyzeResult>Parametry
- indexName
-
string
Název indexu, který obsahuje pole k analýze
- options
- AnalyzeTextOptions
Další argumenty
Návraty
Promise<AnalyzeResult>
createAlias(SearchAlias, OperationOptions)
Vytvoří nový alias hledání.
function createAlias(alias: SearchAlias, options?: OperationOptions): Promise<SearchAlias>Parametry
- alias
- SearchAlias
Definice aliasu, který chcete vytvořit.
- options
- OperationOptions
Parametry možností.
Návraty
Promise<SearchAlias>
createIndex(SearchIndex, OperationOptions)
Vytvoří nový index.
function createIndex(index: SearchIndex, options?: OperationOptions): Promise<SearchIndex>Parametry
- index
- SearchIndex
Informace popisující index, který se má vytvořit.
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SearchIndex>
createKnowledgeBase(KnowledgeBase, CreateKnowledgeBaseOptions)
Vytváří novou znalostní základnu.
function createKnowledgeBase(knowledgeBase: KnowledgeBase, options?: CreateKnowledgeBaseOptions): Promise<KnowledgeBase>Parametry
- knowledgeBase
- KnowledgeBase
Definice znalostní báze, kterou je třeba vytvářet.
- options
- CreateKnowledgeBaseOptions
parametry možností.
Návraty
Promise<KnowledgeBase>
createKnowledgeSource(KnowledgeSource, CreateKnowledgeSourceOptions)
Vytvoří nový zdroj znalostí.
function createKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateKnowledgeSourceOptions): Promise<KnowledgeSource>Parametry
- knowledgeSource
- KnowledgeSource
Definice zdroje znalostí, který chcete vytvořit.
- options
- CreateKnowledgeSourceOptions
Parametry možností.
Návraty
Promise<KnowledgeSource>
createOrUpdateAlias(SearchAlias, CreateOrUpdateAliasOptions)
Vytvoří nový alias vyhledávání nebo aktualizuje alias, pokud už existuje.
function createOrUpdateAlias(alias: SearchAlias, options?: CreateOrUpdateAliasOptions): Promise<SearchAlias>Parametry
- alias
- SearchAlias
Definice aliasu pro vytvoření nebo aktualizaci
- options
- CreateOrUpdateAliasOptions
Parametry možností.
Návraty
Promise<SearchAlias>
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)
Vytvoří nový index nebo upraví existující index.
function createOrUpdateIndex(index: SearchIndex, options?: CreateOrUpdateIndexOptions): Promise<SearchIndex>Parametry
- index
- SearchIndex
Informace popisující index, který se má vytvořit.
- options
- CreateOrUpdateIndexOptions
Další volitelné argumenty.
Návraty
Promise<SearchIndex>
createOrUpdateKnowledgeBase(string, KnowledgeBase, CreateOrUpdateKnowledgeBaseOptions)
Vytváří novou znalostní bázi nebo aktualizuje znalostní bázi, pokud už existuje.
function createOrUpdateKnowledgeBase(knowledgeBaseName: string, knowledgeBase: KnowledgeBase, options?: CreateOrUpdateKnowledgeBaseOptions): Promise<KnowledgeBase>Parametry
- knowledgeBaseName
-
string
název znalostní báze k vytvoření nebo aktualizaci.
- knowledgeBase
- KnowledgeBase
Definice znalostní báze, kterou je třeba vytvořit nebo aktualizovat.
parametry možností.
Návraty
Promise<KnowledgeBase>
createOrUpdateKnowledgeSource(KnowledgeSource, CreateOrUpdateKnowledgeSourceOptions)
function createOrUpdateKnowledgeSource(knowledgeSource: KnowledgeSource, options?: CreateOrUpdateKnowledgeSourceOptions): Promise<KnowledgeSource>Parametry
- knowledgeSource
- KnowledgeSource
Návraty
Promise<KnowledgeSource>
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)
Vytvoří novou mapu synonym nebo upraví existující.
function createOrUpdateSynonymMap(synonymMap: SynonymMap, options?: CreateOrUpdateSynonymMapOptions): Promise<SynonymMap>Parametry
- synonymMap
- SynonymMap
Informace popisující mapu synonym, která se má vytvořit.
- options
- CreateOrUpdateSynonymMapOptions
Další volitelné argumenty.
Návraty
Promise<SynonymMap>
createSynonymMap(SynonymMap, OperationOptions)
Vytvoří novou mapu synonym ve vyhledávací službě.
function createSynonymMap(synonymMap: SynonymMap, options?: OperationOptions): Promise<SynonymMap>Parametry
- synonymMap
- SynonymMap
Definice synonymMap pro vytvoření ve vyhledávací službě.
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SynonymMap>
deleteAlias(SearchAlias, DeleteAliasOptions)
Odstraní alias vyhledávání a jeho přidružené mapování na index. Tato operace je trvalá bez možnosti obnovení. Namapovaný index není touto operací nedotčen.
function deleteAlias(alias: SearchAlias, options?: DeleteAliasOptions): Promise<void>Parametry
- alias
- SearchAlias
Alias, který chcete odstranit.
- options
- DeleteAliasOptions
Další volitelné argumenty.
Návraty
Promise<void>
deleteAlias(string, DeleteAliasOptions)
Odstraní alias vyhledávání a jeho přidružené mapování na index. Tato operace je trvalá bez možnosti obnovení. Namapovaný index není touto operací nedotčen.
function deleteAlias(aliasName: string, options?: DeleteAliasOptions): Promise<void>Parametry
- aliasName
-
string
Název aliasu, který chcete odstranit.
- options
- DeleteAliasOptions
Další volitelné argumenty.
Návraty
Promise<void>
deleteIndex(SearchIndex, DeleteIndexOptions)
Odstraní existující index.
function deleteIndex(index: SearchIndex, options?: DeleteIndexOptions): Promise<void>Parametry
- index
- SearchIndex
Index, který chcete odstranit.
- options
- DeleteIndexOptions
Další volitelné argumenty.
Návraty
Promise<void>
deleteIndex(string, DeleteIndexOptions)
Odstraní existující index.
function deleteIndex(indexName: string, options?: DeleteIndexOptions): Promise<void>Parametry
- indexName
-
string
Název indexu, který chcete odstranit.
- options
- DeleteIndexOptions
Další volitelné argumenty.
Návraty
Promise<void>
deleteKnowledgeBase(KnowledgeBase, DeleteKnowledgeBaseOptions)
Odstraní existující znalostní bázi.
function deleteKnowledgeBase(knowledgeBase: KnowledgeBase, options?: DeleteKnowledgeBaseOptions): Promise<void>Parametry
- knowledgeBase
- KnowledgeBase
Znalostní bázi, kterou je třeba smazat.
- options
- DeleteKnowledgeBaseOptions
parametry možností.
Návraty
Promise<void>
deleteKnowledgeBase(string, DeleteKnowledgeBaseOptions)
Odstraní existující znalostní bázi.
function deleteKnowledgeBase(knowledgeBaseName: string, options?: DeleteKnowledgeBaseOptions): Promise<void>Parametry
- knowledgeBaseName
-
string
název znalostní báze k smazání.
- options
- DeleteKnowledgeBaseOptions
parametry možností.
Návraty
Promise<void>
deleteKnowledgeSource(KnowledgeSource, DeleteKnowledgeSourceOptions)
Odstraní existující zdroj.
function deleteKnowledgeSource(source: KnowledgeSource, options?: DeleteKnowledgeSourceOptions): Promise<void>Parametry
- source
- KnowledgeSource
zdroj znalostí, který chcete odstranit.
- options
- DeleteKnowledgeSourceOptions
parametry možností.
Návraty
Promise<void>
deleteKnowledgeSource(string, DeleteKnowledgeSourceOptions)
Odstraní existující zdroj.
function deleteKnowledgeSource(sourceName: string, options?: DeleteKnowledgeSourceOptions): Promise<void>Parametry
- sourceName
-
string
Název zdroje znalostí, který chcete odstranit.
- options
- DeleteKnowledgeSourceOptions
parametry možností.
Návraty
Promise<void>
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)
Odstraní existující mapu synonym.
function deleteSynonymMap(synonymMap: string | SynonymMap, options?: DeleteSynonymMapOptions): Promise<void>Parametry
- synonymMap
-
string | SynonymMap
- options
- DeleteSynonymMapOptions
Další volitelné argumenty.
Návraty
Promise<void>
getAlias(string, OperationOptions)
Načte definici aliasu.
function getAlias(aliasName: string, options?: OperationOptions): Promise<SearchAlias>Parametry
- aliasName
-
string
Název aliasu, který se má načíst.
- options
- OperationOptions
Parametry možností.
Návraty
Promise<SearchAlias>
getIndex(string, OperationOptions)
Načte informace o indexu.
function getIndex(indexName: string, options?: OperationOptions): Promise<SearchIndex>Parametry
- indexName
-
string
Název indexu.
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SearchIndex>
getIndexStatistics(string, OperationOptions)
Načte statistiky o indexu, například počet dokumentů a velikost úložiště indexů.
function getIndexStatistics(indexName: string, options?: OperationOptions): Promise<SearchIndexStatistics>Parametry
- indexName
-
string
Název indexu.
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SearchIndexStatistics>
getKnowledgeBase(string, GetKnowledgeBaseOptions)
Získává definici znalostní báze.
function getKnowledgeBase(knowledgeBaseName: string, options?: GetKnowledgeBaseOptions): Promise<KnowledgeBase>Parametry
- knowledgeBaseName
-
string
název znalostní báze k získání.
- options
- GetKnowledgeBaseOptions
parametry možností.
Návraty
Promise<KnowledgeBase>
getKnowledgeRetrievalClient(string, KnowledgeRetrievalClientOptions)
Načte KnowledgeRetrievalClient odpovídající tomuto SearchIndexClient
function getKnowledgeRetrievalClient(knowledgeBaseName: string, options?: KnowledgeRetrievalClientOptions): KnowledgeRetrievalClientParametry
- knowledgeBaseName
-
string
Název znalostní báze
- options
- KnowledgeRetrievalClientOptions
KnowledgeRetrievalClient Možnosti
Návraty
getKnowledgeSource(string, GetKnowledgeSourceOptions)
Načte definici zdroje znalostí.
function getKnowledgeSource(sourceName: string, options?: GetKnowledgeSourceOptions): Promise<KnowledgeSource>Parametry
- sourceName
-
string
Název zdroje znalostí, který chcete načíst.
- options
- GetKnowledgeSourceOptions
Parametry možností.
Návraty
Promise<KnowledgeSource>
getKnowledgeSourceStatus(string, GetKnowledgeSourceStatusOptions)
Vrací aktuální stav a historii synchronizace zdroje znalostí.
function getKnowledgeSourceStatus(sourceName: string, options?: GetKnowledgeSourceStatusOptions): Promise<KnowledgeSourceStatus>Parametry
- sourceName
-
string
Název zdroje znalostí, pro který chcete načíst stav.
- options
- GetKnowledgeSourceStatusOptions
Parametry možností.
Návraty
Promise<KnowledgeSourceStatus>
getSearchClient<TModel>(string, SearchClientOptions)
Načte SearchClient odpovídající tomuto SearchIndexClient.
function getSearchClient<TModel>(indexName: string, options?: SearchClientOptions): SearchClient<TModel>Parametry
- indexName
-
string
Název indexu
- options
- SearchClientOptions
Možnosti SearchClient
Návraty
SearchClient<TModel>
getServiceStatistics(OperationOptions)
Načte statistiky o službě, například počet dokumentů, index atd.
function getServiceStatistics(options?: OperationOptions): Promise<SearchServiceStatistics>Parametry
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SearchServiceStatistics>
getSynonymMap(string, OperationOptions)
Načte informace o objektu SynonymMap.
function getSynonymMap(synonymMapName: string, options?: OperationOptions): Promise<SynonymMap>Parametry
- synonymMapName
-
string
Název SynonymMap.
- options
- OperationOptions
Další volitelné argumenty.
Návraty
Promise<SynonymMap>
listAliases(OperationOptions)
Zobrazí seznam všech aliasů dostupných pro vyhledávací službu.
function listAliases(options?: OperationOptions): AliasIteratorParametry
- options
- OperationOptions
Parametry možností.
Návraty
listIndexes(OperationOptions)
Načte seznam existujících indexů ve službě.
function listIndexes(options?: OperationOptions): IndexIteratorParametry
- options
- OperationOptions
Možnosti operace indexu seznamu
Návraty
listIndexesNames(OperationOptions)
Načte seznam názvů existujících indexů ve službě.
function listIndexesNames(options?: OperationOptions): IndexNameIteratorParametry
- options
- OperationOptions
Možnosti operace indexu seznamu
Návraty
listKnowledgeBases(ListKnowledgeBasesOptions)
Získá seznam existujících KnowledgeBases ve službě.
function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIteratorParametry
- options
- ListKnowledgeBasesOptions
Možnosti pro operaci znalostních báz seznamu.
Návraty
listKnowledgeSources(ListKnowledgeSourcesOptions)
Načte seznam existujících zdrojů znalostí ve službě.
function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIteratorParametry
- options
- ListKnowledgeSourcesOptions
Možnosti operace se seznamem zdrojů znalostí.
Návraty
listSynonymMaps(OperationOptions)
Načte seznam existujících synonymMap ve službě.
function listSynonymMaps(options?: OperationOptions): Promise<SynonymMap[]>Parametry
- options
- OperationOptions
Možnosti operace SynonymMaps seznamu
Návraty
Promise<SynonymMap[]>
listSynonymMapsNames(OperationOptions)
Načte seznam názvů existujících objektů SynonymMap ve službě.
function listSynonymMapsNames(options?: OperationOptions): Promise<string[]>Parametry
- options
- OperationOptions
Možnosti operace SynonymMaps seznamu
Návraty
Promise<string[]>