Metadata-Version: 2.4
Name: ginee-x
Version: 0.1.0
Summary: Official server-side Python SDK for the Ginee X API
Author: Ginee X
License-Expression: LicenseRef-Proprietary
Project-URL: Homepage, https://ginee-x.com
Project-URL: Documentation, https://docs.ginee-x.com
Project-URL: Repository, https://github.com/ginee-x/ginee-x-python
Keywords: ginee-x,ai,sdk,openapi
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: urllib3<3.0.0,>=2.1.0
Requires-Dist: python-dateutil>=2.8.2
Requires-Dist: pydantic>=2
Requires-Dist: typing-extensions>=4.7.1

# ginee-x
Public API for Ginee X conversations, workflows, and knowledge bases.

All identifier fields are represented as strings because Ginee X uses
64-bit Snowflake IDs that can exceed JavaScript's safe integer range.


This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:

- API version: 0.1.0
- Package version: 0.1.0
- Generator version: 7.14.0
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
For more information, please visit [https://ginee-x.com](https://ginee-x.com)

## Requirements.

Python 3.9+

## 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/ginee-x/ginee-x-python.git
```
(you may need to run `pip` with root permission: `sudo pip install git+https://github.com/ginee-x/ginee-x-python.git`)

Then import the package:
```python
import gineex
```

### 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 gineex
```

### Tests

Execute `pytest` to run the tests.

## Getting Started

Please follow the [installation procedure](#installation--usage) and then run the following:

```python

import gineex
from gineex.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://openapi.ginee-x.com/ginee-ai
# See configuration.py for a list of all supported configuration parameters.
configuration = gineex.Configuration(
    host = "https://openapi.ginee-x.com/ginee-ai"
)



# Enter a context with an instance of the API client
with gineex.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = gineex.AuthApi(api_client)
    create_token_request = gineex.CreateTokenRequest() # CreateTokenRequest | 

    try:
        # Create an access token
        api_response = api_instance.create_token(create_token_request)
        print("The response of AuthApi->create_token:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AuthApi->create_token: %s\n" % e)

```

## Documentation for API Endpoints

All URIs are relative to *https://openapi.ginee-x.com/ginee-ai*

Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*AuthApi* | [**create_token**](docs/AuthApi.md#create_token) | **POST** /llm/auth/token | Create an access token
*ChatApi* | [**search_knowledge**](docs/ChatApi.md#search_knowledge) | **POST** /llm/chat/search | Search chat knowledge
*ChatApi* | [**stream_chat**](docs/ChatApi.md#stream_chat) | **POST** /llm/chat/sse | Stream a chat response
*DocumentsApi* | [**get_document_process**](docs/DocumentsApi.md#get_document_process) | **POST** /llm/knowledge/doc/process/get | Get document processing state
*DocumentsApi* | [**list_documents**](docs/DocumentsApi.md#list_documents) | **POST** /llm/knowledge/doc/list | List documents in a knowledge base
*DocumentsApi* | [**preview_document**](docs/DocumentsApi.md#preview_document) | **POST** /llm/knowledge/doc/preview | Preview document segments
*DocumentsApi* | [**process_document**](docs/DocumentsApi.md#process_document) | **POST** /llm/knowledge/doc/process | Start processing an uploaded document
*DocumentsApi* | [**upload_document**](docs/DocumentsApi.md#upload_document) | **POST** /llm/knowledge/doc/upload | Upload a document
*KnowledgeBasesApi* | [**list_knowledge_bases**](docs/KnowledgeBasesApi.md#list_knowledge_bases) | **POST** /llm/knowledge/base/list | List knowledge bases
*WorkflowsApi* | [**get_workflow_run**](docs/WorkflowsApi.md#get_workflow_run) | **POST** /llm/agent/process/get | Get a workflow run
*WorkflowsApi* | [**list_workflows**](docs/WorkflowsApi.md#list_workflows) | **POST** /llm/agent/list | List workflows
*WorkflowsApi* | [**run_workflow**](docs/WorkflowsApi.md#run_workflow) | **POST** /llm/agent/process | Start a workflow run


## Documentation For Models

 - [ChatRequest](docs/ChatRequest.md)
 - [ChatStreamEvent](docs/ChatStreamEvent.md)
 - [ChatStreamEventAllOfData](docs/ChatStreamEventAllOfData.md)
 - [CreateTokenRequest](docs/CreateTokenRequest.md)
 - [CreateTokenResponse](docs/CreateTokenResponse.md)
 - [Document](docs/Document.md)
 - [DocumentPage](docs/DocumentPage.md)
 - [DocumentPreview](docs/DocumentPreview.md)
 - [DocumentSegment](docs/DocumentSegment.md)
 - [DocumentTask](docs/DocumentTask.md)
 - [DocumentTaskData](docs/DocumentTaskData.md)
 - [DocumentTaskResponse](docs/DocumentTaskResponse.md)
 - [ErrorResponse](docs/ErrorResponse.md)
 - [IdRequest](docs/IdRequest.md)
 - [KnowledgeBase](docs/KnowledgeBase.md)
 - [KnowledgeBasePage](docs/KnowledgeBasePage.md)
 - [KnowledgeSearchResult](docs/KnowledgeSearchResult.md)
 - [KnowledgeSearchResultData](docs/KnowledgeSearchResultData.md)
 - [KnowledgeType](docs/KnowledgeType.md)
 - [ListDocumentsRequest](docs/ListDocumentsRequest.md)
 - [ListDocumentsResponse](docs/ListDocumentsResponse.md)
 - [ListKnowledgeBasesResponse](docs/ListKnowledgeBasesResponse.md)
 - [ListRequest](docs/ListRequest.md)
 - [ListWorkflowsResponse](docs/ListWorkflowsResponse.md)
 - [PageMetadata](docs/PageMetadata.md)
 - [PreviewDocumentRequest](docs/PreviewDocumentRequest.md)
 - [PreviewDocumentResponse](docs/PreviewDocumentResponse.md)
 - [ProcessDocumentRequest](docs/ProcessDocumentRequest.md)
 - [ResponseMetadata](docs/ResponseMetadata.md)
 - [RunWorkflowRequest](docs/RunWorkflowRequest.md)
 - [SearchKnowledgeRequest](docs/SearchKnowledgeRequest.md)
 - [SearchKnowledgeResponse](docs/SearchKnowledgeResponse.md)
 - [TaskStatus](docs/TaskStatus.md)
 - [Token](docs/Token.md)
 - [UploadDocumentResponse](docs/UploadDocumentResponse.md)
 - [UploadDocumentResult](docs/UploadDocumentResult.md)
 - [Workflow](docs/Workflow.md)
 - [WorkflowNodeField](docs/WorkflowNodeField.md)
 - [WorkflowPage](docs/WorkflowPage.md)
 - [WorkflowProcessNode](docs/WorkflowProcessNode.md)
 - [WorkflowTask](docs/WorkflowTask.md)
 - [WorkflowTaskResponse](docs/WorkflowTaskResponse.md)


<a id="documentation-for-authorization"></a>
## Documentation For Authorization


Authentication schemes defined for the API:
<a id="bearerAuth"></a>
### bearerAuth

- **Type**: Bearer authentication (JWT)


## Author




