Skip to content

Update SDK with new Annotation Types, Message Reasoning, & Message Chunks #99

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 5, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,3 +28,5 @@ coverage.xml
*.cover

.idea

venv
26 changes: 25 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -7,19 +7,36 @@ scaleapi/api_client/v2/api_response.py
scaleapi/api_client/v2/configuration.py
scaleapi/api_client/v2/exceptions.py
scaleapi/api_client/v2/models/__init__.py
scaleapi/api_client/v2/models/annotation_boolean.py
scaleapi/api_client/v2/models/annotation_boolean_properties.py
scaleapi/api_client/v2/models/annotation_category.py
scaleapi/api_client/v2/models/annotation_category_multiple.py
scaleapi/api_client/v2/models/annotation_category_multiple_properties.py
scaleapi/api_client/v2/models/annotation_category_properties.py
scaleapi/api_client/v2/models/annotation_file.py
scaleapi/api_client/v2/models/annotation_file_properties.py
scaleapi/api_client/v2/models/annotation_file_properties_value.py
scaleapi/api_client/v2/models/annotation_integer.py
scaleapi/api_client/v2/models/annotation_integer_properties.py
scaleapi/api_client/v2/models/annotation_metadata.py
scaleapi/api_client/v2/models/annotation_ranked_choices.py
scaleapi/api_client/v2/models/annotation_ranked_choices_properties.py
scaleapi/api_client/v2/models/annotation_ranked_groups.py
scaleapi/api_client/v2/models/annotation_ranked_groups_properties.py
scaleapi/api_client/v2/models/annotation_text.py
scaleapi/api_client/v2/models/annotation_text_properties.py
scaleapi/api_client/v2/models/annotation_type.py
scaleapi/api_client/v2/models/annotation_workspace_container.py
scaleapi/api_client/v2/models/annotation_workspace_container_properties.py
scaleapi/api_client/v2/models/audio_file.py
scaleapi/api_client/v2/models/base_annotation.py
scaleapi/api_client/v2/models/base_chunk.py
scaleapi/api_client/v2/models/basic_file.py
scaleapi/api_client/v2/models/batch.py
scaleapi/api_client/v2/models/chunk.py
scaleapi/api_client/v2/models/chunk_text.py
scaleapi/api_client/v2/models/chunk_text_properties.py
scaleapi/api_client/v2/models/content_and_url.py
scaleapi/api_client/v2/models/delivery.py
scaleapi/api_client/v2/models/detailed_file.py
scaleapi/api_client/v2/models/error_detail.py
Expand All @@ -32,7 +49,6 @@ scaleapi/api_client/v2/models/expandable_enum_deliveries.py
scaleapi/api_client/v2/models/expandable_enum_delivery.py
scaleapi/api_client/v2/models/expandable_enum_task.py
scaleapi/api_client/v2/models/expandable_project.py
scaleapi/api_client/v2/models/file.py
scaleapi/api_client/v2/models/get_delivered_tasks_response.py
scaleapi/api_client/v2/models/get_deliveries_response.py
scaleapi/api_client/v2/models/get_task500_response.py
Expand All @@ -44,12 +60,20 @@ scaleapi/api_client/v2/models/message_role.py
scaleapi/api_client/v2/models/model_parameters.py
scaleapi/api_client/v2/models/option.py
scaleapi/api_client/v2/models/project.py
scaleapi/api_client/v2/models/reasoning.py
scaleapi/api_client/v2/models/reference_text.py
scaleapi/api_client/v2/models/sensitive_content_report.py
scaleapi/api_client/v2/models/submission.py
scaleapi/api_client/v2/models/task.py
scaleapi/api_client/v2/models/task_status.py
scaleapi/api_client/v2/models/thread.py
scaleapi/api_client/v2/models/turn.py
scaleapi/api_client/v2/models/v1_task_task_id_get200_response.py
scaleapi/api_client/v2/models/v1_task_task_id_get200_response_response.py
scaleapi/api_client/v2/models/workspace_container_config.py
scaleapi/api_client/v2/models/workspace_container_value.py
scaleapi/api_client/v2/models/workspace_execution_data.py
scaleapi/api_client/v2/models/workspace_execution_data_result.py
scaleapi/api_client/v2/models/workspace_execution_data_result_status.py
scaleapi/api_client/v2/models/workspace_file.py
scaleapi/api_client/v2/rest.py
8 changes: 4 additions & 4 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
default_language_version:
python: python3.8
python: python3.9
default_stages: [commit]

