Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,14 @@
!/**/*.ts
!/**/*.js
!/**/*.mjs
!/**/*.json
!/package.json
!/jsr.json
!/dist/**/*.json
!/esm/**/*.json
!/**/*.map

/eslint.config.mjs
/.oxlintrc.json
/cjs
/.tshy
/.tshy-*
Expand Down
1,126 changes: 660 additions & 466 deletions .speakeasy/gen.lock

Large diffs are not rendered by default.

10 changes: 9 additions & 1 deletion .speakeasy/gen.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ generation:
requestResponseComponentNamesFeb2024: true
securityFeb2025: true
sharedErrorComponentsApr2025: true
sharedNestedComponentsJan2026: false
nameOverrideFeb2026: false
auth:
oAuth2ClientCredentialsEnabled: true
oAuth2PasswordEnabled: true
Expand All @@ -24,13 +26,14 @@ generation:
schemas:
allOfMergeStrategy: shallowMerge
requestBodyFieldName: ""
versioningStrategy: automatic
persistentEdits: {}
tests:
generateTests: true
generateNewTests: false
skipResponseBodyAssertions: false
typescript:
version: 3.4.1
version: 3.5.0
acceptHeaderEnum: true
additionalDependencies:
dependencies: {}
Expand All @@ -53,6 +56,7 @@ typescript:
enumFormat: union
envVarPrefix: OPPER
exportZodModelNamespace: false
flatAdditionalProperties: false
flattenGlobalSecurity: true
flatteningOrder: parameters-first
formStringArrayEncodeMode: encoded-string
Expand All @@ -71,6 +75,7 @@ typescript:
inputModelSuffix: input
jsonpath: rfc9535
laxMode: strict
legacyFileNaming: true
maxMethodParams: 99
methodArguments: require-security-and-request
modelPropertyCasing: camel
Expand All @@ -79,10 +84,13 @@ typescript:
outputModelSuffix: output
packageName: opperai
preApplyUnionDiscriminators: true
preserveModelFieldNames: false
responseFormat: flat
sseFlatResponse: false
templateVersion: v2
unionStrategy: left-to-right
usageSDKInitImports: []
useIndexModules: true
useOxlint: false
useTsgo: false
zodVersion: v3
12 changes: 6 additions & 6 deletions .speakeasy/workflow.lock
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
speakeasyVersion: 1.680.11
speakeasyVersion: 1.759.1
sources:
FastAPI:
sourceNamespace: fast-api
sourceRevisionDigest: sha256:68b0cbe004a918df9af2bdb9f14fb8603d166eee2514fe752773b87a0b06a602
sourceBlobDigest: sha256:9a8a62a66b7d61f0a406be7b4c63c1b2d555b9ce44d9e3f998d10c31df1d5009
sourceRevisionDigest: sha256:87bf9e79ec18dab172341f8a2e61e26b2c7aa90066e60dba280aa3d6e85b1b67
sourceBlobDigest: sha256:5d351aba9909a3f9597f666711188ceb24f266174a898da591b3130f43779019
tags:
- latest
- main
Expand All @@ -12,10 +12,10 @@ targets:
opper:
source: FastAPI
sourceNamespace: fast-api
sourceRevisionDigest: sha256:68b0cbe004a918df9af2bdb9f14fb8603d166eee2514fe752773b87a0b06a602
sourceBlobDigest: sha256:9a8a62a66b7d61f0a406be7b4c63c1b2d555b9ce44d9e3f998d10c31df1d5009
sourceRevisionDigest: sha256:87bf9e79ec18dab172341f8a2e61e26b2c7aa90066e60dba280aa3d6e85b1b67
sourceBlobDigest: sha256:5d351aba9909a3f9597f666711188ceb24f266174a898da591b3130f43779019
codeSamplesNamespace: fast-api-typescript-code-samples
codeSamplesRevisionDigest: sha256:5c5b7fb4892a2ddb5a8cf1e04b161f2742e976efee6a8b613f3d666aa8474a96
codeSamplesRevisionDigest: sha256:830f81bb8889402ea29ace073221d9ee514edbb6ef5918a15b64d25b0443c3a5
workflow:
workflowVersion: 1.0.0
speakeasyVersion: latest
Expand Down
4 changes: 3 additions & 1 deletion docs/models/annotation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Annotation

