SpellSuggestions Class
Defines a suggested query string that likely represents the user's intent. The search results include this response if Bing determines that the user may have intended to search for something different. For example, if the user searches for alon brown, Bing may determine that the user likely intended to search for Alton Brown instead (based on past searches by others of Alon Brown).
Variables are only populated by the server, and will be ignored when sending a request.
All required parameters must be populated in order to send to Azure.
Constructor
SpellSuggestions(*, value, **kwargs)Parameters
| Name | Description |
|---|---|
|
_type
Required
|
Required. Constant filled by server. |
|
value
Required
|
Required. A list of suggested query strings that may represent the user's intention. The list contains only one Query object. |
Keyword-Only Parameters
| Name | Description |
|---|---|
|
value
Required
|
|
Variables
| Name | Description |
|---|---|
|
id
|
A String identifier. |
|
web_search_url
|
The URL To Bing's search result for this item. |
|
follow_up_queries
|
|
|
query_context
|
|
|
total_estimated_matches
|
<xref:long>
The estimated number of webpages that are relevant to the query. Use this number along with the count and offset query parameters to page the results. |
|
is_family_friendly
|
|
Methods
| as_dict |
Return a dict that can be JSONify using json.dump. Advanced usage might optionally use a callback as parameter: Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object. The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict. See the three examples in this file:
If you want XML serialization, you can pass the kwargs is_xml=True. |
| deserialize |
Parse a str using the RestAPI syntax and return a model. |
| enable_additional_properties_sending | |
| from_dict |
Parse a dict using given key extractor return a model. By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor) |
| is_xml_model | |
| serialize |
Return the JSON that would be sent to azure from this model. This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). If you want XML serialization, you can pass the kwargs is_xml=True. |
| validate |
Validate this model recursively and return a list of ValidationError. |
as_dict
Return a dict that can be JSONify using json.dump.
Advanced usage might optionally use a callback as parameter:
Key is the attribute name used in Python. Attr_desc is a dict of metadata. Currently contains 'type' with the msrest type and 'key' with the RestAPI encoded key. Value is the current value in this object.
The string returned will be used to serialize the key. If the return type is a list, this is considered hierarchical result dict.
See the three examples in this file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
If you want XML serialization, you can pass the kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)Parameters
| Name | Description |
|---|---|
|
key_transformer
|
<xref:function>
A key transformer function. |
|
keep_readonly
|
Default value: True
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
deserialize
Parse a str using the RestAPI syntax and return a model.
deserialize(data, content_type=None)Parameters
| Name | Description |
|---|---|
|
data
Required
|
A str using RestAPI structure. JSON by default. |
|
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of this model |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()from_dict
Parse a dict using given key extractor return a model.
By default consider key extractors (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor and last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)Parameters
| Name | Description |
|---|---|
|
data
Required
|
A dict using RestAPI structure |
|
content_type
|
JSON by default, set application/xml if XML. Default value: None
|
|
key_extractors
|
Default value: None
|
Returns
| Type | Description |
|---|---|
|
An instance of this model |
Exceptions
| Type | Description |
|---|---|
|
DeserializationError if something went wrong
|
is_xml_model
is_xml_model()serialize
Return the JSON that would be sent to azure from this model.
This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
If you want XML serialization, you can pass the kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)Parameters
| Name | Description |
|---|---|
|
keep_readonly
|
If you want to serialize the readonly attributes Default value: False
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
validate
Validate this model recursively and return a list of ValidationError.
validate()Returns
| Type | Description |
|---|---|
|
A list of validation error |
