SimpleField interface

Csomag:

@azure/search-documents

Egy indexdefinícióban lévő mezőt jelöl, amely egy mező nevét, adattípusát és keresési viselkedését írja le.

Tulajdonságok

analyzerName	A mezőhöz használni kívánt elemző neve. Ez a beállítás csak kereshető mezőkkel használható, és nem állítható be együtt sem a searchAnalyzer, sem az indexAnalyzer beállítással. Az elemző kiválasztása után a mező nem módosítható.
facetable	Érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását az aspektusos lekérdezésekben. A találatok kategóriánkénti számát (például digitális kamerák keresését és a találatok márka, megapixel, ár stb. alapján történő megtekintését) tartalmazó találatok bemutatójában általában használják. Az Edm.GeographyPoint vagy a Collection (Edm.GeographyPoint) típusú mezők nem lehetnek facetablek. Az alapértelmezett érték az összes többi egyszerű mező esetében hamis.
filterable	Egy érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását $filter lekérdezésekben. filterable eltér a searchable húrok kezelésének módjától. A szűrhető Edm.String vagy Collection (Edm.String) típusú mezők nem esnek szófelhővé, ezért az összehasonlítások csak pontos egyezéseket tartalmaznak. Ha például egy ilyen f mezőt "napos napra" állít be, $filter=f eq "sunny" nem talál egyezést, de $filter=f eq "napos nap" lesz. Az alapértelmezett érték hamis.
hasSensitivityLabel	Egy érték azt jelzi, hogy a mezőt bizalmassági címkék szűrésére kell-e használni. Ez lehetővé teszi a dokumentumszintű szűrést a Microsoft Purview bizalmassági címkéi alapján.
hidden	Egy érték, amely azt jelzi, hogy a mező visszaadható-e a keresési eredményben. Ezt a beállítást letilthatja, ha egy mezőt (például margót) szeretne szűrőként, rendezési vagy pontozási mechanizmusként használni, de nem szeretné, hogy a mező látható legyen a végfelhasználó számára. Ennek a tulajdonságnak a kulcsmezők esetében hamisnak kell lennie. Ez a tulajdonság a meglévő mezőkön módosítható. A tulajdonság engedélyezése nem jár az indextárolási követelmények növekedésével. Az alapértelmezett érték a vektormezők esetében igaz, máskülönben hamis.
indexAnalyzerName	A mező indexelési idején használt elemző neve. Ez a beállítás csak kereshető mezőkkel használható. A searchAnalyzerrel együtt kell beállítani, és nem állítható be az analyzerName opcióval együtt. Az elemző kiválasztása után a mező nem módosítható. A KnownAnalyzerNames egy ismert értékeket tartalmazó szám.
key	Érték, amely jelzi, hogy a mező egyedileg azonosítja-e az indexben lévő dokumentumokat. Minden indexben pontosan egy legfelső szintű mezőt kell kiválasztani kulcsmezőként, és Edm.String típusúnak kell lennie. A kulcsmezők a dokumentumok közvetlen keresésére és adott dokumentumok frissítésére vagy törlésére használhatók. Az alapértelmezett érték hamis.
name	A mező neve, amelynek egyedinek kell lennie az index vagy szülőmező mezőgyűjteményében.
normalizerName	A mező indexelési idején használt normalizáló neve.
searchable	Egy érték, amely azt jelzi, hogy a mező kereshető-e teljes szöveges formátumban. Ez azt jelenti, hogy az indexelés során elemzést végez, például szótörést. Ha egy kereshető mezőt olyan értékre állít be, mint a "napos nap", a rendszer belsőleg a "napos" és a "nap" egyedi jogkivonatokra lesz felosztva. Ez lehetővé teszi a kifejezések teljes szöveges keresését. Az Edm.String vagy Collection (Edm.String) típusú mezők alapértelmezés szerint kereshetők. Ennek a tulajdonságnak hamisnak kell lennie más, nem sztring típusú adattípusok egyszerű mezőinél. Megjegyzés: A kereshető mezők extra helyet foglalnak el az indexben a mezőérték további jogkivonatos verzióinak elhelyezéséhez a teljes szöveges keresésekhez. Ha helyet szeretne menteni az indexben, és nincs szüksége olyan mezőre, amely szerepel a keresésekben, állítsa a kereshető értéket hamisra. Az alapértelmezett érték hamis.
searchAnalyzerName	A mező keresési idején használt elemző neve. Ez a beállítás csak kereshető mezőkkel használható. A indexAnalyzerName együtt kell beállítani, és nem állítható össze a analyzerName beállítással. Ez a tulajdonság nem állítható be egy nyelvelemző nevére; használja inkább a analyzerName tulajdonságot, ha nyelvelemzőre van szüksége. Ez az elemző frissíthető egy meglévő mezőben.
sortable	Egy érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását $orderby kifejezésekben. A szolgáltatás alapértelmezés szerint pontszám szerint rendezi az eredményeket, de sok esetben a felhasználók a dokumentumok mezői szerint szeretnének rendezni. Egy egyszerű mező csak akkor rendezhető, ha egyértékű (egyetlen értékkel rendelkezik a szülődokumentum hatókörében). Az egyszerű gyűjteménymezők nem rendezhetők, mivel többértékűek. Az összetett gyűjtemények egyszerű almezői szintén többértékűek, ezért nem rendezhetők. Ez igaz, akár közvetlen szülőmezőről, akár ősmezőről van szó, ez az összetett gyűjtemény. Az alapértelmezett érték hamis.
stored	Nem módosítható érték, amely azt jelzi, hogy a mező külön marad-e a lemezen, és a keresési eredményben lesz visszaadva. Letilthatja ezt a beállítást, ha nem tervezi visszaadni a mező tartalmát egy keresési válaszban, hogy a tárterület terhelésére mentsen. Ez csak az index létrehozásakor és csak vektormezők esetén állítható be. Ez a tulajdonság nem módosítható meglévő mezők esetében, és nem állítható be hamisként az új mezőkhöz. Ha ez a tulajdonság értéke false, akkor a tulajdonságot hidden .true Ennek a tulajdonságnak igaznak vagy nem halmaznak kell lennie a kulcsmezők, az új mezők és a nem vektoros mezők esetében, és az összetett mezők esetében null értékűnek kell lennie. A tulajdonság letiltása csökkenti az index tárolási követelményeit. Az alapértelmezett érték a vektormezők esetében igaz.
synonymMapNames	A mezőhöz társítandó szinonimatérképek nevének listája. Ez a beállítás csak kereshető mezőkkel használható. Jelenleg mezőnként csak egy szinonimatérkép támogatott. Szinonimák leképezésének mezőhöz való hozzárendelése biztosítja, hogy a mezőre vonatkozó lekérdezési kifejezések lekérdezési időben ki legyenek bontva a szinonimatérkép szabályaival. Ez az attribútum a meglévő mezőkön módosítható.
type	A mező adattípusa.
vectorEncodingFormat	A mező tartalmának értelmezéséhez használt kódolási formátum.
vectorSearchDimensions	A vektormező dimenziója.
vectorSearchProfileName	A vektorkeresési profil neve, amely meghatározza a vektormezőben való kereséshez használni kívánt algoritmust és vektorizálót.

