SearchIndexClient class

Paket:

@azure/search-documents

Dizinleri yönetme (oluşturma, güncelleştirme, listeleme/silme) & eş anlamlılar için işlemler gerçekleştirme sınıfı.

Oluşturucular

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

SearchIndexClient örneği oluşturur. Örnek kullanım: const { SearchIndexClient, AzureKeyCredential } = require("@azure/search-documents"); const client = new SearchIndexClient( "<endpoint>", new AzureKeyCredential("<Admin Key>"); );

Özellikler

apiVersion	Hizmetle iletişim kurarken kullanılacak API sürümü.
endpoint	Arama hizmetinin uç noktası
serviceVersion	Hizmetle iletişim kurarken kullanılacak API sürümü.

Yöntemler

analyzeText(string, AnalyzeTextOptions)	Sağlanan metinde el ile çözümleyici veya belirteç oluşturucu çağırır.
createIndex(SearchIndex, OperationOptions)	Yeni bir dizin oluşturur.
createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)	Yeni bir dizin oluşturur veya var olan bir dizini değiştirir.
createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)	Yeni bir SynonymMap oluşturur veya var olan bir eşlem haritasını değiştirir.
createSynonymMap(SynonymMap, OperationOptions)	Arama hizmetinde yeni bir SynonymMap oluşturur.
deleteIndex(string | SearchIndex, DeleteIndexOptions)	Varolan bir dizini siler.
deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)	Var olan bir Eş Anlamlı Haritayı siler.
getIndex(string, OperationOptions)	Dizin hakkındaki bilgileri alır.
getIndexStatistics(string, OperationOptions)	Belge sayısı ve dizin depolama alanı boyutu gibi dizinle ilgili istatistikleri alır.
getSearchClient<TModel>(string, SearchClientOptions)	Bu SearchIndexClient'a karşılık gelen SearchClient'ı alır
getServiceStatistics(OperationOptions)	Belge sayısı, dizin vb. gibi hizmetle ilgili istatistikleri alır.
getSynonymMap(string, OperationOptions)	SynonymMap hakkındaki bilgileri alır.
listIndexes(OperationOptions)	Hizmetteki mevcut dizinlerin listesini alır.
listIndexesNames(OperationOptions)	Hizmetteki mevcut dizinlerin adlarının listesini alır.
listSynonymMaps(OperationOptions)	Hizmetteki mevcut SynonymMap'lerin listesini alır.
listSynonymMapsNames(OperationOptions)	Hizmetteki mevcut SynonymMap'lerin adlarının listesini alır.

Oluşturucu Ayrıntıları

SearchIndexClient(string, KeyCredential | TokenCredential, SearchIndexClientOptions)

SearchIndexClient örneği oluşturur.

Örnek kullanım:

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

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

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

Parametreler

endpoint

string

Arama hizmetinin uç noktası

credential

KeyCredential | TokenCredential

Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılır.

options

SearchIndexClientOptions

Arama Dizini istemcisini yapılandırmak için kullanılır.

Özellik Ayrıntıları

apiVersion

Uyarı

Bu API artık kullanım dışıdır.

use {@Link serviceVersion} instead

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

apiVersion: string

Özellik Değeri

string

endpoint

Arama hizmetinin uç noktası

endpoint: string

Özellik Değeri

string

serviceVersion

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

serviceVersion: string

Özellik Değeri

string

Yöntem Ayrıntıları

analyzeText(string, AnalyzeTextOptions)

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

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

Parametreler

indexName

string

Analiz etmek istediğiniz alanı içeren dizinin adı

options

AnalyzeTextOptions

Ek bağımsız değişkenler

Döndürülenler

Promise<AnalyzeResult>

createIndex(SearchIndex, OperationOptions)

Yeni bir dizin oluşturur.

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

Parametreler

index

SearchIndex

Oluşturulacak dizini açıklayan bilgiler.

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SearchIndex>

createOrUpdateIndex(SearchIndex, CreateOrUpdateIndexOptions)

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

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

Parametreler

index

SearchIndex

Oluşturulacak dizini açıklayan bilgiler.

options

CreateOrUpdateIndexOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SearchIndex>

createOrUpdateSynonymMap(SynonymMap, CreateOrUpdateSynonymMapOptions)

Yeni bir SynonymMap oluşturur veya var olan bir eşlem haritasını değiştirir.

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

Parametreler

synonymMap

SynonymMap

Oluşturulacak SynonymMap'i açıklayan bilgiler.

options

CreateOrUpdateSynonymMapOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SynonymMap>

createSynonymMap(SynonymMap, OperationOptions)

Arama hizmetinde yeni bir SynonymMap oluşturur.

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

Parametreler

synonymMap

SynonymMap

Arama hizmetinde oluşturulacak eş anlamlı Harita tanımı.

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SynonymMap>

deleteIndex(string | SearchIndex, DeleteIndexOptions)

Varolan bir dizini siler.

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

Parametreler

index

string | SearchIndex

options

DeleteIndexOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<void>

deleteSynonymMap(string | SynonymMap, DeleteSynonymMapOptions)

Var olan bir Eş Anlamlı Haritayı siler.

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

Parametreler

synonymMap

string | SynonymMap

options

DeleteSynonymMapOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<void>

getIndex(string, OperationOptions)

Dizin hakkındaki bilgileri alır.

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

Parametreler

indexName

string

Dizinin adı.

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SearchIndex>

getIndexStatistics(string, OperationOptions)

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

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

Parametreler

indexName

string

Dizinin adı.

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SearchIndexStatistics>

getSearchClient<TModel>(string, SearchClientOptions)

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

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

Parametreler

indexName

string

Dizinin adı

options

SearchClientOptions

SearchClient Seçenekleri

Döndürülenler

SearchClient<TModel>

getServiceStatistics(OperationOptions)

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

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

Parametreler

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SearchServiceStatistics>

getSynonymMap(string, OperationOptions)

SynonymMap hakkındaki bilgileri alır.

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

Parametreler

synonymMapName

string

SynonymMap'in adı.

options

OperationOptions

Ek isteğe bağlı bağımsız değişkenler.

Döndürülenler

Promise<SynonymMap>

listIndexes(OperationOptions)

Hizmetteki mevcut dizinlerin listesini alır.

function listIndexes(options?: OperationOptions): IndexIterator

Parametreler

options

OperationOptions

Liste dizini işleminin seçenekleri.

Döndürülenler

IndexIterator

listIndexesNames(OperationOptions)

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

function listIndexesNames(options?: OperationOptions): IndexNameIterator

Parametreler

options

OperationOptions

Liste dizini işleminin seçenekleri.

Döndürülenler

IndexNameIterator

listSynonymMaps(OperationOptions)

Hizmetteki mevcut SynonymMap'lerin listesini alır.

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

Parametreler

options

OperationOptions

SynonymMaps işlemini listeleme seçenekleri.

Döndürülenler

Promise<SynonymMap[]>

listSynonymMapsNames(OperationOptions)

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

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

Parametreler

options

OperationOptions

SynonymMaps işlemini listeleme seçenekleri.

Döndürülenler

Promise<string[]>