OpenSearch Helper for Easy I/O
Project description
Open Search Helper (opensearch-helper)
A collection of methods for assisting with OpenSearch querying on AWS
MultiMatch Query Generator
Method Definition
multimatch_generator(input_text: str, size: int = 5, *args) -> MultiMatchQuery
Invoke Function
Pass in one-or-more field names after the query:
from opensearch_helper import multimatch_generator
d_query = multimatch_generator("what is the average PH of rainwater?" "question", "context")
Sample Output
{
"size":5,
"query":{
"multi_match":{
"query":"input_text",
"fields":[
"question"
]
}
}
}
API Query (AWS)
Method Definition
query(d_query: MultiMatchQuery, index_name: str) -> OpenSearchResult
Invoke Function
The following environment variables must exist and be encrypted via baseblock::Run-Encrypt
- OPENSEARCH_HOST
- OPENSEARCH_REGION
- OPENSEARCH_USERNAME
- OPENSEARCH_PASSWORD
from opensearch_helper import query
query(d_query, index_name='myindex')
Score Top Hit
This method will retrieve the top hit and both quantitatively and qualitatively score the result.
Method Definition
score_top_hit(d_hits: dict) -> ScoreResult
Invoke Function
from opensearch_helper import score_top_hit
score_top_hit(d_hits)
Sample Output
{
"score":14.23432,
"type":"HIGH"
}
Local OpenSearch
From the terminal run
docker-compose up
The following environment variables must exist and be encrypted via baseblock::Run-Encrypt
- OPENSEARCH_HOST
- OPENSEARCH_USERNAME
- OPENSEARCH_PASSWORD
Unless these have been modified, the default values can be found here https://opensearch.org/docs/latest/opensearch/install/docker/
from a python script import
from opensearch_helper import OpenSearchDEV
The following functions are available
client = OpenSearchDEV()
client.create_index(...)
client.delete_index(...)
client.add(...)
client.query(...)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for opensearch_helper-0.1.17-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3eaa17d29c9dfc769054dfd44260af2b0434c860a480df9a25079508095746e1 |
|
MD5 | 6c23289b25560258a851ec2af8175a1a |
|
BLAKE2b-256 | 6ef385f1b5b1ca16b1c7b951ff2b429b40d4a3186fade98235ed7e0d5ca124df |