Python
Quickstart
Official Tinq.ai python SDK.
- API version: v2
- Package version: 0.2.27
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
(you may need to run pip
with root permission: `sudo pip install tinq
Then import the package:
Setuptools
Install via Setuptools.
(or sudo python setup.py install
to install the package for all users)
Then import the package:
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Endpoints
All URIs are relative to https://tinq.ai/api/v2
Class | Method | HTTP request | Description |
---|---|---|---|
Assistant | generate | POST /assistant | Generate |
Classifiers | classifiers | GET /classifiers | Classifiers |
Classifiers | classify | POST /classify | Classify |
Classifiers | sentiment_analysis | POST /sentiment-analysis | Sentiment Analysis |
PlagiarismChecker | check_plagiarism | POST /check-plagiarism | Check Plagiarism |
Projects | create_project | POST /projects | Create Project |
Projects | get_all_projects | GET /projects/ | Get All Projects |
Projects | get_project | GET /projects/ | Get Project |
Projects | update_project | PUT /projects/ | Update Project |
Scraper | extract_article | POST /scraper/extract-article | Extract article |
Scraper | google_search | POST /scraper/google | Google Search |
Scraper | scrape | POST /scraper/scrape | Scrape |
Tools | extract_text_from_file | POST /extract-text | Extract text from file |
Tools | extract_url | POST /extract-article | Extract URL |
Workflows | create_workflow | POST /workflows | Create workflow |
Workflows | execute_workflow | POST /workflows//execute | Execute workflow |
Workflows | get_one_workflow | GET /workflows/ | Get one workflow |
Workflows | get_workflows | GET /workflows | Get workflows |
Documentation For Models
Documentation For Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication