SearchClient class

  • Referens
Paket:
@azure/search-documents

Klass som används för att utföra åtgärder mot ett sökindex, inklusive frågekörning mot dokument i indexet samt tillägg, uppdatering och borttagning av dem.

Konstruktorer

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Skapar en instans av SearchClient.

Exempel på användning:

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

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

Alternativt kan modellens typ användas för att aktivera stark typinmatning och typtips:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

Egenskaper

apiVersion

DEN API-version som ska användas vid kommunikation med tjänsten.
endpoint

Slutpunkten för söktjänsten
indexName

Namnet på indexet
serviceVersion

Den tjänstversion som ska användas vid kommunikation med tjänsten.

Metoder

autocomplete(string, string, AutocompleteOptions<TModel>)

Baserat på en partiell searchText från användaren returnerar du en lista över potentiella slutförandesträngar baserat på en angiven förslagsställare.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);
deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Ta bort en uppsättning dokument.
deleteDocuments(TModel[], IndexDocumentsOptions)

Ta bort en uppsättning dokument.
getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Hämta ett visst dokument från indexet efter nyckel.
getDocumentsCount(OperationOptions)

Hämtar antalet dokument i indexet.
indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Utför en uppsättning indexändringar (ladda upp, sammanfoga, mergeOrUpload, ta bort) för den angivna uppsättningen dokument. Den här åtgärden kan delvis lyckas och inte alla dokumentåtgärder återspeglas i indexet. Om du vill behandla detta som ett undantag anger du throwOnAnyFailure alternativet till sant. Mer information om hur sammanslagning fungerar finns i: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeDocuments(TModel[], IndexDocumentsOptions)

Uppdatera en uppsättning dokument i indexet. Mer information om hur sammanslagning fungerar finns i https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Uppdatera en uppsättning dokument i indexet eller ladda upp dem om de inte finns. Mer information om hur sammanslagning fungerar finns i https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents
search<TFields>(string, SearchOptions<TModel, TFields>)

Utför en sökning på det aktuella indexet baserat på de angivna argumenten.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});
suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Returnerar en kort lista med förslag baserat på searchText och angiven förslagsspelare.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});
uploadDocuments(TModel[], IndexDocumentsOptions)

Ladda upp en matris med dokument till indexet.

Konstruktorinformation

SearchClient<TModel>(string, string, KeyCredential | TokenCredential, SearchClientOptions)

Skapar en instans av SearchClient.

Exempel på användning:

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

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

Alternativt kan modellens typ användas för att aktivera stark typinmatning och typtips:

type TModel = {
  keyName: string;
  field1?: string | null;
  field2?: { anotherField?: string | null } | null;
};

const client = new SearchClient<TModel>(
  ...
);

new SearchClient(endpoint: string, indexName: string, credential: KeyCredential | TokenCredential, options?: SearchClientOptions)

Parametrar

endpoint

string

Slutpunkten för söktjänsten

indexName

string

Namnet på indexet

credential

KeyCredential | TokenCredential

Används för att autentisera begäranden till tjänsten.

options
SearchClientOptions

Används för att konfigurera sökklienten.

Egenskapsinformation

apiVersion

Varning

Det här API:et är nu inaktuellt.

use {@Link serviceVersion} instead

DEN API-version som ska användas vid kommunikation med tjänsten.

apiVersion: string

Egenskapsvärde

string

endpoint

Slutpunkten för söktjänsten

endpoint: string

Egenskapsvärde

string

indexName

Namnet på indexet

indexName: string

Egenskapsvärde

string

serviceVersion

Den tjänstversion som ska användas vid kommunikation med tjänsten.

serviceVersion: string

Egenskapsvärde

string

Metodinformation

autocomplete(string, string, AutocompleteOptions<TModel>)

Baserat på en partiell searchText från användaren returnerar du en lista över potentiella slutförandesträngar baserat på en angiven förslagsställare.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const autocompleteResult = await client.autocomplete(
  "searchText",
  "suggesterName",
  { searchFields }
);

function autocomplete(searchText: string, suggesterName: string, options?: AutocompleteOptions<TModel>): Promise<AutocompleteResult>

Parametrar

searchText

string

Söktexten som du vill basera resultat för automatisk komplettering på.

suggesterName

string

Namnet på förslagstagaren enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.

options

AutocompleteOptions<TModel>

Alternativ för automatisk komplettering.

Returer

Promise<AutocompleteResult>

deleteDocuments(keyof TModel, string[], IndexDocumentsOptions)

Ta bort en uppsättning dokument.