Tulajdonság adatai

analyzerName

A mezőhöz használni kívánt elemző neve. Ez a beállítás csak kereshető mezőkkel használható, és nem állítható be együtt sem a searchAnalyzer, sem az indexAnalyzer beállítással. Az elemző kiválasztása után a mező nem módosítható.

analyzerName?: string

Tulajdonság értéke

string

facetable

Érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását az aspektusos lekérdezésekben. A találatok kategóriánkénti számát (például digitális kamerák keresését és a találatok márka, megapixel, ár stb. alapján történő megtekintését) tartalmazó találatok bemutatójában általában használják. Az Edm.GeographyPoint vagy a Collection (Edm.GeographyPoint) típusú mezők nem lehetnek facetablek. Az alapértelmezett érték az összes többi egyszerű mező esetében hamis.

facetable?: boolean

Tulajdonság értéke

boolean

filterable

Egy érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását $filter lekérdezésekben. filterable eltér a searchable húrok kezelésének módjától. A szűrhető Edm.String vagy Collection (Edm.String) típusú mezők nem esnek szófelhővé, ezért az összehasonlítások csak pontos egyezéseket tartalmaznak. Ha például egy ilyen f mezőt "napos napra" állít be, $filter=f eq "sunny" nem talál egyezést, de $filter=f eq "napos nap" lesz. Az alapértelmezett érték hamis.

