Skip to content
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
28 changes: 27 additions & 1 deletion .openapi-generator/FILES
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,17 @@ 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_labeled_text.py
scaleapi/api_client/v2/models/annotation_labeled_text_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_rubric_criteria.py
scaleapi/api_client/v2/models/annotation_rubric_criteria_properties.py
scaleapi/api_client/v2/models/annotation_rubric_rating.py
scaleapi/api_client/v2/models/annotation_rubric_rating_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
Expand All @@ -33,10 +39,17 @@ 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/batch_operation_request.py
scaleapi/api_client/v2/models/batch_status.py
scaleapi/api_client/v2/models/cancel_batch200_response.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/create_batch_request.py
scaleapi/api_client/v2/models/create_chat_task_request.py
scaleapi/api_client/v2/models/criterion_definition.py
scaleapi/api_client/v2/models/criterion_evaluation.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 @@ -45,24 +58,37 @@ scaleapi/api_client/v2/models/expandable.py
scaleapi/api_client/v2/models/expandable_annotation.py
scaleapi/api_client/v2/models/expandable_batch.py
scaleapi/api_client/v2/models/expandable_delivery.py
scaleapi/api_client/v2/models/expandable_enum_batch.py
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/gen_ai_project_type.py
scaleapi/api_client/v2/models/get_batch500_response.py
scaleapi/api_client/v2/models/get_batches_response.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
scaleapi/api_client/v2/models/get_projects_response.py
scaleapi/api_client/v2/models/get_tasks_response.py
scaleapi/api_client/v2/models/image_file.py
scaleapi/api_client/v2/models/labeled_text_value.py
scaleapi/api_client/v2/models/message.py
scaleapi/api_client/v2/models/message_content.py
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/pause_batch200_response.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/resume_batch200_response.py
scaleapi/api_client/v2/models/rubric.py
scaleapi/api_client/v2/models/rubric_criteria_value.py
scaleapi/api_client/v2/models/rubric_evaluation.py
scaleapi/api_client/v2/models/rubric_rating_value.py
scaleapi/api_client/v2/models/sensitive_content_report.py
scaleapi/api_client/v2/models/set_batch_metadata_request.py
scaleapi/api_client/v2/models/set_task_metadata_request.py
scaleapi/api_client/v2/models/submission.py
scaleapi/api_client/v2/models/task.py
scaleapi/api_client/v2/models/task_status.py
Expand Down
54 changes: 54 additions & 0 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -931,9 +931,42 @@ __ https://docs.genai.scale.com/get-started/quickstart
* - **get_task**
- **GET** /v2/task
- Get a Task
* - **create_chat_task**
- **POST** /v2/task
- Create a Chat Task
* - **get_tasks**
- **GET** /v2/tasks
- Get Multiple Tasks
* - **get_batch**
- **GET** /v2/batch
- Get a Batch
* - **create_batch**
- **POST** /v2/batch
- Create a Batch
* - **get_batches**
- **GET** /v2/batches
- Get Multiple Batches
* - **finalize_batch**
- **POST** /v2/batch/finalize
- Finalize a Batch
* - **pause_batch**
- **POST** /v2/batch/pause
- Pause a Batch
* - **resume_batch**
- **POST** /v2/batch/resume
- Resume a Batch
* - **cancel_batch**
- **POST** /v2/batch/cancel
- Cancel a Batch
* - **set_batch_metadata**
- **POST** /v2/batch/metadata
- Set Batch Metadata
* - **get_project**
- **GET** /v2/project
- Get a Project
* - **get_projects**
- **GET** /v2/projects
- Get Multiple Projects
* - **get_deliveries**
- **GET** /v2/deliveries
- List All Deliveries
Expand Down Expand Up @@ -966,6 +999,27 @@ For example:
# Download task or do something!
print(task.task_id)

# Create a chat task
task = client.v2.create_chat_task(
project_name="My Chat Project",
template_variables={
"prompt": "Explain quantum computing",
"context": "For a general audience"
}
)

# Get a batch
batch = client.v2.get_batch('batch_123')

# Create a batch
batch = client.v2.create_batch(
name="My New Batch",
project="project_123"
)

# Finalize a batch
batch = client.v2.finalize_batch('batch_123')


Troubleshooting
_______________
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.17.0"
__version__ = "2.18.0"
__package_name__ = "scaleapi"
138 changes: 57 additions & 81 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 @@ -33,63 +33,48 @@
# 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_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_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_labeled_text import AnnotationLabeledText
from scaleapi.api_client.v2.models.annotation_labeled_text_properties import AnnotationLabeledTextProperties
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_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_rubric_criteria import AnnotationRubricCriteria
from scaleapi.api_client.v2.models.annotation_rubric_criteria_properties import AnnotationRubricCriteriaProperties
from scaleapi.api_client.v2.models.annotation_rubric_rating import AnnotationRubricRating
from scaleapi.api_client.v2.models.annotation_rubric_rating_properties import AnnotationRubricRatingProperties
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.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.batch_operation_request import BatchOperationRequest
from scaleapi.api_client.v2.models.batch_status import BatchStatus
from scaleapi.api_client.v2.models.cancel_batch200_response import CancelBatch200Response
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.create_batch_request import CreateBatchRequest
from scaleapi.api_client.v2.models.create_chat_task_request import CreateChatTaskRequest
from scaleapi.api_client.v2.models.criterion_definition import CriterionDefinition
from scaleapi.api_client.v2.models.criterion_evaluation import CriterionEvaluation
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 @@ -98,56 +83,47 @@
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_batch import ExpandableEnumBatch
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.get_delivered_tasks_response import (
GetDeliveredTasksResponse,
)
from scaleapi.api_client.v2.models.gen_ai_project_type import GenAIProjectType
from scaleapi.api_client.v2.models.get_batch500_response import GetBatch500Response
from scaleapi.api_client.v2.models.get_batches_response import GetBatchesResponse
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_projects_response import GetProjectsResponse
from scaleapi.api_client.v2.models.get_tasks_response import GetTasksResponse
from scaleapi.api_client.v2.models.image_file import ImageFile
from scaleapi.api_client.v2.models.labeled_text_value import LabeledTextValue
from scaleapi.api_client.v2.models.message import Message
from scaleapi.api_client.v2.models.message_content import MessageContent
from scaleapi.api_client.v2.models.message_role import MessageRole
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.pause_batch200_response import PauseBatch200Response
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.resume_batch200_response import ResumeBatch200Response
from scaleapi.api_client.v2.models.rubric import Rubric
from scaleapi.api_client.v2.models.rubric_criteria_value import RubricCriteriaValue
from scaleapi.api_client.v2.models.rubric_evaluation import RubricEvaluation
from scaleapi.api_client.v2.models.rubric_rating_value import RubricRatingValue
from scaleapi.api_client.v2.models.sensitive_content_report import SensitiveContentReport
from scaleapi.api_client.v2.models.set_batch_metadata_request import SetBatchMetadataRequest
from scaleapi.api_client.v2.models.set_task_metadata_request import SetTaskMetadataRequest
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.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.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