Module openai

Expand description

OpenAI API.

Modules§

basicfuncs 🔒: OpenAI API - function 機能向け、すべての場合に共通で提供される基本的な関数群。
chat_history: OpenAI API の会話コンテキストのトークン数制限付き管理。
function: OpenAI API - function.

Structs§

CachedModelInfo: モデル情報。 API から得られるデータ。時々でよいので再取得する必要がある。
ErrorObject 🔒
ExpectedRateLimit
Function: OpenAI API JSON 定義。 function 定義。
FunctionCall
Image 🔒: OpenAI API JSON 定義。画像データ。
ImageGenRequest 🔒: OpenAI API JSON 定義。画像生成リクエスト。
ImageGenResponse 🔒: OpenAI API JSON 定義。画像生成レスポンス。
InputTokensDetails 🔒
Model 🔒: OpenAI API JSON 定義。モデル情報。
ModelInfo: OfflineModelInfo + OnlineModelInfo
OfflineModelInfo: モデル情報。 API からは得られない、ドキュメントにのみある情報。
OnlineModelInfo: Model から必要なもののみ抜き出して読めるデータに変換したもの。
OpenAi: OpenAI システムモジュール。
OpenAiConfig: OpenAI 設定データ。
OutputTokensDetails 🔒
ParameterElement: OpenAI API JSON 定義。 function パラメータ定義 (JSON Schema)。
Parameters: OpenAI API JSON 定義。 function パラメータ定義。
RateLimit 🔒: Rate Limit 情報。
ResponseObject
ResponseRequest: OpenAI API JSON 定義。 Response API リクエスト。
SpeechRequest 🔒: OpenAI API JSON 定義。音声生成リクエスト。
Usage 🔒
WebSearchCall

Enums§

ImageSize 🔒: OpenAI API JSON 定義。画像生成のサイズ。
InputContent
InputImageDetail
InputItem: OpenAI API JSON 定義。入力エレメント。
OpenAiErrorKind: 特別な案内をすべきかもしれないエラー。
OutputContent
OutputElement
ParameterType
ResponseFormat 🔒: OpenAI API JSON 定義。画像生成のフォーマット。
Role: OpenAI API JSON 定義。入力/出力テキストのロール。
SearchContextSize
SpeechFormat
SpeechModel
SpeechVoice
Tool
UserLocation

Constants§

CONN_TIMEOUT 🔒: HTTP 通信のタイムアウト。これを設定しないと無限待ちになる危険性がある。
MAX_OUTPUT_TOKENS_FACTOR 🔒: max_output_tokens をギリギリまで攻めると危ないので、少し余裕を持たせる。
MODEL_INFO_UPDATE_INTERVAL 🔒: モデル情報更新間隔。 24 時間に一度更新する。
MODEL_LIST 🔒: モデル情報。一番上がデフォルト。
OUTPUT_RESERVED_RATIO 🔒: context_window のうち出力用に予約する割合 (まともに決まっていない場合用)。 max_output_tokens が意味をなしていない gpt-4 で適当に決めるための値。
SPEECH_INPUT_MAX
SPEECH_SPEED_MAX
SPEECH_SPEED_MIN
TIMEOUT 🔒: AI 応答待ちのタイムアウト。
URL_AUDIO_SPEECH 🔒
URL_IMAGE_GEN 🔒
URL_RESPONSE 🔒

Functions§

get_offline_model_info 🔒: MODEL_LIST からモデル名で OfflineModelInfo を検索する。
url_model 🔒: https://platform.openai.com/docs/api-reference/models/retrieve