ksapi 2.10.2__tar.gz → 2.11.0__tar.gz

{ksapi-2.10.2 → ksapi-2.11.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 2.10.2
+Version: 2.11.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/__init__.py

@@ -14,7 +14,7 @@
 """  # noqa: E501
 
 
-__version__ = "2.10.2"
+__version__ = "2.11.0"
 
 # Define package exports
 __all__ = [
@@ -24,6 +24,7 @@ __all__ = [
     "SkillsApi",
     "ThreadMessagesApi",
     "ThreadsApi",
+    "TranscriptionsApi",
     "WorkflowDefinitionsApi",
     "WorkflowMemoryApi",
     "WorkflowRunsApi",
@@ -400,6 +401,7 @@ __all__ = [
     "ToolDisplayType",
     "ToolPart",
     "ToolStatus",
+    "TranscriptionResponse",
     "TransferOwnerRequest",
     "TransferOwnerResponse",
     "TrashItemDetailResponse",
@@ -470,6 +472,7 @@ from ksapi.api.memory_api import MemoryApi as MemoryApi
 from ksapi.api.skills_api import SkillsApi as SkillsApi
 from ksapi.api.thread_messages_api import ThreadMessagesApi as ThreadMessagesApi
 from ksapi.api.threads_api import ThreadsApi as ThreadsApi
+from ksapi.api.transcriptions_api import TranscriptionsApi as TranscriptionsApi
 from ksapi.api.workflow_definitions_api import WorkflowDefinitionsApi as WorkflowDefinitionsApi
 from ksapi.api.workflow_memory_api import WorkflowMemoryApi as WorkflowMemoryApi
 from ksapi.api.workflow_runs_api import WorkflowRunsApi as WorkflowRunsApi
@@ -850,6 +853,7 @@ from ksapi.models.timeseries_point import TimeseriesPoint as TimeseriesPoint
 from ksapi.models.tool_display_type import ToolDisplayType as ToolDisplayType
 from ksapi.models.tool_part import ToolPart as ToolPart
 from ksapi.models.tool_status import ToolStatus as ToolStatus
+from ksapi.models.transcription_response import TranscriptionResponse as TranscriptionResponse
 from ksapi.models.transfer_owner_request import TransferOwnerRequest as TransferOwnerRequest
 from ksapi.models.transfer_owner_response import TransferOwnerResponse as TransferOwnerResponse
 from ksapi.models.trash_item_detail_response import TrashItemDetailResponse as TrashItemDetailResponse

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/api/__init__.py

@@ -7,6 +7,7 @@ from ksapi.api.memory_api import MemoryApi
 from ksapi.api.skills_api import SkillsApi
 from ksapi.api.thread_messages_api import ThreadMessagesApi
 from ksapi.api.threads_api import ThreadsApi
+from ksapi.api.transcriptions_api import TranscriptionsApi
 from ksapi.api.workflow_definitions_api import WorkflowDefinitionsApi
 from ksapi.api.workflow_memory_api import WorkflowMemoryApi
 from ksapi.api.workflow_runs_api import WorkflowRunsApi

ksapi-2.11.0/ksapi/api/transcriptions_api.py

@@ -0,0 +1,332 @@
+"""
+    Knowledge Stack API
+
+    Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user's live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema's `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import warnings
+from pydantic import validate_call, Field, StrictFloat, StrictStr, StrictInt
+from typing import Any, Dict, List, Optional, Tuple, Union
+from typing_extensions import Annotated
+
+from pydantic import Field, StrictBytes, StrictStr
+from typing import Optional, Tuple, Union
+from typing_extensions import Annotated
+from ksapi.models.supported_language import SupportedLanguage
+from ksapi.models.transcription_response import TranscriptionResponse
+
+from ksapi.api_client import ApiClient, RequestSerialized
+from ksapi.api_response import ApiResponse
+from ksapi.rest import RESTResponseType
+
+
+class TranscriptionsApi:
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None) -> None:
+        if api_client is None:
+            api_client = ApiClient.get_default()
+        self.api_client = api_client
+
+
+    @validate_call
+    def create_transcription(
+        self,
+        file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend.")],
+        language: Optional[SupportedLanguage] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> TranscriptionResponse:
+        """Create Transcription Handler
+
+        Transcribe a short spoken clip to text.  **Answers synchronously.** Unlike document ingestion there is no `Location` header and nothing to poll — the transcript is in the response body. Expect roughly a second per 10s of audio.  Send `multipart/form-data` with a `file` part; add `language` only to pin `zh` or `en` instead of auto-detecting. The clip is re-encoded server-side to mono 16 kHz mp3, so any listed container works.  Limits: **25 MiB** and **5 min** per clip.  Errors, all carrying the standard `code`/`request_id` body: `413` clip over either limit · `415` content type not accepted · `422` empty clip, or audio that could not be decoded · `503` the speech backend is unreachable or unconfigured.  The audio is held for one ASR call and never persisted; the transcript is never logged.
+
+        :param file: The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend. (required)
+        :type file: bytes
+        :param language:
+        :type language: SupportedLanguage
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_transcription_serialize(
+            file=file,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "TranscriptionResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        ).data
+
+
+    @validate_call
+    def create_transcription_with_http_info(
+        self,
+        file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend.")],
+        language: Optional[SupportedLanguage] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> ApiResponse[TranscriptionResponse]:
+        """Create Transcription Handler
+
+        Transcribe a short spoken clip to text.  **Answers synchronously.** Unlike document ingestion there is no `Location` header and nothing to poll — the transcript is in the response body. Expect roughly a second per 10s of audio.  Send `multipart/form-data` with a `file` part; add `language` only to pin `zh` or `en` instead of auto-detecting. The clip is re-encoded server-side to mono 16 kHz mp3, so any listed container works.  Limits: **25 MiB** and **5 min** per clip.  Errors, all carrying the standard `code`/`request_id` body: `413` clip over either limit · `415` content type not accepted · `422` empty clip, or audio that could not be decoded · `503` the speech backend is unreachable or unconfigured.  The audio is held for one ASR call and never persisted; the transcript is never logged.
+
+        :param file: The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend. (required)
+        :type file: bytes
+        :param language:
+        :type language: SupportedLanguage
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_transcription_serialize(
+            file=file,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "TranscriptionResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        response_data.read()
+        return self.api_client.response_deserialize(
+            response_data=response_data,
+            response_types_map=_response_types_map,
+        )
+
+
+    @validate_call
+    def create_transcription_without_preload_content(
+        self,
+        file: Annotated[Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]], Field(description="The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend.")],
+        language: Optional[SupportedLanguage] = None,
+        _request_timeout: Union[
+            None,
+            Annotated[StrictFloat, Field(gt=0)],
+            Tuple[
+                Annotated[StrictFloat, Field(gt=0)],
+                Annotated[StrictFloat, Field(gt=0)]
+            ]
+        ] = None,
+        _request_auth: Optional[Dict[StrictStr, Any]] = None,
+        _content_type: Optional[StrictStr] = None,
+        _headers: Optional[Dict[StrictStr, Any]] = None,
+        _host_index: Annotated[StrictInt, Field(ge=0, le=0)] = 0,
+    ) -> RESTResponseType:
+        """Create Transcription Handler
+
+        Transcribe a short spoken clip to text.  **Answers synchronously.** Unlike document ingestion there is no `Location` header and nothing to poll — the transcript is in the response body. Expect roughly a second per 10s of audio.  Send `multipart/form-data` with a `file` part; add `language` only to pin `zh` or `en` instead of auto-detecting. The clip is re-encoded server-side to mono 16 kHz mp3, so any listed container works.  Limits: **25 MiB** and **5 min** per clip.  Errors, all carrying the standard `code`/`request_id` body: `413` clip over either limit · `415` content type not accepted · `422` empty clip, or audio that could not be decoded · `503` the speech backend is unreachable or unconfigured.  The audio is held for one ASR call and never persisted; the transcript is never logged.
+
+        :param file: The audio clip. Accepts what a browser records (audio/webm, audio/ogg, audio/mp4) plus audio/mpeg, audio/wav and audio/flac. Re-encoded server-side, so the container does not have to match the backend. (required)
+        :type file: bytes
+        :param language:
+        :type language: SupportedLanguage
+        :param _request_timeout: timeout setting for this request. If one
+                                 number provided, it will be total request
+                                 timeout. It can also be a pair (tuple) of
+                                 (connection, read) timeouts.
+        :type _request_timeout: int, tuple(int, int), optional
+        :param _request_auth: set to override the auth_settings for an a single
+                              request; this effectively ignores the
+                              authentication in the spec for a single request.
+        :type _request_auth: dict, optional
+        :param _content_type: force content-type for the request.
+        :type _content_type: str, Optional
+        :param _headers: set to override the headers for a single
+                         request; this effectively ignores the headers
+                         in the spec for a single request.
+        :type _headers: dict, optional
+        :param _host_index: set to override the host_index for a single
+                            request; this effectively ignores the host_index
+                            in the spec for a single request.
+        :type _host_index: int, optional
+        :return: Returns the result object.
+        """ # noqa: E501
+
+        _param = self._create_transcription_serialize(
+            file=file,
+            language=language,
+            _request_auth=_request_auth,
+            _content_type=_content_type,
+            _headers=_headers,
+            _host_index=_host_index
+        )
+
+        _response_types_map: Dict[str, Optional[str]] = {
+            '200': "TranscriptionResponse",
+            '422': "HTTPValidationError",
+        }
+        response_data = self.api_client.call_api(
+            *_param,
+            _request_timeout=_request_timeout
+        )
+        return response_data.response
+
+
+    def _create_transcription_serialize(
+        self,
+        file,
+        language,
+        _request_auth,
+        _content_type,
+        _headers,
+        _host_index,
+    ) -> RequestSerialized:
+
+        _host = None
+
+        _collection_formats: Dict[str, str] = {
+        }
+
+        _path_params: Dict[str, str] = {}
+        _query_params: List[Tuple[str, str]] = []
+        _header_params: Dict[str, Optional[str]] = _headers or {}
+        _form_params: List[Tuple[str, str]] = []
+        _files: Dict[
+            str, Union[str, bytes, List[str], List[bytes], List[Tuple[str, bytes]]]
+        ] = {}
+        _body_params: Optional[bytes] = None
+
+        # process the path parameters
+        # process the query parameters
+        # process the header parameters
+        # process the form parameters
+        if file is not None:
+            _files['file'] = file
+        if language is not None:
+            _form_params.append(('language', language))
+        # process the body parameter
+
+
+        # set the HTTP header `Accept`
+        if 'Accept' not in _header_params:
+            _header_params['Accept'] = self.api_client.select_header_accept(
+                [
+                    'application/json'
+                ]
+            )
+
+        # set the HTTP header `Content-Type`
+        if _content_type:
+            _header_params['Content-Type'] = _content_type
+        else:
+            _default_content_type = (
+                self.api_client.select_header_content_type(
+                    [
+                        'multipart/form-data'
+                    ]
+                )
+            )
+            if _default_content_type is not None:
+                _header_params['Content-Type'] = _default_content_type
+
+        # authentication setting
+        _auth_settings: List[str] = [
+            'cookieAuth', 
+            'bearerAuth'
+        ]
+
+        return self.api_client.param_serialize(
+            method='POST',
+            resource_path='/v1/transcriptions',
+            path_params=_path_params,
+            query_params=_query_params,
+            header_params=_header_params,
+            body=_body_params,
+            post_params=_form_params,
+            files=_files,
+            auth_settings=_auth_settings,
+            collection_formats=_collection_formats,
+            _host=_host,
+            _request_auth=_request_auth
+        )
+
+

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/api_client.py

@@ -91,7 +91,7 @@ class ApiClient:
             self.default_headers[header_name] = header_value
         self.cookie = cookie
         # Set default User-Agent.
-        self.user_agent = 'OpenAPI-Generator/2.10.2/python'
+        self.user_agent = 'OpenAPI-Generator/2.11.0/python'
         self.client_side_validation = configuration.client_side_validation
 
     def __enter__(self):

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/configuration.py

@@ -562,7 +562,7 @@ conf = ksapi.Configuration(
                "OS: {env}\n"\
                "Python Version: {pyversion}\n"\
                "Version of the API: 0.1.0\n"\
-               "SDK Package Version: 2.10.2".\
+               "SDK Package Version: 2.11.0".\
                format(env=sys.platform, pyversion=sys.version)
 
     def get_host_settings(self) -> List[HostSetting]:

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/models/__init__.py

@@ -345,6 +345,7 @@ from ksapi.models.timeseries_point import TimeseriesPoint
 from ksapi.models.tool_display_type import ToolDisplayType
 from ksapi.models.tool_part import ToolPart
 from ksapi.models.tool_status import ToolStatus
+from ksapi.models.transcription_response import TranscriptionResponse
 from ksapi.models.transfer_owner_request import TransferOwnerRequest
 from ksapi.models.transfer_owner_response import TransferOwnerResponse
 from ksapi.models.trash_item_detail_response import TrashItemDetailResponse

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi/models/error_response.py

@@ -36,8 +36,8 @@ class ErrorResponse(BaseModel):
     @field_validator('code')
     def code_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['error', 'bad_request', 'permission_limit', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'run_busy', 'unprocessable_entity', 'too_many_requests', 'quota_exceeded', 'not_implemented', 'service_configuration_error', 'quota_period_missing', 'internal_error', 'service_unavailable']):
-            raise ValueError("must be one of enum values ('error', 'bad_request', 'permission_limit', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'run_busy', 'unprocessable_entity', 'too_many_requests', 'quota_exceeded', 'not_implemented', 'service_configuration_error', 'quota_period_missing', 'internal_error', 'service_unavailable')")
+        if value not in set(['error', 'bad_request', 'permission_limit', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'run_busy', 'payload_too_large', 'unsupported_media_type', 'unprocessable_entity', 'too_many_requests', 'quota_exceeded', 'not_implemented', 'service_configuration_error', 'quota_period_missing', 'internal_error', 'service_unavailable']):
+            raise ValueError("must be one of enum values ('error', 'bad_request', 'permission_limit', 'unauthorized', 'forbidden', 'not_found', 'conflict', 'run_busy', 'payload_too_large', 'unsupported_media_type', 'unprocessable_entity', 'too_many_requests', 'quota_exceeded', 'not_implemented', 'service_configuration_error', 'quota_period_missing', 'internal_error', 'service_unavailable')")
         return value
 
     model_config = ConfigDict(

ksapi-2.11.0/ksapi/models/transcription_response.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    Knowledge Stack API
+
+    Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user's live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema's `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing import Any, ClassVar, Dict, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+from pydantic_core import to_jsonable_python
+
+class TranscriptionResponse(BaseModel):
+    """
+    A spoken clip rendered as text, ready to send as a chat message.
+    """ # noqa: E501
+    text: StrictStr = Field(description="The transcript. Empty when the clip contained no speech, which is a success, not an error.")
+    language: Optional[StrictStr] = Field(default=None, description="The language ASR detected, or the one the caller pinned. Null when the backend reports none; the text is still valid.")
+    __properties: ClassVar[List[str]] = ["text", "language"]
+
+    model_config = ConfigDict(
+        validate_by_name=True,
+        validate_by_alias=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        return json.dumps(to_jsonable_python(self.to_dict()))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of TranscriptionResponse from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if language (nullable) is None
+        # and model_fields_set contains the field
+        if self.language is None and "language" in self.model_fields_set:
+            _dict['language'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TranscriptionResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "language": obj.get("language")
+        })
+        return _obj
+
+

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ksapi
-Version: 2.10.2
+Version: 2.11.0
 Summary: Knowledge Stack API
 Home-page: 
 Author: OpenAPI Generator community

{ksapi-2.10.2 → ksapi-2.11.0}/ksapi.egg-info/SOURCES.txt

@@ -50,6 +50,7 @@ ksapi/api/tenant_groups_api.py
 ksapi/api/tenants_api.py
 ksapi/api/thread_messages_api.py
 ksapi/api/threads_api.py
+ksapi/api/transcriptions_api.py
 ksapi/api/trash_api.py
 ksapi/api/user_permissions_api.py
 ksapi/api/users_api.py
@@ -389,6 +390,7 @@ ksapi/models/timeseries_point.py
 ksapi/models/tool_display_type.py
 ksapi/models/tool_part.py
 ksapi/models/tool_status.py
+ksapi/models/transcription_response.py
 ksapi/models/transfer_owner_request.py
 ksapi/models/transfer_owner_response.py
 ksapi/models/trash_item_detail_response.py
@@ -817,6 +819,8 @@ test/test_timeseries_point.py
 test/test_tool_display_type.py
 test/test_tool_part.py
 test/test_tool_status.py
+test/test_transcription_response.py
+test/test_transcriptions_api.py
 test/test_transfer_owner_request.py
 test/test_transfer_owner_response.py
 test/test_trash_api.py

{ksapi-2.10.2 → ksapi-2.11.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "ksapi"
-version = "2.10.2"
+version = "2.11.0"
 description = "Knowledge Stack API"
 authors = [
   {name = "OpenAPI Generator Community",email = "team@openapitools.org"},

{ksapi-2.10.2 → ksapi-2.11.0}/setup.py

@@ -19,7 +19,7 @@ from setuptools import setup, find_packages  # noqa: H301
 # prerequisite: setuptools
 # http://pypi.python.org/pypi/setuptools
 NAME = "ksapi"
-VERSION = "2.10.2"
+VERSION = "2.11.0"
 PYTHON_REQUIRES = ">= 3.9"
 REQUIRES = [
     "urllib3 >= 2.1.0, < 3.0.0",

ksapi-2.11.0/test/test_transcription_response.py

@@ -0,0 +1,53 @@
+# coding: utf-8
+
+"""
+    Knowledge Stack API
+
+    Knowledge Stack backend API for authentication and knowledge management.  ## Integrating (RPA / machine clients)  **Base URL.** Knowledge Stack is self-hosted — point at your own deployment host (see `servers`). The `localhost` entry is for local development only.  **Authentication.** Send `Authorization: Bearer <api-key>` on every request. Mint an API key once via `POST /v1/api-keys` from a signed-in browser session; the raw `sk-user-...` secret is returned **only** at creation, so store it then. A key inherits its owning user's live tenant role and path permissions — create RPA keys from a least-privilege user, and set `expires_at` for rotation. The `ks_uat` cookie scheme is browser-only and cannot be used by headless clients.  **Async work is polled, not pushed.** There are no outbound webhooks. - `POST /v1/documents/ingest` returns `201` immediately with a `workflow_id`;   poll `GET /v1/system-jobs/document_versions/{workflow_id}` until `status` is   terminal (anything other than `pending`/`processing`). The `Location` response   header points at this poll resource. - `POST /v1/workflow-runs/{run_id}/start` returns `202`; poll   `GET /v1/workflow-runs/{run_id}` until `execution_state` is `COMPLETED` or   `FAILED`. The `Location` header points at the run resource. - `POST /v1/agent/ask` is **synchronous** — it blocks until the agent finishes   and returns the answer inline. Use a generous HTTP timeout.  **Pagination.** List endpoints accept `limit`/`offset` and return `{items, total, limit, offset}`.  **Errors.** Every non-2xx body is `{detail, code, request_id}`. `code` is a stable value from a closed set (see the `ErrorResponse` schema's `code` enum) — branch on it rather than parsing `detail`. Quota rejections return `429` with a `Retry-After` header; transient lock contention returns a retryable `503`. Quote `request_id` (also the `x-request-id` response header) to support.  **Idempotency.** `POST /v1/workflow-runs` accepts an `idempotency_key` to dedupe retried run creation. `agent/ask` charges one message *before* running and does not refund a client-cancelled call. 
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from ksapi.models.transcription_response import TranscriptionResponse
+
+class TestTranscriptionResponse(unittest.TestCase):
+    """TranscriptionResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> TranscriptionResponse:
+        """Test TranscriptionResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `TranscriptionResponse`
+        """
+        model = TranscriptionResponse()
+        if include_optional:
+            return TranscriptionResponse(
+                text = '请帮我总结这份文档',
+                language = 'zh'
+            )
+        else:
+            return TranscriptionResponse(
+                text = '请帮我总结这份文档',
+        )
+        """
+
+    def testTranscriptionResponse(self):
+        """Test TranscriptionResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()