update

aiphilos/about.md

@@ -0,0 +1,7 @@
+# About
+
+"aiPhilos Smart Product Search" is a product by aiPhilos GmbH. It is based on AI and was developed together with the German Research Center for Artificial Intelligence (DFKI).
+
+aiPhilos supports plug and play and can be used directly with no setup required. The artificial intelligence understands natural search requests via speech or written text, is self-learning and requires no manual maintenance.
+
+aiPhilos provides its own API, which can be used to map individual search experiences in online stores or digital assistants. In addition, plugins are available for Shopware, Magento and, in the future, for all other store systems widely used in German-speaking countries.

aiphilos/changelog.md

@@ -0,0 +1,38 @@
+# Changelog (Shopware)
+
+Version 1.1.9
+- Bug fix for attribute usage
+- Removed limits when fetching search results (Now more than 1000 results are possible)
+- Improved synchronization with aiPhilos database
+
+Version 1.1.8
+- Optimized API search call
+- Might improve performance due to shorter response times
+
+Version 1.1.7
+- Added help text for database name field
+- Improved handling of incomplete article translations
+- Implemented translations for filter properties
+
+Version 1.1.6
+- Improvements for aiPhilos database synchronization
+
+Version 1.1.5
+- Improved article data structure for aiPhilos database
+
+Version 1.1.4
+- Live search delay can now be configured (Default: 750ms)
+
+Version 1.1.3
+- Ajax live search is now delayed by one second to save requests
+
+Version 1.1.2
+- Bugfix for sub-shop capability
+- Improvements when handling large amounts of data
+
+Version 1.1.1
+- Bugfix for excluded categories
+- Bugfix for sub-shop handling
+
+Version 1.1.0
+- Initial release

aiphilos/faq.md

