neuland-hub-sdk 1.0.3

package/docs/Transcription.md

@@ -0,0 +1,114 @@
+# Transcription
+
+All URIs are relative to *http://localhost*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**transcriptionsCreateTranscription**](#transcriptionscreatetranscription) | **POST** /transcriptions/ | Transcribe an audio file|
+|[**transcriptionsTranscriptionCallback**](#transcriptionstranscriptioncallback) | **POST** /transcriptions/callback | Receive an async transcription callback|
+
+# **transcriptionsCreateTranscription**
+> TranscriptionOut transcriptionsCreateTranscription()
+
+Transcribe an uploaded audio file and return the transcript synchronously.
+
+### Example
+
+```typescript
+import {
+    Transcription,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Transcription(configuration);
+
+let file: File; // (default to undefined)
+let cookieName: string; // (optional) (default to undefined)
+
+const { status, data } = await apiInstance.transcriptionsCreateTranscription(
+    file,
+    cookieName
+);
+```
+
+### Parameters
+
+|Name | Type | Description  | Notes|
+|------------- | ------------- | ------------- | -------------|
+| **file** | [**File**] |  | defaults to undefined|
+| **cookieName** | [**string**] |  | (optional) defaults to undefined|
+
+
+### Return type
+
+**TranscriptionOut**
+
+### Authorization
+
+[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
+
+### HTTP request headers
+
+ - **Content-Type**: multipart/form-data
+ - **Accept**: application/json
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | Successful Response |  -  |
+|**401** | Missing or invalid authentication. |  -  |
+|**413** | Audio file exceeds the 25 MB limit. |  -  |
+|**415** | Unsupported audio content type. |  -  |
+|**502** | The transcription provider failed or returned an error. |  -  |
+|**503** | Transcription is not configured or unavailable. |  -  |
+|**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)
+
+# **transcriptionsTranscriptionCallback**
+> { [key: string]: any; } transcriptionsTranscriptionCallback()
+
+Accept a signed transcription result pushed back by the Whisper service.
+
+### Example
+
+```typescript
+import {
+    Transcription,
+    Configuration
+} from 'neuland-hub-sdk';
+
+const configuration = new Configuration();
+const apiInstance = new Transcription(configuration);
+
+const { status, data } = await apiInstance.transcriptionsTranscriptionCallback();
+```
+
+### 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 |
+|-------------|-------------|------------------|
+|**202** | Successful Response |  -  |
+|**401** | Missing or invalid HMAC signature on the callback body. |  -  |
+
+[[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)
+

package/docs/TranscriptionOut.md

@@ -0,0 +1,27 @@
+# TranscriptionOut
+
+The response format from the transcription endpoint
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**text** | **string** | Full transcribed text of the audio. | [default to undefined]
+**language** | **string** |  | [default to undefined]
+**duration_seconds** | **number** | Duration of the transcribed audio in seconds. | [default to undefined]
+**segments** | [**Array<TranscriptionSegment>**](TranscriptionSegment.md) | Time-aligned, optionally diarized transcript segments. | [default to undefined]
+
+## Example
+
+```typescript
+import { TranscriptionOut } from 'neuland-hub-sdk';
+
+const instance: TranscriptionOut = {
+    text,
+    language,
+    duration_seconds,
+    segments,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/TranscriptionSegment.md

@@ -0,0 +1,27 @@
+# TranscriptionSegment
+
+A single time-aligned segment of a transcript.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start** | **number** |  | [default to undefined]
+**end** | **number** |  | [default to undefined]
+**speaker** | **string** |  | [default to undefined]
+**text** | **string** | Transcribed text for this segment. | [default to undefined]
+
+## Example
+
+```typescript
+import { TranscriptionSegment } from 'neuland-hub-sdk';
+
+const instance: TranscriptionSegment = {
+    start,
+    end,
+    speaker,
+    text,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/Translation.md

@@ -0,0 +1,20 @@
+# Translation
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**content** | **string** | The translated or rephrased text. | [default to undefined]
+
+## Example
+
+```typescript
+import { Translation } from 'neuland-hub-sdk';
+
+const instance: Translation = {
+    content,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageCostRequest.md

@@ -0,0 +1,30 @@
+# UsageCostRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**granularity** | **string** | Aggregation window; \'custom\' requires date_start and date_end. | [optional] [default to GranularityEnum_monthly]
+**date_start** | **string** |  | [optional] [default to undefined]
+**date_end** | **string** |  | [optional] [default to undefined]
+**source** | **string** |  | [optional] [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**provider** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UsageCostRequest } from 'neuland-hub-sdk';
+
+const instance: UsageCostRequest = {
+    granularity,
+    date_start,
+    date_end,
+    source,
+    model,
+    provider,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageCostResponse.md

@@ -0,0 +1,40 @@
+# UsageCostResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **string** | Start of the aggregation window. | [default to undefined]
+**end_date** | **string** | End of the aggregation window. | [default to undefined]
+**total_cost** | **number** | Total cost across the window. | [default to undefined]
+**total_tokens** | **number** | Total tokens across the window. | [default to undefined]
+**total_prompt_tokens** | **number** | Total prompt tokens across the window. | [default to undefined]
+**total_completion_tokens** | **number** | Total completion tokens across the window. | [default to undefined]
+**total_cached_tokens** | **number** | Total cached prompt tokens across the window. | [default to undefined]
+**record_count** | **number** | Total number of usage records. | [default to undefined]
+**by_source** | [**Array<CostBySource>**](CostBySource.md) | Cost breakdown grouped by source. | [default to undefined]
+**by_model** | [**Array<CostByModel>**](CostByModel.md) | Cost breakdown grouped by provider and model. | [default to undefined]
+**timeseries** | [**Array<CostTimeseriesPoint>**](CostTimeseriesPoint.md) | Daily cost timeseries across the window. | [default to undefined]
+
+## Example
+
+```typescript
+import { UsageCostResponse } from 'neuland-hub-sdk';
+
+const instance: UsageCostResponse = {
+    start_date,
+    end_date,
+    total_cost,
+    total_tokens,
+    total_prompt_tokens,
+    total_completion_tokens,
+    total_cached_tokens,
+    record_count,
+    by_source,
+    by_model,
+    timeseries,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageMetrics.md

@@ -0,0 +1,28 @@
+# UsageMetrics
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cost** | **number** | Total cost. | [default to undefined]
+**total_tokens** | **number** | Total tokens. | [default to undefined]
+**prompt_tokens** | **number** | Prompt tokens. | [default to undefined]
+**completion_tokens** | **number** | Completion tokens. | [default to undefined]
+**requests** | **number** | Number of usage records. | [default to undefined]
+
+## Example
+
+```typescript
+import { UsageMetrics } from 'neuland-hub-sdk';
+
+const instance: UsageMetrics = {
+    cost,
+    total_tokens,
+    prompt_tokens,
+    completion_tokens,
+    requests,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageQueryRequest.md

@@ -0,0 +1,41 @@
+# UsageQueryRequest
+
+Request for the unified usage aggregation.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**date_start** | **string** | Inclusive start of the window. | [default to undefined]
+**date_end** | **string** | Inclusive end of the window. | [default to undefined]
+**bucket** | **string** |  | [optional] [default to undefined]
+**group_by** | **Array<string>** | Categorical dimensions to break the totals down by. \'user\' and \'group\' require the tenant\'s user-level-analytics opt-in. | [optional] [default to undefined]
+**source** | **string** |  | [optional] [default to undefined]
+**model** | **string** |  | [optional] [default to undefined]
+**provider** | **string** |  | [optional] [default to undefined]
+**assistant_id** | **number** |  | [optional] [default to undefined]
+**project_id** | **number** |  | [optional] [default to undefined]
+**limit** | **number** |  | [optional] [default to undefined]
+**offset** | **number** | Row offset, for paginating rankings. | [optional] [default to 0]
+
+## Example
+
+```typescript
+import { UsageQueryRequest } from 'neuland-hub-sdk';
+
+const instance: UsageQueryRequest = {
+    date_start,
+    date_end,
+    bucket,
+    group_by,
+    source,
+    model,
+    provider,
+    assistant_id,
+    project_id,
+    limit,
+    offset,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageQueryResponse.md

@@ -0,0 +1,32 @@
+# UsageQueryResponse
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**start_date** | **string** | Start of the window. | [default to undefined]
+**end_date** | **string** | End of the window. | [default to undefined]
+**bucket** | **string** |  | [default to undefined]
+**group_by** | **Array<string>** | Dimensions the rows are grouped by. | [default to undefined]
+**totals** | [**UsageMetrics**](UsageMetrics.md) | Window totals, counted once per record (no group fan-out). | [default to undefined]
+**rows** | [**Array<UsageRow>**](UsageRow.md) | One entry per group (and time bucket). | [default to undefined]
+**truncated** | **boolean** | True when more rows matched than were returned (capped at MAX_USAGE_ROWS) — narrow the window or dimensions for a complete set. | [optional] [default to false]
+
+## Example
+
+```typescript
+import { UsageQueryResponse } from 'neuland-hub-sdk';
+
+const instance: UsageQueryResponse = {
+    start_date,
+    end_date,
+    bucket,
+    group_by,
+    totals,
+    rows,
+    truncated,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageRequest.md

@@ -0,0 +1,25 @@
+# UsageRequest
+
+Generic usage request model for both token and cost queries.
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**granularity** | **string** | Aggregation window; \'custom\' requires date_start and date_end. | [default to undefined]
+**date_start** | **string** |  | [optional] [default to undefined]
+**date_end** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UsageRequest } from 'neuland-hub-sdk';
+
+const instance: UsageRequest = {
+    granularity,
+    date_start,
+    date_end,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/UsageRow.md

@@ -0,0 +1,32 @@
+# UsageRow
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**cost** | **number** | Total cost. | [default to undefined]
+**total_tokens** | **number** | Total tokens. | [default to undefined]
+**prompt_tokens** | **number** | Prompt tokens. | [default to undefined]
+**completion_tokens** | **number** | Completion tokens. | [default to undefined]
+**requests** | **number** | Number of usage records. | [default to undefined]
+**group** | [**{ [key: string]: ResponseAuthGetEntraGroupsValue; }**](ResponseAuthGetEntraGroupsValue.md) | Dimension values for this group, keyed by dimension name. A null value means the dimension was unattributed for these rows. | [default to undefined]
+**bucket** | **string** |  | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { UsageRow } from 'neuland-hub-sdk';
+
+const instance: UsageRow = {
+    cost,
+    total_tokens,
+    prompt_tokens,
+    completion_tokens,
+    requests,
+    group,
+    bucket,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)