Description

Implement first set of search endpoints from Sinequa REST API docs.

Acceptance Criteria:

• Python package for Sinequa REST API

Description

Add README, contributing docs, license and package docs.

Acceptance Criteria:

• Proper README file
• Proper contributing directions
• License file
• Add readthedocs

Implement all remaining search.* endpoint methods and fix tests.

The endpoints include:

• search.alerts
• search.baskets
• search.labels
• search.savedQueries
• search.suggest
• search.custom
• suggestField
• engine.sql

This is an open issue to have discussions on restructuring pynequa hoping it will serve as documentation for future changes.

Currently, pynequa is organized as follows:

pynequa
|
|- core.py # contains main REST API method implementations for Sinequa
|- models.py # data models
|-api
   |-api.py # contains HTTP request implementations

This was the initial implementation of pynequa. With incoming changes, it is now time to think of re-structuring classes and separate search, index, collection, engine, extras implementations.

Description

Add github workflows to perform build on new push to develop/master branch. Include tests files.

Acceptance Criteria:

• Github build script
• Unit tests for implemented methods

Current implementation of QueryParams payload generation supports having only one advanced param. Refer to Sinequa's REST API docs and provide a way to support any number of advanced params.

cc: @CarsonDavis

Description

Currently pynequa.core.Sinequa class can only be initialized from a config dict. I propose moving the config-based construction to a new classmethod and use barebone parameters as a primary constructor

class Sinequa(API):
    def __init__(self, app_name=<default?>, query_name=<default?>, ..., debug: bool = False):
        pass

    @classmethod
    def from_config(cls, cfg: dict) -> Sinequa:
        pass

Why

Because we want more nuanced control of the construction without having to know what goes in the config. Normally config-based classes are initialized through secondary constructor