nasa-impact / pynequa

A python library to handle communication with Sinequa's REST API.

Pynequa

A python library to handle communication with Sinequa REST API.

Sinequa is an enterprise search tool. It provides a cognitive search and analytics platform that helps organizations gain insights from their structured and unstructured data spread across various sources, including databases, documents, emails, websites, and more.

Installation

   $ pip install pynequa

Example Usage

import pynequa
from pynequa.models import QueryParams

# provide following config parameters
config = {
   "base_url": "",
   "app_name": "",
   "access_token":"",
   "query_name": ""
}

# initialize a Sinequa connector instance
sinequa=pynequa.Sinequa.from_config(config)

# OR
# you can directly instantiate Sinequa using
sinequa = pynequa.Sinequa(
     access_token: config["access_token"],
     base_url: config["base_url"],
     app_name: config["app_name"],
     query_name: config["query_name"],
)

params = QueryParams()
params.search_text = "<your_search_text>"
# other params

# perform a search query operation
results=sinequa.search_query(params)

Feature Roadmap

Implement following REST endpoints to manage requests with Sinequa API.

Search Endpoints:

• search.app
• search.dataset
• search.query
• queryintent
• search.profile
• search.usersettings
• search.preview
• search.queryexport
• search.recentqueries
• search.similardocuments
• search.querylinks
• search.ratings
• search.profile.subtree
• engine.sql
• search.alerts
• search.baskets
• search.labels
• serach.savedQueries
• search.suggest
• search.custom
• suggestField

Indexing Endpoints

• indexing.collection
• indexing.customCollection
• indexing.partition

Operating Task Endpoints

• operation.actionStatus
• operation.collectionStart
• operation.commandStart
• operation.jobStart
• operation.partitionStart
• operation.server
• operation.serverstatus
• operation.taskstatus

General Endpoints

• audit.notify
• admin.config
• dev.plugin
• multi

Development

Check DEVELOPERS GUIDE for details.

Contributing

When contributing to this repository, please first discuss the change you wish to make via issue, email, or any other method with the authors of this repository before making a change.

License

Distributed under the terms of the MIT license, pynequa is free and open source software.

pynequa's Issues

Add support for multiple AdvancedParams in QueryParams payload

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

Pynequa: Implement 2nd set of Search Endpoints

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

Tasks

Beta Give feedback

1. Implement endpoint methods
2. Update README
3. Update tests
4. Create a new release (0.2.0)
5. Verify if docs have been updated or not

Pynequa: Implement First Set of Search Endpoints

Description

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

Acceptance Criteria:

• Python package for Sinequa REST API

Tasks

Beta Give feedback

1. Implement Search Methods #2
   enhancement +1
   

PI Milestone: Open source python-sinequa library #161

Tasks

Beta Give feedback

1. Pynequa: Implement First Set of Search Endpoints #1
   1 of 1
   enhancement +1
   
2. Pynequa: Add documentation #4
   documentation +1
   
3. Pynequa: Add auto build and test scripts #5
   2 of 2
   enhancement +1
4. Pynequa: Release to pypi

Simplify the constructor for Sinequa class

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

Pynequa: Add auto build and test scripts

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

Tasks

Beta Give feedback

1. Add github build script
2. Add first set of unit tests

Pynequa: Add documentation

Description

Add README, contributing docs, license and package docs.

Acceptance Criteria:

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

Conduct meeting on the removal/change of the AI header

Add pre-commit config

Separate search APIs from core implementation

Restructuring Pynequa

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.

Tasks

Beta Give feedback

1. Add dataclasses for models #15
   +0
   
2. Separate search APIs from core implementation #16
   +0
3. Simplify the constructor for Sinequa class #17
   enhancement +1
   
4. Add pre-commit config #19
   +0
   

Add dataclasses for models