SearchField Klas

Vertegenwoordigt een veld in een indexdefinitie, waarin de naam, het gegevenstype en het zoekgedrag van een veld worden beschreven.

Alle vereiste parameters moeten worden ingevuld om naar Azure te kunnen worden verzonden.

Overname

azure.search.documents.indexes._generated._serialization.Model

SearchField

Constructor

SearchField(**kwargs)

Variabelen

Name	Description
name	str De naam van het veld, die uniek moet zijn binnen de verzameling velden van de index of het bovenliggende veld. Vereist.
type	str of <xref:search_service_client.models.SearchFieldDataType> Het gegevenstype van het veld. Vereist. Bekende waarden zijn: "Edm.String", "Edm.Int32", "Edm.Int64", "Edm.Double", "Edm.Boolean", "Edm.DateTimeOffset", "Edm.GeographyPoint", "Edm.ComplexType" en "Edm.Single".
key	bool Een waarde die aangeeft of het veld documenten in de index uniek identificeert. Er moet precies één veld op het hoogste niveau in elke index als sleutelveld worden gekozen en het veld moet van het type Edm.String zijn. Sleutelvelden kunnen worden gebruikt om documenten rechtstreeks op te zoeken en specifieke documenten bij te werken of te verwijderen. De standaardwaarde is false voor eenvoudige velden en null voor complexe velden.
searchable	bool Een waarde die aangeeft of het veld doorzoekbaar is in volledige tekst. Dit betekent dat deze tijdens het indexeren wordt geanalyseerd, zoals woordbreking. Als u een doorzoekbaar veld instelt op een waarde als 'zonnige dag', wordt de waarde intern gesplitst in de afzonderlijke tokens 'zonnige' en 'dag'. Hiermee kunt u zoeken in volledige tekst naar deze termen. Velden van het type Edm.String of Collection(Edm.String) kunnen standaard worden doorzocht. Deze eigenschap moet onwaar zijn voor eenvoudige velden van andere niet-tekenreeksgegevenstypen en moet null zijn voor complexe velden. Opmerking: doorzoekbare velden verbruiken extra ruimte in uw index omdat Azure Cognitive Search een extra tokenized versie van de veldwaarde opslaat voor zoekopdrachten in volledige tekst. Als u ruimte wilt besparen in uw index en u geen veld wilt opnemen in zoekopdrachten, stelt u doorzoekbaar in op onwaar.
filterable	bool Een waarde die aangeeft of in $filter query's naar het veld moet worden verwezen. filterbaar verschilt van doorzoekbaar in de manier waarop tekenreeksen worden verwerkt. Velden van het type Edm.String of Collection(Edm.String) die kunnen worden gefilterd, ondergaan geen woordbreking, dus vergelijkingen zijn alleen voor exacte overeenkomsten. Als u bijvoorbeeld een dergelijk veld f instelt op 'zonnige dag', vindt $filter=f eq 'sunny' geen overeenkomsten, maar $filter=f eq 'zonnige dag' wel. Deze eigenschap moet null zijn voor complexe velden. De standaardwaarde is waar voor eenvoudige velden en null voor complexe velden.
sortable	bool Een waarde die aangeeft of in $orderby-expressies moet worden verwezen naar het veld. Standaard sorteert Azure Cognitive Search resultaten op score, maar in veel gevallen willen gebruikers sorteren op velden in de documenten. Een eenvoudig veld kan alleen worden gesorteerd als het één waarde heeft (het heeft één waarde in het bereik van het bovenliggende document). Eenvoudige verzamelingsvelden kunnen niet worden gesorteerd, omdat ze meerdere waarden hebben. Eenvoudige subvelden van complexe verzamelingen hebben ook meerdere waarden en kunnen daarom niet worden gesorteerd. Dit geldt voor de complexe verzameling, ongeacht of het een direct bovenliggend veld of een bovenliggend veld is. Complexe velden kunnen niet worden gesorteerd en de sorteerbare eigenschap moet null zijn voor dergelijke velden. De standaardwaarde voor sorteren is waar voor eenvoudige velden met één waarde, onwaar voor velden met meerdere waarden en null voor complexe velden.
facetable	bool Een waarde die aangeeft of er in facetquery's naar het veld moet worden verwezen. Wordt meestal gebruikt in een presentatie van zoekresultaten met het aantal treffers per categorie (bijvoorbeeld zoeken naar digitale camera's en hits bekijken op merk, megapixels, prijs, enzovoort). Deze eigenschap moet null zijn voor complexe velden. Velden van het type Edm.GeographyPoint of Collection(Edm.GeographyPoint) kunnen niet facetable zijn. De standaardwaarde is waar voor alle andere eenvoudige velden.
analyzer_name	str of <xref:search_service_client.models.LexicalAnalyzerName> De naam van de analyse die voor het veld moet worden gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden en kan niet samen met searchAnalyzer of indexAnalyzer worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. Moet null zijn voor complexe velden. Bekende waarden zijn: "ar.microsoft", "ar.lucene", "hy.lucene", "bn.microsoft", "eu.lucene", "bg.microsoft", "bg.lucene", "ca.microsoft", "ca.lucene", "zh-Hans.microsoft", "zh-Hans.lucene", "zh-Hant.microsoft", "zh-Hant.lucene", "hr.microsoft", "cs.microsoft", "cs.lucene", "da.microsoft", "da.lucene", "nl.microsoft", "nl.lucene", "en.microsoft", "en.lucene", "et.microsoft", "fi.microsoft", "fi.lucene", "fr.microsoft", "fr.lucene", "gl.lucene", "de.microsoft", "de.lucene", " el.microsoft", "el.lucene", "gu.microsoft", "he.microsoft", "hi.microsoft", "hi.lucene", "hu.microsoft", "hu.lucene", "is.microsoft", "id.microsoft", "id.lucene", "ga.lucene", "it.microsoft", "it.lucene", "ja.microsoft", "ja.lucene", "kn.microsoft", "ko.microsoft", "ko.lucene", "lv.microsoft", "lv.lucene", "lt.microsoft", "ml.microsoft", "ms.microsoft", "mr.microsoft", "nb.microsoft", "no.lucene", "fa.lucene", "pl.microsoft", "pl.lucene", "pt-BR.microsoft", "pt-BR.lucene", " pt-PT.microsoft", "pt-PT.lucene", "pa.microsoft", "ro.microsoft", "ro.lucene", "ru.microsoft", "ru.lucene", "sr-cyrillic.microsoft", "sr-latin.microsoft", "sk.microsoft", "sl.microsoft", "es.microsoft", "es.lucene", "sv.microsoft", "sv.lucene", "ta.microsoft", "te.microsoft", "th.microsoft", "th.lucene", "tr.microsoft", "tr.lucene", "uk.microsoft", "your.microsoft", "vi.microsoft", "standard.lucene", "standardasciifolding.lucene", "keyword", "pattern", "simple", "stop", en " witruimte'.
search_analyzer_name	str of <xref:search_service_client.models.LexicalAnalyzerName> De naam van de analyse die tijdens het zoeken voor het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met indexAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Deze eigenschap kan niet worden ingesteld op de naam van een taalanalyse. gebruik in plaats daarvan de eigenschap analyzer als u een taalanalyse nodig hebt. Deze analyse kan worden bijgewerkt voor een bestaand veld. Moet null zijn voor complexe velden. Bekende waarden zijn: "ar.microsoft", "ar.lucene", "hy.lucene", "bn.microsoft", "eu.lucene", "bg.microsoft", "bg.lucene", "ca.microsoft", "ca.lucene", "zh-Hans.microsoft", "zh-Hans.lucene", "zh-Hant.microsoft", "zh-Hant.lucene", "hr.microsoft", "cs.microsoft", "cs.lucene", "da.microsoft", "da.lucene", "nl.microsoft", "nl.lucene", "en.microsoft", "en.lucene", "et.microsoft", "fi.microsoft", "fi.lucene", "fr.microsoft", "fr.lucene", "gl.lucene", "de.microsoft", "de.lucene", " el.microsoft", "el.lucene", "gu.microsoft", "he.microsoft", "hi.microsoft", "hi.lucene", "hu.microsoft", "hu.lucene", "is.microsoft", "id.microsoft", "id.lucene", "ga.lucene", "it.microsoft", "it.lucene", "ja.microsoft", "ja.lucene", "kn.microsoft", "ko.microsoft", "ko.lucene", "lv.microsoft", "lv.lucene", "lt.microsoft", "ml.microsoft", "ms.microsoft", "mr.microsoft", "nb.microsoft", "no.lucene", "fa.lucene", "pl.microsoft", "pl.lucene", "pt-BR.microsoft", "pt-BR.lucene", " pt-PT.microsoft", "pt-PT.lucene", "pa.microsoft", "ro.microsoft", "ro.lucene", "ru.microsoft", "ru.lucene", "sr-cyrillic.microsoft", "sr-latin.microsoft", "sk.microsoft", "sl.microsoft", "es.microsoft", "es.lucene", "sv.microsoft", "sv.lucene", "ta.microsoft", "te.microsoft", "th.microsoft", "th.lucene", "tr.microsoft", "tr.lucene", "uk.microsoft", "your.microsoft", "vi.microsoft", "standard.lucene", "standardasciifolding.lucene", "keyword", "pattern", "simple", "stop", en " witruimte'.
index_analyzer_name	str of <xref:search_service_client.models.LexicalAnalyzerName> De naam van de analyse die wordt gebruikt tijdens het indexeren van het veld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met searchAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Deze eigenschap kan niet worden ingesteld op de naam van een taalanalyse. gebruik in plaats daarvan de eigenschap analyzer als u een taalanalyse nodig hebt. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. Moet null zijn voor complexe velden. Bekende waarden zijn: "ar.microsoft", "ar.lucene", "hy.lucene", "bn.microsoft", "eu.lucene", "bg.microsoft", "bg.lucene", "ca.microsoft", "ca.lucene", "zh-Hans.microsoft", "zh-Hans.lucene", "zh-Hant.microsoft", "zh-Hant.lucene", "hr.microsoft", "cs.microsoft", "cs.lucene", "da.microsoft", "da.lucene", "nl.microsoft", "nl.lucene", "en.microsoft", "en.lucene", "et.microsoft", "fi.microsoft", "fi.lucene", "fr.microsoft", "fr.lucene", "gl.lucene", "de.microsoft", "de.lucene", " el.microsoft", "el.lucene", "gu.microsoft", "he.microsoft", "hi.microsoft", "hi.lucene", "hu.microsoft", "hu.lucene", "is.microsoft", "id.microsoft", "id.lucene", "ga.lucene", "it.microsoft", "it.lucene", "ja.microsoft", "ja.lucene", "kn.microsoft", "ko.microsoft", "ko.lucene", "lv.microsoft", "lv.lucene", "lt.microsoft", "ml.microsoft", "ms.microsoft", "mr.microsoft", "nb.microsoft", "no.lucene", "fa.lucene", "pl.microsoft", "pl.lucene", "pt-BR.microsoft", "pt-BR.lucene", " pt-PT.microsoft", "pt-PT.lucene", "pa.microsoft", "ro.microsoft", "ro.lucene", "ru.microsoft", "ru.lucene", "sr-cyrillic.microsoft", "sr-latin.microsoft", "sk.microsoft", "sl.microsoft", "es.microsoft", "es.lucene", "sv.microsoft", "sv.lucene", "ta.microsoft", "te.microsoft", "th.microsoft", "th.lucene", "tr.microsoft", "tr.lucene", "uk.microsoft", "your.microsoft", "vi.microsoft", "standard.lucene", "standardasciifolding.lucene", "keyword", "pattern", "simple", "stop", en " witruimte'.
vector_search_dimensions	int De dimensionaliteit van het vectorveld.
vector_search_profile_name	str De naam van het vectorzoekprofiel dat het algoritme aangeeft dat moet worden gebruikt bij het zoeken in het vectorveld.
synonym_map_names	list[str] Een lijst met de namen van synoniemen die aan dit veld moeten worden gekoppeld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Momenteel wordt slechts één synoniemtoewijzing per veld ondersteund. Als u een synoniemtoewijzing aan een veld toewijst, zorgt u ervoor dat querytermen die op dat veld zijn gericht, tijdens de query worden uitgebreid met behulp van de regels in de synoniementoewijzing. Dit kenmerk kan worden gewijzigd in bestaande velden. Moet null zijn of een lege verzameling voor complexe velden.
fields	list[<xref:search_service_client.models.SearchField>] Een lijst met subvelden als dit een veld is van het type Edm.ComplexType of Collection(Edm.ComplexType). Moet null of leeg zijn voor eenvoudige velden.

Methoden

as_dict	Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump. Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter: Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object. De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren. Bekijk de drie voorbeelden in dit bestand: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.
deserialize	Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.
enable_additional_properties_sending
from_dict	Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model. Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	Retourneert de JSON die vanuit dit model naar de server wordt verzonden. Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False). Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

as_dict

Een dict retourneren dat kan worden geserialiseerd met behulp van json.dump.

Geavanceerd gebruik kan desgewenst een callback gebruiken als parameter:

Sleutel is de kenmerknaam die wordt gebruikt in Python. Attr_desc is een dict van metagegevens. Bevat momenteel 'type' met het msrest-type en 'key' met de restAPI-gecodeerde sleutel. Waarde is de huidige waarde in dit object.

De geretourneerde tekenreeks wordt gebruikt om de sleutel te serialiseren. Als het retourtype een lijst is, wordt dit beschouwd als hiërarchisch resultaatdicteren.

Bekijk de drie voorbeelden in dit bestand:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

Parameters

Name	Description
key_transformer	<xref:function> Een sleuteltransformatorfunctie.
keep_readonly	standaardwaarde: True

Retouren

Type	Description
dict	Een dict JSON-compatibel object

deserialize

Parseert een str met behulp van de RestAPI-syntaxis en retourneert een model.

deserialize(data: Any, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Vereist	str Een str met behulp van restAPI-structuur. JSON standaard.
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

Een dict parseren met behulp van de opgegeven sleutelextractor retourneert een model.

Houd standaard rekening met sleutelextracties (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor en last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

Parameters

Name	Description
data Vereist	dict Een dict met behulp van de RestAPI-structuur
content_type	str JSON standaard: stel application/xml in als XML. standaardwaarde: None
key_extractors	standaardwaarde: None

Retouren

Type	Description
	Een exemplaar van dit model

Uitzonderingen

Type	Description
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

Retourneert de JSON die vanuit dit model naar de server wordt verzonden.

Dit is een alias voor as_dict(full_restapi_key_transformer, keep_readonly=False).

Als u XML-serialisatie wilt, kunt u de kwargs is_xml=True doorgeven.

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

Parameters

Name	Description
keep_readonly	bool Als u de alleen-lezen kenmerken wilt serialiseren standaardwaarde: False

Retouren

Type	Description
dict	Een dict JSON-compatibel object