KnowledgeBase Class
Represents a knowledge base definition.
Constructor
KnowledgeBase(*args: Any, **kwargs: Any)Methods
| as_dict |
Return a dict that can be turned into json using json.dump. |
| clear |
Remove all items from the dictionary. |
| 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: The value for key if key is in the dictionary, else default. :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 the dictionary is empty. |
| setdefault |
Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any |
| update |
Update the dictionary from a mapping or an iterable of key-value pairs. :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 the dictionary.
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: The value for key if key is in the dictionary, else default. :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 |
|---|---|
|
a set-like object providing a view on the mapping's items |
keys
keys() -> KeysView[str]Returns
| Type | Description |
|---|---|
|
a set-like object providing a view on the mapping'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 the dictionary is empty.
popitem() -> tuple[str, Any]setdefault
Return the value for key if key is in the dictionary; otherwise set the key to default and return default. :param str key: The key to look up. :param any default: The value to set if key is not in the dictionary :returns: The value for key if key is in the dictionary, else default. :rtype: any
setdefault(key: str, default: ~typing.Any = <object object>) -> AnyParameters
| Name | Description |
|---|---|
|
key
Required
|
|
|
default
|
|
update
Update the dictionary from a mapping or an iterable of key-value pairs. :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 the mapping's values |
Attributes
answer_instructions
Instructions considered by the knowledge base when generating answers.
answer_instructions: str | Nonecors_options
Options to control Cross-Origin Resource Sharing (CORS) for the knowledge base.
cors_options: '_models.CorsOptions' | Nonedescription
The description of the knowledge base.
description: str | Nonee_tag
The ETag of the knowledge base.
e_tag: str | Noneencryption_key
A description of an encryption key that you create in Azure Key Vault.
encryption_key: '_models.SearchResourceEncryptionKey' | Noneknowledge_sources
Knowledge sources referenced by this knowledge base. Required.
knowledge_sources: list['_models.KnowledgeSourceReference']models
Contains configuration options on how to connect to AI models.
models: list['_models.KnowledgeBaseModel'] | Nonename
The name of the knowledge base. Required.
name: stroutput_mode
"extractiveData" and "answerSynthesis".
output_mode: str | '_knowledgebases_models3.KnowledgeRetrievalOutputMode' | Noneretrieval_instructions
Instructions considered by the knowledge base when developing query plan.
retrieval_instructions: str | Noneretrieval_reasoning_effort
The retrieval reasoning effort configuration.
retrieval_reasoning_effort: '_knowledgebases_models3.KnowledgeRetrievalReasoningEffort' | Noneretrieve_defaults
Persisted request-wide retrieve defaults for this knowledge base. These values apply to retrieve requests that omit the corresponding fields; request-time values take precedence when present.
retrieve_defaults: '_models.KnowledgeBaseRetrieveDefaults' | Nonetags
User-defined key-value pairs for categorizing the knowledge base and attributing its usage and costs.
tags: dict[str, str] | None