Skip to content

Commit 4ab208c

Browse files
fix(api): docs updates
1 parent ae042a4 commit 4ab208c

File tree

8 files changed

+31
-16
lines changed

8 files changed

+31
-16
lines changed

.stats.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 123
2-
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a4bb37d110a22c2888f53e21281434686a6fffa3e672a40f2503ad9bd2759063.yml
3-
openapi_spec_hash: 2d59eefb494dff4eea8c3d008c7e2070
2+
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/openai%2Fopenai-a3c45d9bd3bb25bf4eaa49b7fb473a00038293dec659ffaa44f624ded884abf4.yml
3+
openapi_spec_hash: 9c20aaf786a0700dabd13d9865481c9e
44
config_hash: 50ee3382a63c021a9f821a935950e926

aliases.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
371371
// debugging and understanding the model's reasoning process. One of `auto`,
372372
// `concise`, or `detailed`.
373373
//
374+
// `concise` is only supported for `computer-use-preview` models.
375+
//
374376
// This is an alias to an internal type.
375377
type ReasoningSummary = shared.ReasoningSummary
376378

conversations/aliases.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
371371
// debugging and understanding the model's reasoning process. One of `auto`,
372372
// `concise`, or `detailed`.
373373
//
374+
// `concise` is only supported for `computer-use-preview` models.
375+
//
374376
// This is an alias to an internal type.
375377
type ReasoningSummary = shared.ReasoningSummary
376378

file.go

Lines changed: 13 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,20 +47,19 @@ func NewFileService(opts ...option.RequestOption) (r FileService) {
4747
// up to 512 MB, and the size of all files uploaded by one organization can be up
4848
// to 1 TB.
4949
//
50-
// The Assistants API supports files up to 2 million tokens and of specific file
51-
// types. See the
52-
// [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools) for
53-
// details.
54-
//
55-
// The Fine-tuning API only supports `.jsonl` files. The input also has certain
56-
// required formats for fine-tuning
57-
// [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input) or
58-
// [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
59-
// models.
60-
//
61-
// The Batch API only supports `.jsonl` files up to 200 MB in size. The input also
62-
// has a specific required
63-
// [format](https://platform.openai.com/docs/api-reference/batch/request-input).
50+
// - The Assistants API supports files up to 2 million tokens and of specific file
51+
// types. See the
52+
// [Assistants Tools guide](https://platform.openai.com/docs/assistants/tools)
53+
// for details.
54+
// - The Fine-tuning API only supports `.jsonl` files. The input also has certain
55+
// required formats for fine-tuning
56+
// [chat](https://platform.openai.com/docs/api-reference/fine-tuning/chat-input)
57+
// or
58+
// [completions](https://platform.openai.com/docs/api-reference/fine-tuning/completions-input)
59+
// models.
60+
// - The Batch API only supports `.jsonl` files up to 200 MB in size. The input
61+
// also has a specific required
62+
// [format](https://platform.openai.com/docs/api-reference/batch/request-input).
6463
//
6564
// Please [contact us](https://help.openai.com/) if you need to increase these
6665
// storage limits.

realtime/aliases.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
371371
// debugging and understanding the model's reasoning process. One of `auto`,
372372
// `concise`, or `detailed`.
373373
//
374+
// `concise` is only supported for `computer-use-preview` models.
375+
//
374376
// This is an alias to an internal type.
375377
type ReasoningSummary = shared.ReasoningSummary
376378

responses/aliases.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
371371
// debugging and understanding the model's reasoning process. One of `auto`,
372372
// `concise`, or `detailed`.
373373
//
374+
// `concise` is only supported for `computer-use-preview` models.
375+
//
374376
// This is an alias to an internal type.
375377
type ReasoningSummary = shared.ReasoningSummary
376378

shared/shared.go

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -769,6 +769,8 @@ type Reasoning struct {
769769
// debugging and understanding the model's reasoning process. One of `auto`,
770770
// `concise`, or `detailed`.
771771
//
772+
// `concise` is only supported for `computer-use-preview` models.
773+
//
772774
// Any of "auto", "concise", "detailed".
773775
Summary ReasoningSummary `json:"summary,nullable"`
774776
// JSON contains metadata for fields, check presence with [respjson.Field.Valid].
@@ -812,6 +814,8 @@ const (
812814
// A summary of the reasoning performed by the model. This can be useful for
813815
// debugging and understanding the model's reasoning process. One of `auto`,
814816
// `concise`, or `detailed`.
817+
//
818+
// `concise` is only supported for `computer-use-preview` models.
815819
type ReasoningSummary string
816820

817821
const (
@@ -850,6 +854,8 @@ type ReasoningParam struct {
850854
// debugging and understanding the model's reasoning process. One of `auto`,
851855
// `concise`, or `detailed`.
852856
//
857+
// `concise` is only supported for `computer-use-preview` models.
858+
//
853859
// Any of "auto", "concise", "detailed".
854860
Summary ReasoningSummary `json:"summary,omitzero"`
855861
paramObj

webhooks/aliases.go

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,8 @@ const ReasoningGenerateSummaryDetailed = shared.ReasoningGenerateSummaryDetailed
371371
// debugging and understanding the model's reasoning process. One of `auto`,
372372
// `concise`, or `detailed`.
373373
//
374+
// `concise` is only supported for `computer-use-preview` models.
375+
//
374376
// This is an alias to an internal type.
375377
type ReasoningSummary = shared.ReasoningSummary
376378

0 commit comments

Comments
 (0)