SearchIndexerClient class
Dizin oluşturucuları, veri kaynaklarını & beceri kümelerini yönetmeye (oluşturma, güncelleştirme, listeleme/silme) yönelik işlemler gerçekleştirme sınıfı.
Oluşturucular
Search |
SearchIndexerClient örneğini oluşturur. Örnek kullanım:
|
Özellikler
api |
Hizmetle iletişim kurarken kullanılacak API sürümü. |
endpoint | Arama hizmetinin uç noktası |
service |
Hizmetle iletişim kurarken kullanılacak API sürümü. |
Yöntemler
create |
Arama hizmetinde yeni bir dataSource oluşturur. |
create |
Arama hizmetinde yeni bir dizin oluşturucu oluşturur. |
create |
Yeni bir veri kaynağı oluşturur veya var olan bir veri kaynağını değiştirir. |
create |
Yeni bir dizin oluşturucu oluşturur veya mevcut dizin oluşturucuyu değiştirir. |
create |
Yeni bir Beceri Kümesi oluşturur veya var olan bir beceri kümesini değiştirir. |
create |
Arama hizmetinde yeni bir beceri kümesi oluşturur. |
delete |
Mevcut bir veri kaynağını siler. |
delete |
Mevcut dizin oluşturucuları siler. |
delete |
Mevcut Beceri Kümesini siler. |
get |
DataSource hakkındaki bilgileri alır |
get |
Dizin Oluşturucu hakkındaki bilgileri alır. |
get |
Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini döndürür. |
get |
Beceri Kümesi hakkındaki bilgileri alır. |
list |
Hizmetteki mevcut veri kaynaklarının listesini alır. |
list |
Hizmetteki mevcut veri kaynaklarının adlarının listesini alır. |
list |
Hizmetteki mevcut dizin oluşturucuların listesini alır. |
list |
Hizmetteki mevcut dizin oluşturucuların adlarının listesini alır. |
list |
Hizmetteki mevcut Beceri Kümelerinin listesini alır. |
list |
Hizmetteki mevcut Beceri Kümelerinin adlarının listesini alır. |
reset |
Dizin oluşturucuyla ilişkili değişiklik izleme durumunu sıfırlar. |
run |
İsteğe bağlı olarak bir dizin oluşturucu çalıştırır. |
Oluşturucu Ayrıntıları
SearchIndexerClient(string, KeyCredential | TokenCredential, SearchIndexerClientOptions)
SearchIndexerClient örneğini oluşturur.
Örnek kullanım:
const { SearchIndexerClient, AzureKeyCredential } = require("@azure/search-documents");
const client = new SearchIndexerClient(
"<endpoint>",
new AzureKeyCredential("<Admin Key>");
);
new SearchIndexerClient(endpoint: string, credential: KeyCredential | TokenCredential, options?: SearchIndexerClientOptions)
Parametreler
- endpoint
-
string
Arama hizmetinin uç noktası
- credential
Hizmete yönelik isteklerin kimliğini doğrulamak için kullanılır.
- options
- SearchIndexerClientOptions
Search 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ı
createDataSourceConnection(SearchIndexerDataSourceConnection, OperationOptions)
Arama hizmetinde yeni bir dataSource oluşturur.
function createDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Parametreler
- dataSourceConnection
- SearchIndexerDataSourceConnection
Arama hizmetinde oluşturulacak dataSource tanımı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerDataSourceConnection>
createIndexer(SearchIndexer, OperationOptions)
Arama hizmetinde yeni bir dizin oluşturucu oluşturur.
function createIndexer(indexer: SearchIndexer, options?: OperationOptions): Promise<SearchIndexer>
Parametreler
- indexer
- SearchIndexer
Arama hizmetinde oluşturulacak dizin oluşturucu tanımı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexer>
createOrUpdateDataSourceConnection(SearchIndexerDataSourceConnection, CreateorUpdateDataSourceConnectionOptions)
Yeni bir veri kaynağı oluşturur veya var olan bir veri kaynağını değiştirir.
function createOrUpdateDataSourceConnection(dataSourceConnection: SearchIndexerDataSourceConnection, options?: CreateorUpdateDataSourceConnectionOptions): Promise<SearchIndexerDataSourceConnection>
Parametreler
- dataSourceConnection
- SearchIndexerDataSourceConnection
Oluşturulacak/güncelleştirilecek veri kaynağını açıklayan bilgiler.
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerDataSourceConnection>
createOrUpdateIndexer(SearchIndexer, CreateorUpdateIndexerOptions)
Yeni bir dizin oluşturucu oluşturur veya mevcut dizin oluşturucuyu değiştirir.
function createOrUpdateIndexer(indexer: SearchIndexer, options?: CreateorUpdateIndexerOptions): Promise<SearchIndexer>
Parametreler
- indexer
- SearchIndexer
Oluşturulacak/güncelleştirilecek dizin oluşturucuyu açıklayan bilgiler.
- options
- CreateorUpdateIndexerOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexer>
createOrUpdateSkillset(SearchIndexerSkillset, CreateOrUpdateSkillsetOptions)
Yeni bir Beceri Kümesi oluşturur veya var olan bir beceri kümesini değiştirir.
function createOrUpdateSkillset(skillset: SearchIndexerSkillset, options?: CreateOrUpdateSkillsetOptions): Promise<SearchIndexerSkillset>
Parametreler
- skillset
- SearchIndexerSkillset
Oluşturulacak dizini açıklayan bilgiler.
- options
- CreateOrUpdateSkillsetOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerSkillset>
createSkillset(SearchIndexerSkillset, OperationOptions)
Arama hizmetinde yeni bir beceri kümesi oluşturur.
function createSkillset(skillset: SearchIndexerSkillset, options?: OperationOptions): Promise<SearchIndexerSkillset>
Parametreler
- skillset
- SearchIndexerSkillset
Arama hizmetinde oluşturulacak bir veya daha fazla beceri içeren beceri kümesi.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerSkillset>
deleteDataSourceConnection(string | SearchIndexerDataSourceConnection, DeleteDataSourceConnectionOptions)
Mevcut bir veri kaynağını siler.
function deleteDataSourceConnection(dataSourceConnection: string | SearchIndexerDataSourceConnection, options?: DeleteDataSourceConnectionOptions): Promise<void>
Parametreler
- dataSourceConnection
-
string | SearchIndexerDataSourceConnection
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<void>
deleteIndexer(string | SearchIndexer, DeleteIndexerOptions)
Mevcut dizin oluşturucuları siler.
function deleteIndexer(indexer: string | SearchIndexer, options?: DeleteIndexerOptions): Promise<void>
Parametreler
- indexer
-
string | SearchIndexer
Dizin Oluşturucu/Silinecek dizin oluşturucunun adı.
- options
- DeleteIndexerOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<void>
deleteSkillset(string | SearchIndexerSkillset, DeleteSkillsetOptions)
Mevcut Beceri Kümesini siler.
function deleteSkillset(skillset: string | SearchIndexerSkillset, options?: DeleteSkillsetOptions): Promise<void>
Parametreler
- skillset
-
string | SearchIndexerSkillset
Beceri Kümesi/Silinecek Beceri Kümesinin Adı.
- options
- DeleteSkillsetOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<void>
getDataSourceConnection(string, OperationOptions)
DataSource hakkındaki bilgileri alır
function getDataSourceConnection(dataSourceConnectionName: string, options?: OperationOptions): Promise<SearchIndexerDataSourceConnection>
Parametreler
- dataSourceConnectionName
-
string
- options
- OperationOptions
İsteğe bağlı ek bağımsız değişkenler
Döndürülenler
Promise<SearchIndexerDataSourceConnection>
getIndexer(string, OperationOptions)
Dizin Oluşturucu hakkındaki bilgileri alır.
function getIndexer(indexerName: string, options?: OperationOptions): Promise<SearchIndexer>
Parametreler
- indexerName
-
string
Dizin Oluşturucu'nun adı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexer>
getIndexerStatus(string, OperationOptions)
Dizin oluşturucunun geçerli durumunu ve yürütme geçmişini döndürür.
function getIndexerStatus(indexerName: string, options?: OperationOptions): Promise<SearchIndexerStatus>
Parametreler
- indexerName
-
string
Dizin oluşturucunun adı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerStatus>
getSkillset(string, OperationOptions)
Beceri Kümesi hakkındaki bilgileri alır.
function getSkillset(skillsetName: string, options?: OperationOptions): Promise<SearchIndexerSkillset>
Parametreler
- skillsetName
-
string
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<SearchIndexerSkillset>
listDataSourceConnections(OperationOptions)
Hizmetteki mevcut veri kaynaklarının listesini alır.
function listDataSourceConnections(options?: OperationOptions): Promise<SearchIndexerDataSourceConnection[]>
Parametreler
- options
- OperationOptions
Liste dizin oluşturucuları işleminin seçenekleri.
Döndürülenler
Promise<SearchIndexerDataSourceConnection[]>
listDataSourceConnectionsNames(OperationOptions)
Hizmetteki mevcut veri kaynaklarının adlarının listesini alır.
function listDataSourceConnectionsNames(options?: OperationOptions): Promise<string[]>
Parametreler
- options
- OperationOptions
Liste dizin oluşturucuları işleminin seçenekleri.
Döndürülenler
Promise<string[]>
listIndexers(OperationOptions)
Hizmetteki mevcut dizin oluşturucuların listesini alır.
function listIndexers(options?: OperationOptions): Promise<SearchIndexer[]>
Parametreler
- options
- OperationOptions
Liste dizin oluşturucuları işleminin seçenekleri.
Döndürülenler
Promise<SearchIndexer[]>
listIndexersNames(OperationOptions)
Hizmetteki mevcut dizin oluşturucuların adlarının listesini alır.
function listIndexersNames(options?: OperationOptions): Promise<string[]>
Parametreler
- options
- OperationOptions
Liste dizin oluşturucuları işleminin seçenekleri.
Döndürülenler
Promise<string[]>
listSkillsets(OperationOptions)
Hizmetteki mevcut Beceri Kümelerinin listesini alır.
function listSkillsets(options?: OperationOptions): Promise<SearchIndexerSkillset[]>
Parametreler
- options
- OperationOptions
Beceri kümeleri işlemini listeleme seçenekleri.
Döndürülenler
Promise<SearchIndexerSkillset[]>
listSkillsetsNames(OperationOptions)
Hizmetteki mevcut Beceri Kümelerinin adlarının listesini alır.
function listSkillsetsNames(options?: OperationOptions): Promise<string[]>
Parametreler
- options
- OperationOptions
Beceri kümeleri işlemini listeleme seçenekleri.
Döndürülenler
Promise<string[]>
resetIndexer(string, OperationOptions)
Dizin oluşturucuyla ilişkili değişiklik izleme durumunu sıfırlar.
function resetIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Parametreler
- indexerName
-
string
Sıfırlanması gereken dizin oluşturucunun adı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<void>
runIndexer(string, OperationOptions)
İsteğe bağlı olarak bir dizin oluşturucu çalıştırır.
function runIndexer(indexerName: string, options?: OperationOptions): Promise<void>
Parametreler
- indexerName
-
string
Çalıştırılacak dizin oluşturucunun adı.
- options
- OperationOptions
Ek isteğe bağlı bağımsız değişkenler.
Döndürülenler
Promise<void>