Skip to content

Commit a17b1bb

Browse files
committed
Update readme
1 parent 186f18e commit a17b1bb

File tree

13 files changed

+1267
-147
lines changed

13 files changed

+1267
-147
lines changed

.openapi-generator/FILES

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,14 +39,15 @@ scaleapi/api_client/v2/models/base_annotation.py
3939
scaleapi/api_client/v2/models/base_chunk.py
4040
scaleapi/api_client/v2/models/basic_file.py
4141
scaleapi/api_client/v2/models/batch.py
42+
scaleapi/api_client/v2/models/batch_operation_request.py
4243
scaleapi/api_client/v2/models/batch_status.py
4344
scaleapi/api_client/v2/models/cancel_batch200_response.py
4445
scaleapi/api_client/v2/models/chunk.py
4546
scaleapi/api_client/v2/models/chunk_text.py
4647
scaleapi/api_client/v2/models/chunk_text_properties.py
4748
scaleapi/api_client/v2/models/content_and_url.py
4849
scaleapi/api_client/v2/models/create_batch_request.py
49-
scaleapi/api_client/v2/models/create_batch_request_project.py
50+
scaleapi/api_client/v2/models/create_chat_task_request.py
5051
scaleapi/api_client/v2/models/criterion_definition.py
5152
scaleapi/api_client/v2/models/criterion_evaluation.py
5253
scaleapi/api_client/v2/models/delivery.py
@@ -62,7 +63,6 @@ scaleapi/api_client/v2/models/expandable_enum_deliveries.py
6263
scaleapi/api_client/v2/models/expandable_enum_delivery.py
6364
scaleapi/api_client/v2/models/expandable_enum_task.py
6465
scaleapi/api_client/v2/models/expandable_project.py
65-
scaleapi/api_client/v2/models/finalize_batch_request.py
6666
scaleapi/api_client/v2/models/gen_ai_project_type.py
6767
scaleapi/api_client/v2/models/get_batch500_response.py
6868
scaleapi/api_client/v2/models/get_batches_response.py
@@ -88,6 +88,7 @@ scaleapi/api_client/v2/models/rubric_evaluation.py
8888
scaleapi/api_client/v2/models/rubric_rating_value.py
8989
scaleapi/api_client/v2/models/sensitive_content_report.py
9090
scaleapi/api_client/v2/models/set_batch_metadata_request.py
91+
scaleapi/api_client/v2/models/set_task_metadata_request.py
9192
scaleapi/api_client/v2/models/submission.py
9293
scaleapi/api_client/v2/models/task.py
9394
scaleapi/api_client/v2/models/task_status.py

README.rst

Lines changed: 55 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -919,7 +919,7 @@ ______
919919

920920
If your project is using V2 API, you can use the ``.v2`` API client and also ``v2_get_tasks()`` to retrieve tasks in the V2 API format. See our `V2 API documentation`__.
921921

922-
__ https://docs.genai.scale.com/get-started/quickstart
922+
__ https://scale.com/docs/api-reference
923923

924924
.. list-table::
925925
:widths: 25 25 50
@@ -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/api_client/v2/__init__.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -64,14 +64,15 @@
6464
from scaleapi.api_client.v2.models.base_chunk import BaseChunk
6565
from scaleapi.api_client.v2.models.basic_file import BasicFile
6666
from scaleapi.api_client.v2.models.batch import Batch
67+
from scaleapi.api_client.v2.models.batch_operation_request import BatchOperationRequest
6768
from scaleapi.api_client.v2.models.batch_status import BatchStatus
6869
from scaleapi.api_client.v2.models.cancel_batch200_response import CancelBatch200Response
6970
from scaleapi.api_client.v2.models.chunk import Chunk
7071
from scaleapi.api_client.v2.models.chunk_text import ChunkText
7172
from scaleapi.api_client.v2.models.chunk_text_properties import ChunkTextProperties
7273
from scaleapi.api_client.v2.models.content_and_url import ContentAndUrl
7374
from scaleapi.api_client.v2.models.create_batch_request import CreateBatchRequest
74-
from scaleapi.api_client.v2.models.create_batch_request_project import CreateBatchRequestProject
75+
from scaleapi.api_client.v2.models.create_chat_task_request import CreateChatTaskRequest
7576
from scaleapi.api_client.v2.models.criterion_definition import CriterionDefinition
7677
from scaleapi.api_client.v2.models.criterion_evaluation import CriterionEvaluation
7778
from scaleapi.api_client.v2.models.delivery import Delivery
@@ -87,7 +88,6 @@
8788
from scaleapi.api_client.v2.models.expandable_enum_delivery import ExpandableEnumDelivery
8889
from scaleapi.api_client.v2.models.expandable_enum_task import ExpandableEnumTask
8990
from scaleapi.api_client.v2.models.expandable_project import ExpandableProject
90-
from scaleapi.api_client.v2.models.finalize_batch_request import FinalizeBatchRequest
9191
from scaleapi.api_client.v2.models.gen_ai_project_type import GenAIProjectType
9292
from scaleapi.api_client.v2.models.get_batch500_response import GetBatch500Response
9393
from scaleapi.api_client.v2.models.get_batches_response import GetBatchesResponse
@@ -113,6 +113,7 @@
113113
from scaleapi.api_client.v2.models.rubric_rating_value import RubricRatingValue
114114
from scaleapi.api_client.v2.models.sensitive_content_report import SensitiveContentReport
115115
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
116117
from scaleapi.api_client.v2.models.submission import Submission
117118
from scaleapi.api_client.v2.models.task import Task
118119
from scaleapi.api_client.v2.models.task_status import TaskStatus

0 commit comments

Comments
 (0)