SearchIndexClient class

SearchIndexClient örneği oluşturur.

Örnek kullanım:

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

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

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

Parametreler

Hizmetle iletişim kurarken kullanılacak API sürümü.

apiVersion: string

Özellik Değeri

Arama hizmetinin uç noktası

endpoint: string

Özellik Değeri

Ham isteklerle kullanım için iç HTTP işlem hattına başvuru

pipeline: Pipeline

Özellik Değeri

Hizmetle iletişim kurarken kullanılacak API sürümü.

serviceVersion: string

Özellik Değeri

Sağlanan metinde el ile çözümleyici veya belirteç oluşturucu çağırır.

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

Parametreler

Döndürülenler

Yeni bir arama diğer adı oluşturur.

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

Parametreler

Döndürülenler

Yeni bir dizin oluşturur.

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

Parametreler

Döndürülenler

Yeni bir bilgi tabanı yaratır.

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

Parametreler

Döndürülenler

Yeni bir bilgi kaynağı oluşturur.

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

Parametreler

Döndürülenler

Yeni bir arama diğer adı oluşturur veya zaten varsa diğer adı güncelleştirir.

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

Parametreler

Döndürülenler

Yeni bir dizin oluşturur veya var olan bir dizini değiştirir.

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

Parametreler

Döndürülenler

Yeni bir bilgi tabanı oluşturur veya zaten varsa bir bilgi tabanını günceller.

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

Parametreler

Döndürülenler

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

Parametreler

Döndürülenler

Yeni bir SynonymMap oluşturur veya var olan bir eşlemini değiştirir.

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

Parametreler

Döndürülenler

Arama hizmetinde yeni bir SynonymMap oluşturur.

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

Parametreler

Döndürülenler

Arama diğer adını ve dizinle ilişkili eşlemesini siler. Bu işlem kalıcıdır ve kurtarma seçeneği yoktur. Eşlenen dizine bu işlem tarafından dokunulmaz.

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

Parametreler

Döndürülenler

Arama diğer adını ve dizinle ilişkili eşlemesini siler. Bu işlem kalıcıdır ve kurtarma seçeneği yoktur. Eşlenen dizine bu işlem tarafından dokunulmaz.

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

Parametreler

Döndürülenler

Varolan bir dizini siler.

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

Parametreler

Döndürülenler

Varolan bir dizini siler.

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

Parametreler

Döndürülenler

Mevcut bir bilgi bankasını siler.

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

Parametreler

Döndürülenler

Mevcut bir bilgi bankasını siler.

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

Parametreler

Döndürülenler

Varolan bir kaynağı siler.

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

Parametreler

Döndürülenler

Varolan bir kaynağı siler.

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

Parametreler

Döndürülenler

Var olan bir SynonymMap'i siler.

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

Parametreler

Döndürülenler

Diğer ad tanımını alır.

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

Parametreler

Döndürülenler

Dizin hakkındaki bilgileri alır.

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

Parametreler

Döndürülenler

Belge sayısı ve dizin depolama boyutu gibi bir dizinle ilgili istatistikleri alır.

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

Parametreler

Döndürülenler

Hizmetteki mevcut dizinlerin listesini alır.

function getIndexStatsSummary(options?: GetIndexStatsSummaryOptions): IndexStatisticsSummaryIterator

Parametreler

Döndürülenler

Bir bilgi tabanı tanımını alır.

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

Parametreler

Döndürülenler

Bu SearchIndexClient'a karşılık gelen KnowledgeRetrievalClient'ı alır

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

Parametreler

Döndürülenler

Bir bilgi kaynağı tanımı alır.

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

Parametreler

Döndürülenler

Bir bilgi kaynağının mevcut durumunu ve senkronizasyon geçmişini döndürür.

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

Parametreler

Döndürülenler

Bu SearchIndexClient'a karşılık gelen SearchClient'ı alır

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

Parametreler

Döndürülenler

Belge sayısı, dizin vb. gibi hizmetle ilgili istatistikleri alır.

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

Parametreler

Döndürülenler

SynonymMap hakkındaki bilgileri alır.

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

Parametreler

Döndürülenler

Arama hizmeti için kullanılabilen tüm diğer adları listeler.

function listAliases(options?: OperationOptions): AliasIterator

Parametreler

Döndürülenler

Hizmetteki mevcut dizinlerin listesini alır.

function listIndexes(options?: OperationOptions): IndexIterator

Parametreler

Döndürülenler

Hizmetteki mevcut dizinlerin adlarının listesini alır.

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametreler

Döndürülenler

Hizmetteki mevcut KnowledgeBase'lerin listesini alır.

function listKnowledgeBases(options?: ListKnowledgeBasesOptions): KnowledgeBaseIterator

Parametreler

Döndürülenler

Hizmetteki mevcut KnowledgeSources'ın listesini alır.

function listKnowledgeSources(options?: ListKnowledgeSourcesOptions): KnowledgeSourceIterator

Parametreler

Döndürülenler

Hizmetteki mevcut SynonymMap'lerin listesini alır.

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

Parametreler

Döndürülenler

Hizmetteki mevcut SynonymMap'lerin adlarının listesini alır.

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

Parametreler

Döndürülenler