Deprecations¶
Surfaces that still work and still warn. Nothing else in these docs mentions them: the guide and the reference describe only the canonical path, and this file is deleted whole when the removals land.
Every entry below emits a DeprecationWarning at the call site — except the few marked
silent, which are wire field names as well as keywords. A warning on those would fire while
the server parses a client's payload (pydantic routes request validation through the model's
__init__), blaming the server for its clients' spelling. Run tests with
-W error::DeprecationWarning to find the rest in your own code.
Renamed methods¶
The entity type is SampleStore; the verbs say store.
| Deprecated | Canonical |
|---|---|
create_sample_store |
create_store |
list_sample_stores |
list_stores |
list_sample_store_key_facets |
list_store_key_facets |
get_sample_store |
get_store |
get_sample_store_stats |
get_store_stats |
list_sample_store_attribute_names |
list_store_attribute_names |
list_sample_store_attribute_values |
list_store_attribute_values |
preview_sample_store_grid |
preview_store_grid |
delete_sample_store |
delete_store |
transfer_sample_store |
transfer_store |
archive_sample_store |
archive_store |
restore_sample_store |
restore_store |
list_sample_store_usage |
list_store_usage |
open_workset |
open_workset_stream |
wait_for_dataset_ready |
wait_for_dataset |
wait_for_workset_ready |
wait_for_workset |
wait_for_workset_defined |
wait_for_workset |
publish_attachment_shard |
attach_keys |
get_source_import_by_source_ref |
get_source_import_by_operation_id |
list_source_import_samples_by_source_ref |
list_source_import_samples_by_operation_id |
iter_source_import_samples_by_source_ref |
iter_source_import_samples_by_operation_id |
Renamed and retired parameters¶
| Deprecated keyword | Canonical | Applies to |
|---|---|---|
sample_store= |
store= |
store, producer and source-import verbs |
name= |
store= |
get_store, delete_store, archive_store, and the other store verbs |
from_sample_store= |
from_store= |
add_to_store |
reserve_request=, sample_store= |
store= |
attach_keys |
output_keys= |
keys= |
attach_keys |
output_key_group= |
(retired — bound, warned, ignored) | attach_keys, open_processing |
ttl_days= |
(retired — stored, never read) | create_dataset, convert_workset_to_dataset |
**provenance kwargs |
metadata={…} |
register_producer |
declared_output_keys= |
output_keys= |
register_producer |
source_ref= |
operation_id= |
create_source_import |
scope=WorksetScope(sample_store=…) |
sources=[SourceSpec(sample_store=…, keys=[…])] |
create_workset — silent |
scope=WorksetScope(dataset=…) |
sources=[SourceSpec(kind="dataset_scope", dataset_name=…)] |
create_workset — silent; a dataset read is a source, not a scope arm |
selectors= / key_selectors= / required_input_keys= on a workset |
a source's keys=[…] (+ producer_pins=) |
create_workset — the whole flat form is the wire shape, not an authoring one |
Positional callers are unaffected; only keyword callers see a signal.
Renamed types¶
| Deprecated | Canonical |
|---|---|
DatavoDataset |
SampleStream |
DatasetSourceDraftSpec |
SourceSpec |
NotProducedBy |
Not(AttachedBy(producer_id, output_keys)) |
NotAttachedBy |
Not(AttachedBy(producer_id, output_keys)) |
SampleFilter / SampleFilterDefinition (the named-field record) |
a flat filters=[…] predicate list |
SampleFilter.not_produced_by / .not_attached_by |
Not(AttachedBy(…)) in filters |
SampleStream.iter_inputs |
iterate the stream directly |
WorksetScope |
a SourceSpec — sample_store= for a store, kind="dataset_scope" for a dataset |
Deprecated flows¶
prepare_produce(...) — a convenience that froze the missing-sample set and
minted a scoped token in one call. Create the attach workset directly instead:
create_workset with Not(AttachedBy(producer_id, output_keys)) in filters
(guide chapter 6).
create_dataset(sources=…, key_groups=…) — direct dataset composition.
Select a workset and keep it with convert_workset_to_dataset(...)
(guide chapter 11). create_dataset(from_workset=…) is
the internal form of convert and is not deprecated.
A store purpose — removed outright, including the create field: a label nothing
read to decide anything, whose only readers compared it to the retired
"inference_overlay". Put a label in metadata={…} on the store, which is searchable.
set_default_producer(...) — accepted, and does nothing. It promised that a
consumer omitting a pin would resolve a store's default producer; nothing ever read
the marker, so that fallback never existed. Name the producer you want as a
producer_pin on the source you read
(guide chapter 9).
Wire-level¶
The operation log carries legacy_kind="produce" alongside kind="attach" on
attach entries, so readers written against either spelling recognise one entry.
Read kind.
POST /worksets still accepts the whole flat form — scope, selection_filter,
key_selectors, required_input_keys — which is the shape every deployed SDK sends. It is a
wire shape only: the authoring surface is sources (+ optional key_groups), and the flat
payload desugars to exactly that on arrival. A workset row still carries scope_kind /
scope_ref — derived labels for display and the create-idempotency key. Nothing reads them to
decide behaviour: planning, authorization and workset reuse read the composition
(sources / key_groups). A WorksetResponse returns both, and the composition is the one to
trust — for a multi-source union, scope_ref names only the first source.