Skip to content

Commit 7829731

Browse files
EvanWang2EvanWang2
authored
Update SDK for v2 APIs (#101)
* Update SDK for v2 APIs * Update readme * Fix pause/resume test timing issue * Fix pause/resume test to handle empty batch behavior * Apply black formatting to test file * Update Version
1 parent f5dba5b commit 7829731

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+7580
-905
lines changed

‎.openapi-generator/FILES

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,17 @@ scaleapi/api_client/v2/models/annotation_file_properties.py
1818
scaleapi/api_client/v2/models/annotation_file_properties_value.py
1919
scaleapi/api_client/v2/models/annotation_integer.py
2020
scaleapi/api_client/v2/models/annotation_integer_properties.py
21+
scaleapi/api_client/v2/models/annotation_labeled_text.py
22+
scaleapi/api_client/v2/models/annotation_labeled_text_properties.py
2123
scaleapi/api_client/v2/models/annotation_metadata.py
2224
scaleapi/api_client/v2/models/annotation_ranked_choices.py
2325
scaleapi/api_client/v2/models/annotation_ranked_choices_properties.py
2426
scaleapi/api_client/v2/models/annotation_ranked_groups.py
2527
scaleapi/api_client/v2/models/annotation_ranked_groups_properties.py
28+
scaleapi/api_client/v2/models/annotation_rubric_criteria.py
29+
scaleapi/api_client/v2/models/annotation_rubric_criteria_properties.py
30+
scaleapi/api_client/v2/models/annotation_rubric_rating.py
31+
scaleapi/api_client/v2/models/annotation_rubric_rating_properties.py
2632
scaleapi/api_client/v2/models/annotation_text.py
2733
scaleapi/api_client/v2/models/annotation_text_properties.py
2834
scaleapi/api_client/v2/models/annotation_type.py
@@ -33,10 +39,17 @@ scaleapi/api_client/v2/models/base_annotation.py
3339
scaleapi/api_client/v2/models/base_chunk.py
3440
scaleapi/api_client/v2/models/basic_file.py
3541
scaleapi/api_client/v2/models/batch.py
42+
scaleapi/api_client/v2/models/batch_operation_request.py
43+
scaleapi/api_client/v2/models/batch_status.py
44+
scaleapi/api_client/v2/models/cancel_batch200_response.py
3645
scaleapi/api_client/v2/models/chunk.py
3746
scaleapi/api_client/v2/models/chunk_text.py
3847
scaleapi/api_client/v2/models/chunk_text_properties.py
3948
scaleapi/api_client/v2/models/content_and_url.py
49+
scaleapi/api_client/v2/models/create_batch_request.py
50+
scaleapi/api_client/v2/models/create_chat_task_request.py
51+
scaleapi/api_client/v2/models/criterion_definition.py
52+
scaleapi/api_client/v2/models/criterion_evaluation.py
4053
scaleapi/api_client/v2/models/delivery.py
4154
scaleapi/api_client/v2/models/detailed_file.py
4255
scaleapi/api_client/v2/models/error_detail.py
@@ -45,24 +58,37 @@ scaleapi/api_client/v2/models/expandable.py
4558
scaleapi/api_client/v2/models/expandable_annotation.py
4659
scaleapi/api_client/v2/models/expandable_batch.py
4760
scaleapi/api_client/v2/models/expandable_delivery.py
61+
scaleapi/api_client/v2/models/expandable_enum_batch.py
4862
scaleapi/api_client/v2/models/expandable_enum_deliveries.py
4963
scaleapi/api_client/v2/models/expandable_enum_delivery.py
5064
scaleapi/api_client/v2/models/expandable_enum_task.py
5165
scaleapi/api_client/v2/models/expandable_project.py
66+
scaleapi/api_client/v2/models/gen_ai_project_type.py
67+
scaleapi/api_client/v2/models/get_batch500_response.py
68+
scaleapi/api_client/v2/models/get_batches_response.py
5269
scaleapi/api_client/v2/models/get_delivered_tasks_response.py
5370
scaleapi/api_client/v2/models/get_deliveries_response.py
54-
scaleapi/api_client/v2/models/get_task500_response.py
71+
scaleapi/api_client/v2/models/get_projects_response.py
5572
scaleapi/api_client/v2/models/get_tasks_response.py
5673
scaleapi/api_client/v2/models/image_file.py
74+
scaleapi/api_client/v2/models/labeled_text_value.py
5775
scaleapi/api_client/v2/models/message.py
5876
scaleapi/api_client/v2/models/message_content.py
5977
scaleapi/api_client/v2/models/message_role.py
6078
scaleapi/api_client/v2/models/model_parameters.py
6179
scaleapi/api_client/v2/models/option.py
80+
scaleapi/api_client/v2/models/pause_batch200_response.py
6281
scaleapi/api_client/v2/models/project.py
6382
scaleapi/api_client/v2/models/reasoning.py
6483
scaleapi/api_client/v2/models/reference_text.py
84+
scaleapi/api_client/v2/models/resume_batch200_response.py
85+
scaleapi/api_client/v2/models/rubric.py
86+
scaleapi/api_client/v2/models/rubric_criteria_value.py
87+
scaleapi/api_client/v2/models/rubric_evaluation.py
88+
scaleapi/api_client/v2/models/rubric_rating_value.py
6589
scaleapi/api_client/v2/models/sensitive_content_report.py
90+
scaleapi/api_client/v2/models/set_batch_metadata_request.py
91+
scaleapi/api_client/v2/models/set_task_metadata_request.py
6692
scaleapi/api_client/v2/models/submission.py
6793
scaleapi/api_client/v2/models/task.py
6894
scaleapi/api_client/v2/models/task_status.py

‎README.rst

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -931,9 +931,42 @@ __ https://docs.genai.scale.com/get-started/quickstart
931931
* - **get_task**
932932
- **GET** /v2/task
933933
- Get a Task
934+
* - **create_chat_task**
935+
- **POST** /v2/task
936+
- Create a Chat Task
934937
* - **get_tasks**
935938
- **GET** /v2/tasks
936939
- Get Multiple Tasks
940+
* - **get_batch**
941+
- **GET** /v2/batch
942+
- Get a Batch
943+
* - **create_batch**
944+
- **POST** /v2/batch
945+
- Create a Batch
946+
* - **get_batches**
947+
- **GET** /v2/batches
948+
- Get Multiple Batches
949+
* - **finalize_batch**
950+
- **POST** /v2/batch/finalize
951+
- Finalize a Batch
952+
* - **pause_batch**
953+
- **POST** /v2/batch/pause
954+
- Pause a Batch
955+
* - **resume_batch**
956+
- **POST** /v2/batch/resume
957+
- Resume a Batch
958+
* - **cancel_batch**
959+
- **POST** /v2/batch/cancel
960+
- Cancel a Batch
961+
* - **set_batch_metadata**
962+
- **POST** /v2/batch/metadata
963+
- Set Batch Metadata
964+
* - **get_project**
965+
- **GET** /v2/project
966+
- Get a Project
967+
* - **get_projects**
968+
- **GET** /v2/projects
969+
- Get Multiple Projects
937970
* - **get_deliveries**
938971
- **GET** /v2/deliveries
939972
- List All Deliveries
@@ -966,6 +999,27 @@ For example:
966999
# Download task or do something!
9671000
print(task.task_id)
9681001
1002+
# Create a chat task
1003+
task = client.v2.create_chat_task(
1004+
project_name="My Chat Project",
1005+
template_variables={
1006+
"prompt": "Explain quantum computing",
1007+
"context": "For a general audience"
1008+
}
1009+
)
1010+
1011+
# Get a batch
1012+
batch = client.v2.get_batch('batch_123')
1013+
1014+
# Create a batch
1015+
batch = client.v2.create_batch(
1016+
name="My New Batch",
1017+
project="project_123"
1018+
)
1019+
1020+
# Finalize a batch
1021+
batch = client.v2.finalize_batch('batch_123')
1022+
9691023
9701024
Troubleshooting
9711025
_______________

‎scaleapi/_version.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,2 @@
1-
__version__ = "2.17.0"
1+
__version__ = "2.18.0"
22
__package_name__ = "scaleapi"

‎scaleapi/api_client/v2/__init__.py

Lines changed: 57 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -3,14 +3,14 @@
33
# flake8: noqa
44

55
"""
6-
GenAI API Spec
6+
GenAI API Spec
77
8-
Data Engine: Generative AI API Specification
8+
Data Engine: Generative AI API Specification
99
10-
The version of the OpenAPI document: 0.0.1
11-
Generated by OpenAPI Generator (https://openapi-generator.tech)
10+
The version of the OpenAPI document: 0.0.1
11+
Generated by OpenAPI Generator (https://openapi-generator.tech)
1212
13-
Do not edit the class manually.
13+
Do not edit the class manually.
1414
""" # noqa: E501
1515

1616

@@ -33,63 +33,48 @@
3333
# import models into sdk package
3434
from scaleapi.api_client.v2.models.annotation import Annotation
3535
from scaleapi.api_client.v2.models.annotation_boolean import AnnotationBoolean
36-
from scaleapi.api_client.v2.models.annotation_boolean_properties import (
37-
AnnotationBooleanProperties,
38-
)
36+
from scaleapi.api_client.v2.models.annotation_boolean_properties import AnnotationBooleanProperties
3937
from scaleapi.api_client.v2.models.annotation_category import AnnotationCategory
40-
from scaleapi.api_client.v2.models.annotation_category_multiple import (
41-
AnnotationCategoryMultiple,
42-
)
43-
from scaleapi.api_client.v2.models.annotation_category_multiple_properties import (
44-
AnnotationCategoryMultipleProperties,
45-
)
46-
from scaleapi.api_client.v2.models.annotation_category_properties import (
47-
AnnotationCategoryProperties,
48-
)
38+
from scaleapi.api_client.v2.models.annotation_category_multiple import AnnotationCategoryMultiple
39+
from scaleapi.api_client.v2.models.annotation_category_multiple_properties import AnnotationCategoryMultipleProperties
40+
from scaleapi.api_client.v2.models.annotation_category_properties import AnnotationCategoryProperties
4941
from scaleapi.api_client.v2.models.annotation_file import AnnotationFile
50-
from scaleapi.api_client.v2.models.annotation_file_properties import (
51-
AnnotationFileProperties,
52-
)
53-
from scaleapi.api_client.v2.models.annotation_file_properties_value import (
54-
AnnotationFilePropertiesValue,
55-
)
42+
from scaleapi.api_client.v2.models.annotation_file_properties import AnnotationFileProperties
43+
from scaleapi.api_client.v2.models.annotation_file_properties_value import AnnotationFilePropertiesValue
5644
from scaleapi.api_client.v2.models.annotation_integer import AnnotationInteger
57-
from scaleapi.api_client.v2.models.annotation_integer_properties import (
58-
AnnotationIntegerProperties,
59-
)
45+
from scaleapi.api_client.v2.models.annotation_integer_properties import AnnotationIntegerProperties
46+
from scaleapi.api_client.v2.models.annotation_labeled_text import AnnotationLabeledText
47+
from scaleapi.api_client.v2.models.annotation_labeled_text_properties import AnnotationLabeledTextProperties
6048
from scaleapi.api_client.v2.models.annotation_metadata import AnnotationMetadata
61-
from scaleapi.api_client.v2.models.annotation_ranked_choices import (
62-
AnnotationRankedChoices,
63-
)
64-
from scaleapi.api_client.v2.models.annotation_ranked_choices_properties import (
65-
AnnotationRankedChoicesProperties,
66-
)
67-
from scaleapi.api_client.v2.models.annotation_ranked_groups import (
68-
AnnotationRankedGroups,
69-
)
70-
from scaleapi.api_client.v2.models.annotation_ranked_groups_properties import (
71-
AnnotationRankedGroupsProperties,
72-
)
49+
from scaleapi.api_client.v2.models.annotation_ranked_choices import AnnotationRankedChoices
50+
from scaleapi.api_client.v2.models.annotation_ranked_choices_properties import AnnotationRankedChoicesProperties
51+
from scaleapi.api_client.v2.models.annotation_ranked_groups import AnnotationRankedGroups
52+
from scaleapi.api_client.v2.models.annotation_ranked_groups_properties import AnnotationRankedGroupsProperties
53+
from scaleapi.api_client.v2.models.annotation_rubric_criteria import AnnotationRubricCriteria
54+
from scaleapi.api_client.v2.models.annotation_rubric_criteria_properties import AnnotationRubricCriteriaProperties
55+
from scaleapi.api_client.v2.models.annotation_rubric_rating import AnnotationRubricRating
56+
from scaleapi.api_client.v2.models.annotation_rubric_rating_properties import AnnotationRubricRatingProperties
7357
from scaleapi.api_client.v2.models.annotation_text import AnnotationText
74-
from scaleapi.api_client.v2.models.annotation_text_properties import (
75-
AnnotationTextProperties,
76-
)
58+
from scaleapi.api_client.v2.models.annotation_text_properties import AnnotationTextProperties
7759
from scaleapi.api_client.v2.models.annotation_type import AnnotationType
78-
from scaleapi.api_client.v2.models.annotation_workspace_container import (
79-
AnnotationWorkspaceContainer,
80-
)
81-
from scaleapi.api_client.v2.models.annotation_workspace_container_properties import (
82-
AnnotationWorkspaceContainerProperties,
83-
)
60+
from scaleapi.api_client.v2.models.annotation_workspace_container import AnnotationWorkspaceContainer
61+
from scaleapi.api_client.v2.models.annotation_workspace_container_properties import AnnotationWorkspaceContainerProperties
8462
from scaleapi.api_client.v2.models.audio_file import AudioFile
8563
from scaleapi.api_client.v2.models.base_annotation import BaseAnnotation
8664
from scaleapi.api_client.v2.models.base_chunk import BaseChunk
8765
from scaleapi.api_client.v2.models.basic_file import BasicFile
8866
from scaleapi.api_client.v2.models.batch import Batch
67+
from scaleapi.api_client.v2.models.batch_operation_request import BatchOperationRequest
68+
from scaleapi.api_client.v2.models.batch_status import BatchStatus
69+
from scaleapi.api_client.v2.models.cancel_batch200_response import CancelBatch200Response
8970
from scaleapi.api_client.v2.models.chunk import Chunk
9071
from scaleapi.api_client.v2.models.chunk_text import ChunkText
9172
from scaleapi.api_client.v2.models.chunk_text_properties import ChunkTextProperties
9273
from scaleapi.api_client.v2.models.content_and_url import ContentAndUrl
74+
from scaleapi.api_client.v2.models.create_batch_request import CreateBatchRequest
75+
from scaleapi.api_client.v2.models.create_chat_task_request import CreateChatTaskRequest
76+
from scaleapi.api_client.v2.models.criterion_definition import CriterionDefinition
77+
from scaleapi.api_client.v2.models.criterion_evaluation import CriterionEvaluation
9378
from scaleapi.api_client.v2.models.delivery import Delivery
9479
from scaleapi.api_client.v2.models.detailed_file import DetailedFile
9580
from scaleapi.api_client.v2.models.error_detail import ErrorDetail
@@ -98,56 +83,47 @@
9883
from scaleapi.api_client.v2.models.expandable_annotation import ExpandableAnnotation
9984
from scaleapi.api_client.v2.models.expandable_batch import ExpandableBatch
10085
from scaleapi.api_client.v2.models.expandable_delivery import ExpandableDelivery
101-
from scaleapi.api_client.v2.models.expandable_enum_deliveries import (
102-
ExpandableEnumDeliveries,
103-
)
104-
from scaleapi.api_client.v2.models.expandable_enum_delivery import (
105-
ExpandableEnumDelivery,
106-
)
86+
from scaleapi.api_client.v2.models.expandable_enum_batch import ExpandableEnumBatch
87+
from scaleapi.api_client.v2.models.expandable_enum_deliveries import ExpandableEnumDeliveries
88+
from scaleapi.api_client.v2.models.expandable_enum_delivery import ExpandableEnumDelivery
10789
from scaleapi.api_client.v2.models.expandable_enum_task import ExpandableEnumTask
10890
from scaleapi.api_client.v2.models.expandable_project import ExpandableProject
109-
from scaleapi.api_client.v2.models.get_delivered_tasks_response import (
110-
GetDeliveredTasksResponse,
111-
)
91+
from scaleapi.api_client.v2.models.gen_ai_project_type import GenAIProjectType
92+
from scaleapi.api_client.v2.models.get_batch500_response import GetBatch500Response
93+
from scaleapi.api_client.v2.models.get_batches_response import GetBatchesResponse
94+
from scaleapi.api_client.v2.models.get_delivered_tasks_response import GetDeliveredTasksResponse
11295
from scaleapi.api_client.v2.models.get_deliveries_response import GetDeliveriesResponse
113-
from scaleapi.api_client.v2.models.get_task500_response import GetTask500Response
96+
from scaleapi.api_client.v2.models.get_projects_response import GetProjectsResponse
11497
from scaleapi.api_client.v2.models.get_tasks_response import GetTasksResponse
11598
from scaleapi.api_client.v2.models.image_file import ImageFile
99+
from scaleapi.api_client.v2.models.labeled_text_value import LabeledTextValue
116100
from scaleapi.api_client.v2.models.message import Message
117101
from scaleapi.api_client.v2.models.message_content import MessageContent
118102
from scaleapi.api_client.v2.models.message_role import MessageRole
119103
from scaleapi.api_client.v2.models.model_parameters import ModelParameters
120104
from scaleapi.api_client.v2.models.option import Option
105+
from scaleapi.api_client.v2.models.pause_batch200_response import PauseBatch200Response
121106
from scaleapi.api_client.v2.models.project import Project
122107
from scaleapi.api_client.v2.models.reasoning import Reasoning
123108
from scaleapi.api_client.v2.models.reference_text import ReferenceText
124-
from scaleapi.api_client.v2.models.sensitive_content_report import (
125-
SensitiveContentReport,
126-
)
109+
from scaleapi.api_client.v2.models.resume_batch200_response import ResumeBatch200Response
110+
from scaleapi.api_client.v2.models.rubric import Rubric
111+
from scaleapi.api_client.v2.models.rubric_criteria_value import RubricCriteriaValue
112+
from scaleapi.api_client.v2.models.rubric_evaluation import RubricEvaluation
113+
from scaleapi.api_client.v2.models.rubric_rating_value import RubricRatingValue
114+
from scaleapi.api_client.v2.models.sensitive_content_report import SensitiveContentReport
115+
from scaleapi.api_client.v2.models.set_batch_metadata_request import SetBatchMetadataRequest
116+
from scaleapi.api_client.v2.models.set_task_metadata_request import SetTaskMetadataRequest
127117
from scaleapi.api_client.v2.models.submission import Submission
128118
from scaleapi.api_client.v2.models.task import Task
129119
from scaleapi.api_client.v2.models.task_status import TaskStatus
130120
from scaleapi.api_client.v2.models.thread import Thread
131121
from scaleapi.api_client.v2.models.turn import Turn
132-
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response import (
133-
V1TaskTaskIdGet200Response,
134-
)
135-
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response_response import (
136-
V1TaskTaskIdGet200ResponseResponse,
137-
)
138-
from scaleapi.api_client.v2.models.workspace_container_config import (
139-
WorkspaceContainerConfig,
140-
)
141-
from scaleapi.api_client.v2.models.workspace_container_value import (
142-
WorkspaceContainerValue,
143-
)
144-
from scaleapi.api_client.v2.models.workspace_execution_data import (
145-
WorkspaceExecutionData,
146-
)
147-
from scaleapi.api_client.v2.models.workspace_execution_data_result import (
148-
WorkspaceExecutionDataResult,
149-
)
150-
from scaleapi.api_client.v2.models.workspace_execution_data_result_status import (
151-
WorkspaceExecutionDataResultStatus,
152-
)
122+
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response import V1TaskTaskIdGet200Response
123+
from scaleapi.api_client.v2.models.v1_task_task_id_get200_response_response import V1TaskTaskIdGet200ResponseResponse
124+
from scaleapi.api_client.v2.models.workspace_container_config import WorkspaceContainerConfig
125+
from scaleapi.api_client.v2.models.workspace_container_value import WorkspaceContainerValue
126+
from scaleapi.api_client.v2.models.workspace_execution_data import WorkspaceExecutionData
127+
from scaleapi.api_client.v2.models.workspace_execution_data_result import WorkspaceExecutionDataResult
128+
from scaleapi.api_client.v2.models.workspace_execution_data_result_status import WorkspaceExecutionDataResultStatus
153129
from scaleapi.api_client.v2.models.workspace_file import WorkspaceFile

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy