@azure/openai-assistants package

クラス

AssistantsClient	クライアント処理アシスタント関連する操作。
AzureKeyCredential	基になるキー値の更新をサポートする静的キーベースの資格情報。
OpenAIKeyCredential	OpenAIKeyCredential クラスは OpenAI API キーを表し、OpenAI エンドポイントの Assistants クライアントに対する認証に使用されます。

インターフェイス

Assistant	モデルを呼び出してツールを使用できるアシスタントを表します。
AssistantCreationOptions	新しいアシスタントの作成時に使用する要求の詳細。
AssistantDeletionStatus	アシスタント削除操作の状態。
AssistantFile	ファイルを読み取ることができるツールで使用される、アシスタントに添付されたファイルに関する情報。
AssistantFileDeletionStatus	アシスタント ファイルの削除操作の状態。
AssistantThread	アシスタントに関連付けられている 1 つのスレッドに関する情報。
AssistantThreadCreationOptions	新しいアシスタント スレッドの作成に使用される詳細。
AssistantsClientOptions	アシスタント クライアントの作成に使用される詳細 *
CancelRunOptions	実行を取り消すために使用される詳細。
CodeInterpreterImageOutput	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力される画像出力の表現。
CodeInterpreterImageReference	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力されるイメージ参照。
CodeInterpreterLogOutput	モデルによるツール呼び出しに応答してコード インタープリター ツールによって出力されるログ出力の表現。
CodeInterpreterToolCall	コード インタープリターによって使用および出力される入力と出力を表す、定義されたツールの評価でモデルによって発行されるコード インタープリター ツールの呼び出しのレコード。
CodeInterpreterToolCallDetails	モデルによるコード インタープリター呼び出しに関する詳細情報。
CodeInterpreterToolDefinition	アシスタントの構成に使用されるコード インタープリター ツールの入力定義情報。
CreateAndRunThreadOptions	新しいアシスタント スレッドを作成してすぐに実行するときに使用される詳細。
CreateAssistantFileOptions	アシスタント ファイルの作成に使用される詳細。
CreateAssistantOptions	アシスタントの作成に使用される詳細。
CreateMessageOptions	メッセージの作成に使用される詳細。
CreateRunOptions	アシスタント スレッドの新しい実行を作成するときに使用される詳細。
CreateRunRequestOptions	実行要求の作成に使用される詳細。
CreateThreadAndRunOptions	スレッドの作成と実行に使用される詳細。
CreateThreadOptions	スレッドの作成に使用される詳細。
DeleteAssistantFileOptions	アシスタント ファイルの削除に使用される詳細。
DeleteAssistantOptions	アシスタントの削除に使用される詳細。
DeleteFileOptions	ファイルの削除に使用される詳細。
DeleteThreadOptions	スレッドの削除に使用される詳細。
DeletionStatus	OpenAI 削除操作の結果状態の抽象表現。
FileDeletionStatus	ファイル削除操作からの状態応答。
FileListResponse	ファイル リスト操作からの応答データ。
FunctionDefinition	関数の入力定義情報。
FunctionToolCall	定義されたツールの評価でモデルによって発行される関数ツールの呼び出しのレコード。指定された関数によって消費および出力される入力と出力を表します。
FunctionToolCallDetails	モデルによって呼び出される関数に関する詳細情報。
FunctionToolDefinition	アシスタントの構成に使用される関数ツールの入力定義情報。
GetAssistantFileOptions	アシスタント ファイルの取得に使用される詳細。
GetAssistantOptions	アシスタントの取得に使用される詳細。
GetFileOptions	ファイルの取得に使用される詳細。
GetMessageFileOptions	メッセージ ファイルの取得に使用される詳細。
GetMessageOptions	メッセージの取得に使用される詳細。
GetRunOptions	実行の取得に使用される詳細。
GetRunStepOptions	実行ステップの取得に使用される詳細。
GetThreadOptions	スレッドの取得に使用される詳細。
InputFile	モデルを呼び出してツールを使用できるアシスタントを表します。
ListAssistantFilesOptions	アシスタント ファイルの一覧表示に使用される詳細。
ListAssistantsOptions	アシスタントの一覧表示に使用される詳細。
ListFilesOptions	ファイルの一覧表示に使用される詳細。
ListMessageFilesOptions	メッセージ ファイルの一覧表示に使用される詳細。
ListMessagesOptions	メッセージの一覧表示に使用される詳細。
ListResponseOf	要求された項目の一覧の応答データ。
ListRunStepsOptions	実行ステップの一覧表示に使用される詳細。
ListRunsOptions	実行の一覧表示に使用される詳細。
MessageFile	アシスタント スレッド メッセージに添付されたファイルに関する情報。
MessageImageFileContent	スレッド メッセージ内のイメージ ファイルの内容の表現。
MessageImageFileDetails	スレッド メッセージの内容で表されるイメージ参照。
MessageTextContent	スレッド メッセージ コンテンツのテキストアイテムの表現。
MessageTextDetails	スレッド メッセージ コンテンツの 1 つの項目のテキストと関連付けられた注釈アシスタント。
MessageTextFileCitationAnnotation	アシスタントまたはメッセージに関連付けられている特定のファイルからの特定の引用符を指すメッセージ内の引用。 アシスタントが '取得' ツールを使用してファイルを検索するときに生成されます。
MessageTextFileCitationDetails	テキスト スレッド メッセージコンテンツのファイルベースの注釈で使用される、ファイルベースのテキスト引用の表現。
MessageTextFilePathAnnotation	特定のパスにあるファイルを指すメッセージ内の引用。
MessageTextFilePathDetails	メッセージ イメージ コンテンツで使用されるイメージ ファイル ID のカプセル化。
RequiredAction	アシスタント スレッド実行を続行するために必要なアクションの抽象表現。
RequiredFunctionToolCall	実行の評価を継続するためにモデルが必要とする、関数ツールに対する要求された呼び出しの表現。
RetrievalToolCall	定義されたツールの評価でモデルによって発行された、実行された取得アクションを表す取得ツールの呼び出しのレコード。
RetrievalToolDefinition	アシスタントの構成に使用される取得ツールの入力定義情報。
RunError	アシスタント スレッド実行で発生したエラーの詳細。
RunStep	アシスタント スレッド実行の単一ステップに関する詳細情報。
RunStepError	失敗した実行ステップに関連するエラー情報。
RunStepMessageCreationDetails	メッセージ作成実行ステップに関連する詳細情報。
RunStepMessageCreationReference	実行ステップの一部として作成されたメッセージの詳細。
RunStepToolCallDetails	実行ステップ呼び出しツールに関連付けられている詳細情報。
SubmitToolOutputsDetails	ツール出力を送信するために呼び出す必要があるツールの詳細。
SubmitToolOutputsToRunOptions	ツールの出力を実行に送信するために使用される詳細。
ThreadDeletionStatus	スレッド削除操作の状態。
ThreadMessage	アシスタント スレッド内の 1 つの既存のメッセージ。
ThreadRun	アシスタント スレッドの 1 つの評価実行を表すデータ。
ToolOutput	ツールの実行中に提供されたデータは、保留中のツール呼び出しを解決し、モデルを続行できるように送信を出力します。
UpdateAssistantOptions	既存のアシスタントを変更するときに使用する要求の詳細。
UpdateAssistantRequestOptions	アシスタントの更新に使用される詳細。
UpdateMessageOptions	メッセージの更新に使用される詳細。
UpdateRunOptions	実行の更新に使用される詳細。
UpdateThreadOptions	スレッドの更新に使用される詳細。
UploadFileOptions	ファイルのアップロードに使用される詳細。

型エイリアス

CodeInterpreterToolCallOutput	CodeInterpreterToolCallOutput のエイリアス
FilePurpose	"微調整"、"微調整結果"、"アシスタント"、"assistants_output"
ListSortOrder	"asc"、"desc"
MessageContent	MessageContent のエイリアス
MessageRole	"user"、"アシスタント"
MessageTextAnnotation	MessageTextAnnotation のエイリアス
RequiredToolCall	RequiredToolCall のエイリアス
RunStatus	"queued"、"in_progress"、"requires_action"、"cancelling"、"cancelled"、"failed"、"completed"、"expired"
RunStepDetails	RunStepDetails のエイリアス
RunStepErrorCode	"server_error"、"rate_limit_exceeded"
RunStepStatus	"in_progress"、"cancelled"、"failed"、"completed"、"expired"
RunStepType	"message_creation"、"tool_calls"
ToolCall	ToolCall のエイリアス
ToolDefinition	アシスタントが使用できる入力ツール定義の抽象表現。