docs(api): add end-user lookup (#684)

* docs(api): add end-user lookup

* update zh and ja docs

---------

Co-authored-by: RiskeyL <7a8y@163.com>
This commit is contained in:
盐粒 Yanli
2026-03-01 19:53:17 +08:00
committed by GitHub
parent c2909cd5ee
commit b7f1aab7b4
12 changed files with 594 additions and 13 deletions

View File

@@ -117,6 +117,35 @@
}
}
},
"/end-users/{end_user_id}": {
"get": {
"summary": "エンドユーザー取得",
"description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーIDファイルアップロードの `created_by`)を返す場合に利用できます。",
"operationId": "getEndUserChatJa",
"tags": ["エンドユーザー"],
"parameters": [
{
"name": "end_user_id",
"in": "path",
"required": true,
"description": "エンドユーザーID。",
"schema": { "type": "string", "format": "uuid" }
}
],
"responses": {
"200": {
"description": "エンドユーザーの取得に成功しました。",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EndUserDetailJa" }
}
}
},
"404": { "$ref": "#/components/responses/EndUserNotFoundJa" },
"500": { "$ref": "#/components/responses/InternalServerErrorJa" }
}
}
},
"/files/{file_id}/preview": {
"get": {
"summary": "ファイルプレビュー",
@@ -424,7 +453,8 @@
"S3ErrorFileJa": { "description": "S3ストレージサービスエラー。考えられる原因s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } },
"InternalServerErrorJa": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } },
"SuccessResultJa": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } },
"ConversationNotFoundJa": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }
"ConversationNotFoundJa": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } },
"EndUserNotFoundJa": { "description": "エンドユーザーが見つかりません。エラーコード:`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJa" } } } }
},
"schemas": {
"BasicChatRequestJa": {
@@ -534,6 +564,21 @@
"UsageJa": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } },
"RetrieverResourceJa": { "type": "object", "description": "引用と帰属情報。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } },
"FileUploadResponseJa": { "type": "object", "description": "ファイルアップロード成功後の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ(バイト)。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } },
"EndUserDetailJa": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"tenant_id": { "type": "string", "format": "uuid" },
"app_id": { "type": "string", "format": "uuid", "nullable": true },
"type": { "type": "string", "example": "service_api" },
"external_user_id": { "type": "string", "nullable": true },
"name": { "type": "string", "nullable": true },
"is_anonymous": { "type": "boolean" },
"session_id": { "type": "string" },
"created_at": { "type": "string", "format": "date-time" },
"updated_at": { "type": "string", "format": "date-time" }
}
},
"MessageFeedbackRequestJa": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、アップボートの取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージのフィードバックです。" } } },
"AppFeedbacksResponseJa": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJa" }, "description": "このアプリの「いいね」とフィードバックの一覧を返します。" } } },
"FeedbackItemJa": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } },
@@ -582,6 +627,7 @@
"tags": [
{ "name": "チャットメッセージ", "description": "チャットメッセージと対話に関連する操作。" },
{ "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" },
{ "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" },
{ "name": "メッセージフィードバック", "description": "ユーザーからのメッセージフィードバック操作。" },
{ "name": "会話管理", "description": "会話セッションの管理に関連する操作。" },
{ "name": "音声とテキスト変換", "description": "テキストから音声、音声からテキストへの変換操作。" },

View File

@@ -136,6 +136,35 @@
}
}
},
"/end-users/{end_user_id}": {
"get": {
"summary": "エンドユーザー取得",
"description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーIDファイルアップロードの `created_by`)を返す場合に利用できます。",
"operationId": "getEndUserChatflowJp",
"tags": ["エンドユーザー"],
"parameters": [
{
"name": "end_user_id",
"in": "path",
"required": true,
"description": "エンドユーザーID。",
"schema": { "type": "string", "format": "uuid" }
}
],
"responses": {
"200": {
"description": "エンドユーザーの取得に成功しました。",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EndUserDetailJp" }
}
}
},
"404": { "$ref": "#/components/responses/EndUserNotFoundJp" },
"500": { "$ref": "#/components/responses/InternalServerErrorJp" }
}
}
},
"/files/{file_id}/preview": {
"get": {
"summary": "ファイルプレビュー",
@@ -585,7 +614,8 @@
"S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられる原因s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } },
"ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }
"ConversationNotFoundJp": { "description": "会話が存在しません。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード:`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }
},
"schemas": {
"ChatflowRequestJp": {
@@ -694,6 +724,21 @@
"UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } },
"RetrieverResourceJp": { "type": "object", "description": "引用と帰属リスト。", "properties": { "position": { "type": "integer" }, "dataset_id": { "type": "string", "format": "uuid" }, "dataset_name": { "type": "string" }, "document_id": { "type": "string", "format": "uuid" }, "document_name": { "type": "string" }, "segment_id": { "type": "string", "format": "uuid" }, "score": { "type": "number", "format": "float" }, "content": { "type": "string" } } },
"FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ(バイト)。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } },
"EndUserDetailJp": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"tenant_id": { "type": "string", "format": "uuid" },
"app_id": { "type": "string", "format": "uuid", "nullable": true },
"type": { "type": "string", "example": "service_api" },
"external_user_id": { "type": "string", "nullable": true },
"name": { "type": "string", "nullable": true },
"is_anonymous": { "type": "boolean" },
"session_id": { "type": "string" },
"created_at": { "type": "string", "format": "date-time" },
"updated_at": { "type": "string", "format": "date-time" }
}
},
"MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "アップボートは`like`、ダウンボートは`dislike`、取り消しは`null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } },
"AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } },
"FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } },
@@ -728,6 +773,7 @@
"tags": [
{ "name": "チャットメッセージ", "description": "チャットメッセージとインタラクションに関連する操作。" },
{ "name": "ファイル操作", "description": "ファイルアップロードとプレビューに関連する操作。" },
{ "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" },
{ "name": "メッセージフィードバック", "description": "ユーザーメッセージへのフィードバック操作。" },
{ "name": "会話管理", "description": "会話セッションの管理に関連する操作。" },
{ "name": "音声・テキスト変換", "description": "テキストから音声へ、音声からテキストへの変換操作。" },

View File

@@ -106,6 +106,35 @@
}
}
},
"/end-users/{end_user_id}": {
"get": {
"summary": "エンドユーザー取得",
"description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーIDファイルアップロードの `created_by`)を返す場合に利用できます。",
"operationId": "getEndUserCompletionJp",
"tags": ["エンドユーザー"],
"parameters": [
{
"name": "end_user_id",
"in": "path",
"required": true,
"description": "エンドユーザーID。",
"schema": { "type": "string", "format": "uuid" }
}
],
"responses": {
"200": {
"description": "エンドユーザーの取得に成功しました。",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EndUserDetailJp" }
}
}
},
"404": { "$ref": "#/components/responses/EndUserNotFoundJp" },
"500": { "$ref": "#/components/responses/InternalServerErrorJp" }
}
}
},
"/completion-messages/{task_id}/stop": {
"post": {
"summary": "生成の停止",
@@ -198,7 +227,8 @@
"FileTooLargeJp": { "description": "ファイルが大きすぎます (file_too_large)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"S3ErrorFileJp": { "description": "S3ストレージサービスエラー。エラーコード例: s3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }
"SuccessResultJp": { "description": "操作成功。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } },
"EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード:`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }
},
"schemas": {
"CompletionRequestJp": {
@@ -265,6 +295,21 @@
"UsageJp": { "type": "object", "description": "モデル使用情報。", "properties": { "prompt_tokens": { "type": "integer" }, "prompt_unit_price": { "type": "string" }, "prompt_price_unit": { "type": "string" }, "prompt_price": { "type": "string" }, "completion_tokens": { "type": "integer" }, "completion_unit_price": { "type": "string" }, "completion_price_unit": { "type": "string" }, "completion_price": { "type": "string" }, "total_tokens": { "type": "integer" }, "total_price": { "type": "string" }, "currency": { "type": "string" }, "latency": { "type": "number", "format": "double" } } },
"RetrieverResourceJp": { "type": "object", "description": "引用と帰属の情報。", "properties": { "document_id": { "type": "string" }, "segment_id": { "type": "string" }, "score": { "type": "number" }, "content": { "type": "string" } } },
"FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時のレスポンス。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ(バイト)。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } },
"EndUserDetailJp": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"tenant_id": { "type": "string", "format": "uuid" },
"app_id": { "type": "string", "format": "uuid", "nullable": true },
"type": { "type": "string", "example": "service_api" },
"external_user_id": { "type": "string", "nullable": true },
"name": { "type": "string", "nullable": true },
"is_anonymous": { "type": "boolean" },
"session_id": { "type": "string" },
"created_at": { "type": "string", "format": "date-time" },
"updated_at": { "type": "string", "format": "date-time" }
}
},
"MessageFeedbackRequestJp": { "type": "object", "required": ["user"], "properties": { "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true, "description": "高評価 `like`, 低評価 `dislike`, 取り消し `null`。" }, "user": { "type": "string", "description": "ユーザー識別子。" }, "content": { "type": "string", "nullable": true, "description": "メッセージフィードバックの具体的な内容。" } } },
"AppFeedbacksResponseJp": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/FeedbackItemJp" }, "description": "このアプリの「いいね」とフィードバックの一覧。" } } },
"FeedbackItemJp": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "app_id": { "type": "string", "format": "uuid" }, "conversation_id": { "type": "string", "format": "uuid" }, "message_id": { "type": "string", "format": "uuid" }, "rating": { "type": "string", "enum": ["like", "dislike", null], "nullable": true }, "content": { "type": "string" }, "from_source": { "type": "string" }, "from_end_user_id": { "type": "string", "format": "uuid" }, "from_account_id": { "type": "string", "format": "uuid", "nullable": true }, "created_at": { "type": "string", "format": "date-time" }, "updated_at": { "type": "string", "format": "date-time" } } },
@@ -285,6 +330,7 @@
"tags": [
{ "name": "完了メッセージ", "description": "テキスト生成と完了に関連する操作。" },
{ "name": "ファイル操作", "description": "ファイル管理に関連する操作。" },
{ "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" },
{ "name": "メッセージフィードバック", "description": "ユーザーフィードバックに関連する操作。" },
{ "name": "音声変換", "description": "テキストから音声への変換に関連する操作。" },
{ "name": "アプリケーション情報", "description": "アプリケーションの設定と情報を取得する操作。" }

View File

@@ -188,6 +188,35 @@
}
}
},
"/end-users/{end_user_id}": {
"get": {
"summary": "エンドユーザー取得",
"description": "IDでエンドユーザーを取得します。\n\n他のAPIがエンドユーザーIDファイルアップロードの `created_by`)を返す場合に利用できます。",
"operationId": "getEndUserWorkflowJp",
"tags": ["エンドユーザー"],
"parameters": [
{
"name": "end_user_id",
"in": "path",
"required": true,
"description": "エンドユーザーID。",
"schema": { "type": "string", "format": "uuid" }
}
],
"responses": {
"200": {
"description": "エンドユーザーの取得に成功しました。",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/EndUserDetailJp" }
}
}
},
"404": { "$ref": "#/components/responses/EndUserNotFoundJp" },
"500": { "$ref": "#/components/responses/InternalServerErrorJp" }
}
}
},
"/workflows/logs": {
"get": {
"summary": "ワークフローログを取得",
@@ -241,7 +270,8 @@
"UnsupportedFileTypeFileJp": { "description": "サポートされていないファイルタイプです (unsupported_file_type)。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"S3ErrorFileJp": { "description": "S3ストレージサービスエラー。考えられるエラーコードs3_connection_failed, s3_permission_denied, s3_file_too_large。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"InternalServerErrorJp": { "description": "内部サーバーエラー。", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } },
"SuccessResultJp": { "description": "操作に成功しました。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } }
"SuccessResultJp": { "description": "操作に成功しました。", "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "example": "success" } } } } } },
"EndUserNotFoundJp": { "description": "エンドユーザーが見つかりません。エラーコード:`end_user_not_found`", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponseJp" } } } }
},
"schemas": {
"WorkflowExecutionRequestJp": {
@@ -341,6 +371,21 @@
}
},
"FileUploadResponseJp": { "type": "object", "description": "ファイルアップロード成功時の応答。", "properties": { "id": { "type": "string", "format": "uuid", "description": "ID。" }, "name": { "type": "string", "description": "ファイル名。" }, "size": { "type": "integer", "description": "ファイルサイズ(バイト)。" }, "extension": { "type": "string", "description": "ファイル拡張子。" }, "mime_type": { "type": "string", "description": "ファイルのMIMEタイプ。" }, "created_by": { "type": "string", "format": "uuid", "description": "エンドユーザーID。" }, "created_at": { "type": "integer", "format": "int64", "description": "作成タイムスタンプ。" } } },
"EndUserDetailJp": {
"type": "object",
"properties": {
"id": { "type": "string", "format": "uuid" },
"tenant_id": { "type": "string", "format": "uuid" },
"app_id": { "type": "string", "format": "uuid", "nullable": true },
"type": { "type": "string", "example": "service_api" },
"external_user_id": { "type": "string", "nullable": true },
"name": { "type": "string", "nullable": true },
"is_anonymous": { "type": "boolean" },
"session_id": { "type": "string" },
"created_at": { "type": "string", "format": "date-time" },
"updated_at": { "type": "string", "format": "date-time" }
}
},
"WorkflowLogsResponseJp": {
"type": "object", "description": "ワークフローログリストの応答。",
"properties": {
@@ -397,6 +442,7 @@
"tags": [
{ "name": "ワークフロー実行", "description": "ワークフローの実行と管理に関連する操作。" },
{ "name": "ファイル操作 (ワークフロー)", "description": "ワークフロー固有のファイルアップロードとプレビュー操作。" },
{ "name": "エンドユーザー", "description": "エンドユーザー情報に関連する操作。" },
{ "name": "アプリケーション設定 (ワークフロー)", "description": "ワークフローアプリのアプリケーション設定と情報。" }
]
}