Merge pull request #17 from maisaai/release-please--branches--main--changes--next

release: 0.1.0-alpha.4

Author: GuillermoBlasco

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
 
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Install Rye
         run: |

.github/workflows/publish-pypi.yml

@@ -1,6 +1,6 @@
 # This workflow is triggered when a GitHub release is created.
 # It can also be run manually to re-publish to PyPI in case it failed for some reason.
-# You can run this workflow by navigating to https://www.github.com/clibrain/python-sdk/actions/workflows/publish-pypi.yml
+# You can run this workflow by navigating to https://www.github.com/maisaai/python-sdk/actions/workflows/publish-pypi.yml
 name: Publish PyPI
 on:
   workflow_dispatch:

.github/workflows/release-doctor.yml

@@ -7,7 +7,7 @@ jobs:
   release_doctor:
     name: release doctor
     runs-on: ubuntu-latest
-    if: github.repository == 'clibrain/python-sdk' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
+    if: github.repository == 'maisaai/python-sdk' && (github.event_name == 'push' || github.event_name == 'workflow_dispatch' || startsWith(github.head_ref, 'release-please') || github.head_ref == 'next')
 
     steps:
       - uses: actions/checkout@v3

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.3"
+  ".": "0.1.0-alpha.4"
 }

.stats.yml

