SimpleField interface

Paket:

@azure/search-documents

Stellt ein Feld in einer Indexdefinition dar, die den Namen, den Datentyp und das Suchverhalten eines Felds beschreibt.

Eigenschaften

analyzerName	Der Name des Sprachanalysetools, der für das Feld verwendet werden soll. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden und weder zusammen mit searchAnalyzer noch mit indexAnalyzer festgelegt werden. Eine einmal für ein Feld gewählte Analysemethode kann nicht mehr geändert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.
facetable	Ein Wert, der angibt, ob in Facetabfragen auf das Feld verwiesen werden soll. Wird in der Regel in einer Präsentation von Suchergebnissen verwendet, die die Trefferanzahl nach Kategorie enthält (z. B. suchen Sie nach Digitalkameras und sehen Sie Treffer nach Marke, nach Megapixeln, nach Preis usw.). Felder vom Typ Edm.GeographyPoint oder Collection(Edm.GeographyPoint) können nicht facetable sein. Der Standardwert ist false für alle anderen einfachen Felder.
filterable	Ein Wert, der angibt, ob in $filter Abfragen auf das Feld verwiesen werden soll. Filterbar unterscheidet sich von durchsuchbar in der Behandlung von Zeichenfolgen. Felder vom Typ Edm.String oder Collection(Edm.String), die gefiltert werden können, unterliegen keine Wortbrüche, sodass Vergleiche nur für genaue Übereinstimmungen gelten. Wenn Sie beispielsweise ein solches Feld f auf "sonniger Tag" festlegen, findet $filter=f eq 'sunny' keine Übereinstimmungen, aber $filter=f eq 'sonniger Tag' wird dies. Der Standardwert ist "false".
hidden	Ein Wert, der angibt, ob das Feld in einem Suchergebnis zurückgegeben werden kann. Sie können diese Option aktivieren, wenn Sie ein Feld (z. B. Rand) als Filter-, Sortier- oder Bewertungsmechanismus verwenden möchten, aber nicht möchten, dass das Feld für den Endbenutzer sichtbar ist. Diese Eigenschaft muss für Schlüsselfelder false sein. Diese Eigenschaft kann für vorhandene Felder geändert werden. Das Deaktivieren dieser Eigenschaft führt nicht zu einer Erhöhung der Indexspeicheranforderungen. Der Standardwert ist "false".
indexAnalyzerName	Der Name des Analysetools, der zur Indizierungszeit für das Feld verwendet wird. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Er muss zusammen mit searchAnalyzer festgelegt werden und kann nicht zusammen mit der Analyseoption festgelegt werden. Eine einmal für ein Feld gewählte Analysemethode kann nicht mehr geändert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.
key	Ein Wert, der angibt, ob das Feld Dokumente im Index eindeutig identifiziert. Es muss genau ein Feld der obersten Ebene in jedem Index als Schlüsselfeld ausgewählt werden, und es muss vom Typ Edm.String sein. Schlüsselfelder können verwendet werden, um Dokumente direkt nachzuschlagen und bestimmte Dokumente zu aktualisieren oder zu löschen. Der Standardwert ist "false".
name	Der Name des Felds, das innerhalb der Fields-Auflistung des Index- oder übergeordneten Felds eindeutig sein muss.
searchable	Ein Wert, der angibt, ob das Feld volltextsuchbar ist. Es wird während der Indizierung somit Analysen wie etwa der Worttrennung unterzogen. Wenn Sie ein durchsuchbares Feld auf einen Wert wie „sunny day“ festlegen, wird es intern in die einzelnen Token „sunny“ und „day“ unterteilt. Dies ermöglicht die Volltextsuche nach diesen Begriffen. Diese Eigenschaft muss für einfache Felder anderer Nicht-Zeichenfolgen-Datentypen false sein. Hinweis: Durchsuchbare Felder verbrauchen zusätzlichen Speicherplatz in Ihrem Index, da Azure Cognitive Search eine zusätzliche tokenisierte Version des Feldwerts für Volltextsuchen speichert. Standardmäßig false für einfache Felder.
searchAnalyzerName	Der Name des Analysetools, der zur Suchzeit für das Feld verwendet wird. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Er muss zusammen mit indexAnalyzer festgelegt werden und kann nicht zusammen mit der Analyseoption festgelegt werden. Dieses Analyseprogramm kann für ein vorhandenes Feld aktualisiert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.
sortable	Ein Wert, der angibt, ob in $orderby Ausdrücken auf das Feld verwiesen werden soll. Standardmäßig sortiert Azure Cognitive Search Ergebnisse nach Bewertung, aber in vielen Umgebungen möchten Benutzer nach Feldern in den Dokumenten sortieren. Ein einfaches Feld kann nur sortiert werden, wenn es sich um einen einzelwertigen Wert handelt (es verfügt über einen einzelnen Wert im Bereich des übergeordneten Dokuments). Einfache Sammlungsfelder können nicht sortiert werden, da sie mehrwertig sind. Einfache Unterfelder komplexer Sammlungen sind ebenfalls mehrwertig und können daher nicht sortiert werden. Dies gilt unabhängig davon, ob es sich um ein unmittelbares übergeordnetes Feld oder ein Vorgängerfeld handelt, das die komplexe Auflistung ist. Der Standardwert für sortierbar ist false.
synonymMapNames	Eine Liste der Namen von Synonymzuordnungen, die diesem Feld zugeordnet werden sollen. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Derzeit wird nur eine Synonymzuordnung pro Feld unterstützt. Durch Zuweisen einer Synonymzuordnung zu einem Feld wird sichergestellt, dass Abfragebegriffe, die auf dieses Feld abzielen, zur Abfragezeit mithilfe der Regeln in der Synonymzuordnung erweitert werden. Dieses Attribut kann für vorhandene Felder geändert werden.
type	Der Datentyp des Felds. Mögliche Werte: "Edm.String", "Edm.Int32", "Edm.Int64", "Edm.Double", "Edm.Boolean", "Edm.DateTimeOffset", "Edm.GeographyPoint", "Collection(Edm.String)", "Collection(Edm.Int32)", "Collection(Edm.Int64)", "Collection(Edm.Double)", "Collection(Edm.Boolean)", "Collection(Edm.DateTimeOffset)", "Collection(Edm.GeographyPoint)", "Collection(Edm.Single)"
vectorSearchDimensions	Die Dimensionalität des Vektorfelds.
vectorSearchProfileName	Der Name der Vektorsuchalgorithmuskonfiguration, die den Algorithmus und optionale Parameter für die Suche nach dem Vektorfeld angibt.

