Skip to content

Commit

Permalink
New published version
Browse files Browse the repository at this point in the history
  • Loading branch information
yorevs committed Oct 8, 2024
1 parent e4f6fec commit 972b096
Show file tree
Hide file tree
Showing 38 changed files with 126 additions and 78 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Terminal](https://badgen.net/badge/icon/terminal?icon=terminal&label)](https://github.com/yorevs/homesetup)
[![License](https://badgen.net/badge/license/MIT/gray)](LICENSE.md)
[![Release](https://badgen.net/badge/release/v1.0.20/gray)](docs/CHANGELOG.md#unreleased)
[![Release](https://badgen.net/badge/release/v1.0.21/gray)](docs/CHANGELOG.md#unreleased)
[![Donate](https://badgen.net/badge/paypal/donate/yellow)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)
[![build-and-test](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml)

Expand Down
2 changes: 1 addition & 1 deletion bumpver.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[bumpver]
current_version = "1.0.20"
current_version = "1.0.21"
version_pattern = "MAJOR.MINOR.PATCH"
commit_message = "++version {old_version} -> {new_version}"
commit = false
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ author = <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior
mailTo = yorevs@hotmail.com
siteUrl = https://github.com/yorevs/askai
app_name = hspylib-askai
app_version = 1.0.20
app_version = 1.0.21

# Build Tools
buildTools = setuptools, wheel, build, twine, bumpver, pipenv, isort, black, mypy, pylint, pdoc, pytest
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "hspylib-askai"
version = "1.0.20"
version = "1.0.21"
description = "HomeSetup - AskAI"
authors = ["Hugo Saporetti Junior <yorevs@hotmail.com>"]
license = "MIT"
Expand Down
4 changes: 2 additions & 2 deletions src/demo/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo
"""Package initialization."""
Expand All @@ -12,4 +12,4 @@
'others',
'utils'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/components/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.components
"""Package initialization."""
Expand All @@ -14,4 +14,4 @@
'vision_demo',
'webcam_demo'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/devel/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.devel
"""Package initialization."""
Expand All @@ -9,4 +9,4 @@
'google_suggestions',
'gpt2_suggester'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/features/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.features
"""Package initialization."""
Expand All @@ -10,4 +10,4 @@
'router_demo',
'tools'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/features/rag/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.features.rag
"""Package initialization."""

__all__ = [
'x_refs_demo'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/features/tools/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.features.tools
"""Package initialization."""

__all__ = [
'query_output_demo'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/demo/others/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: demo.others
"""Package initialization."""
Expand All @@ -14,4 +14,4 @@
'translate_demo',
'vision_model_demos'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
50 changes: 49 additions & 1 deletion src/main/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
[![Terminal](https://badgen.net/badge/icon/terminal?icon=terminal&label)](https://github.com/yorevs/homesetup)
[![License](https://badgen.net/badge/license/MIT/gray)](LICENSE.md)
[![Release](https://badgen.net/badge/release/v1.0.19/gray)](docs/CHANGELOG.md#unreleased)
[![Release](https://badgen.net/badge/release/v1.0.20/gray)](docs/CHANGELOG.md#unreleased)
[![Donate](https://badgen.net/badge/paypal/donate/yellow)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=J5CDEFLF6M3H4)
[![build-and-test](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml/badge.svg)](https://github.com/yorevs/askai/actions/workflows/build-and-test.yml)

Expand Down Expand Up @@ -101,6 +101,54 @@ AskAI is available at [PyPi](https://pypi.org/project/hspylib-askai/)
$ python3 -m pip install hspylib-askai
```

#### ApiKeys

In order to use AskAI you need to have the following Api Keys:

- DEEPL_API_KEY (for translations).
- GOOGLE_API_KEY (for internet browsing).
- OPENAI_API_KEY (to use ChatGPT api).

##### Google Search API Integration

To enable the Custom Search API:

1. Navigate to the APIs & Services→Dashboard panel in Cloud Console.
2. Click Enable APIs and Services.
3. Search for Custom Search API and click on it.
4. Click Enable.

> URL for it: https://console.cloud.google.com/apis/library/customsearch.googleapis.com
To create an API key:

1. Navigate to the APIs & Services → Credentials panel in Cloud Console.
2. Select Create credentials, then select API key from the drop-down menu.
3. The API key created dialog box displays your newly created key.
4. You now have an GOOGLE_API_KEY.

> Alternatively, you can just generate an API key here: https://developers.google.com/custom-search/docs/paid_element#api_key
##### DeepL API

To enable the DeepL online translation:

1. Navigate to you account settings.
2. Select the tab API Keys.
3. Click on Create key + .
4. You now have a DEEPL_API_KEY.

##### OpenAI API

To enable your OpenAI LLM:

1. Access the OpenAI [API Section](https://platform.openai.com/settings/profile?tab=api-keys):
2. Navigate to the API section of the OpenAI dashboard.
3. Create a New API Key by clicking on “Create API Key” or a similar button.
4. Name Your API Key:
5. You now have a OPENAI_API_KEY.


## Support

> Your support and contributions are greatly appreciated in helping us improve and enhance HomeSetup. Together, we can
Expand Down
4 changes: 2 additions & 2 deletions src/main/__init__.py
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main
"""Package initialization."""

__all__ = [
'askai'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
2 changes: 1 addition & 1 deletion src/main/askai/.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
1.0.20
1.0.21
4 changes: 2 additions & 2 deletions src/main/askai/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai
"""Package initialization."""
Expand All @@ -11,4 +11,4 @@
'language',
'tui'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core
"""Package initialization."""
Expand All @@ -21,4 +21,4 @@
'model',
'support'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/commander/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.commander
"""Package initialization."""
Expand All @@ -9,4 +9,4 @@
'commander',
'commands'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/commander/commands/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.commander.commands
"""Package initialization."""
Expand All @@ -13,4 +13,4 @@
'settings_cmd',
'tts_stt_cmd'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
5 changes: 3 additions & 2 deletions src/main/askai/core/component/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.component
"""Package initialization."""
Expand All @@ -12,9 +12,10 @@
'geo_location',
'image_store',
'internet_service',
'rag_provider',
'recorder',
'scheduler',
'summarizer',
'text_streamer'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/engine/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.engine
"""Package initialization."""
Expand All @@ -12,4 +12,4 @@
'engine_factory',
'openai'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/engine/openai/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.engine.openai
"""Package initialization."""
Expand All @@ -12,4 +12,4 @@
'openai_vision',
'temperature'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/enums/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.enums
"""Package initialization."""
Expand All @@ -12,4 +12,4 @@
'run_modes',
'verbosity'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/features/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.features
"""Package initialization."""
Expand All @@ -10,4 +10,4 @@
'router',
'tools'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/features/processors/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.features.processors
"""Package initialization."""
Expand All @@ -13,4 +13,4 @@
'rag',
'task_splitter'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/features/router/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.features.router
"""Package initialization."""
Expand All @@ -11,4 +11,4 @@
'model_selector',
'task_agent'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/features/tools/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.features.tools
"""Package initialization."""
Expand All @@ -15,4 +15,4 @@
'vision',
'webcam'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
4 changes: 2 additions & 2 deletions src/main/askai/core/model/__init__.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# _*_ coding: utf-8 _*_
#
# hspylib-askai v1.0.20
# hspylib-askai v1.0.21
#
# Package: main.askai.core.model
"""Package initialization."""
Expand All @@ -15,4 +15,4 @@
'search_result',
'summary_result'
]
__version__ = '1.0.20'
__version__ = '1.0.21'
Loading

0 comments on commit 972b096

Please sign in to comment.