delete_dataset_examples¶
Operation¶
delete_dataset_examples
¶
delete_dataset_examples(request: DeleteDatasetExamplesInput | DeleteDatasetExamplesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDatasetExamplesInputDict]) -> DeleteDatasetExamplesOutput
Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteDatasetExamplesInput | DeleteDatasetExamplesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteDatasetExamplesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDatasetExamplesOutput
|
An instance of |
delete_dataset_examples
async
¶
delete_dataset_examples(request: DeleteDatasetExamplesInput | DeleteDatasetExamplesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteDatasetExamplesInputDict]) -> DeleteDatasetExamplesOutput
Deletes specific examples by ID from DRAFT. All example IDs are validated before any deletes occur. If any ID does not exist in DRAFT, the entire batch is rejected (all-or-nothing semantics).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteDatasetExamplesInput | DeleteDatasetExamplesInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
**kwargs
|
Unpack[DeleteDatasetExamplesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteDatasetExamplesOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
DeleteDatasetExamplesInputDict
¶
Bases: TypedDict
Dictionary form of DeleteDatasetExamplesInput.
Attributes¶
client_token
instance-attribute
¶
client_token: str | None
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
DeleteDatasetExamplesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteDatasetExamplesInput structure.
Attributes¶
client_token
class-attribute
instance-attribute
¶
client_token: str | None = ...
A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If you don't specify this field, a value is randomly generated for you. If this token matches a previous request, the service ignores the request, but doesn't return an error. For more information, see Ensuring idempotency.
This field is autopopulated if not provided.
Output¶
DeleteDatasetExamplesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteDatasetExamplesOutput structure.