filterable?: boolean

Tulajdonság értéke

boolean

hasSensitivityLabel

Egy érték azt jelzi, hogy a mezőt bizalmassági címkék szűrésére kell-e használni. Ez lehetővé teszi a dokumentumszintű szűrést a Microsoft Purview bizalmassági címkéi alapján.

hasSensitivityLabel?: boolean

Tulajdonság értéke

boolean

hidden

Egy érték, amely azt jelzi, hogy a mező visszaadható-e a keresési eredményben. Ezt a beállítást letilthatja, ha egy mezőt (például margót) szeretne szűrőként, rendezési vagy pontozási mechanizmusként használni, de nem szeretné, hogy a mező látható legyen a végfelhasználó számára. Ennek a tulajdonságnak a kulcsmezők esetében hamisnak kell lennie. Ez a tulajdonság a meglévő mezőkön módosítható. A tulajdonság engedélyezése nem jár az indextárolási követelmények növekedésével. Az alapértelmezett érték a vektormezők esetében igaz, máskülönben hamis.

hidden?: boolean

Tulajdonság értéke

boolean

indexAnalyzerName

A mező indexelési idején használt elemző neve. Ez a beállítás csak kereshető mezőkkel használható. A searchAnalyzerrel együtt kell beállítani, és nem állítható be az analyzerName opcióval együtt. Az elemző kiválasztása után a mező nem módosítható. A KnownAnalyzerNames egy ismert értékeket tartalmazó szám.

indexAnalyzerName?: string

Tulajdonság értéke

string

key

Érték, amely jelzi, hogy a mező egyedileg azonosítja-e az indexben lévő dokumentumokat. Minden indexben pontosan egy legfelső szintű mezőt kell kiválasztani kulcsmezőként, és Edm.String típusúnak kell lennie. A kulcsmezők a dokumentumok közvetlen keresésére és adott dokumentumok frissítésére vagy törlésére használhatók. Az alapértelmezett érték hamis.

key?: boolean

Tulajdonság értéke

boolean

name

A mező neve, amelynek egyedinek kell lennie az index vagy szülőmező mezőgyűjteményében.

name: string

Tulajdonság értéke

string

normalizerName

A mező indexelési idején használt normalizáló neve.

normalizerName?: string

Tulajdonság értéke

string

searchable

Egy érték, amely azt jelzi, hogy a mező kereshető-e teljes szöveges formátumban. Ez azt jelenti, hogy az indexelés során elemzést végez, például szótörést. Ha egy kereshető mezőt olyan értékre állít be, mint a "napos nap", a rendszer belsőleg a "napos" és a "nap" egyedi jogkivonatokra lesz felosztva. Ez lehetővé teszi a kifejezések teljes szöveges keresését. Az Edm.String vagy Collection (Edm.String) típusú mezők alapértelmezés szerint kereshetők. Ennek a tulajdonságnak hamisnak kell lennie más, nem sztring típusú adattípusok egyszerű mezőinél. Megjegyzés: A kereshető mezők extra helyet foglalnak el az indexben a mezőérték további jogkivonatos verzióinak elhelyezéséhez a teljes szöveges keresésekhez. Ha helyet szeretne menteni az indexben, és nincs szüksége olyan mezőre, amely szerepel a keresésekben, állítsa a kereshető értéket hamisra. Az alapértelmezett érték hamis.

