Python client for the Artifact API
Project description
artifact-client
API for interacting with the Artifact Client.
This Python package is automatically generated by the OpenAPI Generator project:
- API version: 1.0.0
- Package version: 1.0.0
- Generator version: 7.7.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
Requirements.
Python 3.7+
Installation & Usage
pip install
If the python package is hosted on a repository, you can install directly using:
pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
(you may need to run pip
with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git
)
Then import the package:
import artifact
Setuptools
Install via Setuptools.
python setup.py install --user
(or sudo python setup.py install
to install the package for all users)
Then import the package:
import artifact
Tests
Execute pytest
to run the tests.
Getting Started
Please follow the installation procedure and then run the following:
import os
from artifact import ArtifactClient
from artifact.models import ApiException
from pprint import pprint
# ArtifactClient wraps some of the boilerplate functionality needed to drive the
# autogenerated code. The API key can be passed in to the constructor as `api_key`.
# If not specified, the client looks for the key in the environment under ARTIFACT_API_KEY.
api_client = ArtifactClient()
# The client supports all the API endpoints. Below are examples of a few of the commonly used actions.
graph = api_client.create_graph(name="My First Graph")
doc_str = (
"Input a corpus of text and save it as a string in memory. Then pass it to the ingest method."
)
api_client.ingest_document(graph.uuid, doc_str)
# Kick off an async server process to index the graph
api_client.index_graph(graph.uuid)
# When the indexing completes, the graph is ready to be queried for useful information.
response = api_client.query_graph(graph.uuid)
Documentation for API Endpoints
All URIs are relative to https://api.useartifact.ai
Class | Method | HTTP request | Description |
---|---|---|---|
DefaultApi | create_graph | POST /graphs | Create a new graph |
DefaultApi | delete_all_graphs | POST /graphs/delete_all | Deletes all graphs |
DefaultApi | delete_graph | POST /graphs/{graphId}/delete | Delete a graph |
DefaultApi | get_graph_documents_meta | POST /graphs/{graphId}/documents_meta | Get graph documents meta |
DefaultApi | get_graph_stats | POST /graphs/{graphId}/stats | Get graph statistics |
DefaultApi | ingest_document | POST /graphs/{graphId}/ingest | Ingest a document into a graph |
DefaultApi | list_graphs | GET /graphs | List all graphs |
DefaultApi | query_graph | POST /graphs/{graphId}/query | Query a graph |
Documentation For Models
Documentation For Authorization
Authentication schemes defined for the API:
ApiKeyAuth
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header
Author
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for artifact_client-2.4.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b7dbfca1d13e2d0da9af28f1628d48c0b1063ee636f25c969803497857f6eccc |
|
MD5 | 504ea6c730223b100552d2b1fec48986 |
|
BLAKE2b-256 | d2fca3b9e78304c3fdba20b025aedfbdc4a10a64f70ca4fe0eaa15baa3410eb6 |