SearchIndex Classe

  • Riferimento

Rappresenta una definizione dell'indice di ricerca, che descrive i campi e il comportamento di ricerca di un indice.

Tutti i parametri obbligatori devono essere popolati per inviare ad Azure.

Ereditarietà
azure.search.documents.indexes._generated._serialization.Model
SearchIndex

Costruttore

SearchIndex(**kwargs)

Variabili

Nome Descrizione
name
str

Obbligatorio. Nome dell'indice.
fields
list[SearchField]

Obbligatorio. Campi dell'indice.
scoring_profiles
list[ScoringProfile]

Profili di assegnazione dei punteggi per l'indice.
default_scoring_profile
str

Nome del profilo di assegnazione dei punteggi da usare se non è specificato nessuno nella query. Se questa proprietà non è impostata e non viene specificato alcun profilo di assegnazione dei punteggi nella query, verrà usato il punteggio predefinito (tf-idf).
cors_options
CorsOptions

Opzioni per controllare la condivisione delle risorse tra origini (CORS) per l'indice.
suggesters
list[SearchSuggester]

I suggeritori per l'indice.
analyzers
list[LexicalAnalyzer]

Analizzatori per l'indice.
tokenizers
list[LexicalTokenizer]

Tokenizer per l'indice.
token_filters
list[TokenFilter]

Filtri token per l'indice.
char_filters
list[CharFilter]

Filtri di carattere per l'indice.
encryption_key
SearchResourceEncryptionKey

Descrizione di una chiave di crittografia creata in Azure Key Vault. Questa chiave viene usata per fornire un livello aggiuntivo di crittografia inattivi per i dati quando si vuole garantire che nessuno, non anche Microsoft, possa decrittografare i dati in Ricerca cognitiva di Azure. Dopo aver crittografato i dati, rimarrà sempre crittografato. Ricerca cognitiva di Azure ignorerà i tentativi di impostare questa proprietà su Null. È possibile modificare questa proprietà in base alle esigenze se si vuole ruotare la chiave di crittografia; I dati non saranno interessati. La crittografia con chiavi gestite dal cliente non è disponibile per i servizi di ricerca gratuiti ed è disponibile solo per i servizi a pagamento creati o dopo il 1° gennaio 2019.
similarity
SimilarityAlgorithm

Tipo di algoritmo di somiglianza da usare durante l'assegnazione dei punteggi e la classificazione dei documenti corrispondenti a una query di ricerca. L'algoritmo di somiglianza può essere definito solo in fase di creazione dell'indice e non può essere modificato negli indici esistenti. Se null, viene usato l'algoritmo ClassicSimilarity.
semantic_search
SemanticSearch

Definisce i parametri per un indice di ricerca che influiscono sulle funzionalità semantiche.
vector_search
VectorSearch

Definisce i parametri per un indice di ricerca che influisce sul punteggio in uno spazio vettoriale.
e_tag
str

ETag dell'indice.

Metodi

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.
deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.
enable_additional_properties_sending
from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
is_xml_model
serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

as_dict

Restituisce un dict che può essere serializzato usando json.dump.

L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:

La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.

La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.

Vedere i tre esempi in questo file:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

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]

Parametri

Nome Descrizione
key_transformer
<xref:function>

Funzione di trasformatore chiave.
keep_readonly
valore predefinito: True

Restituisce

Tipo Descrizione
dict

Oggetto compatibile con JSON dict

deserialize

Analizzare uno str usando la sintassi RestAPI e restituire un modello.

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

Parametri

Nome Descrizione
data
Necessario
str

Str usando la struttura RestAPI. JSON per impostazione predefinita.
content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Analizzare un dict usando un estrattore chiave specificato restituisce un modello.

Per impostazione predefinita, considerare gli estrattori di chiavi (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e 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

Parametri

Nome Descrizione
data
Necessario
dict

Dict using RestAPI structure
content_type
str

JSON per impostazione predefinita, impostare application/xml se XML.

valore predefinito: None
key_extractors
valore predefinito: None

Restituisce

Tipo Descrizione

Istanza di questo modello

Eccezioni

Tipo Descrizione
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Restituire il codice JSON che verrà inviato al server da questo modello.

Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).

Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.

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

Parametri

Nome Descrizione
keep_readonly
bool

Se si vuole serializzare gli attributi readonly

valore predefinito: False

Restituisce

Tipo Descrizione
dict

Oggetto compatibile con JSON dict