2025/03/27 generate kotlin then modify #3
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
There was a problem hiding this comment.
Pull Request Overview
This PR updates the Kotlin client documentation by adding new specification files, properties, and endpoints along with updating model names and request/response types. Key changes include:
- Addition of new documentation files for annotations, file attachments, and updated enums.
- Updates to the ChatApi and AudioApi documents to reflect new endpoints (e.g., delete, update, get messages) and revised request/response models.
- Updates to the README and build configuration files (e.g., version bumps and additions such as the Spotless plugin).
Reviewed Changes
Copilot reviewed 739 out of 741 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| lib/docs/ChatCompletionResponseMessageAnnotationsInner.md | New markdown docs describing annotation properties. |
| lib/docs/ChatCompletionRequestUserMessageContentPart.md | Addition of a new "file" property and corresponding enum update. |
| lib/docs/ChatApi.md | Updates to include new endpoints and revised documentation for chat completions. |
| lib/docs/AudioApi.md | Updates to transcription/translation endpoints and inclusion of new request parameters. |
| lib/docs/AssistantsApiResponseFormatOption.md | Renaming schema reference for response format documentation. |
| gradle/libs.versions.toml | Addition of the Spotless plugin version entry. |
| README.md | Documentation updates and clarification notes on current library support. |
Files not reviewed (2)
- gradle/wrapper/gradle-wrapper.properties: Language not supported
- lib/build.gradle.kts: Language not supported
| val temperature : java.math.BigDecimal = 8.14 // java.math.BigDecimal | The sampling temperature, between 0 and 1. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic. If set to 0, the model will use [log probability](https://en.wikipedia.org/wiki/Log_probability) to automatically increase the temperature until certain thresholds are hit. | ||
| val include : kotlin.collections.List<TranscriptionInclude> = // kotlin.collections.List<TranscriptionInclude> | Additional information to include in the transcription response. `logprobs` will return the log probabilities of the tokens in the response to understand the model's confidence in the transcription. `logprobs` only works with response_format set to `json` and only with the models `gpt-4o-transcribe` and `gpt-4o-mini-transcribe`. | ||
| val timestampGranularities : kotlin.collections.List<kotlin.String> = // kotlin.collections.List<kotlin.String> | The timestamp granularities to populate for this transcription. `response_format` must be set `verbose_json` to use timestamp granularities. Either or both of these options are supported: `word`, or `segment`. Note: There is no additional latency for segment timestamps, but generating word timestamps incurs additional latency. | ||
| val stream : kotlin.Boolean = true // kotlin.Boolean | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions) for more information. Note: Streaming is not supported for the `whisper-1` model and will be ignored. |
There was a problem hiding this comment.
The default value for 'stream' is set to true in the code sample, yet the accompanying documentation notes a default of false. Consider aligning the default value to avoid potential confusion.
Suggested change
| val stream : kotlin.Boolean = true // kotlin.Boolean | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions) for more information. Note: Streaming is not supported for the `whisper-1` model and will be ignored. | |
| val stream : kotlin.Boolean = false // kotlin.Boolean | If set to true, the model response data will be streamed to the client as it is generated using [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format). See the [Streaming section of the Speech-to-Text guide](/docs/guides/speech-to-text?lang=curl#streaming-transcriptions) for more information. Note: Streaming is not supported for the `whisper-1` model and will be ignored. |
paulpv
force-pushed
the
generated_20250327
branch
3 times, most recently
from
5706636 to
72434a6
Compare
paulpv
force-pushed
the
generated_20250327
branch
from
72434a6 to
6a8655c
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.