@@ -0,0 +1,34 @@
+# FAQ
+
+## Why should I register for aiPhilos?
+
+Only registered users have access to the functions and benefits of aiPhilos. All booked services are available as soon as the registration and login are completed successfully.
+
+## How does the registration for aiPhilos work?
+
+The registration is as simple as that: [Click here](https://www.aiphilos.com/registrierung) and fill in the registration form completely.
+After your entered Data is checked, you will get a copy of your login details to your inserted e-mail address.
+
+## What can I do if I have problems with the registration?
+
+Please check your entries once again.
+Every e-mail address can only be used once.
+The username is generated by the system. You will get informed about your username together with your login details per e-mail. Especially the correct spelling of capital and small letters is important. This applies for the username as well as for the password, you registered with. If the registration does still not work, please contact our support at support@aiphilos.com.
+
+## What are the next steps after the registration?
+
+After the registration is completed log in with your username and password in the login section an. The login section is located on the top right corner on our website or on the top right corner in the menu on your smartphone. After this, create an aiPhilos-account with a suitable user at: > Administration > User Management > Add
+
+## How do I log in to aiPhilos?
+
+The login section is located on the top right corner on our website or on the top right corner in the menu on your smartphone. You may also just [click here](https://account.aiphilos.com/login). You need your username and password to log in to the administration area.
+
+## What can I do if I have problems with the login?
+
+Please check your inserts once again.
+If the login does not work, you can reset your password or request a new username. If this does not help, please send us an e-mail at support@aiphilos.com.
+
+## What can I do if I forgot my password?
+
+If you forget your password, you can reset it easily by clicking on “Forgot your password?” underneath the login button. Afterwards insert your username. Usually this is the e-mail address you entered when registering or your chosen username. Now click on “send”. We will send you an e-mail with further information about how to reset your password.
+If this does not help, please send us an e-mail with your concern at support@aiphilos.com. 

aiphilos/index.rst

@@ -0,0 +1,8 @@
+.. toctree::
+  :maxdepth: 1
+  :caption: aiPhilos
+  :name: toc-aiphilos
+
+  about
+  changelog
+  faq

concepts/api.md

@@ -0,0 +1,2 @@
+# API
+coming soon

concepts/auth.md

@@ -0,0 +1,6 @@
+# Auth
+
+You can use Basic Authentication to access the API for your Cloud account. With Basic Authentication, you pass your credentials in each request to the API.
+
+You can pass your credentials as a Base64-encoded header or as an URL parameter in an HTTP client.
+When you pass your credentials in the header, you must Base64-encode them.

concepts/data_management.md

@@ -0,0 +1,2 @@
+# Data Management
+coming soon

concepts/index.rst

@@ -0,0 +1,5 @@
+.. toctree::
+  api
+  auth
+  ** data_management **
+  versioning

concepts/versioning.md

@@ -0,0 +1,12 @@
+# Versioning
+
+As with every API we will be releasing new versions from time to time. We do promise to adhere to the following API contract:
+
+- No value types or fields will be changed or deleted in the same API version
+- What we will change within the same API version:
+  - add new fields to an object
+  - add new API endpoints
+  - required fields can become optional
+  - endpoints can become deprecated
+
+In case we introduce breaking changes we will adjust the API base path to reflect each new major version.

conf.py

@@ -22,6 +22,8 @@
 # sys.path.insert(0, os.path.abspath('.'))
 
 from recommonmark.parser import CommonMarkParser
+import sphinx_rtd_theme
+import sphinx_modern_theme
 
 # -- General configuration ------------------------------------------------
 
@@ -32,7 +34,14 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = []
+extensions = [
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.mathjax",
+    "sphinx.ext.viewcode",
+    'recommonmark',
+    'sphinx_rtd_theme'
+]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -52,18 +61,18 @@
 master_doc = 'index'
 
 # General information about the project.
-project = 'aiphilos'
-copyright = '2018, aiPhilos'
-author = 'aiPhilos'
+project = 'aiPhilos'
+copyright = '2021, aiPhilos'
+author = 'aiPhilos GmbH'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = '1.0'
+version = '1.1'
 # The full version, including alpha/beta/rc tags.
-release = '1.0'
+release = '1.1-alpha'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -90,17 +99,23 @@
 # a list of builtin themes.
 #
 html_theme = 'sphinx_rtd_theme'
+html_theme = 'sphinx_modern_theme'
+html_theme_path = [sphinx_modern_theme.get_html_theme_path()]
+html_logo = 'shared/img/logo.svg'
+html_show_sourcelink = False
+html_show_sphinx = True
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
 #
 # html_theme_options = {}
 
+
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = []
 
 # Custom sidebar templates, must be a dictionary that maps document names
 # to template names.

index.rst

@@ -5,39 +5,49 @@ aiPhilos Documentation
 
 Welcome to the official aiPhilos documentation.
 
+Links
+-----
+
 .. _a link: https://domain.invalid/
 
-If you are interested in our full API-Documentation, follow this link:
+Full API-Documentation:
 
 .. include:: shared/docLinks/swaggerLink.txt
 
+aiPhilos on GitHub:
+
+.. include:: shared/docLinks/githubLink.txt
+
+Content
+-------
+
 .. toctree::
    :maxdepth: 2
-   :caption: About aiPhilos
-   :name: sec-about
+   :caption: Concepts
+   :name: sec-concepts
 
-   about/index
+   concepts/index
 
 .. toctree::
    :maxdepth: 2
-   :caption: Getting Started
-   :name: sec-getting_started
+   :caption: Integrations
+   :name: sec-integrations
 
-   getting_started/integration  
+   integrations/standard
+   integrations/development
 
 .. toctree::
    :maxdepth: 2
-   :caption: Development
-   :name: sec-dev
+   :caption: Ressources
+   :name: sec-ressources
 
-   dev/sdks
-   dev/plugin_dev
-   dev/terminology
+   ressources/sdks
+   ressources/terminology
 
-Index And Directories
-=======================
+.. toctree::
+   :maxdepth: 2
+   :caption: aiPhilos
+   :name: sec-aiphilos
 
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+   aiphilos/index
 

integrations/backend.rst

@@ -0,0 +1,113 @@
+==================
+Backend
+==================
+
+
+Important Configuration Options
+===============================
+
+
+
+ Your integration will need to provide the following settings. The names are suggestions.
+
+ **active**
+
+ This setting should determine whether or not the AI search is active. Since aiPhilos needs to analyze and interpret the data before delivering reliable results, in addition to 
+ **on** or **off** a third option should be made available: **preparation**. This mode syncs the products to the aiPhilos-Cloud, but still retain the native search behaviour. After 
+ a certain period of time the setting can be switched to **on** at which point the search requests and results should be made via the aiPhilos api. 
+
+ **username**
+
+ Similar to developers, users will need to create an account with aiPhilos to authorize with our cloud services. This is where they enter their username.
+
+ **password**
+
+ Similar to developers, users will need to create an account with aiPhilos to authorize with our cloud services. This is where they enter their password.
+
+ **database name**
+
+ The name of the aiPhilos database used by the shop. This must be a unique name comprised of only upper and lower case letters from the English alphabet numbers and underscores.
+
+ **fallback**
+
+ This option should let the user configure if and under what conditions the search should fall back to systems default search.
+
+ * errors and no results (default)
+
+ Fall back to the default search when either no results are found by aiPhilos or an error occurs. This should be the default setting.
+
+ * Only on errors (minimal recommendation)
+
+ Only fall back when an error occurs during the attempted aiPhilos search. This is the recommended minimum setting and especially useful once aiPhilos has fully learned your article data and the results have become good enough that you can be certain that if aiPhilos finds nothing, nothing is the correct result.
+
+ * Only when no results are returned
+
+ Only fall back if aiPhilos returns no results. This option should exist mostly for the sake of completeness.
+
+
+Store system Configuration Options
+==================================
+
+Main Website
+^^^^^^^^^^^^
+
+Possible configurations. Accessible after unchecking "use default option":
+
+ * Activate aiPhilos search: yes/no
+ * Change username
+ * Change password
+ * Database: Development/test environment/production environment
+ * Activate aiPhilos logs: yes/no
+
+Store Website
+^^^^^^^^^^^^^
+
+Possible configuration options for the store website backend you may implenet in your plugins:
+
+**General settings:**
+
+ Dynamic search: yes/no
+    * Activates/Deactivates the dynamic search for a very fast display of search results.
+
+ Waiting time 
+    * Sets the optimal waiting time in milliseconds
+
+ Activation Autocomplete from
+    * For entering the number of letters from which Autocomplete should be played (at least 3).
+
+ URL for no-results page
+    * Sets the URL of the no-results page in case no search results are found
+
+**Appearance for no-result page:**
+
+ Display top search results: yes/no
+    * Activates/Deactivates top search results of your store shown on the no-results page.
+
+ Number of top search results
+    * Defines the number of top search results to be displayed on the no-results page.
+
+ Displayed attributes: article name, article picture, article price
+    * Selection of attributes that should be displayed during autosuggest.
+
+**Suggestions for search terms:**
+
+ Activate autosuggest: yes/no
+    * Activates/Deactivates the display of search suggestions (top search results).
+
+
+Feature Configuration Options
+=============================
+
+Some features of aiPhios can be configured individually.
+
+
+**Autosuggest**
+
+You can choose weather you want to show variations of the same product or similar products to the search request. You can also make the items in the list apear in a small or wide shape.
+
+
+**Categories**
+
+While context search works automatically, you can also manually add data to the products of your shop to sort them into categories.
+Visitors can search for categories and browse through different items of a specific categorie.
+The categories work by using the search function. They can also be displayed on the shop website itself.