searchable?: boolean

Tulajdonság értéke

boolean

searchAnalyzerName

A mező keresési idején használt elemző neve. Ez a beállítás csak kereshető mezőkkel használható. A indexAnalyzerName együtt kell beállítani, és nem állítható össze a analyzerName beállítással. Ez a tulajdonság nem állítható be egy nyelvelemző nevére; használja inkább a analyzerName tulajdonságot, ha nyelvelemzőre van szüksége. Ez az elemző frissíthető egy meglévő mezőben.

searchAnalyzerName?: string

Tulajdonság értéke

string

sortable

Egy érték, amely azt jelzi, hogy engedélyezi-e a mező hivatkozását $orderby kifejezésekben. A szolgáltatás alapértelmezés szerint pontszám szerint rendezi az eredményeket, de sok esetben a felhasználók a dokumentumok mezői szerint szeretnének rendezni. Egy egyszerű mező csak akkor rendezhető, ha egyértékű (egyetlen értékkel rendelkezik a szülődokumentum hatókörében). Az egyszerű gyűjteménymezők nem rendezhetők, mivel többértékűek. Az összetett gyűjtemények egyszerű almezői szintén többértékűek, ezért nem rendezhetők. Ez igaz, akár közvetlen szülőmezőről, akár ősmezőről van szó, ez az összetett gyűjtemény. Az alapértelmezett érték hamis.

sortable?: boolean

Tulajdonság értéke

boolean

stored

Nem módosítható érték, amely azt jelzi, hogy a mező külön marad-e a lemezen, és a keresési eredményben lesz visszaadva. Letilthatja ezt a beállítást, ha nem tervezi visszaadni a mező tartalmát egy keresési válaszban, hogy a tárterület terhelésére mentsen. Ez csak az index létrehozásakor és csak vektormezők esetén állítható be. Ez a tulajdonság nem módosítható meglévő mezők esetében, és nem állítható be hamisként az új mezőkhöz. Ha ez a tulajdonság értéke false, akkor a tulajdonságot hidden .true Ennek a tulajdonságnak igaznak vagy nem halmaznak kell lennie a kulcsmezők, az új mezők és a nem vektoros mezők esetében, és az összetett mezők esetében null értékűnek kell lennie. A tulajdonság letiltása csökkenti az index tárolási követelményeit. Az alapértelmezett érték a vektormezők esetében igaz.

stored?: boolean

Tulajdonság értéke

boolean

synonymMapNames

A mezőhöz társítandó szinonimatérképek nevének listája. Ez a beállítás csak kereshető mezőkkel használható. Jelenleg mezőnként csak egy szinonimatérkép támogatott. Szinonimák leképezésének mezőhöz való hozzárendelése biztosítja, hogy a mezőre vonatkozó lekérdezési kifejezések lekérdezési időben ki legyenek bontva a szinonimatérkép szabályaival. Ez az attribútum a meglévő mezőkön módosítható.

synonymMapNames?: string[]

Tulajdonság értéke

string[]

type

A mező adattípusa.

type: SearchFieldDataType

Tulajdonság értéke

SearchFieldDataType

vectorEncodingFormat

A mező tartalmának értelmezéséhez használt kódolási formátum.

vectorEncodingFormat?: string

Tulajdonság értéke

string

vectorSearchDimensions

A vektormező dimenziója.

vectorSearchDimensions?: number

Tulajdonság értéke

number

vectorSearchProfileName

A vektorkeresési profil neve, amely meghatározza a vektormezőben való kereséshez használni kívánt algoritmust és vektorizálót.

vectorSearchProfileName?: string

Tulajdonság értéke

string