Logger
components.Retrieval
Retrieval functionality for Components integration.
RetrievalConfig
Retrieval config.
This class provides functionality to manage retrieval configurations.
RetrievalConfigDict
Retrieval config dict.
This class provides functionality to manage retrieval config dictionaries.
get_retrieval_config_dict
Get the retrieval config dict.
Arguments:
Name | Type | Description |
---|---|---|
config | Union[RetrievalConfig, RetrievalConfigDict] | The config to get the dict from. |
Returns:
dict[str, Any]: The retrieval config dict.
Retrieval
This class represents a retrieval.
__init__
Initialize a retrieval.
Arguments:
Name | Description |
---|---|
config | The config to initialize the retrieval with. |
writer | The writer to use. |
input
Set the input for the retrieval.
Arguments:
Name | Description |
---|---|
query | The query to set for the retrieval. |
input_
Set the input for the retrieval.
Arguments:
Name | Description |
---|---|
writer | The writer to use. |
id | The id of the retrieval. |
query | The query to set for the retrieval. |
output
Set the output for the retrieval.
Arguments:
Name | Description |
---|---|
docs | The docs to set for the retrieval. |
add_attachment
Add an attachment to the retrieval.
Arguments:
Name | Description |
---|---|
attachment | The attachment to add to the retrieval. |
add_attachment_
Add an attachment to the retrieval.
Arguments:
Name | Description |
---|---|
writer | The writer to use. |
id | The id of the retrieval. |
attachment | The attachment to add to the retrieval. |
output_
Set the output for the retrieval.
Arguments:
Name | Description |
---|---|
writer | The writer to use. |
id | The id of the retrieval. |
docs | The docs to set for the retrieval. |
end_
End the retrieval.
Arguments:
Name | Description |
---|---|
writer | The writer to use. |
id | The id of the retrieval. |
data | The data to set for the retrieval. |
add_tag_
Add a tag to the retrieval.
Arguments:
Name | Description |
---|---|
writer | The writer to use. |
id | The id of the retrieval. |
key | The key of the tag. |
value | The value of the tag. |