aliases.go

// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.

package openai

import (
	"github.com/openai/openai-go/internal/apierror"
	"github.com/openai/openai-go/shared"
)

type Error = apierror.Error

// This is an alias to an internal type.
type ChatModel = shared.ChatModel

// This is an alias to an internal value.
const ChatModelO3Mini = shared.ChatModelO3Mini

// This is an alias to an internal value.
const ChatModelO3Mini2025_01_31 = shared.ChatModelO3Mini2025_01_31

// This is an alias to an internal value.
const ChatModelO1 = shared.ChatModelO1

// This is an alias to an internal value.
const ChatModelO1_2024_12_17 = shared.ChatModelO1_2024_12_17

// This is an alias to an internal value.
const ChatModelO1Preview = shared.ChatModelO1Preview

// This is an alias to an internal value.
const ChatModelO1Preview2024_09_12 = shared.ChatModelO1Preview2024_09_12

// This is an alias to an internal value.
const ChatModelO1Mini = shared.ChatModelO1Mini

// This is an alias to an internal value.
const ChatModelO1Mini2024_09_12 = shared.ChatModelO1Mini2024_09_12

// This is an alias to an internal value.
const ChatModelGPT4o = shared.ChatModelGPT4o

// This is an alias to an internal value.
const ChatModelGPT4o2024_11_20 = shared.ChatModelGPT4o2024_11_20

// This is an alias to an internal value.
const ChatModelGPT4o2024_08_06 = shared.ChatModelGPT4o2024_08_06

// This is an alias to an internal value.
const ChatModelGPT4o2024_05_13 = shared.ChatModelGPT4o2024_05_13

// This is an alias to an internal value.
const ChatModelGPT4oAudioPreview = shared.ChatModelGPT4oAudioPreview

// This is an alias to an internal value.
const ChatModelGPT4oAudioPreview2024_10_01 = shared.ChatModelGPT4oAudioPreview2024_10_01

// This is an alias to an internal value.
const ChatModelGPT4oAudioPreview2024_12_17 = shared.ChatModelGPT4oAudioPreview2024_12_17

// This is an alias to an internal value.
const ChatModelGPT4oMiniAudioPreview = shared.ChatModelGPT4oMiniAudioPreview

// This is an alias to an internal value.
const ChatModelGPT4oMiniAudioPreview2024_12_17 = shared.ChatModelGPT4oMiniAudioPreview2024_12_17

// This is an alias to an internal value.
const ChatModelGPT4oSearchPreview = shared.ChatModelGPT4oSearchPreview

// This is an alias to an internal value.
const ChatModelGPT4oMiniSearchPreview = shared.ChatModelGPT4oMiniSearchPreview

// This is an alias to an internal value.
const ChatModelGPT4oSearchPreview2025_03_11 = shared.ChatModelGPT4oSearchPreview2025_03_11

// This is an alias to an internal value.
const ChatModelGPT4oMiniSearchPreview2025_03_11 = shared.ChatModelGPT4oMiniSearchPreview2025_03_11

// This is an alias to an internal value.
const ChatModelChatgpt4oLatest = shared.ChatModelChatgpt4oLatest

// This is an alias to an internal value.
const ChatModelGPT4oMini = shared.ChatModelGPT4oMini

// This is an alias to an internal value.
const ChatModelGPT4oMini2024_07_18 = shared.ChatModelGPT4oMini2024_07_18

// This is an alias to an internal value.
const ChatModelGPT4Turbo = shared.ChatModelGPT4Turbo

// This is an alias to an internal value.
const ChatModelGPT4Turbo2024_04_09 = shared.ChatModelGPT4Turbo2024_04_09

// This is an alias to an internal value.
const ChatModelGPT4_0125Preview = shared.ChatModelGPT4_0125Preview

// This is an alias to an internal value.
const ChatModelGPT4TurboPreview = shared.ChatModelGPT4TurboPreview

// This is an alias to an internal value.
const ChatModelGPT4_1106Preview = shared.ChatModelGPT4_1106Preview

