update_dataset_examples¶
Operation¶
update_dataset_examples
¶
update_dataset_examples(request: UpdateDatasetExamplesInput | UpdateDatasetExamplesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDatasetExamplesInputDict]) -> UpdateDatasetExamplesOutput
Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateDatasetExamplesInput | UpdateDatasetExamplesInputDict | 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[UpdateDatasetExamplesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateDatasetExamplesOutput
|
An instance of |
update_dataset_examples
async
¶
update_dataset_examples(request: UpdateDatasetExamplesInput | UpdateDatasetExamplesInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateDatasetExamplesInputDict]) -> UpdateDatasetExamplesOutput
Updates multiple existing examples in-place on DRAFT. All examples are validated against the dataset's schema type before any writes occur. If any example fails validation, the entire batch is rejected (all-or-nothing semantics).
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateDatasetExamplesInput | UpdateDatasetExamplesInputDict | 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[UpdateDatasetExamplesInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateDatasetExamplesOutput
|
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.
UpdateDatasetExamplesInputDict
¶
Bases: TypedDict
Dictionary form of UpdateDatasetExamplesInput.
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.
UpdateDatasetExamplesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateDatasetExamplesInput 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¶
UpdateDatasetExamplesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateDatasetExamplesOutput structure.