function deleteDocuments(keyName: keyof TModel, keyValues: string[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

keyName

keyof TModel

Namnet på primärnyckeln i indexet.

keyValues

string[]

De primära nyckelvärdena för dokument som ska tas bort.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>

deleteDocuments(TModel[], IndexDocumentsOptions)

Ta bort en uppsättning dokument.

function deleteDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

documents

TModel[]

Dokument som ska tas bort.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>

getDocument<TFields>(string, GetDocumentOptions<TModel, TFields>)

Hämta ett visst dokument från indexet efter nyckel.

function getDocument<TFields>(key: string, options?: GetDocumentOptions<TModel, TFields>): Promise<NarrowedModel<TModel, TFields>>

Parametrar

key

string

Det primära nyckelvärdet för dokumentet

options

GetDocumentOptions<TModel, TFields>

Ytterligare alternativ

Returer

Promise<NarrowedModel<TModel, TFields>>

getDocumentsCount(OperationOptions)

Hämtar antalet dokument i indexet.

function getDocumentsCount(options?: OperationOptions): Promise<number>

Parametrar

options
OperationOptions

Alternativ för antalsåtgärden.

Returer

Promise<number>

indexDocuments(IndexDocumentsBatch<TModel>, IndexDocumentsOptions)

Utför en uppsättning indexändringar (ladda upp, sammanfoga, mergeOrUpload, ta bort) för den angivna uppsättningen dokument. Den här åtgärden kan delvis lyckas och inte alla dokumentåtgärder återspeglas i indexet. Om du vill behandla detta som ett undantag anger du throwOnAnyFailure alternativet till sant. Mer information om hur sammanslagning fungerar finns i: https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function indexDocuments(batch: IndexDocumentsBatch<TModel>, options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

batch

IndexDocumentsBatch<TModel>

En matris med åtgärder som ska utföras på indexet.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>

mergeDocuments(TModel[], IndexDocumentsOptions)

Uppdatera en uppsättning dokument i indexet. Mer information om hur sammanslagning fungerar finns i https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

documents

TModel[]

De uppdaterade dokumenten.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>

mergeOrUploadDocuments(TModel[], IndexDocumentsOptions)

Uppdatera en uppsättning dokument i indexet eller ladda upp dem om de inte finns. Mer information om hur sammanslagning fungerar finns i https://docs.microsoft.com/en-us/rest/api/searchservice/AddUpdate-or-Delete-Documents

function mergeOrUploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

documents

TModel[]

De uppdaterade dokumenten.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>

Utför en sökning på det aktuella indexet baserat på de angivna argumenten.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const searchResult = await client.search("searchText", {
  select,
  searchFields,
});

function search<TFields>(searchText?: string, options?: SearchOptions<TModel, TFields>): Promise<SearchDocumentsResult<TModel, TFields>>

Parametrar

searchText

string

Text som ska sökas

options

SearchOptions<TModel, TFields>

Alternativ för sökåtgärden.

Returer

Promise<SearchDocumentsResult<TModel, TFields>>

suggest<TFields>(string, string, SuggestOptions<TModel, TFields>)

Returnerar en kort lista med förslag baserat på searchText och angiven förslagsspelare.

Exempel

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

type TModel = {
  key: string;
  azure?: { sdk: string | null } | null;
};

const client = new SearchClient<TModel>(
  "endpoint.azure",
  "indexName",
  new AzureKeyCredential("key")
);

const select = ["azure/sdk"] as const;
const searchFields: SearchFieldArray<TModel> = ["azure/sdk"];

const suggestResult = await client.suggest("searchText", "suggesterName", {
  select,
  searchFields,
});

function suggest<TFields>(searchText: string, suggesterName: string, options?: SuggestOptions<TModel, TFields>): Promise<SuggestDocumentsResult<TModel, TFields>>

Parametrar

searchText

string

Söktexten som ska användas för att föreslå dokument. Måste vara minst 1 tecken och högst 100 tecken.

suggesterName

string

Namnet på förslagstagaren enligt beskrivningen i den förslagssamling som ingår i indexdefinitionen.

options

SuggestOptions<TModel, TFields>

Alternativ för förslagsåtgärden

Returer

Promise<SuggestDocumentsResult<TModel, TFields>>

uploadDocuments(TModel[], IndexDocumentsOptions)

Ladda upp en matris med dokument till indexet.

function uploadDocuments(documents: TModel[], options?: IndexDocumentsOptions): Promise<IndexDocumentsResult>

Parametrar

documents

TModel[]

Dokumenten som ska laddas upp.

options
IndexDocumentsOptions

Ytterligare alternativ.

Returer

Promise<IndexDocumentsResult>