// This is an alias to an internal value.
const ChatModelGPT4VisionPreview = shared.ChatModelGPT4VisionPreview

// This is an alias to an internal value.
const ChatModelGPT4 = shared.ChatModelGPT4

// This is an alias to an internal value.
const ChatModelGPT4_0314 = shared.ChatModelGPT4_0314

// This is an alias to an internal value.
const ChatModelGPT4_0613 = shared.ChatModelGPT4_0613

// This is an alias to an internal value.
const ChatModelGPT4_32k = shared.ChatModelGPT4_32k

// This is an alias to an internal value.
const ChatModelGPT4_32k0314 = shared.ChatModelGPT4_32k0314

// This is an alias to an internal value.
const ChatModelGPT4_32k0613 = shared.ChatModelGPT4_32k0613

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo = shared.ChatModelGPT3_5Turbo

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo16k = shared.ChatModelGPT3_5Turbo16k

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo0301 = shared.ChatModelGPT3_5Turbo0301

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo0613 = shared.ChatModelGPT3_5Turbo0613

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo1106 = shared.ChatModelGPT3_5Turbo1106

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo0125 = shared.ChatModelGPT3_5Turbo0125

// This is an alias to an internal value.
const ChatModelGPT3_5Turbo16k0613 = shared.ChatModelGPT3_5Turbo16k0613

// A filter used to compare a specified attribute key to a given value using a
// defined comparison operation.
//
// This is an alias to an internal type.
type ComparisonFilterParam = shared.ComparisonFilterParam

// Specifies the comparison operator: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`.
//
// - `eq`: equals
// - `ne`: not equal
// - `gt`: greater than
// - `gte`: greater than or equal
// - `lt`: less than
// - `lte`: less than or equal
//
// This is an alias to an internal type.
type ComparisonFilterType = shared.ComparisonFilterType

// This is an alias to an internal value.
const ComparisonFilterTypeEq = shared.ComparisonFilterTypeEq

// This is an alias to an internal value.
const ComparisonFilterTypeNe = shared.ComparisonFilterTypeNe

// This is an alias to an internal value.
const ComparisonFilterTypeGt = shared.ComparisonFilterTypeGt

// This is an alias to an internal value.
const ComparisonFilterTypeGte = shared.ComparisonFilterTypeGte

// This is an alias to an internal value.
const ComparisonFilterTypeLt = shared.ComparisonFilterTypeLt

// This is an alias to an internal value.
const ComparisonFilterTypeLte = shared.ComparisonFilterTypeLte

// The value to compare against the attribute key; supports string, number, or
// boolean types.
//
// This is an alias to an internal type.
type ComparisonFilterValueUnionParam = shared.ComparisonFilterValueUnionParam

// Combine multiple filters using `and` or `or`.
//
// This is an alias to an internal type.
type CompoundFilterParam = shared.CompoundFilterParam

// Type of operation: `and` or `or`.
//
// This is an alias to an internal type.
type CompoundFilterType = shared.CompoundFilterType

// This is an alias to an internal value.
const CompoundFilterTypeAnd = shared.CompoundFilterTypeAnd

// This is an alias to an internal value.
const CompoundFilterTypeOr = shared.CompoundFilterTypeOr

// This is an alias to an internal type.
type ErrorObject = shared.ErrorObject

// This is an alias to an internal type.
type FunctionDefinition = shared.FunctionDefinition

// This is an alias to an internal type.
type FunctionDefinitionParam = shared.FunctionDefinitionParam

// The parameters the functions accepts, described as a JSON Schema object. See the
// [guide](https://platform.openai.com/docs/guides/function-calling) for examples,
// and the
// [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
// documentation about the format.
//
// Omitting `parameters` defines a function with an empty parameter list.
//
// This is an alias to an internal type.
type FunctionParameters = shared.FunctionParameters

