WebKnowledgeSourceParams Class
Specifies runtime parameters for a web knowledge source.
Constructor
WebKnowledgeSourceParams(*args: Any, **kwargs: Any)Variables
| Name | Description |
|---|---|
|
knowledge_source_name
|
The name of the index the params apply to. Required. |
|
include_references
|
Indicates whether references should be included for data retrieved from this source. |
|
include_reference_source_data
|
Indicates whether references should include the structured data obtained during retrieval in their payload. |
|
reranker_threshold
|
The reranker threshold all retrieved documents must meet to be included in the response. |
|
kind
|
str or
<xref:azure.search.documents.indexes.models.WEB>
The discriminator value. Required. A knowledge source that reads data from the web. |
|
language
|
The language of the web results. |
|
market
|
The market of the web results. |
|
count
|
The number of web results to return. |
|
freshness
|
The freshness of web results. |
Methods
| as_dict |
Return a dict that can be turned into json using json.dump. |
| clear |
Remove all items from D. |
| copy | |
| get |
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any |
| items | |
| keys | |
| pop |
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given. |
| popitem |
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty. |
| setdefault |
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any |
| update |
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs. |
| values |
as_dict
Return a dict that can be turned into json using json.dump.
as_dict(*, exclude_readonly: bool = False) -> dict[str, Any]Keyword-Only Parameters
| Name | Description |
|---|---|
|
exclude_readonly
|
Whether to remove the readonly properties. Default value: False
|
Returns
| Type | Description |
|---|---|
|
A dict JSON compatible object |
clear
Remove all items from D.
clear() -> Nonecopy
copy() -> Modelget
Get the value for key if key is in the dictionary, else default. :param str key: The key to look up. :param any default: The value to return if key is not in the dictionary. Defaults to None :returns: D[k] if k in D, else d. :rtype: any
get(key: str, default: Any = None) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
Default value: None
|
items
items() -> ItemsView[str, Any]Returns
| Type | Description |
|---|---|
|
set-like object providing a view on D's items |
keys
keys() -> KeysView[str]Returns
| Type | Description |
|---|---|
|
a set-like object providing a view on D's keys |
pop
Removes specified key and return the corresponding value. :param str key: The key to pop. :param any default: The value to return if key is not in the dictionary :returns: The value corresponding to the key. :rtype: any :raises KeyError: If key is not found and default is not given.
pop(key: str, default: ~typing.Any = <object object>) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
popitem
Removes and returns some (key, value) pair :returns: The (key, value) pair. :rtype: tuple :raises KeyError: if D is empty.
popitem() -> tuple[str, Any]setdefault
Same as calling D.get(k, d), and setting D[k]=d if k not found :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: D[k] if k in D, else d. :rtype: any
setdefault(key: str, default: ~typing.Any = <object object>) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
update
Updates D from mapping/iterable E and F. :param any args: Either a mapping object or an iterable of key-value pairs.
update(*args: Any, **kwargs: Any) -> Nonevalues
values() -> ValuesView[Any]Returns
| Type | Description |
|---|---|
|
an object providing a view on D's values |
Attributes
count
The number of web results to return.
count: int | Nonefreshness
The freshness of web results.
freshness: str | Noneinclude_reference_source_data
Indicates whether references should include the structured data obtained during retrieval in their payload.
include_reference_source_data: bool | Noneinclude_references
Indicates whether references should be included for data retrieved from this source.
include_references: bool | Nonekind
The discriminator value. Required. A knowledge source that reads data from the web.
kind: WEB: 'web'>]knowledge_source_name
The name of the index the params apply to. Required.
knowledge_source_name: strlanguage
The language of the web results.
language: str | Nonemarket
The market of the web results.
market: str | Nonereranker_threshold
The reranker threshold all retrieved documents must meet to be included in the response.
reranker_threshold: float | None