A URL citation when using web search.

## Example Usage

```typescript
Expand All @@ -21,5 +23,5 @@ let value: Annotation = {
| Field | Type | Required | Description |
| ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ | ------------------------------------------------------------------ |
| `type` | *"url_citation"* | :heavy_check_mark: | N/A |
| `urlCitation` | [models.AnnotationURLCitation](../models/annotationurlcitation.md) | :heavy_check_mark: | N/A |
| `urlCitation` | [models.AnnotationURLCitation](../models/annotationurlcitation.md) | :heavy_check_mark: | A URL citation when using web search. |
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
2 changes: 2 additions & 0 deletions docs/models/annotationurlcitation.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# AnnotationURLCitation

A URL citation when using web search.

## Example Usage

```typescript
Expand Down

Large diffs are not rendered by default.

3 changes: 3 additions & 0 deletions docs/models/audio.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Audio

Data about a previous audio response from the model.
[Learn more](https://platform.openai.com/docs/guides/audio).

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletion.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletion

Represents a chat completion response returned by model, based on the provided input.

## Example Usage

```typescript
Expand Down
4 changes: 3 additions & 1 deletion docs/models/chatcompletionallowedtoolchoiceparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionAllowedToolChoiceParam

Constrains the tools available to the model to a pre-defined set.

## Example Usage

```typescript
Expand Down Expand Up @@ -28,5 +30,5 @@ let value: ChatCompletionAllowedToolChoiceParam = {

| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- |
| `allowedTools` | [models.ChatCompletionAllowedToolsParam](../models/chatcompletionallowedtoolsparam.md) | :heavy_check_mark: | N/A |
| `allowedTools` | [models.ChatCompletionAllowedToolsParam](../models/chatcompletionallowedtoolsparam.md) | :heavy_check_mark: | Constrains the tools available to the model to a pre-defined set. |
| `type` | *"allowed_tools"* | :heavy_check_mark: | N/A |
2 changes: 2 additions & 0 deletions docs/models/chatcompletionallowedtoolsparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionAllowedToolsParam

Constrains the tools available to the model to a pre-defined set.

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletionassistantmessageparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionAssistantMessageParam

Messages sent by the model in response to user messages.

## Example Usage

```typescript
Expand Down
3 changes: 3 additions & 0 deletions docs/models/chatcompletionaudio.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# ChatCompletionAudio

If the audio output modality is requested, this object contains data
about the audio response from the model. [Learn more](https://platform.openai.com/docs/guides/audio).

## Example Usage

```typescript
Expand Down
7 changes: 6 additions & 1 deletion docs/models/chatcompletionaudioparam.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,18 @@
# ChatCompletionAudioParam

Parameters for audio output.

Required when audio output is requested with
`modalities: ["audio"]`. [Learn more](https://platform.openai.com/docs/guides/audio).

## Example Usage

```typescript
import { ChatCompletionAudioParam } from "opperai/models";

let value: ChatCompletionAudioParam = {
format: "wav",
voice: "shimmer",
voice: "verse",
};
```

Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletioncontentpartimageparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionContentPartImageParam

Learn about [image inputs](https://platform.openai.com/docs/guides/vision).

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletioncontentpartinputaudioparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionContentPartInputAudioParam

Learn about [audio inputs](https://platform.openai.com/docs/guides/audio).

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletioncontentparttextparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionContentPartTextParam

Learn about [text inputs](https://platform.openai.com/docs/guides/text-generation).

## Example Usage

```typescript
Expand Down
4 changes: 3 additions & 1 deletion docs/models/chatcompletioncustomtoolparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionCustomToolParam

A custom tool that processes input using a specified format.

## Example Usage

```typescript
Expand All @@ -17,5 +19,5 @@ let value: ChatCompletionCustomToolParam = {

| Field | Type | Required | Description |
| ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `custom` | [models.OpenaiTypesChatChatCompletionCustomToolParamCustom](../models/openaitypeschatchatcompletioncustomtoolparamcustom.md) | :heavy_check_mark: | N/A |
| `custom` | [models.OpenaiTypesChatChatCompletionCustomToolParamCustom](../models/openaitypeschatchatcompletioncustomtoolparamcustom.md) | :heavy_check_mark: | Properties of the custom tool. |
| `type` | *"custom"* | :heavy_check_mark: | N/A |
4 changes: 4 additions & 0 deletions docs/models/chatcompletiondevelopermessageparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# ChatCompletionDeveloperMessageParam

Developer-provided instructions that the model should follow, regardless of
messages sent by the user. With o1 models and newer, `developer` messages
replace the previous `system` messages.

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletionfunctioncalloptionparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionFunctionCallOptionParam

Specifying a particular function via `{"name": "my_function"}` forces the model to call that function.

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletionfunctiontoolparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionFunctionToolParam

A function tool that can be used to generate a response.

## Example Usage

```typescript
Expand Down
2 changes: 2 additions & 0 deletions docs/models/chatcompletionmessage.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionMessage

A chat completion message generated by the model.

## Example Usage

```typescript
Expand Down
4 changes: 3 additions & 1 deletion docs/models/chatcompletionmessagecustomtoolcall.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionMessageCustomToolCall

A call to a custom tool created by the model.

## Example Usage

```typescript
Expand All @@ -20,6 +22,6 @@ let value: ChatCompletionMessageCustomToolCall = {
| Field | Type | Required | Description |
| ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ | ------------------------------------------------ |
| `id` | *string* | :heavy_check_mark: | N/A |
| `custom` | [models.CustomOutput](../models/customoutput.md) | :heavy_check_mark: | N/A |
| `custom` | [models.CustomOutput](../models/customoutput.md) | :heavy_check_mark: | The custom tool that the model called. |
| `type` | *"custom"* | :heavy_check_mark: | N/A |
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
4 changes: 3 additions & 1 deletion docs/models/chatcompletionmessagecustomtoolcallparam.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionMessageCustomToolCallParam

A call to a custom tool created by the model.

## Example Usage

```typescript
Expand All @@ -20,5 +22,5 @@ let value: ChatCompletionMessageCustomToolCallParam = {
| Field | Type | Required | Description |
| -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | N/A |
| `custom` | [models.OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom](../models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md) | :heavy_check_mark: | N/A |
| `custom` | [models.OpenaiTypesChatChatCompletionMessageCustomToolCallParamCustom](../models/openaitypeschatchatcompletionmessagecustomtoolcallparamcustom.md) | :heavy_check_mark: | The custom tool that the model called. |
| `type` | *"custom"* | :heavy_check_mark: | N/A |
4 changes: 3 additions & 1 deletion docs/models/chatcompletionmessagefunctiontoolcall.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# ChatCompletionMessageFunctionToolCall

A call to a function tool created by the model.

## Example Usage

```typescript
Expand All @@ -20,6 +22,6 @@ let value: ChatCompletionMessageFunctionToolCall = {
| Field | Type | Required | Description |
| ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- | ---------------------------------------------------- |
| `id` | *string* | :heavy_check_mark: | N/A |
| `function` | [models.FunctionOutput](../models/functionoutput.md) | :heavy_check_mark: | N/A |
| `function` | [models.FunctionOutput](../models/functionoutput.md) | :heavy_check_mark: | The function that the model called. |
| `type` | *"function"* | :heavy_check_mark: | N/A |
| `additionalProperties` | Record<string, *any*> | :heavy_minus_sign: | N/A |
Loading