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 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

Requirements.

Python 3.9+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

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:

import gineex

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 gineex

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

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

Documentation For Models

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

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (JWT)

Author