Details zur Eigenschaft

analyzerName

Der Name des Sprachanalysetools, der für das Feld verwendet werden soll. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden und weder zusammen mit searchAnalyzer noch mit indexAnalyzer festgelegt werden. Eine einmal für ein Feld gewählte Analysemethode kann nicht mehr geändert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.

analyzerName?: string

Eigenschaftswert

string

facetable

Ein Wert, der angibt, ob in Facetabfragen auf das Feld verwiesen werden soll. Wird in der Regel in einer Präsentation von Suchergebnissen verwendet, die die Trefferanzahl nach Kategorie enthält (z. B. suchen Sie nach Digitalkameras und sehen Sie Treffer nach Marke, nach Megapixeln, nach Preis usw.). Felder vom Typ Edm.GeographyPoint oder Collection(Edm.GeographyPoint) können nicht facetable sein. Der Standardwert ist false für alle anderen einfachen Felder.

facetable?: boolean

Eigenschaftswert

boolean

filterable

Ein Wert, der angibt, ob in $filter Abfragen auf das Feld verwiesen werden soll. Filterbar unterscheidet sich von durchsuchbar in der Behandlung von Zeichenfolgen. Felder vom Typ Edm.String oder Collection(Edm.String), die gefiltert werden können, unterliegen keine Wortbrüche, sodass Vergleiche nur für genaue Übereinstimmungen gelten. Wenn Sie beispielsweise ein solches Feld f auf "sonniger Tag" festlegen, findet $filter=f eq 'sunny' keine Übereinstimmungen, aber $filter=f eq 'sonniger Tag' wird dies. Der Standardwert ist "false".

filterable?: boolean

Eigenschaftswert

boolean

hidden

Ein Wert, der angibt, ob das Feld in einem Suchergebnis zurückgegeben werden kann. Sie können diese Option aktivieren, wenn Sie ein Feld (z. B. Rand) als Filter-, Sortier- oder Bewertungsmechanismus verwenden möchten, aber nicht möchten, dass das Feld für den Endbenutzer sichtbar ist. Diese Eigenschaft muss für Schlüsselfelder false sein. Diese Eigenschaft kann für vorhandene Felder geändert werden. Das Deaktivieren dieser Eigenschaft führt nicht zu einer Erhöhung der Indexspeicheranforderungen. Der Standardwert ist "false".

hidden?: boolean

Eigenschaftswert

boolean

indexAnalyzerName

Der Name des Analysetools, der zur Indizierungszeit für das Feld verwendet wird. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Er muss zusammen mit searchAnalyzer festgelegt werden und kann nicht zusammen mit der Analyseoption festgelegt werden. Eine einmal für ein Feld gewählte Analysemethode kann nicht mehr geändert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.

indexAnalyzerName?: string

