# artifact-client
API for interacting with the Artifact Client.
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) 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:
```sh
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:
```python
import artifact
```
### Setuptools
Install via [Setuptools](http://pypi.python.org/pypi/setuptools).
```sh
python setup.py install --user
```
(or `sudo python setup.py install` to install the package for all users)
Then import the package:
```python
import artifact
```
### Tests
Execute `pytest` to run the tests.
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
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**](docs/DefaultApi.md#create_graph) | **POST** /graphs | Create a new graph
*DefaultApi* | [**delete_all_graphs**](docs/DefaultApi.md#delete_all_graphs) | **POST** /graphs/delete_all | Deletes all graphs
*DefaultApi* | [**delete_graph**](docs/DefaultApi.md#delete_graph) | **POST** /graphs/{graphId}/delete | Delete a graph
*DefaultApi* | [**get_graph_documents_meta**](docs/DefaultApi.md#get_graph_documents_meta) | **POST** /graphs/{graphId}/documents_meta | Get graph documents meta
*DefaultApi* | [**get_graph_stats**](docs/DefaultApi.md#get_graph_stats) | **POST** /graphs/{graphId}/stats | Get graph statistics
*DefaultApi* | [**ingest_document**](docs/DefaultApi.md#ingest_document) | **POST** /graphs/{graphId}/ingest | Ingest a document into a graph
*DefaultApi* | [**list_graphs**](docs/DefaultApi.md#list_graphs) | **GET** /graphs | List all graphs
*DefaultApi* | [**query_graph**](docs/DefaultApi.md#query_graph) | **POST** /graphs/{graphId}/query | Query a graph
## Documentation For Models
- [CreateGraphRequest](docs/CreateGraphRequest.md)
- [DocumentMeta](docs/DocumentMeta.md)
- [Graph](docs/Graph.md)
- [GraphStats](docs/GraphStats.md)
- [IngestDocumentRequest](docs/IngestDocumentRequest.md)
- [QueryRequest](docs/QueryRequest.md)
- [QueryResult](docs/QueryResult.md)
<a id="documentation-for-authorization"></a>
## Documentation For Authorization
Authentication schemes defined for the API:
<a id="ApiKeyAuth"></a>
### ApiKeyAuth
- **Type**: API key
- **API key parameter name**: Authorization
- **Location**: HTTP header
## Author
Raw data
{
"_id": null,
"home_page": null,
"name": "artifact-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "Artifact, Artifact Client API, GraphRAG, Ozone",
"author": null,
"author_email": "Ozone Dev <ozone@ozone.tech>",
"download_url": "https://files.pythonhosted.org/packages/ba/59/3cb3f8e58a41c7a315f6ebe893eca5f29d35392495660cd8629fd830563e/artifact_client-2.4.5.tar.gz",
"platform": null,
"description": "# artifact-client\nAPI for interacting with the Artifact Client.\n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- API version: 1.0.0\n- Package version: 1.0.0\n- Generator version: 7.7.0\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nIf the python package is hosted on a repository, you can install directly using:\n\n```sh\npip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git\n```\n(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git`)\n\nThen import the package:\n\n```python\nimport artifact\n```\n\n### Setuptools\n\nInstall via [Setuptools](http://pypi.python.org/pypi/setuptools).\n\n```sh\npython setup.py install --user\n```\n(or `sudo python setup.py install` to install the package for all users)\n\nThen import the package:\n\n```python\nimport artifact\n```\n\n### Tests\n\nExecute `pytest` to run the tests.\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nimport os\nfrom artifact import ArtifactClient\nfrom artifact.models import ApiException\nfrom pprint import pprint\n\n# ArtifactClient wraps some of the boilerplate functionality needed to drive the\n# autogenerated code. The API key can be passed in to the constructor as `api_key`.\n# If not specified, the client looks for the key in the environment under ARTIFACT_API_KEY.\napi_client = ArtifactClient()\n\n# The client supports all the API endpoints. Below are examples of a few of the commonly used actions.\ngraph = api_client.create_graph(name=\"My First Graph\")\n\ndoc_str = (\n \"Input a corpus of text and save it as a string in memory. Then pass it to the ingest method.\"\n)\napi_client.ingest_document(graph.uuid, doc_str)\n\n# Kick off an async server process to index the graph\napi_client.index_graph(graph.uuid)\n\n# When the indexing completes, the graph is ready to be queried for useful information.\nresponse = api_client.query_graph(graph.uuid)\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://api.useartifact.ai*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*DefaultApi* | [**create_graph**](docs/DefaultApi.md#create_graph) | **POST** /graphs | Create a new graph\n*DefaultApi* | [**delete_all_graphs**](docs/DefaultApi.md#delete_all_graphs) | **POST** /graphs/delete_all | Deletes all graphs\n*DefaultApi* | [**delete_graph**](docs/DefaultApi.md#delete_graph) | **POST** /graphs/{graphId}/delete | Delete a graph\n*DefaultApi* | [**get_graph_documents_meta**](docs/DefaultApi.md#get_graph_documents_meta) | **POST** /graphs/{graphId}/documents_meta | Get graph documents meta\n*DefaultApi* | [**get_graph_stats**](docs/DefaultApi.md#get_graph_stats) | **POST** /graphs/{graphId}/stats | Get graph statistics\n*DefaultApi* | [**ingest_document**](docs/DefaultApi.md#ingest_document) | **POST** /graphs/{graphId}/ingest | Ingest a document into a graph\n*DefaultApi* | [**list_graphs**](docs/DefaultApi.md#list_graphs) | **GET** /graphs | List all graphs\n*DefaultApi* | [**query_graph**](docs/DefaultApi.md#query_graph) | **POST** /graphs/{graphId}/query | Query a graph\n\n\n## Documentation For Models\n\n - [CreateGraphRequest](docs/CreateGraphRequest.md)\n - [DocumentMeta](docs/DocumentMeta.md)\n - [Graph](docs/Graph.md)\n - [GraphStats](docs/GraphStats.md)\n - [IngestDocumentRequest](docs/IngestDocumentRequest.md)\n - [QueryRequest](docs/QueryRequest.md)\n - [QueryResult](docs/QueryResult.md)\n\n\n<a id=\"documentation-for-authorization\"></a>\n## Documentation For Authorization\n\n\nAuthentication schemes defined for the API:\n<a id=\"ApiKeyAuth\"></a>\n### ApiKeyAuth\n\n- **Type**: API key\n- **API key parameter name**: Authorization\n- **Location**: HTTP header\n\n\n## Author\n\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Python client for the Artifact API",
"version": "2.4.5",
"project_urls": {
"Homepage": "https://github.com/Ozone-App/artifact-python-client",
"Repository": "https://github.com/Ozone-App/artifact-python-client"
},
"split_keywords": [
"artifact",
" artifact client api",
" graphrag",
" ozone"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "cf48b0067e59e10ecaef4e4fdcb44b49f20894e335e3990ed97e606c5bcc0ad3",
"md5": "04d5bc654186bb9dbabc568a2922c7ae",
"sha256": "d3a6f4d396233edb7f7c1b8396ef1f3aa36a65af732558e351caac5657a3ccf1"
},
"downloads": -1,
"filename": "artifact_client-2.4.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "04d5bc654186bb9dbabc568a2922c7ae",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 73367,
"upload_time": "2024-10-04T21:37:15",
"upload_time_iso_8601": "2024-10-04T21:37:15.132566Z",
"url": "https://files.pythonhosted.org/packages/cf/48/b0067e59e10ecaef4e4fdcb44b49f20894e335e3990ed97e606c5bcc0ad3/artifact_client-2.4.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ba593cb3f8e58a41c7a315f6ebe893eca5f29d35392495660cd8629fd830563e",
"md5": "7429d45b5327f577f7c3d3027cff4bb5",
"sha256": "4aa90603988db2d29db2de15f0f4e38302a8bdaff604a6bfc8025d9600abbff1"
},
"downloads": -1,
"filename": "artifact_client-2.4.5.tar.gz",
"has_sig": false,
"md5_digest": "7429d45b5327f577f7c3d3027cff4bb5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 41011,
"upload_time": "2024-10-04T21:37:16",
"upload_time_iso_8601": "2024-10-04T21:37:16.235738Z",
"url": "https://files.pythonhosted.org/packages/ba/59/3cb3f8e58a41c7a315f6ebe893eca5f29d35392495660cd8629fd830563e/artifact_client-2.4.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 21:37:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Ozone-App",
"github_project": "artifact-python-client",
"github_not_found": true,
"lcname": "artifact-client"
}
JSON
