You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
Commit d2ba1fe
Browse filesBrowse the repository at this point in the historyBrowse files
Copy file name to clipboardExpand all lines: .speakeasy/in.openapi.yaml
+124-3Lines changed: 124 additions & 3 deletions
Original file line number
Diff line number
Diff line change
@@ -11100,6 +11100,16 @@ components:
11100
11100
- 'type'
11101
11101
- 'instructions'
11102
11102
type: 'object'
11103
+
DecisionsRefusalAnswer:
11104
+
description: 'The provider declined to answer this question; no value or probabilities are returned. Other questions in the same request can still have answers.'
11105
+
properties:
11106
+
type:
11107
+
enum:
11108
+
- 'refusal'
11109
+
type: 'string'
11110
+
required:
11111
+
- 'type'
11112
+
type: 'object'
11103
11113
DecisionsRequest:
11104
11114
properties:
11105
11115
assets:
@@ -11154,21 +11164,28 @@ components:
11154
11164
type: 'object'
11155
11165
DecisionsResponse:
11156
11166
properties:
11167
+
annotations:
11168
+
description: 'Sources for the request as a whole, when the provider returns them. Not attributed to individual answers.'
description: 'A web source the provider used for this request. Applies to the whole request, not to a specific answer.'
11279
+
properties:
11280
+
type:
11281
+
enum:
11282
+
- 'url_citation'
11283
+
type: 'string'
11284
+
url_citation:
11285
+
properties:
11286
+
content:
11287
+
type: 'string'
11288
+
title:
11289
+
type: 'string'
11290
+
url:
11291
+
type: 'string'
11292
+
required:
11293
+
- 'url'
11294
+
type: 'object'
11295
+
required:
11296
+
- 'type'
11297
+
- 'url_citation'
11298
+
type: 'object'
11260
11299
DecisionsUsageInputTokensDetails:
11261
11300
description: 'Of `input_tokens`, those the provider served from its prompt cache.'
11262
11301
properties:
@@ -31333,8 +31372,13 @@ components:
31333
31372
example: 'mistralai/voxtral-mini-tts-2603'
31334
31373
type: 'string'
31335
31374
provider:
31336
-
description: 'Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options'
31375
+
description: 'Provider configuration: provider routing preferences (`order`, `only`, `ignore`, `allow_fallbacks`), data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options'
31337
31376
properties:
31377
+
allow_fallbacks:
31378
+
description: "Whether to allow backup providers to serve requests\n- true: (default) when the primary provider (or your custom providers in \"order\") is unavailable, use the next best provider.\n- false: use only the primary/custom provider, and return the upstream error if it's unavailable.\n"
31379
+
type:
31380
+
- 'boolean'
31381
+
- 'null'
31338
31382
data_collection:
31339
31383
description: "Data collection setting. If no available model provider meets the requirement, your request will return an error.\n- allow: (default) allow providers which store user data non-transiently and may train on it\n\n- deny: use only providers which do not collect user data."
31340
31384
enum:
@@ -31346,8 +31390,44 @@ components:
31346
31390
type:
31347
31391
- 'string'
31348
31392
- 'null'
31393
+
ignore:
31394
+
description: 'List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request.'
31395
+
example:
31396
+
- 'openai'
31397
+
- 'anthropic'
31398
+
items:
31399
+
anyOf:
31400
+
- $ref: '#/components/schemas/ProviderName'
31401
+
- type: 'string'
31402
+
type:
31403
+
- 'array'
31404
+
- 'null'
31405
+
only:
31406
+
description: 'List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request.'
31407
+
example:
31408
+
- 'openai'
31409
+
- 'anthropic'
31410
+
items:
31411
+
anyOf:
31412
+
- $ref: '#/components/schemas/ProviderName'
31413
+
- type: 'string'
31414
+
type:
31415
+
- 'array'
31416
+
- 'null'
31349
31417
options:
31350
31418
$ref: '#/components/schemas/ProviderOptions'
31419
+
order:
31420
+
description: 'An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message.'
31421
+
example:
31422
+
- 'openai'
31423
+
- 'anthropic'
31424
+
items:
31425
+
anyOf:
31426
+
- $ref: '#/components/schemas/ProviderName'
31427
+
- type: 'string'
31428
+
type:
31429
+
- 'array'
31430
+
- 'null'
31351
31431
zdr:
31352
31432
description: 'Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used.'
31353
31433
example: true
@@ -31944,8 +32024,13 @@ components:
31944
32024
example: 'openai/whisper-large-v3'
31945
32025
type: 'string'
31946
32026
provider:
31947
-
description: 'Provider configuration: data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options'
32027
+
description: 'Provider configuration: provider routing preferences (`order`, `only`, `ignore`, `allow_fallbacks`), data policy routing preferences (`zdr`, `data_collection`) and provider-specific passthrough options'
31948
32028
properties:
32029
+
allow_fallbacks:
32030
+
description: "Whether to allow backup providers to serve requests\n- true: (default) when the primary provider (or your custom providers in \"order\") is unavailable, use the next best provider.\n- false: use only the primary/custom provider, and return the upstream error if it's unavailable.\n"
32031
+
type:
32032
+
- 'boolean'
32033
+
- 'null'
31949
32034
data_collection:
31950
32035
description: "Data collection setting. If no available model provider meets the requirement, your request will return an error.\n- allow: (default) allow providers which store user data non-transiently and may train on it\n\n- deny: use only providers which do not collect user data."
31951
32036
enum:
@@ -31957,8 +32042,44 @@ components:
31957
32042
type:
31958
32043
- 'string'
31959
32044
- 'null'
32045
+
ignore:
32046
+
description: 'List of provider slugs to ignore. If provided, this list is merged with your account-wide ignored provider settings for this request.'
32047
+
example:
32048
+
- 'openai'
32049
+
- 'anthropic'
32050
+
items:
32051
+
anyOf:
32052
+
- $ref: '#/components/schemas/ProviderName'
32053
+
- type: 'string'
32054
+
type:
32055
+
- 'array'
32056
+
- 'null'
32057
+
only:
32058
+
description: 'List of provider slugs to allow. If provided, this list is merged with your account-wide allowed provider settings for this request.'
32059
+
example:
32060
+
- 'openai'
32061
+
- 'anthropic'
32062
+
items:
32063
+
anyOf:
32064
+
- $ref: '#/components/schemas/ProviderName'
32065
+
- type: 'string'
32066
+
type:
32067
+
- 'array'
32068
+
- 'null'
31960
32069
options:
31961
32070
$ref: '#/components/schemas/ProviderOptions'
32071
+
order:
32072
+
description: 'An ordered list of provider slugs. The router will attempt to use the first provider in the subset of this list that supports your requested model, and fall back to the next if it is unavailable. If no providers are available, the request will fail with an error message.'
32073
+
example:
32074
+
- 'openai'
32075
+
- 'anthropic'
32076
+
items:
32077
+
anyOf:
32078
+
- $ref: '#/components/schemas/ProviderName'
32079
+
- type: 'string'
32080
+
type:
32081
+
- 'array'
32082
+
- 'null'
31962
32083
zdr:
31963
32084
description: 'Whether to restrict routing to only ZDR (Zero Data Retention) endpoints. When true, only endpoints that do not retain prompts will be used.'
0 commit comments