IndexAction Sınıf

  • Başvuru

Belge üzerinde çalışan bir dizin eylemini temsil eder.

Devralma
azure.search.documents._generated._serialization.Model
IndexAction

Oluşturucu

IndexAction(*, additional_properties: Dict[str, Any] | None = None, action_type: str | _models.IndexActionType | None = None, **kwargs: Any)

Yalnızca Anahtar Sözcük Parametreleri

Name Description
additional_properties
dict[str, any]

İletideki eşleşmeyen özellikler bu koleksiyonda seri durumdan çıkarılır.
action_type
str veya <xref:azure.search.documents.models.IndexActionType>

Dizin oluşturma toplu işlemindeki bir belge üzerinde gerçekleştirilecek işlem. Bilinen değerler şunlardır: "upload", "merge", "mergeOrUpload" ve "delete".

Değişkenler

Name Description
additional_properties
dict[str, any]

İletideki eşleşmeyen özellikler bu koleksiyonda seri durumdan çıkarılır.
action_type
str veya <xref:azure.search.documents.models.IndexActionType>

Dizin oluşturma toplu işlemindeki bir belge üzerinde gerçekleştirilecek işlem. Bilinen değerler şunlardır: "upload", "merge", "mergeOrUpload" ve "delete".

Yöntemler

as_dict

json.dump kullanılarak seri hale getirilebilen bir dikte döndürür.

Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir:

Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir.

Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir.

Bu dosyadaki üç örne bakın:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.
deserialize

RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.
enable_additional_properties_sending
from_dict

Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür.

Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun
is_xml_model
serialize

Bu modelden sunucuya gönderilecek JSON'ı döndür.

Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.

XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.

as_dict

json.dump kullanılarak seri hale getirilebilen bir dikte döndürür.

Gelişmiş kullanım isteğe bağlı olarak parametre olarak bir geri çağırma kullanabilir:

Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc, meta verilerin bir diktesidir. Şu anda msrest türüyle 'type' ve RestAPI kodlanmış anahtarıyla 'key' içerir. Değer, bu nesnedeki geçerli değerdir.

Döndürülen dize, anahtarı seri hale getirmek için kullanılır. Dönüş türü bir listeyse, bu hiyerarşik sonuç diktesi olarak kabul edilir.

Bu dosyadaki üç örne bakın:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.

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]

Parametreler

Name Description
key_transformer
<xref:function>

Anahtar transformatörü işlevi.
keep_readonly
Default value: True

Döndürülenler

Tür Description
dict

JSON uyumlu bir dikte nesnesi

deserialize

RestAPI söz dizimini kullanarak bir str ayrıştırın ve bir model döndürün.

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

Parametreler

Name Description
data
Gerekli
str

RestAPI yapısını kullanan bir str. Varsayılan olarak JSON.
content_type
str

JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.

Default value: None

Döndürülenler

Tür Description

Bu modelin bir örneği

Özel durumlar

Tür Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending() -> None

from_dict

Verilen anahtar ayıklayıcıyı kullanarak bir dikteyi ayrıştırma bir model döndürür.

Varsayılan olarak anahtar ayıklayıcıları (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor ve last_rest_key_case_insensitive_extractor) göz önünde bulundurun

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

Parametreler

Name Description
data
Gerekli
dict

RestAPI yapısını kullanan bir dikte
content_type
str

JSON varsayılan olarak, XML ise application/xml değerini ayarlayın.

Default value: None
key_extractors
Default value: None

Döndürülenler

Tür Description

Bu modelin bir örneği

Özel durumlar

Tür Description
DeserializationError if something went wrong

is_xml_model 

is_xml_model() -> bool

serialize

Bu modelden sunucuya gönderilecek JSON'ı döndür.

Bu, as_dict(full_restapi_key_transformer, keep_readonly=False) için bir diğer addır.

XML serileştirme istiyorsanız, kwargs is_xml=True geçirebilirsiniz.

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

Parametreler

Name Description
keep_readonly
bool

Salt okunur öznitelikleri seri hale getirmek istiyorsanız

Default value: False

Döndürülenler

Tür Description
dict

JSON uyumlu bir dikte nesnesi