Aracılığıyla paylaş


IndexingResult Sınıf

Tek bir belge için dizin oluşturma işleminin durumu.

Değişkenler yalnızca sunucu tarafından doldurulur ve istek gönderilirken yoksayılır.

Azure'a göndermek için tüm gerekli parametrelerin doldurulması gerekir.

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

Oluşturucu

IndexingResult(**kwargs: Any)

Değişkenler

Name Description
key
str

Dizin oluşturma isteğindeki bir belgenin anahtarı. Gereklidir.

error_message
str

Anahtar tarafından tanımlanan belge için dizin oluşturma işleminin neden başarısız olduğunu açıklayan hata iletisi; dizin oluşturma başarılı olursa null.

succeeded

Anahtar tarafından tanımlanan belge için dizin oluşturma işleminin başarılı olup olmadığını gösteren değer. Gereklidir.

status_code
int

Dizin oluşturma işleminin durum kodu. Olası değerler şunlardır: başarılı bir güncelleştirme veya silme için 200, başarılı belge oluşturma için 201, hatalı biçimlendirilmiş bir giriş belgesi için 400, belge bulunamadı için 404, sürüm çakışması için 409, dizin geçici olarak kullanılamadığında 422 veya hizmet çok meşgul olduğunda 503. Gereklidir.

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 geri çağırma kullanabilir:

Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc meta verilerin bir diktesidir. Şu anda msrest türüne sahip 'type' ve RestAPI kodlanmış anahtarıyla 'key' içeriyor. 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ştirmesini istiyorsanız kwargs is_xml=True değerini 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ştirmesini istiyorsanız kwargs is_xml=True değerini 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 geri çağırma kullanabilir:

Anahtar, Python'da kullanılan öznitelik adıdır. Attr_desc meta verilerin bir diktesidir. Şu anda msrest türüne sahip 'type' ve RestAPI kodlanmış anahtarıyla 'key' içeriyor. 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ştirmesini istiyorsanız kwargs is_xml=True değerini 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
varsayılan değer: True

Döndürülenler

Tür Description

JSON uyumlu bir nesne dikte

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

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

varsayılan değer: 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

RestAPI yapısını kullanan bir dikte

content_type
str

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

varsayılan değer: None
key_extractors
varsayılan değer: 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ştirmesini istiyorsanız kwargs is_xml=True değerini geçirebilirsiniz.

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

Parametreler

Name Description
keep_readonly

Salt okunur öznitelikleri seri hale getirmek istiyorsanız

varsayılan değer: False

Döndürülenler

Tür Description

JSON uyumlu bir nesne dikte