# StreamingApi

All URIs are relative to *http://localhost*

|Method | HTTP request | Description|
|------------- | ------------- | -------------|
|[**getConsumerStatsApiStreamingStatsConsumerIdGet**](#getconsumerstatsapistreamingstatsconsumeridget) | **GET** /api/streaming/stats/{consumer_id} | Get Consumer Stats|
|[**getConsumerTasksApiStreamingTasksConsumerIdGet**](#getconsumertasksapistreamingtasksconsumeridget) | **GET** /api/streaming/tasks/{consumer_id} | Get Consumer Tasks|
|[**listActiveConsumersApiStreamingConsumersGet**](#listactiveconsumersapistreamingconsumersget) | **GET** /api/streaming/consumers | List Active Consumers|
|[**startStreamingPredictionApiStreamingStartPost**](#startstreamingpredictionapistreamingstartpost) | **POST** /api/streaming/start | Start Streaming Prediction|
|[**stopAllStreamingConsumersApiStreamingStopAllPost**](#stopallstreamingconsumersapistreamingstopallpost) | **POST** /api/streaming/stop-all | Stop All Streaming Consumers|
|[**stopStreamingPredictionApiStreamingStopConsumerIdPost**](#stopstreamingpredictionapistreamingstopconsumeridpost) | **POST** /api/streaming/stop/{consumer_id} | Stop Streaming Prediction|

# **getConsumerStatsApiStreamingStatsConsumerIdGet**
> ConsumerStatsResponse getConsumerStatsApiStreamingStatsConsumerIdGet()

Get statistics for a specific streaming consumer.  Args:     consumer_id: Unique identifier of the consumer      Returns:     ConsumerStatsResponse with detailed consumer statistics      Raises:     HTTPException: If consumer not found

### Example

```typescript
import {
    StreamingApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

let consumerId: string; // (default to undefined)

const { status, data } = await apiInstance.getConsumerStatsApiStreamingStatsConsumerIdGet(
    consumerId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **consumerId** | [**string**] |  | defaults to undefined|


### Return type

**ConsumerStatsResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **getConsumerTasksApiStreamingTasksConsumerIdGet**
> ConsumerTasksResponse getConsumerTasksApiStreamingTasksConsumerIdGet()

Get task list for a specific streaming consumer.  Args:     consumer_id: Unique identifier of the consumer     limit: Maximum number of tasks to return (most recent first)     since: ISO timestamp to filter tasks triggered after this time      Returns:     ConsumerTasksResponse containing task list and metadata      Raises:     HTTPException: If consumer not found

### Example

```typescript
import {
    StreamingApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

let consumerId: string; // (default to undefined)
let limit: number; // (optional) (default to undefined)
let since: string; // (optional) (default to undefined)

const { status, data } = await apiInstance.getConsumerTasksApiStreamingTasksConsumerIdGet(
    consumerId,
    limit,
    since
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **consumerId** | [**string**] |  | defaults to undefined|
| **limit** | [**number**] |  | (optional) defaults to undefined|
| **since** | [**string**] |  | (optional) defaults to undefined|


### Return type

**ConsumerTasksResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **listActiveConsumersApiStreamingConsumersGet**
> { [key: string]: any; } listActiveConsumersApiStreamingConsumersGet()

List all active streaming consumers.  Returns:     Dict containing list of active consumer IDs and summary stats

### Example

```typescript
import {
    StreamingApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

const { status, data } = await apiInstance.listActiveConsumersApiStreamingConsumersGet();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**{ [key: string]: any; }**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **startStreamingPredictionApiStreamingStartPost**
> StreamingResponse startStreamingPredictionApiStreamingStartPost(vIPRConfigWithStreaming)

Start streaming prediction consumer for real-time processing.  This endpoint starts a RabbitMQ consumer that listens for spectral data messages and triggers individual VIPR inference tasks for each subscan message.  Args:     request: StreamingStartRequest containing config and RabbitMQ settings      Returns:     StreamingResponse with consumer ID and status      Raises:     HTTPException: If consumer startup fails

### Example

```typescript
import {
    StreamingApi,
    Configuration,
    VIPRConfigWithStreaming
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

let vIPRConfigWithStreaming: VIPRConfigWithStreaming; //

const { status, data } = await apiInstance.startStreamingPredictionApiStreamingStartPost(
    vIPRConfigWithStreaming
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **vIPRConfigWithStreaming** | **VIPRConfigWithStreaming**|  | |


### Return type

**StreamingResponse**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **stopAllStreamingConsumersApiStreamingStopAllPost**
> { [key: string]: any; } stopAllStreamingConsumersApiStreamingStopAllPost()

Stop all active streaming consumers.  Returns:     Dict containing final statistics for all stopped consumers      Raises:     HTTPException: If operation fails

### Example

```typescript
import {
    StreamingApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

const { status, data } = await apiInstance.stopAllStreamingConsumersApiStreamingStopAllPost();
```

### Parameters
This endpoint does not have any parameters.


### Return type

**{ [key: string]: any; }**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

# **stopStreamingPredictionApiStreamingStopConsumerIdPost**
> { [key: string]: any; } stopStreamingPredictionApiStreamingStopConsumerIdPost()

Stop a running streaming prediction consumer.  Args:     consumer_id: Unique identifier of the consumer to stop      Returns:     Dict containing final consumer statistics      Raises:     HTTPException: If consumer not found or stop fails

### Example

```typescript
import {
    StreamingApi,
    Configuration
} from '@vipr/api';

const configuration = new Configuration();
const apiInstance = new StreamingApi(configuration);

let consumerId: string; // (default to undefined)

const { status, data } = await apiInstance.stopStreamingPredictionApiStreamingStopConsumerIdPost(
    consumerId
);
```

### Parameters

|Name | Type | Description  | Notes|
|------------- | ------------- | ------------- | -------------|
| **consumerId** | [**string**] |  | defaults to undefined|


### Return type

**{ [key: string]: any; }**

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json


### HTTP response details
| Status code | Description | Response headers |
|-------------|-------------|------------------|
|**200** | Successful Response |  -  |
|**422** | Validation Error |  -  |

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

