Skip to content

Commit 06c17bd

Browse files
feat: update API specifications (#30)
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
1 parent 7a0fad2 commit 06c17bd

File tree

1 file changed

+102
-56
lines changed

1 file changed

+102
-56
lines changed

openapi.yml

Lines changed: 102 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -484,7 +484,7 @@ paths:
484484
/v1/projects/{project_id}/models:
485485
description: Manage your project models
486486
get:
487-
summary: Returns metadata on all the latest models
487+
summary: Get All Project Models
488488
tags:
489489
- Management API
490490
security:
@@ -627,7 +627,7 @@ paths:
627627
security:
628628
- ApiKeyAuth: []
629629
operationId: deleteProjectKey
630-
summary: Deletes an API key for a specific project
630+
summary: Delete a Project Key
631631
description: Deletes an API key for a specific project
632632
parameters:
633633
- $ref: '#/components/parameters/project_id'
@@ -1040,14 +1040,17 @@ paths:
10401040
- ApiKeyAuth: []
10411041
operationId: getProjectUsageBreakdown
10421042
description: |
1043-
Returns the breakdown of usage for a specific project. Supports the following filter options:
1044-
- &accessor={accessor_id} - The public API key accessor used
1045-
- &deployment={deployment} - The deployment type used
1046-
- &endpoint={endpoint} - The endpoint used
1047-
- &feature_set={feature_set} - The collection of features used
1048-
- &model={model_id} - The model used
1049-
- &method={method} - The processing method used
1050-
- &tags={tag} - Any tags used
1043+
| Parameter | Type | Description |
1044+
|-----------|------|-------------|
1045+
| accessor | boolean | The public API key accessor used |
1046+
| deployment | boolean | The deployment type used |
1047+
| endpoint | boolean | The endpoint used |
1048+
| feature_set | boolean | The collection of features used |
1049+
| model | boolean | The model used |
1050+
| method | boolean | The processing method used |
1051+
| tags | boolean | Any tags used |
1052+
| diarize | boolean | Filter by diarization usage |
1053+
| utterances | boolean | Filter by utterances usage |
10511054
parameters:
10521055
- $ref: '#/components/parameters/project_id'
10531056
- $ref: '#/components/parameters/start'
@@ -1107,7 +1110,7 @@ paths:
11071110
security:
11081111
- ApiKeyAuth: []
11091112
operationId: getModel
1110-
summary: Returns metadata for a specific model
1113+
summary: Get a specific Project Model
11111114
description: Returns metadata for a specific model
11121115
parameters:
11131116
- $ref: '#/components/parameters/model_id'
@@ -1942,7 +1945,7 @@ components:
19421945
include_outdated:
19431946
name: include_outdated
19441947
in: query
1945-
required: true
1948+
required: false
19461949
description: returns non-latest versions of models
19471950
schema:
19481951
type: boolean
@@ -1991,49 +1994,92 @@ components:
19911994
name: project_filters
19921995
in: query
19931996
required: false
1994-
description: Common filter parameters
1997+
description: |
1998+
Filter options for project features. Each filter can be used as an individual query parameter.
1999+
Example: ?diarize=true&utterances=true
2000+
style: form
2001+
explode: true
19952002
schema:
1996-
type: string
1997-
enum:
1998-
- alternatives.yml
1999-
- callback_method.yml
2000-
- callback.yml
2001-
- channels.yml
2002-
- custom_intent_mode.yml
2003-
- custom_intent.yml
2004-
- custom_topic_mode.yml
2005-
- custom_topic.yml
2006-
- detect_entities.yml
2007-
- detect_language.yml
2008-
- diarize.yml
2009-
- diarize_version.yml
2010-
- dictation.yml
2011-
- detect_topics.yml
2012-
- encoding.yml
2013-
- extra.yml
2014-
- filler_words.yml
2015-
- intents.yml
2016-
- keywords.yml
2017-
- language.yml
2018-
- measurements.yml
2019-
- model.yml
2020-
- multichannel.yml
2021-
- numerals.yml
2022-
- paragraphs.yml
2023-
- profanity_filter.yml
2024-
- punctuate.yml
2025-
- redact.yml
2026-
- replace.yml
2027-
- sample_rate.yml
2028-
- smart_format.yml
2029-
- search.yml
2030-
- sentiment.yml
2031-
- summarize.yml
2032-
- tag.yml
2033-
- topics.yml
2034-
- utterances.yml
2035-
- utt_split.yml
2036-
- version.yml
2003+
type: object
2004+
properties:
2005+
alternatives:
2006+
type: boolean
2007+
callback_method:
2008+
type: boolean
2009+
callback:
2010+
type: boolean
2011+
channels:
2012+
type: boolean
2013+
custom_intent_mode:
2014+
type: boolean
2015+
custom_intent:
2016+
type: boolean
2017+
custom_topic_mode:
2018+
type: boolean
2019+
custom_topic:
2020+
type: boolean
2021+
detect_entities:
2022+
type: boolean
2023+
detect_language:
2024+
type: boolean
2025+
diarize:
2026+
type: boolean
2027+
diarize_version:
2028+
type: boolean
2029+
dictation:
2030+
type: boolean
2031+
detect_topics:
2032+
type: boolean
2033+
encoding:
2034+
type: boolean
2035+
extra:
2036+
type: boolean
2037+
filler_words:
2038+
type: boolean
2039+
intents:
2040+
type: boolean
2041+
keywords:
2042+
type: boolean
2043+
language:
2044+
type: boolean
2045+
measurements:
2046+
type: boolean
2047+
model:
2048+
type: boolean
2049+
multichannel:
2050+
type: boolean
2051+
numerals:
2052+
type: boolean
2053+
paragraphs:
2054+
type: boolean
2055+
profanity_filter:
2056+
type: boolean
2057+
punctuate:
2058+
type: boolean
2059+
redact:
2060+
type: boolean
2061+
replace:
2062+
type: boolean
2063+
sample_rate:
2064+
type: boolean
2065+
smart_format:
2066+
type: boolean
2067+
search:
2068+
type: boolean
2069+
sentiment:
2070+
type: boolean
2071+
summarize:
2072+
type: boolean
2073+
tag:
2074+
type: boolean
2075+
topics:
2076+
type: boolean
2077+
utterances:
2078+
type: boolean
2079+
utt_split:
2080+
type: boolean
2081+
version:
2082+
type: boolean
20372083
usage_breakdown_filters:
20382084
name: usage_breakdown_filters
20392085
in: query
@@ -2714,10 +2760,10 @@ components:
27142760
properties:
27152761
name:
27162762
type: string
2717-
example: conversationalai
2763+
example: nova-3
27182764
canonical_name:
27192765
type: string
2720-
example: conversationalai
2766+
example: nova-3
27212767
architecture:
27222768
type: string
27232769
example: base

0 commit comments

Comments
 (0)