# Resource API

## Usage

There are 2 main approaches to using the SDK. One is using the [SegmentsClient](client.md) for each API call directly. However, you can also call methods attached to the Segments.ai resources directly. We recommend using the latter in most cases, as this allows the SDK to perform better validation checks to the inputs you provide to the API. This will both speed up performance, reduce the risk of errors, and give more descriptive error messages in case there is a mistake anywhere.

When using the resource-driven approach, you will always start out fetching or creating a resource using a [SegmentsClient](client.md):

```python
import segments

client = segment.SegmentsClient(api_key_here)
dataset = client.get_dataset(your_dataset_identifier)

# Get all samples in a dataset
samples = dataset.get_samples()
# Add samples to the dataset
sample = dataset.add_sample(attributes=your_sample_attributes, name="Sample 1")
# Add a prelabel to that sample
label = sample.add_label(attributes=your_prelabel_attributes)

# Update the sample
sample.update(name="New name")
# Delete the sample
sample.delete()
```

## API

### Dataset
```{eval-rst}
.. autoclass:: segments.resource_api.Dataset
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Sample
```{eval-rst}
.. autoclass:: segments.resource_api.Sample
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Label
```{eval-rst}
.. autoclass:: segments.resource_api.Label
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Issue
```{eval-rst}
.. autoclass:: segments.resource_api.Issue
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Collaborator

```{eval-rst}
.. autoclass:: segments.resource_api.Collaborator
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Labelset

```{eval-rst}
.. autoclass:: segments.resource_api.Labelset
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```

### Release

```{eval-rst}
.. autoclass:: segments.resource_api.Release
    :members:
    :undoc-members:
    :exclude-members: model_config, model_post_init
```