@@ -1 +1 @@
-configured_endpoints: 14
+configured_endpoints: 15

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.4 (2024-03-05)
+
+Full Changelog: [v0.1.0-alpha.3...v0.1.0-alpha.4](https://github.com/maisaai/python-sdk/compare/v0.1.0-alpha.3...v0.1.0-alpha.4)
+
+### Features
+
+* update via SDK Studio ([#16](https://github.com/maisaai/python-sdk/issues/16)) ([c67fc05](https://github.com/maisaai/python-sdk/commit/c67fc05ae116d31bb6113c12b26c4192d1d669ee))
+
 ## 0.1.0-alpha.3 (2024-02-20)
 
 Full Changelog: [v0.1.0-alpha.2...v0.1.0-alpha.3](https://github.com/clibrain/python-sdk/compare/v0.1.0-alpha.2...v0.1.0-alpha.3)

CONTRIBUTING.md

@@ -59,7 +59,7 @@ If you’d like to use the repository from source, you can either install from g
 To install via git:
 
 ```bash
-pip install git+ssh://git@github.com:clibrain/python-sdk.git
+pip install git+ssh://git@github.com/maisaai/python-sdk.git
 ```
 
 Alternatively, you can build from source and install the wheel file:
@@ -82,7 +82,7 @@ pip install ./path-to-wheel-file.whl
 
 ## Running tests
 
-Most tests will require you to [setup a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
+Most tests require you to [set up a mock server](https://github.com/stoplightio/prism) against the OpenAPI spec to run the tests.
 
 ```bash
 # you will need npm installed
@@ -117,7 +117,7 @@ the changes aren't made through the automated pipeline, you may want to make rel
 
 ### Publish with a GitHub workflow
 
-You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/clibrain/python-sdk/actions/workflows/publish-pypi.yml). This will require a setup organization or repository secret to be set up.
+You can release to package managers by using [the `Publish PyPI` GitHub action](https://www.github.com/maisaai/python-sdk/actions/workflows/publish-pypi.yml). This requires a setup organization or repository secret to be set up.
 
 ### Publish manually
 

README.md

@@ -8,11 +8,12 @@ and offers both synchronous and asynchronous clients powered by [httpx](https://
 
 ## Documentation
 
-The REST API documentation can be found [on maisa.ai](https://maisa.ai/). The full API of this library can be found in [api.md](api.md).
+The REST API documentation can be found [on docs.maisa.ai](https://docs.maisa.ai/). The full API of this library can be found in [api.md](api.md).
 
 ## Installation
 
 ```sh
+# install from PyPI
 pip install --pre maisa
 ```
 
@@ -29,10 +30,10 @@ client = Maisa(
     api_key=os.environ.get("MAISA_API_KEY"),
 )
 
-embeddings = client.models.embeddings.create(
-    texts=["string"],
+text_summary = client.capabilities.summarize(
+    text="Example long text...",
 )
-print(embeddings.embeddings)
+print(text_summary.summary)
 ```
 
 While you can provide an `api_key` keyword argument,
@@ -56,10 +57,10 @@ client = AsyncMaisa(
 
 
 async def main() -> None:
-    embeddings = await client.models.embeddings.create(
-        texts=["string"],
+    text_summary = await client.capabilities.summarize(
+        text="Example long text...",
     )
-    print(embeddings.embeddings)
+    print(text_summary.summary)
 
 
 asyncio.run(main())
@@ -92,8 +93,8 @@ from maisa import Maisa
 client = Maisa()
 
 try:
-    client.models.embeddings.create(
-        texts=["string"],
+    client.capabilities.summarize(
+        text="Example long text...",
     )
 except maisa.APIConnectionError as e:
     print("The server could not be reached")
@@ -121,7 +122,7 @@ Error codes are as followed:
 
 ### Retries
 
-Certain errors are automatically retried 3 times by default, with a short exponential backoff.
+Certain errors are automatically retried 2 times by default, with a short exponential backoff.
 Connection errors (for example, due to a network connectivity problem), 408 Request Timeout, 409 Conflict,
 429 Rate Limit, and >=500 Internal errors are all retried by default.
 
@@ -137,8 +138,8 @@ client = Maisa(
 )
 
 # Or, configure per-request:
-client.with_options(max_retries=5).models.embeddings.create(
-    texts=["string"],
+client.with_options(max_retries=5).capabilities.summarize(
+    text="Example long text...",
 )
 ```
 
@@ -162,8 +163,8 @@ client = Maisa(
 )
 
 # Override per-request:
-client.with_options(timeout=5 * 1000).models.embeddings.create(
-    texts=["string"],
+client.with_options(timeout=5 * 1000).capabilities.summarize(
+    text="Example long text...",
 )
 ```
 
@@ -203,18 +204,18 @@ The "raw" Response object can be accessed by prefixing `.with_raw_response.` to
 from maisa import Maisa
 
 client = Maisa()
-response = client.models.embeddings.with_raw_response.create(
-    texts=["string"],
+response = client.capabilities.with_raw_response.summarize(
+    text="Example long text...",
 )
 print(response.headers.get('X-My-Header'))
 
-embedding = response.parse()  # get the object that `models.embeddings.create()` would have returned
-print(embedding.embeddings)
+capability = response.parse()  # get the object that `capabilities.summarize()` would have returned
+print(capability.summary)
 ```
 
-These methods return an [`APIResponse`](https://github.com/clibrain/python-sdk/tree/main/src/maisa/_response.py) object.
+These methods return an [`APIResponse`](https://github.com/maisaai/python-sdk/tree/main/src/maisa/_response.py) object.
 
-The async client returns an [`AsyncAPIResponse`](https://github.com/clibrain/python-sdk/tree/main/src/maisa/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
+The async client returns an [`AsyncAPIResponse`](https://github.com/maisaai/python-sdk/tree/main/src/maisa/_response.py) with the same structure, the only difference being `await`able methods for reading the response content.
 
 #### `.with_streaming_response`
 
@@ -223,8 +224,8 @@ The above interface eagerly reads the full response body when you make the reque
 To stream the response body, use `.with_streaming_response` instead, which requires a context manager and only reads the response body once you call `.read()`, `.text()`, `.json()`, `.iter_bytes()`, `.iter_text()`, `.iter_lines()` or `.parse()`. In the async client, these are async methods.
 
 ```python
-with client.models.embeddings.with_streaming_response.create(
-    texts=["string"],
+with client.capabilities.with_streaming_response.summarize(
+    text="Example long text...",
 ) as response:
     print(response.headers.get("X-My-Header"))
 
@@ -270,7 +271,7 @@ This package generally follows [SemVer](https://semver.org/spec/v2.0.0.html) con
 
 We take backwards-compatibility seriously and work hard to ensure you can rely on a smooth upgrade experience.
 
-We are keen for your feedback; please open an [issue](https://www.github.com/clibrain/python-sdk/issues) with questions, bugs, or suggestions.
+We are keen for your feedback; please open an [issue](https://www.github.com/maisaai/python-sdk/issues) with questions, bugs, or suggestions.
 
 ## Requirements
 

api.md

@@ -46,6 +46,18 @@ Methods:
 
 - <code title="post /v1/models/rerank">client.models.rerank.<a href="./src/maisa/resources/models/rerank.py">create</a>(\*\*<a href="src/maisa/types/models/rerank_create_params.py">params</a>) -> <a href="./src/maisa/types/models/rerank.py">Rerank</a></code>
 
+# Kpu
+
+Types:
+
+```python
+from maisa.types import KpuRunResponse
+```
+
+Methods:
+
+- <code title="post /v1/kpu/run">client.kpu.<a href="./src/maisa/resources/kpu.py">run</a>(\*\*<a href="src/maisa/types/kpu_run_params.py">params</a>) -> <a href="./src/maisa/types/kpu_run_response.py">KpuRunResponse</a></code>
+
 # FileInterpreter
 
 ## FromPdf

pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "maisa"
-version = "0.1.0-alpha.3"
+version = "0.1.0-alpha.4"
 description = "The official Python library for the Maisa API"
 readme = "README.md"
 license = "Apache-2.0"
@@ -39,8 +39,8 @@ classifiers = [
 
 
 [project.urls]
-Homepage = "https://github.com/clibrain/python-sdk"
-Repository = "https://github.com/clibrain/python-sdk"
+Homepage = "https://github.com/maisaai/python-sdk"
+Repository = "https://github.com/maisaai/python-sdk"