// Set of 16 key-value pairs that can be attached to an object. This can be useful
// for storing additional information about the object in a structured format, and
// querying for objects via API or the dashboard.
//
// Keys are strings with a maximum length of 64 characters. Values are strings with
// a maximum length of 512 characters.
//
// This is an alias to an internal type.
type Metadata = shared.Metadata

// Set of 16 key-value pairs that can be attached to an object. This can be useful
// for storing additional information about the object in a structured format, and
// querying for objects via API or the dashboard.
//
// Keys are strings with a maximum length of 64 characters. Values are strings with
// a maximum length of 512 characters.
//
// This is an alias to an internal type.
type MetadataParam = shared.MetadataParam

// **o-series models only**
//
// Constrains effort on reasoning for
// [reasoning models](https://platform.openai.com/docs/guides/reasoning). Currently
// supported values are `low`, `medium`, and `high`. Reducing reasoning effort can
// result in faster responses and fewer tokens used on reasoning in a response.
//
// This is an alias to an internal type.
type ReasoningEffort = shared.ReasoningEffort

// This is an alias to an internal value.
const ReasoningEffortLow = shared.ReasoningEffortLow

// This is an alias to an internal value.
const ReasoningEffortMedium = shared.ReasoningEffortMedium

// This is an alias to an internal value.
const ReasoningEffortHigh = shared.ReasoningEffortHigh

// JSON object response format. An older method of generating JSON responses. Using
// `json_schema` is recommended for models that support it. Note that the model
// will not generate JSON without a system or user message instructing it to do so.
//
// This is an alias to an internal type.
type ResponseFormatJSONObject = shared.ResponseFormatJSONObject

// The type of response format being defined. Always `json_object`.
//
// This is an alias to an internal type.
type ResponseFormatJSONObjectType = shared.ResponseFormatJSONObjectType

// This is an alias to an internal value.
const ResponseFormatJSONObjectTypeJSONObject = shared.ResponseFormatJSONObjectTypeJSONObject

// JSON object response format. An older method of generating JSON responses. Using
// `json_schema` is recommended for models that support it. Note that the model
// will not generate JSON without a system or user message instructing it to do so.
//
// This is an alias to an internal type.
type ResponseFormatJSONObjectParam = shared.ResponseFormatJSONObjectParam

// JSON Schema response format. Used to generate structured JSON responses. Learn
// more about
// [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
//
// This is an alias to an internal type.
type ResponseFormatJSONSchema = shared.ResponseFormatJSONSchema

// Structured Outputs configuration options, including a JSON Schema.
//
// This is an alias to an internal type.
type ResponseFormatJSONSchemaJSONSchema = shared.ResponseFormatJSONSchemaJSONSchema

// The type of response format being defined. Always `json_schema`.
//
// This is an alias to an internal type.
type ResponseFormatJSONSchemaType = shared.ResponseFormatJSONSchemaType

// This is an alias to an internal value.
const ResponseFormatJSONSchemaTypeJSONSchema = shared.ResponseFormatJSONSchemaTypeJSONSchema

// JSON Schema response format. Used to generate structured JSON responses. Learn
// more about
// [Structured Outputs](https://platform.openai.com/docs/guides/structured-outputs).
//
// This is an alias to an internal type.
type ResponseFormatJSONSchemaParam = shared.ResponseFormatJSONSchemaParam

// Structured Outputs configuration options, including a JSON Schema.
//
// This is an alias to an internal type.
type ResponseFormatJSONSchemaJSONSchemaParam = shared.ResponseFormatJSONSchemaJSONSchemaParam

// Default response format. Used to generate text responses.
//
// This is an alias to an internal type.
type ResponseFormatText = shared.ResponseFormatText

// The type of response format being defined. Always `text`.
//
// This is an alias to an internal type.
type ResponseFormatTextType = shared.ResponseFormatTextType

// This is an alias to an internal value.
const ResponseFormatTextTypeText = shared.ResponseFormatTextTypeText

// Default response format. Used to generate text responses.
//
// This is an alias to an internal type.
type ResponseFormatTextParam = shared.ResponseFormatTextParam