Skip to content

Latest commit

 

History

History
109 lines (85 loc) · 2.69 KB

README.md

File metadata and controls

109 lines (85 loc) · 2.69 KB
Raw

Pynequa

A python library to handle communication with Sinequa REST API.

Documentation Status Build

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.