repos:
Expand All @@ -12,19 +12,19 @@ repos:
- id: check-yaml
- id: check-case-conflict
- repo: https://github.com/pycqa/isort
rev: 5.8.0
rev: 5.13.2
hooks:
- id: isort
name: isort
args: ["--profile", "black"]
exclude: ^scaleapi/api_client/
- repo: https://github.com/psf/black
rev: 20.8b1
rev: 25.1.0
hooks:
- id: black
exclude: ^scaleapi/api_client/
- repo: https://github.com/PyCQA/flake8
rev: 3.8.4
rev: 7.2.0
hooks:
- id: flake8
exclude: ^scaleapi/api_client/
Expand Down
2 changes: 1 addition & 1 deletion docs/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ tests/test_client.py::test_transcription_ok PASSED [
.........
```

#### 7. Updating auto-generated v2 client
### 7. Updating auto-generated v2 client

The V2 API client is auto-generated from openapi.yaml using the v2_generator.json config. Run this to update the client:

Expand Down
2 changes: 1 addition & 1 deletion scaleapi/_version.py
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
__version__ = "2.16.0"
__version__ = "2.17.0"
__package_name__ = "scaleapi"
106 changes: 90 additions & 16 deletions scaleapi/api_client/v2/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
# flake8: noqa

"""
GenAI API Spec
GenAI API Spec

Data Engine: Generative AI API Specification
Data Engine: Generative AI API Specification

The version of the OpenAPI document: 0.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)
The version of the OpenAPI document: 0.0.1
Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.
Do not edit the class manually.
""" # noqa: E501


Expand All @@ -32,19 +32,64 @@

# import models into sdk package
from scaleapi.api_client.v2.models.annotation import Annotation
from scaleapi.api_client.v2.models.annotation_boolean import AnnotationBoolean
from scaleapi.api_client.v2.models.annotation_boolean_properties import (
AnnotationBooleanProperties,
)
from scaleapi.api_client.v2.models.annotation_category import AnnotationCategory
from scaleapi.api_client.v2.models.annotation_category_multiple import AnnotationCategoryMultiple
from scaleapi.api_client.v2.models.annotation_category_multiple_properties import AnnotationCategoryMultipleProperties
from scaleapi.api_client.v2.models.annotation_category_properties import AnnotationCategoryProperties
from scaleapi.api_client.v2.models.annotation_category_multiple import (
AnnotationCategoryMultiple,
)
from scaleapi.api_client.v2.models.annotation_category_multiple_properties import (
AnnotationCategoryMultipleProperties,
)
from scaleapi.api_client.v2.models.annotation_category_properties import (
AnnotationCategoryProperties,
)
from scaleapi.api_client.v2.models.annotation_file import AnnotationFile
from scaleapi.api_client.v2.models.annotation_file_properties import (
AnnotationFileProperties,
)
from scaleapi.api_client.v2.models.annotation_file_properties_value import (
AnnotationFilePropertiesValue,
)
from scaleapi.api_client.v2.models.annotation_integer import AnnotationInteger
from scaleapi.api_client.v2.models.annotation_integer_properties import AnnotationIntegerProperties
from scaleapi.api_client.v2.models.annotation_integer_properties import (
AnnotationIntegerProperties,
)
from scaleapi.api_client.v2.models.annotation_metadata import AnnotationMetadata
from scaleapi.api_client.v2.models.annotation_ranked_choices import (
AnnotationRankedChoices,
)
from scaleapi.api_client.v2.models.annotation_ranked_choices_properties import (
AnnotationRankedChoicesProperties,
)
from scaleapi.api_client.v2.models.annotation_ranked_groups import (
AnnotationRankedGroups,
)
from scaleapi.api_client.v2.models.annotation_ranked_groups_properties import (
AnnotationRankedGroupsProperties,
)
from scaleapi.api_client.v2.models.annotation_text import AnnotationText
from scaleapi.api_client.v2.models.annotation_text_properties import AnnotationTextProperties
from scaleapi.api_client.v2.models.annotation_text_properties import (
AnnotationTextProperties,
)
from scaleapi.api_client.v2.models.annotation_type import AnnotationType
from scaleapi.api_client.v2.models.annotation_workspace_container import (
AnnotationWorkspaceContainer,
)
from scaleapi.api_client.v2.models.annotation_workspace_container_properties import (
AnnotationWorkspaceContainerProperties,
)
from scaleapi.api_client.v2.models.audio_file import AudioFile
from scaleapi.api_client.v2.models.base_annotation import BaseAnnotation
from scaleapi.api_client.v2.models.base_chunk import BaseChunk
from scaleapi.api_client.v2.models.basic_file import BasicFile
from scaleapi.api_client.v2.models.batch import Batch
from scaleapi.api_client.v2.models.chunk import Chunk
from scaleapi.api_client.v2.models.chunk_text import ChunkText
from scaleapi.api_client.v2.models.chunk_text_properties import ChunkTextProperties
from scaleapi.api_client.v2.models.content_and_url import ContentAndUrl
from scaleapi.api_client.v2.models.delivery import Delivery
from scaleapi.api_client.v2.models.detailed_file import DetailedFile
from scaleapi.api_client.v2.models.error_detail import ErrorDetail
Expand All @@ -53,12 +98,17 @@
from scaleapi.api_client.v2.models.expandable_annotation import ExpandableAnnotation
from scaleapi.api_client.v2.models.expandable_batch import ExpandableBatch
from scaleapi.api_client.v2.models.expandable_delivery import ExpandableDelivery
from scaleapi.api_client.v2.models.expandable_enum_deliveries import ExpandableEnumDeliveries
from scaleapi.api_client.v2.models.expandable_enum_delivery import ExpandableEnumDelivery
from scaleapi.api_client.v2.models.expandable_enum_deliveries import (
ExpandableEnumDeliveries,
)
from scaleapi.api_client.v2.models.expandable_enum_delivery import (
ExpandableEnumDelivery,
)
from scaleapi.api_client.v2.models.expandable_enum_task import ExpandableEnumTask
from scaleapi.api_client.v2.models.expandable_project import ExpandableProject
from scaleapi.api_client.v2.models.file import File
from scaleapi.api_client.v2.models.get_delivered_tasks_response import GetDeliveredTasksResponse
from scaleapi.api_client.v2.models.get_delivered_tasks_response import (
GetDeliveredTasksResponse,
)
from scaleapi.api_client.v2.models.get_deliveries_response import GetDeliveriesResponse
from scaleapi.api_client.v2.models.get_task500_response import GetTask500Response
from scaleapi.api_client.v2.models.get_tasks_response import GetTasksResponse
Expand All @@ -69,11 +119,35 @@
from scaleapi.api_client.v2.models.model_parameters import ModelParameters
from scaleapi.api_client.v2.models.option import Option
from scaleapi.api_client.v2.models.project import Project
from scaleapi.api_client.v2.models.reasoning import Reasoning
from scaleapi.api_client.v2.models.reference_text import ReferenceText
from scaleapi.api_client.v2.models.sensitive_content_report import (
SensitiveContentReport,
)
from scaleapi.api_client.v2.models.submission import Submission
from scaleapi.api_client.v2.models.task import Task
from scaleapi.api_client.v2.models.task_status import TaskStatus
from scaleapi.api_client.v2.models.thread import Thread
from scaleapi.api_client.v2.models.turn import Turn
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response import V1TaskTaskIdGet200Response
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response_response import V1TaskTaskIdGet200ResponseResponse
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response import (
V1TaskTaskIdGet200Response,
)
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response_response import (
V1TaskTaskIdGet200ResponseResponse,
)
from scaleapi.api_client.v2.models.workspace_container_config import (
WorkspaceContainerConfig,
)
from scaleapi.api_client.v2.models.workspace_container_value import (
WorkspaceContainerValue,
)
from scaleapi.api_client.v2.models.workspace_execution_data import (
WorkspaceExecutionData,
)
from scaleapi.api_client.v2.models.workspace_execution_data_result import (
WorkspaceExecutionDataResult,
)
from scaleapi.api_client.v2.models.workspace_execution_data_result_status import (
WorkspaceExecutionDataResultStatus,
)
from scaleapi.api_client.v2.models.workspace_file import WorkspaceFile
Loading