Eigenschaftswert

string

key

Ein Wert, der angibt, ob das Feld Dokumente im Index eindeutig identifiziert. Es muss genau ein Feld der obersten Ebene in jedem Index als Schlüsselfeld ausgewählt werden, und es muss vom Typ Edm.String sein. Schlüsselfelder können verwendet werden, um Dokumente direkt nachzuschlagen und bestimmte Dokumente zu aktualisieren oder zu löschen. Der Standardwert ist "false".

key?: boolean

Eigenschaftswert

boolean

name

Der Name des Felds, das innerhalb der Fields-Auflistung des Index- oder übergeordneten Felds eindeutig sein muss.

name: string

Eigenschaftswert

string

searchable

Ein Wert, der angibt, ob das Feld volltextsuchbar ist. Es wird während der Indizierung somit Analysen wie etwa der Worttrennung unterzogen. Wenn Sie ein durchsuchbares Feld auf einen Wert wie „sunny day“ festlegen, wird es intern in die einzelnen Token „sunny“ und „day“ unterteilt. Dies ermöglicht die Volltextsuche nach diesen Begriffen. Diese Eigenschaft muss für einfache Felder anderer Nicht-Zeichenfolgen-Datentypen false sein. Hinweis: Durchsuchbare Felder verbrauchen zusätzlichen Speicherplatz in Ihrem Index, da Azure Cognitive Search eine zusätzliche tokenisierte Version des Feldwerts für Volltextsuchen speichert. Standardmäßig false für einfache Felder.

searchable?: boolean

Eigenschaftswert

boolean

searchAnalyzerName

Der Name des Analysetools, der zur Suchzeit für das Feld verwendet wird. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Er muss zusammen mit indexAnalyzer festgelegt werden und kann nicht zusammen mit der Analyseoption festgelegt werden. Dieses Analyseprogramm kann für ein vorhandenes Feld aktualisiert werden. KnownAnalyzerNames ist eine Enumeration, die integrierte Analysenamen enthält.

searchAnalyzerName?: string

Eigenschaftswert

string

sortable

Ein Wert, der angibt, ob in $orderby Ausdrücken auf das Feld verwiesen werden soll. Standardmäßig sortiert Azure Cognitive Search Ergebnisse nach Bewertung, aber in vielen Umgebungen möchten Benutzer nach Feldern in den Dokumenten sortieren. Ein einfaches Feld kann nur sortiert werden, wenn es sich um einen einzelwertigen Wert handelt (es verfügt über einen einzelnen Wert im Bereich des übergeordneten Dokuments). Einfache Sammlungsfelder können nicht sortiert werden, da sie mehrwertig sind. Einfache Unterfelder komplexer Sammlungen sind ebenfalls mehrwertig und können daher nicht sortiert werden. Dies gilt unabhängig davon, ob es sich um ein unmittelbares übergeordnetes Feld oder ein Vorgängerfeld handelt, das die komplexe Auflistung ist. Der Standardwert für sortierbar ist false.

sortable?: boolean

Eigenschaftswert

boolean

synonymMapNames

Eine Liste der Namen von Synonymzuordnungen, die diesem Feld zugeordnet werden sollen. Diese Option kann nur mit durchsuchbaren Feldern verwendet werden. Derzeit wird nur eine Synonymzuordnung pro Feld unterstützt. Durch Zuweisen einer Synonymzuordnung zu einem Feld wird sichergestellt, dass Abfragebegriffe, die auf dieses Feld abzielen, zur Abfragezeit mithilfe der Regeln in der Synonymzuordnung erweitert werden. Dieses Attribut kann für vorhandene Felder geändert werden.

synonymMapNames?: string[]

Eigenschaftswert

string[]

type

Der Datentyp des Felds. Mögliche Werte: "Edm.String", "Edm.Int32", "Edm.Int64", "Edm.Double", "Edm.Boolean", "Edm.DateTimeOffset", "Edm.GeographyPoint", "Collection(Edm.String)", "Collection(Edm.Int32)", "Collection(Edm.Int64)", "Collection(Edm.Double)", "Collection(Edm.Boolean)", "Collection(Edm.DateTimeOffset)", "Collection(Edm.GeographyPoint)", "Collection(Edm.Single)"

type: SearchFieldDataType

Eigenschaftswert

SearchFieldDataType

vectorSearchDimensions

Die Dimensionalität des Vektorfelds.

vectorSearchDimensions?: number

Eigenschaftswert

number

vectorSearchProfileName

Der Name der Vektorsuchalgorithmuskonfiguration, die den Algorithmus und optionale Parameter für die Suche nach dem Vektorfeld angibt.

vectorSearchProfileName?: string

Eigenschaftswert

string