Skip to content

Commit

Permalink
[Autogenerated] markdowns for toloka-kit v1.2.2 release
Browse files Browse the repository at this point in the history
  • Loading branch information
alexdrydew authored Oct 26, 2023
1 parent c28c2ac commit d182520
Show file tree
Hide file tree
Showing 1,045 changed files with 1,793 additions and 1,348 deletions.
39 changes: 35 additions & 4 deletions en/_includes/toloka-kit-reference-toc.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,8 @@ items:
items:
- name: archive_app_project
href: ../toloka-kit/reference/toloka.client.TolokaClient.archive_app_project.md
- name: unarchive_app_project
href: ../toloka-kit/reference/toloka.client.TolokaClient.unarchive_app_project.md
- name: create_app_batch
href: ../toloka-kit/reference/toloka.client.TolokaClient.create_app_batch.md
- name: patch_app_batch
Expand Down Expand Up @@ -66,8 +68,12 @@ items:
href: ../toloka-kit/reference/toloka.client.TolokaClient.stop_app_batch.md
- name: resume_app_batch
href: ../toloka-kit/reference/toloka.client.TolokaClient.resume_app_batch.md
- name: unarchive_app_project
href: ../toloka-kit/reference/toloka.client.TolokaClient.unarchive_app_project.md
- name: archive_app_batch
href: ../toloka-kit/reference/toloka.client.TolokaClient.archive_app_batch.md
- name: unarchive_app_batch
href: ../toloka-kit/reference/toloka.client.TolokaClient.unarchive_app_batch.md
- name: start_sync_batch_processing
href: ../toloka-kit/reference/toloka.client.TolokaClient.start_sync_batch_processing.md
- name: assignments
items:
- name: accept_assignment
Expand Down Expand Up @@ -138,6 +144,8 @@ items:
href: ../toloka-kit/reference/toloka.client.TolokaClient.close_pool_for_update.md
- name: close_pool_for_update_async
href: ../toloka-kit/reference/toloka.client.TolokaClient.close_pool_for_update_async.md
- name: check_update_project_for_major_version_change
href: ../toloka-kit/reference/toloka.client.TolokaClient.check_update_project_for_major_version_change.md
- name: create_pool
href: ../toloka-kit/reference/toloka.client.TolokaClient.create_pool.md
- name: find_pools
Expand Down Expand Up @@ -406,6 +414,8 @@ items:
- name: _AppError
href: ../toloka-kit/reference/toloka.client.app._AppError.md
hidden: true
- name: BaseApp
href: ../toloka-kit/reference/toloka.client.app.BaseApp.md
- name: App
href: ../toloka-kit/reference/toloka.client.app.App.md
- name: AppLightestResult
Expand All @@ -416,8 +426,13 @@ items:
- name: AppBatch.Status
href: ../toloka-kit/reference/toloka.client.app.AppBatch.Status.md
hidden: true
- name: AppBatch.PriorityOrder
href: ../toloka-kit/reference/toloka.client.app.AppBatch.PriorityOrder.md
hidden: true
- name: AppBatchCreateRequest
href: ../toloka-kit/reference/toloka.client.app.AppBatchCreateRequest.md
- name: SyncBatchCreateRequest
href: ../toloka-kit/reference/toloka.client.app.SyncBatchCreateRequest.md
- name: AppItemImport
href: ../toloka-kit/reference/toloka.client.app.AppItemImport.md
hidden: true
Expand All @@ -426,6 +441,8 @@ items:
- name: AppItem.Status
href: ../toloka-kit/reference/toloka.client.app.AppItem.Status.md
hidden: true
- name: AppItemCreateRequest
href: ../toloka-kit/reference/toloka.client.app.AppItemCreateRequest.md
- name: AppItemsCreateRequest
href: ../toloka-kit/reference/toloka.client.app.AppItemsCreateRequest.md
- name: AppProject
Expand Down Expand Up @@ -1101,6 +1118,12 @@ items:
- name: Project.set_default_language
href: ../toloka-kit/reference/toloka.client.project.Project.set_default_language.md
hidden: true
- name: ProjectCheckResponse
href: ../toloka-kit/reference/toloka.client.project.ProjectCheckResponse.md
hidden: true
- name: ProjectUpdateDifferenceLevel
href: ../toloka-kit/reference/toloka.client.project.ProjectUpdateDifferenceLevel.md
hidden: true
- name: localization
items:
- name: AdditionalLanguage
Expand Down Expand Up @@ -1991,6 +2014,8 @@ items:
items:
- name: archive_app_project
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.archive_app_project.md
- name: unarchive_app_project
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.unarchive_app_project.md
- name: create_app_batch
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.create_app_batch.md
- name: patch_app_batch
Expand Down Expand Up @@ -2031,8 +2056,12 @@ items:
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.stop_app_batch.md
- name: resume_app_batch
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.resume_app_batch.md
- name: unarchive_app_project
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.unarchive_app_project.md
- name: archive_app_batch
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.archive_app_batch.md
- name: unarchive_app_batch
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.unarchive_app_batch.md
- name: start_sync_batch_processing
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.start_sync_batch_processing.md
- name: assignments
items:
- name: accept_assignment
Expand Down Expand Up @@ -2103,6 +2132,8 @@ items:
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.close_pool_for_update.md
- name: close_pool_for_update_async
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.close_pool_for_update_async.md
- name: check_update_project_for_major_version_change
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.check_update_project_for_major_version_change.md
- name: create_pool
href: ../toloka-kit/reference/toloka.async_client.client.AsyncTolokaClient.create_pool.md
- name: find_pools
Expand Down
4 changes: 2 additions & 2 deletions en/_includes/toloka-kit-toc.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
items:
- name: Overview
href: ../toloka-kit/index.md
- name: Getting API key
- name: Getting OAuth token
href: ../toloka-kit/registration.md
- name: Quick start
href: ../toloka-kit/quick-start.md
Expand Down Expand Up @@ -122,4 +122,4 @@ items:
include:
path: toloka-kit-reference-toc.yaml
mode: link
base: en
base: en
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# accept_assignment
`toloka.async_client.client.AsyncTolokaClient.accept_assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.accept_assignment` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async accept_assignment(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# add_message_thread_to_folders
`toloka.async_client.client.AsyncTolokaClient.add_message_thread_to_folders` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.add_message_thread_to_folders` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async add_message_thread_to_folders(
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# aggregate_solutions_by_pool
`toloka.async_client.client.AsyncTolokaClient.aggregate_solutions_by_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/client/__init__.py#L0)
`toloka.async_client.client.AsyncTolokaClient.aggregate_solutions_by_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/client/__init__.py#L0)

Starts aggregation of responses in all completed tasks in a pool.

Expand All @@ -16,9 +16,9 @@ Try [crowd-kit library](https://toloka.ai/docs/crowd-kit). It has many aggregati

| Parameters | Type | Description |
| :----------| :----| :-----------|
`type`|**Union\[[AggregatedSolutionType](toloka.client.aggregation.AggregatedSolutionType.md), str, None\]**|<p>Aggregation model:</p> <ul> <li>`WEIGHTED_DYNAMIC_OVERLAP`[Aggregation](https://toloka.ai/docs/guide/result-aggregation#aggr-by-skill) based on Tolokers' skill in a pool with a dynamic overlap.</li> <li>`DAWID_SKENE`[Dawid-Skene aggregation model](https://toloka.ai/docs/guide/result-aggregation#dawid-skene). It is used in pools without a dynamic overlap.</li> </ul>
`type`|**Union\[[AggregatedSolutionType](toloka.client.aggregation.AggregatedSolutionType.md), str, None\]**|<p>Aggregation model:</p> <ul> <li>`WEIGHTED_DYNAMIC_OVERLAP`[Aggregation](https://toloka.ai/docs/guide/result-aggregation#aggr-by-skill) based on Tolokers&#x27; skill in a pool with a dynamic overlap.</li> <li>`DAWID_SKENE`[Dawid-Skene aggregation model](https://toloka.ai/docs/guide/result-aggregation#dawid-skene). It is used in pools without a dynamic overlap.</li> </ul>
`pool_id`|**Optional\[str\]**|<p>The ID of the pool.</p>
`answer_weight_skill_id`|**Optional\[str\]**|<p>The ID of the skill that determines the weight of the Toloker's responses.</p>
`answer_weight_skill_id`|**Optional\[str\]**|<p>The ID of the skill that determines the weight of the Toloker&#x27;s responses.</p>
`fields`|**Optional\[List\[[PoolAggregatedSolutionRequest.Field](toloka.client.aggregation.PoolAggregatedSolutionRequest.Field.md)\]\]**|<p>Output data fields to aggregate. For the best results, each of these fields should have limited number of response options. If the `DAWID_SKENE` aggregation type is selected, you can only specify one value.</p>

* **Returns:**
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# aggregate_solutions_by_task
`toloka.async_client.client.AsyncTolokaClient.aggregate_solutions_by_task` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/client/__init__.py#L0)
`toloka.async_client.client.AsyncTolokaClient.aggregate_solutions_by_task` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/client/__init__.py#L0)

Aggregates responses to a single task on the Toloka server.

Expand All @@ -16,7 +16,7 @@ Try [crowd-kit library](https://toloka.ai/docs/crowd-kit). It has many aggregati
| :----------| :----| :-----------|
`task_id`|**Optional\[str\]**|<p>The ID of the task.</p>
`pool_id`|**Optional\[str\]**|<p>The ID of the pool containing the task.</p>
`answer_weight_skill_id`|**Optional\[str\]**|<p>The ID of the skill that determines the weight of the Toloker's responses.</p>
`answer_weight_skill_id`|**Optional\[str\]**|<p>The ID of the skill that determines the weight of the Toloker&#x27;s responses.</p>
`fields`|**Optional\[List\[[WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field](toloka.client.aggregation.WeightedDynamicOverlapTaskAggregatedSolutionRequest.Field.md)\]\]**|<p>Output data fields to aggregate. For the best results, each of these fields should have limited number of response options. If the `DAWID_SKENE` aggregation type is selected, you can only specify one value.</p>

* **Returns:**
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# archive_app_batch
`toloka.async_client.client.AsyncTolokaClient.archive_app_batch` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_app_batch(
self,
app_project_id: str,
batch_id: str
)
```

Archives the batch with the ID specified in the request to hide its data.


You can archive the batches which are not currently being processed (are not in the `PROCESSING` status). You
must stop the batches before archiving them. The batch gets the `ARCHIVE` status.

## Parameters Description

| Parameters | Type | Description |
| :----------| :----| :-----------|
`app_project_id`|**str**|<p>The ID of the project with which the batch is associated.</p>
`batch_id`|**str**|<p>The ID of the batch you want to archive.</p>

**Examples:**


```python
toloka_client.archive_app_batch(
app_project_id='Q2d15QBjpwWuDz8Z321g',
batch_id='4Va2BBWKL88S4QyAgVje'
)
```
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_app_project
`toloka.async_client.client.AsyncTolokaClient.archive_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_app_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_app_project(self, app_project_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_pool
`toloka.async_client.client.AsyncTolokaClient.archive_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_pool(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_pool_async
`toloka.async_client.client.AsyncTolokaClient.archive_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_pool_async(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_project
`toloka.async_client.client.AsyncTolokaClient.archive_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_project(self, project_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_project_async
`toloka.async_client.client.AsyncTolokaClient.archive_project_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_project_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_project_async(self, project_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_training
`toloka.async_client.client.AsyncTolokaClient.archive_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_training(self, training_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# archive_training_async
`toloka.async_client.client.AsyncTolokaClient.archive_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.archive_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async archive_training_async(self, training_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# check_update_project_for_major_version_change
`toloka.async_client.client.AsyncTolokaClient.check_update_project_for_major_version_change` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async check_update_project_for_major_version_change(
self,
project_id: str,
project: Project
)
```

Checks if the project update is a breaking change or not.


This method is similar to the `update_project` method, but instead of actually applying the changes it checks if
the update is a breaking change or not. If the update is a breaking change, every pool in the project will not
receive the current project update and any future project changes and will be tied to the last version of the
project before the breaking change happened.

## Parameters Description

| Parameters | Type | Description |
| :----------| :----| :-----------|
`project_id`|**str**|<p>The ID of the project to be updated.</p>
`project`|**[Project](toloka.client.project.Project.md)**|<p>The project with new parameters.</p>

* **Returns:**

enum value that describes the level of difference between the current project
and the project that would be created if the update is applied.

* **Return type:**

[ProjectUpdateDifferenceLevel](toloka.client.project.ProjectUpdateDifferenceLevel.md)
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clone_pool
`toloka.async_client.client.AsyncTolokaClient.clone_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.clone_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async clone_pool(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clone_pool_async
`toloka.async_client.client.AsyncTolokaClient.clone_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.clone_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async clone_pool_async(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clone_project
`toloka.async_client.client.AsyncTolokaClient.clone_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.clone_project` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async clone_project(
Expand All @@ -26,7 +26,7 @@ Important notes:
| Parameters | Type | Description |
| :----------| :----| :-----------|
`project_id`|**str**|<p>The ID of the project to be cloned.</p>
`reuse_controllers`|**bool**|<ul> <li>`True` — Use same quality controllers in cloned and created projects.</li> <li>`False` — Use separate quality controllers.</li> </ul> <p>Default value: `True`.</p>
`reuse_controllers`|**bool**|<ul> <li>`True` — Use same quality controllers in cloned and created projects.</li> <li>`False` — Use separate quality controllers.</li> </ul> <p></p><p>Default value: `True`.</p>

* **Returns:**

Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clone_training
`toloka.async_client.client.AsyncTolokaClient.clone_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.clone_training` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async clone_training(self, training_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# clone_training_async
`toloka.async_client.client.AsyncTolokaClient.clone_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.clone_training_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async clone_training_async(self, training_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# close_pool
`toloka.async_client.client.AsyncTolokaClient.close_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.close_pool` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async close_pool(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# close_pool_async
`toloka.async_client.client.AsyncTolokaClient.close_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.close_pool_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async close_pool_async(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# close_pool_for_update
`toloka.async_client.client.AsyncTolokaClient.close_pool_for_update` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.close_pool_for_update` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async close_pool_for_update(self, pool_id: str)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# close_pool_for_update_async
`toloka.async_client.client.AsyncTolokaClient.close_pool_for_update_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.1/src/async_client/client.py#L0)
`toloka.async_client.client.AsyncTolokaClient.close_pool_for_update_async` | [Source code](https://github.com/Toloka/toloka-kit/blob/v1.2.2/src/async_client/client.py#L0)

```python
async close_pool_for_update_async(self, pool_id: str)
Expand Down
Loading

0 comments on commit d182520

Please sign in to comment.