ksapi 1.18.3

Knowledge Stack API

ksapi

Knowledge Stack backend API for authentication and knowledge management

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 0.1.0
• Package version: 1.18.3
• Generator version: 7.16.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

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

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 ksapi

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import ksapi
from ksapi.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to http://localhost:8000
# See configuration.py for a list of all supported configuration parameters.
configuration = ksapi.Configuration(
    host = "http://localhost:8000"
)



# Enter a context with an instance of the API client
with ksapi.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = ksapi.ThreadMessagesApi(api_client)
    thread_id = 'thread_id_example' # str | 
    create_thread_message_request = ksapi.CreateThreadMessageRequest() # CreateThreadMessageRequest | 
    ks_uat = 'ks_uat_example' # str |  (optional)

    try:
        # Create Thread Message Handler
        api_response = api_instance.create_thread_message(thread_id, create_thread_message_request, ks_uat=ks_uat)
        print("The response of ThreadMessagesApi->create_thread_message:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ThreadMessagesApi->create_thread_message: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://localhost:8000

Class	Method	HTTP request	Description
ThreadMessagesApi	create_thread_message	POST /v1/threads/{thread_id}/messages	Create Thread Message Handler
ThreadMessagesApi	get_thread_message	GET /v1/threads/{thread_id}/messages/{message_id}	Get Thread Message Handler
ThreadMessagesApi	list_thread_messages	GET /v1/threads/{thread_id}/messages	List Thread Messages Handler
ThreadsApi	create_thread	POST /v1/threads	Create Thread Handler
ThreadsApi	delete_thread	DELETE /v1/threads/{thread_id}	Delete Thread Handler
ThreadsApi	get_thread	GET /v1/threads/{thread_id}	Get Thread Handler
ThreadsApi	list_threads	GET /v1/threads	List Threads Handler
ThreadsApi	update_thread	PATCH /v1/threads/{thread_id}	Update Thread Handler
AuthApi	create_password_user	POST /v1/auth/pw/user	Create Password User Handler
AuthApi	initiate_sso	POST /v1/auth/sso/initiate	Initiate Sso Handler
AuthApi	oauth2_callback	GET /v1/auth/sso/oauth2/callback	Oauth2 Callback Handler
AuthApi	pw_email_verification	POST /v1/auth/pw/email_verification	Pw Email Verification Handler
AuthApi	pw_signin	POST /v1/auth/pw/signin	Signin Handler
AuthApi	refresh_uat	POST /v1/auth/uat	Refresh Uat Handler
AuthApi	reset_password	POST /v1/auth/pw/reset	Reset Password Handler
AuthApi	reset_password_with_token	POST /v1/auth/pw/reset_with_token	Reset Password With Token Handler
AuthApi	send_pw_reset_email	POST /v1/auth/pw/send_reset_email	Send Pw Reset Email Handler
AuthApi	signout	POST /v1/auth/signout	Signout Handler
ChunkLineagesApi	create_chunk_lineage	POST /v1/chunk-lineages	Create Chunk Lineage Handler
ChunkLineagesApi	delete_chunk_lineage	DELETE /v1/chunk-lineages	Delete Chunk Lineage Handler
ChunkLineagesApi	get_chunk_lineage	GET /v1/chunk-lineages/{chunk_id}	Get Chunk Lineage Handler
ChunksApi	create_chunk	POST /v1/chunks	Create Chunk Handler
ChunksApi	delete_chunk	DELETE /v1/chunks/{chunk_id}	Delete Chunk Handler
ChunksApi	get_chunk	GET /v1/chunks/{chunk_id}	Get Chunk Handler
ChunksApi	search_chunks	POST /v1/chunks/search	Search Chunks Handler
ChunksApi	update_chunk_content	PATCH /v1/chunks/{chunk_id}/content	Update Chunk Content Handler
ChunksApi	update_chunk_metadata	PATCH /v1/chunks/{chunk_id}	Update Chunk Metadata Handler
DefaultApi	health_check	GET /healthz	Health Check Handler
DefaultApi	hello	GET /	Root Handler
DocumentVersionsApi	create_document_version	POST /v1/documents/{document_id}/versions	Create Document Version Handler
DocumentVersionsApi	delete_document_version	DELETE /v1/document_versions/{version_id}	Delete Document Version Handler
DocumentVersionsApi	get_document_version	GET /v1/document_versions/{version_id}	Get Document Version Handler
DocumentVersionsApi	get_document_version_contents	GET /v1/document_versions/{version_id}/contents	Get Document Version Contents Handler
DocumentVersionsApi	list_document_versions	GET /v1/document_versions	List Document Versions Handler
DocumentVersionsApi	update_document_version_metadata	PATCH /v1/document_versions/{version_id}/metadata	Update Document Version Metadata Handler
DocumentsApi	create_document	POST /v1/documents	Create Document Handler
DocumentsApi	delete_document	DELETE /v1/documents/{document_id}	Delete Document Handler
DocumentsApi	get_document	GET /v1/documents/{document_id}	Get Document Handler
DocumentsApi	ingest_document	POST /v1/documents/ingest	Ingest Document Handler
DocumentsApi	list_documents	GET /v1/documents	List Documents Handler
DocumentsApi	update_document	PATCH /v1/documents/{document_id}	Update Document Handler
FoldersApi	create_folder	POST /v1/folders	Create Folder Handler
FoldersApi	delete_folder	DELETE /v1/folders/{folder_id}	Delete Folder Handler
FoldersApi	get_folder	GET /v1/folders/{folder_id}	Get Folder Handler
FoldersApi	list_folder_contents	GET /v1/folders/{folder_id}/contents	List Folder Contents Handler
FoldersApi	list_folders	GET /v1/folders	List Folders Handler
FoldersApi	update_folder	PATCH /v1/folders/{folder_id}	Update Folder Handler
InvitesApi	accept_invite	POST /v1/invites/{invite_id}/accept	Accept Invite
InvitesApi	create_invite	POST /v1/invites	Create Invite
InvitesApi	delete_invite	DELETE /v1/invites/{invite_id}	Delete Invite
InvitesApi	list_invites	GET /v1/invites	List Invites Handler
PathPartsApi	get_path_part	GET /v1/path-parts/{path_part_id}	Get Path Part Handler
PathPartsApi	list_path_parts	GET /v1/path-parts	List Path Parts Handler
SectionsApi	create_section	POST /v1/sections	Create Section Handler
SectionsApi	delete_section	DELETE /v1/sections/{section_id}	Delete Section Handler
SectionsApi	get_section	GET /v1/sections/{section_id}	Get Section Handler
SectionsApi	update_section	PATCH /v1/sections/{section_id}	Update Section Handler
TagsApi	attach_tag_to_path_part	POST /v1/tags/{tag_id}/path-parts	Attach Tag Handler
TagsApi	create_tag	POST /v1/tags	Create Tag Handler
TagsApi	delete_tag	DELETE /v1/tags/{tag_id}	Delete Tag Handler
TagsApi	detach_tag_from_path_part	DELETE /v1/tags/{tag_id}/path-parts/{path_part_id}	Detach Tag Handler
TagsApi	get_tag	GET /v1/tags/{tag_id}	Get Tag Handler
TagsApi	list_tags	GET /v1/tags	List Tags Handler
TagsApi	update_tag	PATCH /v1/tags/{tag_id}	Update Tag Handler
TenantsApi	create_tenant	POST /v1/tenants	Create Tenant
TenantsApi	delete_tenant	DELETE /v1/tenants/{tenant_id}	Delete Tenant
TenantsApi	get_tenant	GET /v1/tenants/{tenant_id}	Get Tenant
TenantsApi	list_tenant_users	GET /v1/tenants/{tenant_id}/users	List Tenant Users
TenantsApi	list_tenants	GET /v1/tenants	List Tenants
TenantsApi	update_tenant	PATCH /v1/tenants/{tenant_id}	Update Tenant
UserPermissionsApi	create_user_permission	POST /v1/user-permissions	Create User Permission Handler
UserPermissionsApi	delete_user_permission	DELETE /v1/user-permissions/{permission_id}	Delete User Permission Handler
UserPermissionsApi	list_user_permissions	GET /v1/user-permissions	List User Permissions Handler
UserPermissionsApi	update_user_permission	PATCH /v1/user-permissions/{permission_id}	Update User Permission Handler
UsersApi	get_me	GET /v1/users/me	Get Me Handler
UsersApi	update_me	PATCH /v1/users	Update Me Handler
WorkflowsApi	get_workflow	GET /v1/workflows/{workflow_id}	Get Workflow Handler
WorkflowsApi	list_workflows	GET /v1/workflows	List Workflows Handler
WorkflowsApi	workflow_action	POST /v1/workflows/{workflow_id}	Workflow Action Handler

Documentation For Models

• ChunkLineageResponse
• ChunkMetadataInput
• ChunkMetadataOutput
• ChunkResponse
• ChunkSearchRequest
• ChunkType
• CreateChunkLineageRequest
• CreateChunkRequest
• CreateDocumentRequest
• CreateFolderRequest
• CreatePasswordUserRequest
• CreatePermissionRequest
• CreateSectionRequest
• CreateTagRequest
• CreateTenantRequest
• CreateThreadMessageRequest
• CreateThreadRequest
• DocumentContentPathPart
• DocumentOrigin
• DocumentResponse
• DocumentType
• DocumentVersionMetadata
• DocumentVersionMetadataUpdate
• DocumentVersionResponse
• EmailSentResponse
• EmailVerificationRequest
• EmbeddingModel
• FolderDocumentResponse
• FolderResponse
• HTTPValidationError
• HealthCheckResponse
• IdpType
• IngestDocumentResponse
• InviteResponse
• InviteStatus
• InviteUserRequest
• LineageEdgeResponse
• LineageGraphResponse
• LineageNodeResponse
• MessageRole
• OAuth2Config
• PaginatedResponseDocumentContentPathPart
• PaginatedResponseDocumentResponse
• PaginatedResponseDocumentVersionResponse
• PaginatedResponseFolderDocumentResponse
• PaginatedResponseFolderResponse
• PaginatedResponseInviteResponse
• PaginatedResponsePathPartResponse
• PaginatedResponsePermissionResponse
• PaginatedResponseTagResponse
• PaginatedResponseTenantResponse
• PaginatedResponseTenantUserInTenantResponse
• PaginatedResponseThreadMessageResponse
• PaginatedResponseThreadResponse
• PaginatedResponseWorkflowSummaryResponse
• PartType
• PasswordResetRequest
• PasswordResetWithTokenRequest
• PathOrder
• PathPartResponse
• PermissionCapability
• PermissionResponse
• PipelineState
• PipelineStatus
• Polygon
• PolygonReference
• RootResponse
• ScoredChunkResponse
• SectionResponse
• SignInRequest
• TagPathPartRequest
• TagResponse
• TenantResponse
• TenantUserInTenantResponse
• TenantUserRole
• ThreadMessageResponse
• ThreadResponse
• UpdateChunkContentRequest
• UpdateChunkMetadataRequest
• UpdateDocumentRequest
• UpdateFolderRequest
• UpdatePermissionRequest
• UpdateSectionRequest
• UpdateTagRequest
• UpdateTenantRequest
• UpdateThreadRequest
• UpdateUserRequest
• UserResponse
• ValidationError
• ValidationErrorLocInner
• WorkflowAction
• WorkflowActionResponse
• WorkflowDetailResponse
• WorkflowSummaryResponse

Documentation For Authorization

Endpoints do not require authorization.

Author