API ========================== 認証 ---- - HTTP認証、スキーム Bearer HTTP Bearer認証 デフォルト ---------- ListUsers ^^^^^^^^^ ``GET /users`` **応答例** .. code:: json { "properties": { "users": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "organizations": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "created_at", "email", "organizations", "updated_at", "user_id" ], "type": "object" }, "type": "array" } }, "type": "object" } 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListUsers 200レスポンス,:ref:`ListUsersResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ApiKeys ------- DeleteApiKey ^^^^^^^^^^^^ ``DELETE /api-keys/{api_key_id}`` パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-1: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteApiKey 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetApiKey ^^^^^^^^^ ``GET /api-keys/{api_key_id}`` .. _パラメーター-1: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,なし **応答例** .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-2: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetApiKey 200レスポンス,:ref:`GetApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateApiKey ^^^^^^^^^^^^ ``PATCH /api-keys/{api_key_id}`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-2: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable api_key_id,path,string,true,なし body,body,:ref:`UpdateApiKeyRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-3: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateApiKey 200レスポンス,:ref:`UpdateApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListOrganizationApiKeys ^^^^^^^^^^^^^^^^^^^^^^^ ``GET /organizations/{organization_id}/api-keys`` .. _パラメーター-3: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "api_keys": { "items": { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "api_keys", "pagination" ], "type": "object" } .. _応答-4: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizationApiKeys 200レスポンス,:ref:`ListOrganizationApiKeysResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateOrganizationApiKey ^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /organizations/{organization_id}/api-keys`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-4: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし body,body,:ref:`CreateOrganizationApiKeyRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "value": { "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at", "value" ], "type": "object" } .. _応答-5: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateOrganizationApiKey 201レスポンス,:ref:`CreateOrganizationApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListApiKeys ^^^^^^^^^^^ ``GET /users/{user_id}/api-keys`` .. _パラメーター-5: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "api_keys": { "items": { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "api_keys", "pagination" ], "type": "object" } .. _応答-6: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListApiKeys 200レスポンス,:ref:`ListApiKeysResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateApiKey ^^^^^^^^^^^^ ``POST /users/{user_id}/api-keys`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-6: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,なし body,body,:ref:`CreateApiKeyRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "value": { "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at", "value" ], "type": "object" } .. _応答-7: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateApiKey 201レスポンス,:ref:`CreateApiKeyResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth AssistantRuns ------------- GetAssistantRun ^^^^^^^^^^^^^^^ ``GET /assistant-runs/{assistant_run_id}`` .. _パラメーター-7: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-8: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistantRun 200レスポンス,:ref:`GetAssistantRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CancelAssistantRun ^^^^^^^^^^^^^^^^^^ ``POST /assistant-runs/{assistant_run_id}/cancel`` .. _パラメーター-8: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-9: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelAssistantRun 200レスポンス,:ref:`CancelAssistantRunResponseコンテンツ` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListAssistantRuns ^^^^^^^^^^^^^^^^^ ``GET /assistants/{assistant_id}/runs`` .. _パラメーター-9: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングする実行ステータスのコンマ区切りリスト。 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **応答例** .. code:: json { "properties": { "assistant_runs": { "items": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "assistant_runs", "pagination" ], "type": "object" } .. _応答-10: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistantRuns 200レスポンス,:ref:`ListAssistantRunsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateAssistantRun ^^^^^^^^^^^^^^^^^^ ``POST /assistants/{assistant_id}/runs`` **ボディパラメーター** .. code:: json { "properties": { "additional_knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "args": { "items": { "type": "string" }, "type": "array" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "new_thread": { "description": "If true, create a new thread for this run to be returned in the response thread_id.", "type": "boolean" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "description": "If provided, the run will be associated with the given thread. This takes precedence over new_thread.", "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _パラメーター-10: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,なし body,body,:ref:`CreateAssistantRunRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-11: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAssistantRun 201レスポンス,:ref:`CreateAssistantRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth イベント -------- ListAssistantEvents ^^^^^^^^^^^^^^^^^^^ ``GET /assistant-runs/{assistant_run_id}/events`` .. _パラメーター-11: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,なし limit,query,string,false,なし offset,query,string,false,なし **応答例** .. code:: json { "properties": { "count": { "type": "number" }, "events": { "items": { "properties": { "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "assistant_run_id", "created_at", "event_id", "origin", "payload", "timestamp", "type" ], "type": "object" }, "type": "array" }, "limit": { "type": "number" }, "next_offset": { "type": "number" }, "offset": { "type": "number" }, "total_count": { "type": "number" } }, "required": [ "count", "events", "limit", "next_offset", "offset", "total_count" ], "type": "object" } .. _応答-12: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistantEvents 200応答,:ref:`ListAssistantEventsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetAssistantRunEventsSSE ^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /assistant-runs/{assistant_run_id}/events/stream`` .. _パラメーター-12: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_run_id,path,string,true,なし **応答例** 400 レスポンス .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-13: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistantRunEventsSSE 200レスポンス,:ref:`GetAssistantRunEventsSSEOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetEvent ^^^^^^^^ ``GET /events/{event_id}`` .. _パラメーター-13: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable event_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "created_at", "event_id", "origin", "payload", "structure_run_id", "timestamp", "type" ], "type": "object" } .. _応答-14: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetEvent 200レスポンス,:ref:`GetEventResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListEvents ^^^^^^^^^^ ``GET /structure-runs/{structure_run_id}/events`` .. _パラメーター-14: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし limit,query,string,false,なし offset,query,string,false,なし **応答例** .. code:: json { "properties": { "count": { "type": "number" }, "events": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "created_at", "event_id", "origin", "payload", "structure_run_id", "timestamp", "type" ], "type": "object" }, "type": "array" }, "limit": { "type": "number" }, "next_offset": { "type": "number" }, "offset": { "type": "number" }, "total_count": { "type": "number" } }, "required": [ "count", "events", "limit", "next_offset", "offset", "total_count" ], "type": "object" } .. _応答-15: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListEvents 200レスポンス,:ref:`ListEventsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateEvents ^^^^^^^^^^^^ ``POST /structure-runs/{structure_run_id}/events`` **ボディパラメーター** .. code:: json { "properties": { "events": { "items": { "properties": { "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "timestamp", "type" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _パラメーター-15: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし body,body,:ref:`CreateEventsRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-16: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateEvents 202レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetStructureRunEventsSSE ^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /structure-runs/{structure_run_id}/events/stream`` .. _パラメーター-16: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし **応答例** 400 レスポンス .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-17: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructureRunEventsSSE 200レスポンス,:ref:`GetStructureRunEventsSSEOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アシスタント ------------ リストアシスタント ^^^^^^^^^^^^^^^^^^ ``GET /assistants`` .. _パラメーター-17: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "assistants": { "items": { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "assistants", "pagination" ], "type": "object" } .. _応答-18: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssistants 200の応答,:ref:`ListAssistantsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateAssistant ^^^^^^^^^^^^^^^ ``POST /assistants`` **ボディパラメーター** .. code:: json { "properties": { "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-18: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateAssistantRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-19: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAssistant 201応答,:ref:`CreateAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteAssistant ^^^^^^^^^^^^^^^ ``DELETE /assistants/{assistant_id}`` .. _パラメーター-19: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-20: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteAssistant 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetAssistant ^^^^^^^^^^^^ ``GET /assistants/{assistant_id}`` .. _パラメーター-20: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-21: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAssistant 200レスポンス,:ref:`GetAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アップデートアシスタント ^^^^^^^^^^^^^^^^^^^^^^^^ ``PATCH /assistants/{assistant_id}`` **ボディパラメーター** .. code:: json { "properties": { "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _パラメーター-21: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable assistant_id,path,string,true,なし body,body,:ref:`UpdateAssistantRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _応答-22: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateAssistant 200の応答,:ref:`UpdateAssistantResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth Billing ------- CreateCheckoutSession ^^^^^^^^^^^^^^^^^^^^^ ``POST /billing/checkout-session`` **ボディパラメーター** .. code:: json { "properties": { "price_lookup_key": { "type": "string" } }, "required": [ "price_lookup_key" ], "type": "object" } .. _パラメーター-22: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateCheckoutSessionRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "redirect_url": { "type": "string" } }, "required": [ "redirect_url" ], "type": "object" } .. _応答-23: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateCheckoutSession 201レスポンス,:ref:`CreateCheckoutSessionResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateBillingManagementUrl ^^^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /billing/management-url`` **応答例** .. code:: json { "properties": { "billing_management_url": { "type": "string" } }, "required": [ "billing_management_url" ], "type": "object" } .. _応答-24: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateBillingManagementUrl 201レスポンス,:ref:`CreateBillingManagementUrlResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth バケット -------- リストバケット ^^^^^^^^^^^^^^ ``GET /buckets`` .. _パラメーター-23: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "buckets": { "items": { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "buckets", "pagination" ], "type": "object" } .. _応答-25: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListBuckets 200レスポンス,:ref:`ListBucketsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateBucket ^^^^^^^^^^^^ ``POST /buckets`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-24: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateBucketRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-26: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateBucket 201レスポンス,:ref:`CreateBucketResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteBucket ^^^^^^^^^^^^ ``DELETE /buckets/{bucket_id}`` .. _パラメーター-25: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-27: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteBucket 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetBucket ^^^^^^^^^ ``GET /buckets/{bucket_id}`` .. _パラメーター-26: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-28: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetBucket 200レスポンス,:ref:`GetBucketResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateBucket ^^^^^^^^^^^^ ``PATCH /buckets/{bucket_id}`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-27: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,なし body,body,:ref:`UpdateBucketRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-29: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateBucket 200レスポンス,:ref:`UpdateBucketResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アセット -------- CreateAssetUrl ^^^^^^^^^^^^^^ ``POST /buckets/{bucket_id}/asset-urls/{name}`` **ボディパラメーター** .. code:: json { "properties": { "operation": { "enum": [ "PUT", "GET" ], "type": "string" } }, "type": "object" } .. _パラメーター-28: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,なし bucket_id,path,string,true,なし body,body,:ref:`CreateAssetUrlRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "headers": { "additionalProperties": {}, "type": "object" }, "url": { "type": "string" } }, "required": [ "headers", "url" ], "type": "object" } .. _応答-30: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateAssetUrl 200レスポンス,:ref:`CreateAssetUrlResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListAssets ^^^^^^^^^^ ``GET /buckets/{bucket_id}/assets`` .. _パラメーター-29: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし prefix,query,string,false,なし postfix,query,string,false,なし **応答例** .. code:: json { "properties": { "assets": { "items": { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "postfix": { "type": "string" }, "prefix": { "type": "string" } }, "required": [ "assets", "pagination" ], "type": "object" } .. _応答-31: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListAssets 200レスポンス,:ref:`ListAssetsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateAsset ^^^^^^^^^^^ ``PUT /buckets/{bucket_id}/assets`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-30: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable bucket_id,path,string,true,なし body,body,:ref:`CreateAssetRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-32: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateAsset 201レスポンス,:ref:`CreateAssetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アセットの削除 ^^^^^^^^^^^^^^ ``DELETE /buckets/{bucket_id}/assets/{name}`` .. _パラメーター-31: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,なし bucket_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-33: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteAsset 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetAsset ^^^^^^^^ ``GET /buckets/{bucket_id}/assets/{name}`` .. _パラメーター-32: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable name,path,string,true,なし bucket_id,path,string,true,なし include_contents,query,boolean,false,アセットのコンテンツを含めるにはtrue/false。 **応答例** .. code:: json { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-34: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetAsset 200レスポンス,:ref:`GetAssetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth チャットメッセージ ------------------ CreateChatMessage ^^^^^^^^^^^^^^^^^ ``POST /chat/messages`` **ボディパラメーター** .. code:: json { "properties": { "driver_configuration": { "properties": { "extra_params": {}, "max_tokens": { "type": "number" }, "model": { "type": "string" }, "structured_output_strategy": { "type": "string" }, "temperature": { "format": "float", "type": "number" }, "use_native_tools": { "type": "boolean" } }, "type": "object" }, "messages": { "items": { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "usage" ], "type": "object" }, "type": "array" }, "output_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "tools": { "items": { "properties": { "activities": { "items": { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "activities", "name" ], "type": "object" }, "type": "array" } }, "required": [ "driver_configuration", "messages", "output_schema", "tools" ], "type": "object" } .. _パラメーター-33: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateChatMessageRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "type": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "type", "usage" ], "type": "object" } .. _応答-35: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateChatMessage 201応答,:ref:`CreateChatMessageResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateChatMessageStream ^^^^^^^^^^^^^^^^^^^^^^^ ``POST /chat/messages/stream`` **ボディパラメーター** .. code:: json { "properties": { "driver_configuration": { "properties": { "extra_params": {}, "max_tokens": { "type": "number" }, "model": { "type": "string" }, "structured_output_strategy": { "type": "string" }, "temperature": { "format": "float", "type": "number" }, "use_native_tools": { "type": "boolean" } }, "type": "object" }, "messages": { "items": { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "usage" ], "type": "object" }, "type": "array" }, "output_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "tools": { "items": { "properties": { "activities": { "items": { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "activities", "name" ], "type": "object" }, "type": "array" } }, "required": [ "driver_configuration", "messages", "output_schema", "tools" ], "type": "object" } .. _パラメーター-34: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateChatMessageStreamRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "type": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "type" ], "type": "object" } .. _応答-36: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateChatMessageStream 201応答,:ref:`CreateChatMessageStreamResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 構成 ---- GetConfig ^^^^^^^^^ ``GET /config`` **応答例** .. code:: json { "properties": { "data_lake_s3_bucket": { "type": "string" }, "data_lake_s3_region": { "type": "string" }, "data_lake_s3_url": { "type": "string" }, "google_drive_data_connector_client_id": { "type": "string" } }, "required": [ "data_lake_s3_bucket", "data_lake_s3_region", "data_lake_s3_url", "google_drive_data_connector_client_id" ], "type": "object" } .. _応答-37: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetConfig 200レスポンス,:ref:`GetConfigResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 接続 ---- ListConnections ^^^^^^^^^^^^^^^ ``GET /connections`` .. _パラメーター-35: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし type,query,string,false,なし **応答例** .. code:: json { "properties": { "connections": { "items": { "properties": { "connection_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "connection_id", "created_at", "created_by", "name", "type", "updated_at" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _応答-38: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListConnections 200応答,:ref:`ListConnectionsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateConnection ^^^^^^^^^^^^^^^^ ``POST /connections`` **ボディパラメーター** .. code:: json { "properties": { "credentials": { "oneOf": [ { "properties": { "github": { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "credentials", "type" ], "type": "object" } .. _パラメーター-36: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateConnectionRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "connection_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "connection_id", "created_at", "created_by", "name", "type" ], "type": "object" } .. _応答-39: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateConnection 201応答,:ref:`CreateConnectionResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteConnection ^^^^^^^^^^^^^^^^ ``DELETE /connections/{connection_id}`` .. _パラメーター-37: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable connection_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-40: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteConnection 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetToken ^^^^^^^^ ``GET /connections/{connection_id}/access-token`` .. _パラメーター-38: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable connection_id,path,string,true,なし **応答例** .. code:: json { "properties": { "access_token": { "type": "string" } }, "required": [ "access_token" ], "type": "object" } .. _応答-41: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToken 200レスポンス,:ref:`GetTokenResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 構造体 ------ GetStructuresダッシュボード ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /dashboards/structures`` .. _パラメーター-39: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable start_time,query,string(date-time),false,なし end_time,query,string(date-time),false,なし period,query,:ref:`期間<期間>` ,false,なし structure_ids,query,string,false,なし .. _列挙値-1: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable period,1m period,1h period,1d period,1w **応答例** .. code:: json { "properties": { "deployment_count_gauge": { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" }, "deployment_duration_gauge": { "properties": { "total_seconds": { "type": "number" } }, "type": "object" }, "deployment_error_rate_gauge": { "properties": { "rate": { "format": "float", "type": "number" } }, "type": "object" }, "duration_plot": { "properties": { "seconds_avg": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "timeseries": { "items": { "properties": { "seconds_p0": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "time": { "format": "date-time", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "error_rate_gauge": { "properties": { "error_type_counts": { "items": { "properties": { "count": { "type": "number" }, "error_type": { "type": "string" } }, "type": "object" }, "type": "array" }, "rate": { "format": "float", "type": "number" } }, "type": "object" }, "run_count_gauge": { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" }, "run_duration_gauge": { "properties": { "activity_durations": { "items": { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" }, "type": "array" }, "total_seconds": { "type": "number" } }, "type": "object" }, "token_count_gauge": { "properties": { "by_model": { "additionalProperties": { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" }, "type": "object" }, "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } .. _応答-42: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructuresDashboard 200レスポンス,:ref:`GetStructuresDashboardResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth リスト構造 ^^^^^^^^^^ ``GET /structures`` .. _パラメーター-40: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "structures": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "structures" ], "type": "object" } .. _応答-43: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructures 200レスポンス,:ref:`ListStructuresResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateStructure ^^^^^^^^^^^^^^^ ``POST /structures`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-41: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateStructureRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _応答-44: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateStructure 201レスポンス,:ref:`CreateStructureResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteStructure ^^^^^^^^^^^^^^^ ``DELETE /structures/{structure_id}`` .. _パラメーター-42: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-45: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteStructure 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetStructure ^^^^^^^^^^^^ ``GET /structures/{structure_id}`` .. _パラメーター-43: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _応答-46: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructure 200レスポンス,:ref:`GetStructureResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ストラクチャの更新 ^^^^^^^^^^^^^^^^^^ ``PATCH /structures/{structure_id}`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "type": "object" } .. _パラメーター-44: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし body,body,:ref:`UpdateStructureRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _応答-47: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateStructure 200レスポンス,:ref:`UpdateStructureResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth InvokeStructureWebhookGet ^^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /structures/{structure_id}/webhook`` ストラクチャーのWebhookを呼び出します。 ``webhook_enabled`` フラグを\ ``true`` に設定する必要があります。 .. _パラメーター-45: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし api_key,query,string,false,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _応答-48: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,InvokeStructureWebhookGet 200レスポンス,:ref:`InvokeStructureWebhookGetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth InvokeStructureWebhookPost ^^^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /structures/{structure_id}/webhook`` 構造体のWebhookを呼び出し、最初の構造体引数としてPOST本文を送信します。 ``webhook_enabled`` フラグを\ ``true`` に設定する必要があります。 .. _パラメーター-46: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし api_key,query,string,false,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _応答-49: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,InvokeStructureWebhookPost200レスポンス,:ref:`InvokeStructureWebhookPostResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth データコネクター ---------------- ListDataConnectors ^^^^^^^^^^^^^^^^^^ ``GET /data-connectors`` .. _パラメーター-47: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "data_connectors": { "items": { "properties": { "bucket_id": { "type": "string" }, "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "data_connectors", "pagination" ], "type": "object" } .. _応答-50: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListDataConnectors 200応答,:ref:`ListDataConnectorsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateDataConnector ^^^^^^^^^^^^^^^^^^^ ``POST /data-connectors`` **ボディパラメーター** .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _パラメーター-48: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateDataConnectorRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "schedule_expression": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "type", "updated_at" ], "type": "object" } .. _応答-51: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateDataConnector 201レスポンス,:ref:`CreateDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteDataConnector ^^^^^^^^^^^^^^^^^^^ ``DELETE /data-connectors/{data_connector_id}`` .. _パラメーター-49: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-52: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteDataConnector 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetDataConnector ^^^^^^^^^^^^^^^^ ``GET /data-connectors/{data_connector_id}`` .. _パラメーター-50: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bucket_id": { "type": "string" }, "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _応答-53: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDataConnector 200レスポンス,:ref:`GetDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateDataConnector ^^^^^^^^^^^^^^^^^^^ ``PATCH /data-connectors/{data_connector_id}`` **ボディパラメーター** .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-51: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,なし body,body,:ref:`UpdateDataConnectorRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _応答-54: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateDataConnector 200応答,:ref:`UpdateDataConnectorResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth データジョブ ------------ ListDataJobs ^^^^^^^^^^^^ ``GET /data-connectors/{data_connector_id}/data-jobs`` .. _パラメーター-52: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングするステータスのコンマ区切りリスト。 .. _列挙値-2: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,RUNNING status,SUCCEEDED status,FAILED status,CANCELLED **応答例** .. code:: json { "properties": { "data_jobs": { "items": { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "data_jobs", "pagination" ], "type": "object" } .. _応答-55: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListDataJobs 200レスポンス,:ref:`ListDataJobsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateDataJob ^^^^^^^^^^^^^ ``POST /data-connectors/{data_connector_id}/data-jobs`` .. _パラメーター-53: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_connector_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _応答-56: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateDataJob 202レスポンス,:ref:`CreateDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetDataJob ^^^^^^^^^^ ``GET /data-jobs/{data_job_id}`` .. _パラメーター-54: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_job_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _応答-57: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDataJob 200レスポンス,:ref:`GetDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CancelDataJob ^^^^^^^^^^^^^ ``POST /data-jobs/{data_job_id}/cancel`` .. _パラメーター-55: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable data_job_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _応答-58: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelDataJob 200レスポンス,:ref:`CancelDataJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 展開 ---- GetDeployment ^^^^^^^^^^^^^ ``GET /deployments/{deployment_id}`` .. _パラメーター-56: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable deployment_id,path,string,true,なし **応答例** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status" ], "type": "object" } .. _応答-59: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetDeployment 200レスポンス,:ref:`GetDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListFunctionDeployments ^^^^^^^^^^^^^^^^^^^^^^^ ``GET /functions/{function_id}/deployments`` .. _パラメーター-57: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {} }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "function_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _応答-60: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionDeployments 200レスポンス,:ref:`ListFunctionDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateFunctionDeployment ^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /functions/{function_id}/deployments`` **ボディパラメーター** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _パラメーター-58: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし body,body,:ref:`CreateFunctionDeploymentRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {} }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "function_id", "status" ], "type": "object" } .. _応答-61: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateFunctionDeployment 202レスポンス,:ref:`CreateFunctionDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListStructureDeployments ^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /structures/{structure_id}/deployments`` .. _パラメーター-59: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングする展開ステータスのコンマ区切りリスト。 .. _列挙値-3: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,DEPLOYING status,SUCCEEDED status,FAILED status,ERROR **応答例** .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "structure_id" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _応答-62: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureDeployments 200レスポンス,:ref:`ListStructureDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateStructureDeployment ^^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /structures/{structure_id}/deployments`` **ボディパラメーター** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _パラメーター-60: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし body,body,:ref:`CreateStructureDeploymentRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "structure_id" ], "type": "object" } .. _応答-63: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateStructureDeployment 202レスポンス,:ref:`CreateStructureDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListToolDeployments ^^^^^^^^^^^^^^^^^^^ ``GET /tools/{tool_id}/deployments`` .. _パラメーター-61: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "tool_id" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _応答-64: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolDeployments 200レスポンス,:ref:`ListToolDeploymentsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateToolDeployment ^^^^^^^^^^^^^^^^^^^^ ``POST /tools/{tool_id}/deployments`` **ボディパラメーター** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _パラメーター-62: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし body,body,:ref:`CreateToolDeploymentRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "tool_id" ], "type": "object" } .. _応答-65: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateToolDeployment 202レスポンス,:ref:`CreateToolDeploymentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth FunctionRuns ------------ GetFunctionRun ^^^^^^^^^^^^^^ ``GET /function-runs/{function_run_id}`` .. _パラメーター-63: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "function_id", "function_run_id", "input", "runtime_path", "started_at", "status", "updated_at" ], "type": "object" } .. _応答-66: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetFunctionRun 200レスポンス,:ref:`GetFunctionRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListFunctionRunLogs ^^^^^^^^^^^^^^^^^^^ ``GET /function-runs/{function_run_id}/logs`` .. _パラメーター-64: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _応答-67: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionRunLogs 200応答,:ref:`ListFunctionRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListFunctionRuns ^^^^^^^^^^^^^^^^ ``GET /functions/{function_id}/runs`` .. _パラメーター-65: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングする実行ステータスのコンマ区切りリスト。 .. _列挙値-4: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **応答例** .. code:: json { "properties": { "function_runs": { "items": { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "function_id", "function_run_id", "input", "runtime_path", "started_at", "status", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "function_runs", "pagination" ], "type": "object" } .. _応答-68: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctionRuns200レスポンス,:ref:`ListFunctionRunsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ファンクション -------------- リストファンクション ^^^^^^^^^^^^^^^^^^^^ ``GET /functions`` .. _パラメーター-66: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "functions": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "functions", "pagination" ], "type": "object" } .. _応答-69: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListFunctions 200応答,:ref:`ListFunctionsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateFunction ^^^^^^^^^^^^^^ ``POST /functions`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-67: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateFunctionRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-70: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateFunction 201レスポンス,:ref:`CreateFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteFunction ^^^^^^^^^^^^^^ ``DELETE /functions/{function_id}`` .. _パラメーター-68: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-71: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteFunction 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetFunction ^^^^^^^^^^^ ``GET /functions/{function_id}`` .. _パラメーター-69: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-72: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetFunction 200レスポンス,:ref:`GetFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth Updateファンクション ^^^^^^^^^^^^^^^^^^^^ ``PATCH /functions/{function_id}`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-70: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし body,body,:ref:`UpdateFunctionRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-73: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateFunction 200応答,:ref:`UpdateFunctionResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth FunctionExecute --------------- CreateFunctionExecutionGet ^^^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /functions/{function_id}/execute`` 指定された入力でファンクションを実行します。クエリパラメーターは、 ’query_params’としてファンクションに渡されます。 .. _パラメーター-71: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし **応答例** .. code:: json {} .. _応答-74: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateFunctionExecutionGet 200レスポンス,:ref:`CreateFunctionExecutionGetOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateFunctionExecutionPost ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /functions/{function_id}/execute`` 指定された入力でファンクションを実行します。入力本文は「body」としてファンクションに渡されます。クエリパラメーターは’query_params’として渡されます。 **ボディパラメーター** .. code:: json {} .. _パラメーター-72: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable function_id,path,string,true,なし body,body,:ref:`CreateFunctionExecutionPostInputPayload` ,false,なし **応答例** .. code:: json {} .. _応答-75: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateFunctionExecutionPost 200レスポンス,:ref:`CreateFunctionExecutionPostOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 統合 ---- リストインテグレーション ^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /integrations`` .. _パラメーター-73: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "integrations": { "items": { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "integrations", "pagination" ], "type": "object" } .. _応答-76: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListIntegrations 200応答,:ref:`ListIntegrationsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateIntegration ^^^^^^^^^^^^^^^^^ ``POST /integrations`` **ボディパラメーター** .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _パラメーター-74: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateIntegrationRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _応答-77: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateIntegration 201レスポンス,:ref:`CreateIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteIntegration ^^^^^^^^^^^^^^^^^ ``DELETE /integrations/{integration_id}`` .. _パラメーター-75: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-78: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteIntegration 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetIntegration ^^^^^^^^^^^^^^ ``GET /integrations/{integration_id}`` .. _パラメーター-76: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,なし **応答例** .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _応答-79: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetIntegration 200レスポンス,:ref:`GetIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth Update統合 ^^^^^^^^^^ ``PATCH /integrations/{integration_id}`` **ボディパラメーター** .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } }, "type": "object" } .. _パラメーター-77: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable integration_id,path,string,true,なし body,body,:ref:`UpdateIntegrationRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _応答-80: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateIntegration 200レスポンス,:ref:`UpdateIntegrationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 招待者 ------ ListUserInvites ^^^^^^^^^^^^^^^ ``GET /invites`` .. _パラメーター-78: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "invites": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "invites", "pagination" ], "type": "object" } .. _応答-81: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListUserInvites 200 レスポンス,:ref:`ListUserInvitesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteInvite ^^^^^^^^^^^^ ``DELETE /invites/{invite_id}`` .. _パラメーター-79: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-82: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteInvite 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetInvite ^^^^^^^^^ ``GET /invites/{invite_id}`` .. _パラメーター-80: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" } .. _応答-83: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetInvite 200レスポンス,:ref:`GetInviteResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth RespondToInvite ^^^^^^^^^^^^^^^ ``POST /invites/{invite_id}/response`` **ボディパラメーター** .. code:: json { "properties": { "response": { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } }, "required": [ "response" ], "type": "object" } .. _パラメーター-81: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable invite_id,path,string,true,なし body,body,:ref:`RespondToInviteRequestコンテンツ` ,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-84: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,RespondToInvite 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListInvites ^^^^^^^^^^^ ``GET /organizations/{organization_id}/invites`` .. _パラメーター-82: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "invites": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "invites", "pagination" ], "type": "object" } .. _応答-85: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListInvites 200 レスポンス,:ref:`ListInvitesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateInvite ^^^^^^^^^^^^ ``POST /organizations/{organization_id}/invites`` **ボディパラメーター** .. code:: json { "properties": { "email": { "maxLength": 254, "minLength": 1, "type": "string" } }, "required": [ "email" ], "type": "object" } .. _パラメーター-83: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし body,body,:ref:`CreateInviteRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" } .. _応答-86: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateInvite 201レスポンス,:ref:`CreateInviteResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth KnowledgeBaseJobs ----------------- GetKnowledgeBaseJob ^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-base-jobs/{knowledge_base_job_id}`` .. _パラメーター-84: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_job_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _応答-87: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseJob 200レスポンス,:ref:`GetKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CancelKnowledgeBaseJob ^^^^^^^^^^^^^^^^^^^^^^ ``POST /knowledge-base-jobs/{knowledge_base_job_id}/cancel`` .. _パラメーター-85: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_job_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _応答-88: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelKnowledgeBaseJob 200レスポンス,:ref:`CancelKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListKnowledgeBaseJobs ^^^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs`` .. _パラメーター-86: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングするステータスのコンマ区切りリスト。 .. _列挙値-5: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,RUNNING status,SUCCEEDED status,FAILED status,CANCELLED **応答例** .. code:: json { "properties": { "knowledge_base_jobs": { "items": { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "knowledge_base_jobs", "pagination" ], "type": "object" } .. _応答-89: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseJobs 200レスポンス,:ref:`ListKnowledgeBaseJobsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateKnowledgeBaseJob ^^^^^^^^^^^^^^^^^^^^^^ ``POST /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs`` .. _パラメーター-87: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _応答-90: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 202, `Accepted `__ ,CreateKnowledgeBaseJob 202レスポンス,:ref:`CreateKnowledgeBaseJobResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ナレッジベース -------------- GetKnowledgeBaseQuery ^^^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-base-queries/{knowledge_base_query_id}`` .. _パラメーター-88: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_query_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" } .. _応答-91: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseQuery 200レスポンス,:ref:`GetKnowledgeBaseQueryResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetKnowledgeBaseSearch ^^^^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-base-searches/{knowledge_base_search_id}`` .. _パラメーター-89: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_search_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" } .. _応答-92: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBaseSearch 200レスポンス,:ref:`GetKnowledgeBaseSearchResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListKnowledgeBases ^^^^^^^^^^^^^^^^^^ ``GET /knowledge-bases`` .. _パラメーター-90: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "knowledge_bases": { "items": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "knowledge_bases", "pagination" ], "type": "object" } .. _応答-93: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBases 200 レスポンス,:ref:`ListKnowledgeBasesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateKnowledgeBase ^^^^^^^^^^^^^^^^^^^ ``POST /knowledge-bases`` **ボディパラメーター** .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _パラメーター-91: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateKnowledgeBaseRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _応答-94: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateKnowledgeBase 201レスポンス,:ref:`CreateKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteKnowledgeBase ^^^^^^^^^^^^^^^^^^^ ``DELETE /knowledge-bases/{knowledge_base_id}`` .. _パラメーター-92: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-95: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,KnowledgeBase 204レスポンスの削除,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetKnowledgeBase ^^^^^^^^^^^^^^^^ ``GET /knowledge-bases/{knowledge_base_id}`` .. _パラメーター-93: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし **応答例** .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _応答-96: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetKnowledgeBase 200レスポンス,:ref:`GetKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ナレッジベースの更新 ^^^^^^^^^^^^^^^^^^^^ ``PATCH /knowledge-bases/{knowledge_base_id}`` **ボディパラメーター** .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "config", "type" ], "type": "object" } .. _パラメーター-94: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし body,body,:ref:`UpdateKnowledgeBaseRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _応答-97: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateKnowledgeBase 200レスポンス,:ref:`UpdateKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListKnowledgeBaseQueries ^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-bases/{knowledge_base_id}/queries`` .. _パラメーター-95: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "knowledge_base_queries": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _応答-98: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseQueries 200レスポンス,:ref:`ListKnowledgeBaseQueriesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth QueryKnowledgeBase ^^^^^^^^^^^^^^^^^^ ``POST /knowledge-bases/{knowledge_base_id}/query`` **ボディパラメーター** .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "type": "object" } .. _パラメーター-96: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし body,body,:ref:`QueryKnowledgeBaseRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" } .. _応答-99: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,QueryKnowledgeBase 200レスポンス,:ref:`QueryKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth SearchKnowledgeBase ^^^^^^^^^^^^^^^^^^^ ``POST /knowledge-bases/{knowledge_base_id}/search`` **ボディパラメーター** .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "required": [ "query" ], "type": "object" } .. _パラメーター-97: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし body,body,:ref:`SearchKnowledgeBaseRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" } .. _応答-100: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,SearchKnowledgeBase 200レスポンス,:ref:`SearchKnowledgeBaseResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListKnowledgeBaseSearches ^^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /knowledge-bases/{knowledge_base_id}/searches`` .. _パラメーター-98: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable knowledge_base_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "knowledge_base_searches": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _応答-101: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListKnowledgeBaseSearches 200 レスポンス,:ref:`ListKnowledgeBaseSearchesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ライブラリ ---------- リストライブラリ ^^^^^^^^^^^^^^^^ ``GET /libraries`` .. _パラメーター-99: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "libraries": { "items": { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "libraries", "pagination" ], "type": "object" } .. _応答-102: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListLibraries 200応答,:ref:`ListLibrariesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateLibrary ^^^^^^^^^^^^^ ``POST /libraries`` **ボディパラメーター** .. code:: json { "properties": { "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "knowledge_base_configs": { "items": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "type": "array" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "data_connector_ids", "knowledge_base_configs", "name" ], "type": "object" } .. _パラメーター-100: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateLibraryRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _応答-103: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateLibrary 201レスポンス,:ref:`CreateLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteLibrary ^^^^^^^^^^^^^ ``DELETE /libraries/{library_id}`` .. _パラメーター-101: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-104: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteLibrary 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetLibrary ^^^^^^^^^^ ``GET /libraries/{library_id}`` .. _パラメーター-102: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _応答-105: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetLibrary 200レスポンス,:ref:`GetLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateLibrary ^^^^^^^^^^^^^ ``PATCH /libraries/{library_id}`` **ボディパラメーター** .. code:: json { "properties": { "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "knowledge_base_configs": { "items": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "type": "array" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "data_connector_ids", "knowledge_base_configs", "name" ], "type": "object" } .. _パラメーター-103: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable library_id,path,string,true,なし body,body,:ref:`UpdateLibraryRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _応答-106: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateLibrary 200レスポンス,:ref:`UpdateLibraryResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth メッセージ ---------- DeleteMessage ^^^^^^^^^^^^^ ``DELETE /messages/{message_id}`` .. _パラメーター-104: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-107: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteMessage 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetMessage ^^^^^^^^^^ ``GET /messages/{message_id}`` .. _パラメーター-105: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _応答-108: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetMessage 200応答,:ref:`GetMessageResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アップデートメッセージ ^^^^^^^^^^^^^^^^^^^^^^ ``PATCH /messages/{message_id}`` **ボディパラメーター** .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "type": "object" } .. _パラメーター-106: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable message_id,path,string,true,なし body,body,:ref:`UpdateMessageRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _応答-109: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateMessage 200応答,:ref:`UpdateMessageResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth リストメッセージ ^^^^^^^^^^^^^^^^ ``GET /threads/{thread_id}/messages`` .. _パラメーター-107: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "messages": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "messages", "pagination" ], "type": "object" } .. _応答-110: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListMessages 200応答,:ref:`ListMessagesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateMessage ^^^^^^^^^^^^^ ``POST /threads/{thread_id}/messages`` **ボディパラメーター** .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _パラメーター-108: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,なし body,body,:ref:`CreateMessageRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _応答-111: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateMessage 201応答,:ref:`CreateMessageResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth モデル ------ ListModels ^^^^^^^^^^ ``GET /models`` .. _パラメーター-109: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし model_type,query,string,false,なし default,query,boolean,false,なし **応答例** .. code:: json { "properties": { "models": { "items": { "properties": { "default": { "type": "boolean" }, "description": { "type": "string" }, "model_name": { "type": "string" }, "model_type": { "enum": [ "chat", "embedding", "rerank", "image_generation", "unknown" ], "type": "string" } }, "required": [ "default", "model_name", "model_type" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "models", "pagination" ], "type": "object" } .. _応答-112: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListModels 200レスポンス,:ref:`ListModelsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 組織 ---- リスト組織 ^^^^^^^^^^ ``GET /organizations`` **応答例** .. code:: json { "properties": { "organizations": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _応答-113: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizations 200 応答,:ref:`ListOrganizationsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateOrganization ^^^^^^^^^^^^^^^^^^ ``POST /organizations`` **ボディパラメーター** .. code:: json { "properties": { "description": { "maxLength": 2000, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-110: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateOrganizationRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-114: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateOrganization 201レスポンス,:ref:`CreateOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 組織の削除 ^^^^^^^^^^ ``DELETE /organizations/{organization_id}`` .. _パラメーター-111: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-115: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteOrganization 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetOrganization ^^^^^^^^^^^^^^^ ``GET /organizations/{organization_id}`` .. _パラメーター-112: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-116: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetOrganization 200レスポンス,:ref:`GetOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateOrganization ^^^^^^^^^^^^^^^^^^ ``PATCH /organizations/{organization_id}`` **ボディパラメーター** .. code:: json { "properties": { "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-113: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし body,body,:ref:`UpdateOrganizationRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _応答-117: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateOrganization 200レスポンス,:ref:`UpdateOrganizationResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListOrganizationUsers ^^^^^^^^^^^^^^^^^^^^^ ``GET /organizations/{organization_id}/users`` .. _パラメーター-114: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "users": { "items": { "properties": { "email": { "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "email", "user_id" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "users" ], "type": "object" } .. _応答-118: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListOrganizationUsers 200レスポンス,:ref:`ListOrganizationUsersResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteOrganizationUser ^^^^^^^^^^^^^^^^^^^^^^ ``DELETE /organizations/{organization_id}/users/{user_id}`` .. _パラメーター-115: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable organization_id,path,string,true,なし user_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-119: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteOrganizationUser 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth Retrieverコンポーネント ----------------------- ListRetrieverコンポーネント ^^^^^^^^^^^^^^^^^^^^^^^^^^^ ``GET /retriever-components`` .. _パラメーター-116: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "retriever_components" ], "type": "object" } .. _応答-120: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRetrieverComponents 200レスポンス,:ref:`ListRetrieverComponentsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateRetrieverComponent ^^^^^^^^^^^^^^^^^^^^^^^^ ``POST /retriever-components`` **ボディパラメーター** .. code:: json { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _パラメーター-117: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRetrieverComponentRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _応答-121: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRetrieverComponent 201レスポンス,:ref:`CreateRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteRetrieverComponent ^^^^^^^^^^^^^^^^^^^^^^^^ ``DELETE /retriever-components/{retriever_component_id}`` .. _パラメーター-118: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-122: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRetrieverComponent 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetRetrieverComponent ^^^^^^^^^^^^^^^^^^^^^ ``GET /retriever-components/{retriever_component_id}`` .. _パラメーター-119: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,なし **応答例** .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _応答-123: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRetrieverComponent 200レスポンス,:ref:`GetRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateRetrieverComponent ^^^^^^^^^^^^^^^^^^^^^^^^ ``PATCH /retriever-components/{retriever_component_id}`` **ボディパラメーター** .. code:: json { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "config", "type" ], "type": "object" } .. _パラメーター-120: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_component_id,path,string,true,なし body,body,:ref:`UpdateRetrieverComponentRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _応答-124: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRetrieverComponent 200レスポンス,:ref:`UpdateRetrieverComponentResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth レトリバー ---------- ListRetrievers ^^^^^^^^^^^^^^ ``GET /retrievers`` .. _パラメーター-121: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "retrievers": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "retrievers" ], "type": "object" } .. _応答-125: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRetrievers 200 応答,:ref:`ListRetrieversResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateRetriever ^^^^^^^^^^^^^^^ ``POST /retrievers`` **ボディパラメーター** .. code:: json { "properties": { "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "retriever_component_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "retriever_components": { "items": { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-122: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRetrieverRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _応答-126: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRetriever 201レスポンス,:ref:`CreateRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteRetriever ^^^^^^^^^^^^^^^ ``DELETE /retrievers/{retriever_id}`` .. _パラメーター-123: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-127: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRetriever 204応答,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetRetriever ^^^^^^^^^^^^ ``GET /retrievers/{retriever_id}`` .. _パラメーター-124: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _応答-128: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRetriever 200レスポンス,:ref:`GetRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateRetriever ^^^^^^^^^^^^^^^ ``PATCH /retrievers/{retriever_id}`` **ボディパラメーター** .. code:: json { "properties": { "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "retriever_component_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "retriever_components": { "items": { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _パラメーター-125: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,なし body,body,:ref:`UpdateRetrieverRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _応答-129: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRetriever 200レスポンス,:ref:`UpdateRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth QueryRetriever ^^^^^^^^^^^^^^ ``POST /retrievers/{retriever_id}/query`` **ボディパラメーター** .. code:: json { "properties": { "query": { "type": "string" }, "retriever_components_query_args": {} }, "required": [ "query" ], "type": "object" } .. _パラメーター-126: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable retriever_id,path,string,true,なし body,body,:ref:`QueryRetrieverRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "outputs": { "items": {}, "type": "array" } }, "required": [ "outputs" ], "type": "object" } .. _応答-130: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,QueryRetriever 200応答,:ref:`QueryRetrieverResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ルール ------ ListRules ^^^^^^^^^ ``GET /rules`` .. _パラメーター-127: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし ruleset_id,query,string,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "rules": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "rules" ], "type": "object" } .. _応答-131: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRules 200レスポンス,:ref:`ListRulesResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateRule ^^^^^^^^^^ ``POST /rules`` **ボディパラメーター** .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "name", "rule" ], "type": "object" } .. _パラメーター-128: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRuleRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _応答-132: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRule 201レスポンス,:ref:`CreateRuleResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteRule ^^^^^^^^^^ ``DELETE /rules/{rule_id}`` .. _パラメーター-129: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-133: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRule 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetRule ^^^^^^^ ``GET /rules/{rule_id}`` .. _パラメーター-130: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _応答-134: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRule 200レスポンス,:ref:`GetRuleResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateRule ^^^^^^^^^^ ``PATCH /rules/{rule_id}`` **ボディパラメーター** .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-131: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable rule_id,path,string,true,なし body,body,:ref:`UpdateRuleRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _応答-135: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRule 200レスポンス,:ref:`UpdateRuleResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ルールセット ------------ リストルールセット ^^^^^^^^^^^^^^^^^^ ``GET /rulesets`` .. _パラメーター-132: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし alias,query,string,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "rulesets": { "items": { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "rulesets" ], "type": "object" } .. _応答-136: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListRulesets 200レスポンス,:ref:`ListRulesetsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateRuleset ^^^^^^^^^^^^^ ``POST /rulesets`` **ボディパラメーター** .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-133: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateRulesetRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _応答-137: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateRuleset 201レスポンス,:ref:`CreateRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteRuleset ^^^^^^^^^^^^^ ``DELETE /rulesets/{ruleset_id}`` .. _パラメーター-134: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-138: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteRuleset 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetRuleset ^^^^^^^^^^ ``GET /rulesets/{ruleset_id}`` .. _パラメーター-135: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _応答-139: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetRuleset 200レスポンス,:ref:`GetRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth Updateルールセット ^^^^^^^^^^^^^^^^^^ ``PATCH /rulesets/{ruleset_id}`` **ボディパラメーター** .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _パラメーター-136: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable ruleset_id,path,string,true,なし body,body,:ref:`UpdateRulesetRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _応答-140: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateRuleset 200レスポンス,:ref:`UpdateRulesetResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth シークレット ------------ ListSecrets ^^^^^^^^^^^ ``GET /secrets`` .. _パラメーター-137: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "secrets": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "secrets" ], "type": "object" } .. _応答-141: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListSecrets 200 レスポンス,:ref:`ListSecretsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateSecret ^^^^^^^^^^^^ ``POST /secrets`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _パラメーター-138: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateSecretRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _応答-142: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateSecret 201レスポンス,:ref:`CreateSecretResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteSecret ^^^^^^^^^^^^ ``DELETE /secrets/{secret_id}`` .. _パラメーター-139: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-143: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteSecret 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetSecret ^^^^^^^^^ ``GET /secrets/{secret_id}`` .. _パラメーター-140: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _応答-144: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetSecret 200レスポンス,:ref:`GetSecretResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth UpdateSecret ^^^^^^^^^^^^ ``PATCH /secrets/{secret_id}`` **ボディパラメーター** .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-141: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable secret_id,path,string,true,なし body,body,:ref:`UpdateSecretRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _応答-145: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateSecret 200レスポンス,:ref:`UpdateSecretResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth StructureRuns ------------- GetStructureRun ^^^^^^^^^^^^^^^ ``GET /structure-runs/{structure_run_id}`` .. _パラメーター-142: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _応答-146: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetStructureRun 200レスポンス,:ref:`GetStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CancelStructureRun ^^^^^^^^^^^^^^^^^^ ``POST /structure-runs/{structure_run_id}/cancel`` .. _パラメーター-143: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _応答-147: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CancelStructureRun 200レスポンス,:ref:`CancelStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListStructureRunLogs ^^^^^^^^^^^^^^^^^^^^ ``GET /structure-runs/{structure_run_id}/logs`` .. _パラメーター-144: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _応答-148: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureRunLogs 200レスポンス,:ref:`ListStructureRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListStructureRuns ^^^^^^^^^^^^^^^^^ ``GET /structures/{structure_id}/runs`` .. _パラメーター-145: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングする実行ステータスのコンマ区切りリスト。 .. _列挙値-6: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "structure_runs": { "items": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "structure_runs" ], "type": "object" } .. _応答-149: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListStructureRuns 200レスポンス,:ref:`ListStructureRunsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateStructureRun ^^^^^^^^^^^^^^^^^^ ``POST /structures/{structure_id}/runs`` **ボディパラメーター** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } .. _パラメーター-146: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_id,path,string,true,なし body,body,:ref:`CreateStructureRunRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _応答-150: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateStructureRun 201レスポンス,:ref:`CreateStructureRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth スパン ------ リストスパン ^^^^^^^^^^^^ ``GET /structure-runs/{structure_run_id}/spans`` .. _パラメーター-147: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable structure_run_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "page": { "type": "number" }, "spans": { "items": { "properties": { "attributes": {}, "end_time": { "format": "date-time", "type": "string" }, "events": { "properties": { "attributes": {}, "name": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "required": [ "attributes", "name", "timestamp" ], "type": "object" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "span_id": { "type": "string" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "enum": [ "UNSET", "OK", "ERROR" ], "type": "string" }, "trace_id": { "type": "string" } }, "required": [ "attributes", "end_time", "events", "name", "span_id", "start_time", "status", "trace_id" ], "type": "object" }, "type": "array" } }, "required": [ "spans" ], "type": "object" } .. _応答-151: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListSpans 200レスポンス,:ref:`ListSpansResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth スレッド -------- リストスレッド ^^^^^^^^^^^^^^ ``GET /threads`` .. _パラメーター-148: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし alias,query,string,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "threads": { "items": { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "threads" ], "type": "object" } .. _応答-152: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListThreads 200応答,:ref:`ListThreadsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateThread ^^^^^^^^^^^^ ``POST /threads`` **ボディパラメーター** .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "messages": { "items": { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-149: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateThreadRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _応答-153: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateThread 201レスポンス,:ref:`CreateThreadResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth スレッドの削除 ^^^^^^^^^^^^^^ ``DELETE /threads/{thread_id}`` .. _パラメーター-150: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-154: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteThread 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetThread ^^^^^^^^^ ``GET /threads/{thread_id}`` .. _パラメーター-151: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _応答-155: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetThread 200レスポンス,:ref:`GetThreadResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 更新スレッド ^^^^^^^^^^^^ ``PATCH /threads/{thread_id}`` **ボディパラメーター** .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "messages": { "items": { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-152: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable thread_id,path,string,true,なし body,body,:ref:`UpdateThreadRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _応答-156: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateThread 200レスポンス,:ref:`UpdateThreadResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ツール実行 ---------- GetToolRun ^^^^^^^^^^ ``GET /tool-runs/{tool_run_id}`` .. _パラメーター-153: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "input", "runtime_path", "started_at", "status", "tool_id", "tool_run_id", "updated_at" ], "type": "object" } .. _応答-157: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToolRun 200レスポンス,:ref:`GetToolRunResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListToolRunLogs ^^^^^^^^^^^^^^^ ``GET /tool-runs/{tool_run_id}/logs`` .. _パラメーター-154: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_run_id,path,string,true,なし **応答例** .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _応答-158: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolRunLogs 200 レスポンス,:ref:`ListToolRunLogsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ListToolRuns ^^^^^^^^^^^^ ``GET /tools/{tool_id}/runs`` .. _パラメーター-155: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし page,query,number,false,なし page_size,query,number,false,なし status,query,array[string],false,フィルタリングする実行ステータスのコンマ区切りリスト。 .. _列挙値-7: 列挙値 '''''' .. csv-table:: :header: Parameter,Value :widths: 10,30 :align: left :class: longtable status,QUEUED status,STARTING status,RUNNING status,SUCCEEDED status,FAILED status,ERROR status,CANCELLED **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "tool_runs": { "items": { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "input", "runtime_path", "started_at", "status", "tool_id", "tool_run_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "tool_runs" ], "type": "object" } .. _応答-159: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListToolRuns 200レスポンス,:ref:`ListToolRunsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ツール ------ リストツール ^^^^^^^^^^^^ ``GET /tools`` .. _パラメーター-156: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable page,query,number,false,なし page_size,query,number,false,なし **応答例** .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "tools": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "tools" ], "type": "object" } .. _応答-160: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,ListTools 200レスポンス,:ref:`ListToolsResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth CreateTool ^^^^^^^^^^ ``POST /tools`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "tool_config_file": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _パラメーター-157: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable body,body,:ref:`CreateToolRequestContent` ,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _応答-161: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 201,:ref:`CreateDataConnector` ,CreateTool 201レスポンス,:ref:`CreateToolResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth DeleteTool ^^^^^^^^^^ ``DELETE /tools/{tool_id}`` .. _パラメーター-158: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし **応答例** .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _応答-162: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 204, `No Content `__ ,DeleteTool 204レスポンス,None 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetTool ^^^^^^^ ``GET /tools/{tool_id}`` .. _パラメーター-159: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _応答-163: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetTool 200レスポンス,:ref:`GetToolResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth アップデートツール ^^^^^^^^^^^^^^^^^^ ``PATCH /tools/{tool_id}`` **ボディパラメーター** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "tool_config_file": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _パラメーター-160: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし body,body,:ref:`UpdateToolRequestContent` ,false,なし **応答例** .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _応答-164: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,UpdateTool 200レスポンス,:ref:`UpdateToolResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ToolInvoke ---------- CreateToolActivityRun ^^^^^^^^^^^^^^^^^^^^^ ``POST /tools/{tool_id}/activities/{activity_path}`` **ボディパラメーター** .. code:: json {} .. _パラメーター-161: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし activity_path,path,string,true,なし body,body,:ref:`CreateToolActivityRunInputPayload` ,false,なし **応答例** .. code:: json {} .. _応答-165: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,CreateToolActivityRun 200レスポンス,:ref:`CreateToolActivityRunOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth GetToolOpenApiRun ^^^^^^^^^^^^^^^^^ ``GET /tools/{tool_id}/openapi`` .. _パラメーター-162: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable tool_id,path,string,true,なし **応答例** .. code:: json {} .. _応答-166: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetToolOpenApiRun 200レスポンス,:ref:`GetToolOpenApiRunOutputPayload` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth 使用法 ------ GetUsage ^^^^^^^^ ``GET /usage`` **応答例** .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "bytes_ingested_limit": { "type": "number" }, "rag_queries": { "type": "number" }, "rag_queries_limit": { "type": "number" }, "runtime_seconds": { "type": "number" }, "runtime_seconds_limit": { "type": "number" }, "usage_period_end": { "format": "date-time", "type": "string" }, "usage_period_start": { "format": "date-time", "type": "string" } }, "required": [ "bytes_ingested", "bytes_ingested_limit", "rag_queries", "rag_queries_limit", "runtime_seconds", "runtime_seconds_limit", "usage_period_end", "usage_period_start" ], "type": "object" } .. _応答-167: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetUsage 200レスポンス,:ref:`GetUsageResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth ユーザー -------- GetUser ^^^^^^^ ``GET /users/{user_id}`` .. _パラメーター-163: パラメーター ^^^^^^^^^^^^ .. csv-table:: :header: Name,In,Type,Required,Description :widths: auto :align: left :class: longtable user_id,path,string,true,なし **応答例** .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "organizations": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "created_at", "email", "organizations", "updated_at", "user_id" ], "type": "object" } .. _応答-168: 応答 ^^^^ .. csv-table:: :header: Status,Meaning,Description,Schema :widths: 15,12,12,20 :align: left :class: longtable 200,:ref:`GetToken` ,GetUser 200レスポンス,:ref:`GetUserResponseContent` 400, `Bad Request `__ ,ClientError 400応答,:ref:`ClientErrorResponseコンテンツ` 500, `Internal Server Error `__ ,ServiceError 500応答,:ref:`ServiceErrorResponseコンテンツ` .. warning:: この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth スキーマ -------- アクティビティ期間 ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" } プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activity_type,string,false,none,なし seconds,number,false,none,なし ApiKeyDetail ^^^^^^^^^^^^ .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-1: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,なし api_key_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし アーティファクト ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" } .. _プロパティ-2: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable id,string,true,none,なし meta,any,false,none,なし name,string,true,none,なし reference,string,false,none,なし type,string,true,none,なし value,string,true,none,なし AssertUrlオペレーション ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "PUT", "GET" ], "type": "string" } .. _プロパティ-3: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-8: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,PUT *anonymous*,GET アセットの詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-4: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,なし contents,any,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし size,number,false,none,なし updated_at,string(date-time),true,none,なし アシスタント詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-5: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし structure_ids,[string],true,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし アシスタントイベントの詳細 ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "assistant_run_id", "created_at", "event_id", "origin", "payload", "timestamp", "type" ], "type": "object" } .. _プロパティ-6: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_run_id,string,true,none,なし created_at,string(date-time),true,none,なし event_id,string,true,none,なし origin,string,true,none,なし payload,any,true,none,なし timestamp,number(double),true,none,なし type,string,true,none,なし AssistantRunDetail ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-7: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし assistant_id,string,true,none,なし assistant_run_id,string,true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし output,any,false,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし status,:ref:`AssistantRunStatus` ,true,none,なし status_detail,any,false,none,なし stream,boolean,true,none,なし structure_ids,[string],true,none,なし thread_id,string,false,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし AssistantRunStatus ^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _プロパティ-8: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-9: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED バケットの詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-9: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし CancelAssistantRunResponseコンテンツ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-10: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし assistant_id,string,true,none,なし assistant_run_id,string,true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし output,any,false,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし status,:ref:`AssistantRunStatus` ,true,none,なし status_detail,any,false,none,なし stream,boolean,true,none,なし structure_ids,[string],true,none,なし thread_id,string,false,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし CancelDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _プロパティ-11: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし status,:ref:`データジョブステータス<データジョブステータス>` ,true,none,なし status_detail,any,false,none,なし CancelKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _プロパティ-12: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし knowledge_base_id,string,true,none,なし knowledge_base_job_id,string,true,none,なし status,:ref:`KnowledgeBaseJobStatus` ,true,none,なし status_detail,any,false,none,なし CancelStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _プロパティ-13: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`StructureRunStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし structure_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし Chatメッセージドライバーの構成 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "extra_params": {}, "max_tokens": { "type": "number" }, "model": { "type": "string" }, "structured_output_strategy": { "type": "string" }, "temperature": { "format": "float", "type": "number" }, "use_native_tools": { "type": "boolean" } }, "type": "object" } .. _プロパティ-14: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable extra_params,any,false,none,なし max_tokens,number,false,none,なし model,string,false,none,なし structured_output_strategy,string,false,none,なし temperature,number(float),false,none,なし use_native_tools,boolean,false,none,なし ChatMessageメッセージ ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "usage" ], "type": "object" } .. _プロパティ-15: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[MessageContent <.#tocs_messagecontent>` ],true,none,なし role,string,true,none,なし usage,:ref:`Chatメッセージの使用状況` ,true,none,なし Chatメッセージツール ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "activities": { "items": { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "activities", "name" ], "type": "object" } .. _プロパティ-16: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activities,\ :ref:`[ChatMessageToolActivity <.#tocs_chatmessagetoolactivity>` ],true,none,なし name,string,true,none,なし ChatMessageToolアクティビティ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" } .. _プロパティ-17: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,true,none,なし json_schema,:ref:`JsonSchema` ,true,none,なし name,string,true,none,なし Chatメッセージの使用状況 ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } .. _プロパティ-18: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input_tokens,number,true,none,なし output_tokens,number,true,none,なし type,string,true,none,なし ClientErrorResponseコンテンツ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _プロパティ-19: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable errors,[any],false,none,なし type,string,true,none,なし コードソース ^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] } .. _プロパティ-20: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github,:ref:`GithubCodeSource` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeCodeSource` ,true,none,なし コードソース入力 ^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] } .. _プロパティ-21: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable github,:ref:`GithubCodeSourceInput` ,true,none,なし Confluence詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } .. _プロパティ-22: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable atlassian_email,string,true,none,なし domain,string,true,none,なし ConfluenceInput ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } .. _プロパティ-23: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable atlassian_api_token,string,true,none,なし atlassian_email,string,true,none,なし domain,string,true,none,なし ConnectionCredentials入力 ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] } .. _プロパティ-24: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable github,:ref:`GitHubCredentials入力` ,true,none,なし 接続の詳細 ^^^^^^^^^^ .. code:: json { "properties": { "connection_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "connection_id", "created_at", "created_by", "name", "type", "updated_at" ], "type": "object" } .. _プロパティ-25: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし CreateApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-26: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし CreateApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "value": { "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at", "value" ], "type": "object" } .. _プロパティ-27: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,なし api_key_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし value,string,true,none,なし CreateAssetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-28: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし CreateAssetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-29: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,なし contents,any,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし size,number,false,none,なし updated_at,string(date-time),true,none,なし CreateAssetUrlRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "operation": { "enum": [ "PUT", "GET" ], "type": "string" } }, "type": "object" } .. _プロパティ-30: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable operation,:ref:`AssertUrlオペレーション` ,false,none,なし CreateAssetUrlResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "headers": { "additionalProperties": {}, "type": "object" }, "url": { "type": "string" } }, "required": [ "headers", "url" ], "type": "object" } .. _プロパティ-31: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable headers,:ref:`メタデータ<メタデータ>` ,true,none,なし url,string,true,none,なし CreateAssistantRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-32: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,なし input,string,false,none,なし knowledge_base_ids,[string],false,none,なし name,string,true,none,なし retriever_ids,[string],false,none,なし ruleset_ids,[string],false,none,なし structure_ids,[string],false,none,なし tool_ids,[string],false,none,なし CreateAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-33: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし structure_ids,[string],true,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし CreateAssistantRunRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "additional_knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "additional_tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "args": { "items": { "type": "string" }, "type": "array" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "new_thread": { "description": "If true, create a new thread for this run to be returned in the response thread_id.", "type": "boolean" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "description": "If provided, the run will be associated with the given thread. This takes precedence over new_thread.", "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _プロパティ-34: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additional_knowledge_base_ids,[string],false,none,なし additional_retriever_ids,[string],false,none,なし additional_ruleset_ids,[string],false,none,なし additional_structure_ids,[string],false,none,なし additional_tool_ids,[string],false,none,なし args,[string],false,none,なし input,string,false,none,なし knowledge_base_ids,[string],false,none,なし new_thread,boolean,false,none,trueの場合、この実行の新しいスレッドを作成して、応答thread_idで返されます。 retriever_ids,[string],false,none,なし ruleset_ids,[string],false,none,なし stream,boolean,false,none,なし structure_ids,[string],false,none,なし thread_id,string,false,none,指定すると、実行は指定されたスレッドに関連付けられます。これはnew_threadより優先されます。 tool_ids,[string],false,none,なし CreateAssistantRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-35: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし assistant_id,string,true,none,なし assistant_run_id,string,true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし output,any,false,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし status,:ref:`AssistantRunStatus` ,true,none,なし status_detail,any,false,none,なし stream,boolean,true,none,なし structure_ids,[string],true,none,なし thread_id,string,false,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし CreateBillingManagementUrlResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "billing_management_url": { "type": "string" } }, "required": [ "billing_management_url" ], "type": "object" } .. _プロパティ-36: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable billing_management_url,string,true,none,なし CreateBucketRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-37: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし CreateBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-38: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateChatMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "driver_configuration": { "properties": { "extra_params": {}, "max_tokens": { "type": "number" }, "model": { "type": "string" }, "structured_output_strategy": { "type": "string" }, "temperature": { "format": "float", "type": "number" }, "use_native_tools": { "type": "boolean" } }, "type": "object" }, "messages": { "items": { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "usage" ], "type": "object" }, "type": "array" }, "output_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "tools": { "items": { "properties": { "activities": { "items": { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "activities", "name" ], "type": "object" }, "type": "array" } }, "required": [ "driver_configuration", "messages", "output_schema", "tools" ], "type": "object" } .. _プロパティ-39: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable driver_configuration,:ref:`Chatメッセージドライバーの構成` ,true,none,なし messages,\ :ref:`[ChatMessageMessage <.#tocs_chatmessagemessage>` ],true,none,なし output_schema,:ref:`JsonSchema` ,true,none,なし tools,\ :ref:`[ChatMessageTool <.#tocs_chatmessagetool>` ],true,none,なし CreateChatMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "type": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "type", "usage" ], "type": "object" } .. _プロパティ-40: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[MessageContent <.#tocs_messagecontent>` ],true,none,なし role,string,true,none,なし type,string,true,none,なし usage,:ref:`Chatメッセージの使用状況` ,true,none,なし CreateChatMessageStreamRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "driver_configuration": { "properties": { "extra_params": {}, "max_tokens": { "type": "number" }, "model": { "type": "string" }, "structured_output_strategy": { "type": "string" }, "temperature": { "format": "float", "type": "number" }, "use_native_tools": { "type": "boolean" } }, "type": "object" }, "messages": { "items": { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "usage" ], "type": "object" }, "type": "array" }, "output_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "tools": { "items": { "properties": { "activities": { "items": { "properties": { "description": { "type": "string" }, "json_schema": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" }, "name": { "type": "string" } }, "required": [ "description", "json_schema", "name" ], "type": "object" }, "type": "array" }, "name": { "type": "string" } }, "required": [ "activities", "name" ], "type": "object" }, "type": "array" } }, "required": [ "driver_configuration", "messages", "output_schema", "tools" ], "type": "object" } .. _プロパティ-41: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable driver_configuration,:ref:`Chatメッセージドライバーの構成` ,true,none,なし messages,\ :ref:`[ChatMessageMessage <.#tocs_chatmessagemessage>` ],true,none,なし output_schema,:ref:`JsonSchema` ,true,none,なし tools,\ :ref:`[ChatMessageTool <.#tocs_chatmessagetool>` ],true,none,なし CreateChatMessageStreamResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "content": { "items": { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" }, "type": "array" }, "role": { "type": "string" }, "type": { "type": "string" }, "usage": { "properties": { "input_tokens": { "type": "number" }, "output_tokens": { "type": "number" }, "type": { "type": "string" } }, "required": [ "input_tokens", "output_tokens", "type" ], "type": "object" } }, "required": [ "content", "role", "type" ], "type": "object" } .. _プロパティ-42: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable content,\ :ref:`[StreamMessageContent <.#tocs_streammessagecontent>` ],true,none,なし role,string,true,none,なし type,string,true,none,なし usage,:ref:`Chatメッセージの使用状況` ,false,none,なし CreateCheckoutSessionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "price_lookup_key": { "type": "string" } }, "required": [ "price_lookup_key" ], "type": "object" } .. _プロパティ-43: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable price_lookup_key,string,true,none,なし CreateCheckoutSessionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "redirect_url": { "type": "string" } }, "required": [ "redirect_url" ], "type": "object" } .. _プロパティ-44: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable redirect_url,string,true,none,なし CreateConnectionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "credentials": { "oneOf": [ { "properties": { "github": { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "credentials", "type" ], "type": "object" } .. _プロパティ-45: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable credentials,:ref:`ConnectionCredentials入力` ,true,none,なし name,string,false,none,なし type,string,true,none,なし CreateConnectionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "connection_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" } }, "required": [ "connection_id", "created_at", "created_by", "name", "type" ], "type": "object" } .. _プロパティ-46: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし type,string,true,none,なし CreateDataConnectorRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _プロパティ-47: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigInputUnion` ,true,none,なし description,string,false,none,なし name,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformInput <.#tocs_transforminput>` ],false,none,なし type,string,true,none,なし CreateDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "schedule_expression": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "type", "updated_at" ], "type": "object" } .. _プロパティ-48: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,false,none,なし description,string,false,none,なし name,string,true,none,なし schedule_expression,string,false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし CreateDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _プロパティ-49: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし status,:ref:`データジョブステータス<データジョブステータス>` ,true,none,なし status_detail,any,false,none,なし CreateEventsRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "events": { "items": { "properties": { "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "timestamp", "type" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-50: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable events,\ :ref:`[EventInput <.#tocs_eventinput>` ],false,none,なし CreateFunctionDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _プロパティ-51: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース入力<コードソース入力>` ,false,none,なし force,boolean,false,none,なし CreateFunctionDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {} }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "function_id", "status" ], "type": "object" } .. _プロパティ-52: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし function_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし CreateFunctionExecutionGetOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-53: プロパティ ^^^^^^^^^^ *なし* CreateFunctionExecutionPostInputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-54: プロパティ ^^^^^^^^^^ *なし* CreateFunctionExecutionPostOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-55: プロパティ ^^^^^^^^^^ *なし* CreateFunctionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-56: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし function_config_file,string,false,none,なし name,string,true,none,なし CreateFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-57: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし function_config_file,string,false,none,なし function_id,string,true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateIntegrationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _プロパティ-58: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],false,none,なし config,:ref:`IntegrationConfigInputUnion` ,true,none,なし description,string,false,none,なし name,string,true,none,なし structure_ids,[string],false,none,なし type,:ref:`統合タイプ<統合タイプ>` ,true,none,なし CreateIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _プロパティ-59: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,なし config,:ref:`IntegrationConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし integration_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_ids,[string],true,none,なし type,:ref:`統合タイプ<統合タイプ>` ,true,none,なし updated_at,string(date-time),true,none,なし CreateInviteRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "email": { "maxLength": 254, "minLength": 1, "type": "string" } }, "required": [ "email" ], "type": "object" } .. _プロパティ-60: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable email,string,true,none,なし CreateInviteResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" } .. _プロパティ-61: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし email,string,true,none,なし expires_at,string(date-time),true,none,なし invite_id,string,true,none,なし organization_id,string,true,none,なし responded_at,string(date-time),false,none,なし status,:ref:`InviteStatus` ,true,none,なし CreateKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _プロパティ-62: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし knowledge_base_id,string,true,none,なし knowledge_base_job_id,string,true,none,なし status,:ref:`KnowledgeBaseJobStatus` ,true,none,なし status_detail,any,false,none,なし CreateKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _プロパティ-63: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,なし config,:ref:`KnowledgeBaseConfigInputUnion` ,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし name,string,true,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし use_default_embedding_model,boolean,false,none,なし CreateKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-64: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,なし config,:ref:`KnowledgeBaseConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし knowledge_base_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし use_default_embedding_model,boolean,false,none,なし CreateLibraryRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "knowledge_base_configs": { "items": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "type": "array" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "data_connector_ids", "knowledge_base_configs", "name" ], "type": "object" } .. _プロパティ-65: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_configs,\ :ref:`[KnowledgeBaseConfigInputUnion <.#tocs_knowledgebaseconfiginputunion>` ],true,none,なし name,string,true,none,なし CreateLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-66: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_ids,[string],true,none,なし library_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _プロパティ-67: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし output,string,true,none,なし CreateMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-68: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし index,number,true,none,なし input,string,true,none,なし message_id,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし output,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateOrganizationApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-69: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし CreateOrganizationApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "value": { "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at", "value" ], "type": "object" } .. _プロパティ-70: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,なし api_key_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし value,string,true,none,なし CreateOrganizationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 2000, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-71: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,なし name,string,true,none,なし CreateOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-72: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし default_bucket_id,string,true,none,なし description,string,true,none,なし entitlement,any,true,none,なし すべての .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`資格<資格>` ,false,none,なし そして .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,なし 続き .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateRetrieverComponentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "config", "name", "type" ], "type": "object" } .. _プロパティ-73: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし description,string,false,none,なし name,string,true,none,なし type,string,true,none,なし CreateRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-74: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_component_id,string,true,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし CreateRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "retriever_component_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "retriever_components": { "items": { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-75: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,なし name,string,true,none,なし retriever_component_ids,[string],false,none,なし retriever_components,\ :ref:`[RetrieverComponentInput <.#tocs_retrievercomponentinput>` ],false,none,なし CreateRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-76: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,なし retriever_components_schema,any,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateRuleRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "required": [ "name", "rule" ], "type": "object" } .. _プロパティ-77: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,true,none,なし rule,string,true,none,なし CreateRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _プロパティ-78: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule,string,true,none,なし rule_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateRulesetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-79: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,なし description,string,false,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,true,none,なし rule_ids,[string],false,none,なし CreateRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _プロパティ-80: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule_ids,[string],true,none,なし ruleset_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateSecretRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _プロパティ-81: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし value,string,true,none,なし CreateSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _プロパティ-82: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし secret_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateStructureDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _プロパティ-83: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース入力<コードソース入力>` ,false,none,なし force,boolean,false,none,なし CreateStructureDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "structure_id" ], "type": "object" } .. _プロパティ-84: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし CreateStructureRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-85: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし name,string,true,none,なし structure_config_file,string,false,none,なし webhook_enabled,boolean,false,none,なし CreateStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-86: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし CreateStructureRunRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" } }, "required": [ "args" ], "type": "object" } .. _プロパティ-87: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし CreateStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _プロパティ-88: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`StructureRunStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし structure_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateThreadRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "messages": { "items": { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-89: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,なし messages,\ :ref:`[MessageInput <.#tocs_messageinput>` ],false,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,true,none,なし CreateThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-90: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし CreateToolActivityRunInputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-91: プロパティ ^^^^^^^^^^ *なし* CreateToolActivityRunOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-92: プロパティ ^^^^^^^^^^ *なし* CreateToolDeploymentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" } ] }, "force": { "type": "boolean" } }, "type": "object" } .. _プロパティ-93: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース入力<コードソース入力>` ,false,none,なし force,boolean,false,none,なし CreateToolDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "tool_id" ], "type": "object" } .. _プロパティ-94: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし tool_id,string,true,none,なし CreateToolRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "tool_config_file": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "name" ], "type": "object" } .. _プロパティ-95: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし name,string,true,none,なし tool_config_file,string,false,none,なし CreateToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _プロパティ-96: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし tool_config_file,string,false,none,なし tool_id,string,true,none,なし updated_at,string(date-time),true,none,なし DataConnectorConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] } .. _プロパティ-97: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » confluence,:ref:`ConfluenceInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » google_drive,:ref:`GoogleDriveInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » webscraper,:ref:`Webscraper入力` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » structure,:ref:`StructureConnectorInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » s3,:ref:`S3ConnectorInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeConnectorInput` ,true,none,なし DataConnectorConfigUnion ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] } .. _プロパティ-98: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » confluence,:ref:`Confluence詳細` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » google_drive,:ref:`GoogleDriveの詳細` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » webscraper,:ref:`Webscraper詳細` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » structure,:ref:`StructureConnectorDetail` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » s3,:ref:`S3コネクタの詳細` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeConnectorDetail` ,true,none,なし DataConnectorDetail ^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "type": "string" }, "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-99: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,なし config,:ref:`DataConnectorConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし DataJobDetail ^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _プロパティ-100: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし status,:ref:`データジョブステータス<データジョブステータス>` ,true,none,なし status_detail,any,false,none,なし データジョブステータス ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" } .. _プロパティ-101: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-10: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,CANCELLED DataLakeCodeSource ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } .. _プロパティ-102: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,なし bucket_id,string,true,none,なし DataLakeConnectorDetail ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } .. _プロパティ-103: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,なし bucket_id,string,true,none,なし DataLakeConnectorInput ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } .. _プロパティ-104: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,なし bucket_id,string,true,none,なし DataLakeファンクションコード ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } .. _プロパティ-105: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,なし bucket_id,string,true,none,なし DataLakeStructureCode ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } .. _プロパティ-106: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,なし bucket_id,string,true,none,なし DataLakeToolCode ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } .. _プロパティ-107: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_path,string,true,none,なし bucket_id,string,true,none,なし デフォルトファンクションコード ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _プロパティ-108: プロパティ ^^^^^^^^^^ *なし* DefaultStructureCode ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _プロパティ-109: プロパティ ^^^^^^^^^^ *なし* DefaultToolCode ^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _プロパティ-110: プロパティ ^^^^^^^^^^ *なし* DeploymentCountGauge ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" } .. _プロパティ-111: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active_count,number,false,none,なし total_count,number,false,none,なし DeploymentDurationゲージ ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "total_seconds": { "type": "number" } }, "type": "object" } .. _プロパティ-112: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable total_seconds,number,false,none,なし DeploymentErrorRateGauge ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "rate": { "format": "float", "type": "number" } }, "type": "object" } .. _プロパティ-113: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable rate,number(float),false,none,なし DeploymentStatus ^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" } .. _プロパティ-114: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-11: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,DEPLOYING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR 期間プロット ^^^^^^^^^^^^ .. code:: json { "properties": { "seconds_avg": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "timeseries": { "items": { "properties": { "seconds_p0": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "time": { "format": "date-time", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-115: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable seconds_avg,number,false,none,なし seconds_p100,number,false,none,なし seconds_p50,number,false,none,なし timeseries,\ :ref:`[DurationTimeseriesElement <.#tocs_durationtimeserieselement>` ],false,none,なし Timeseries要素 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "seconds_p0": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "time": { "format": "date-time", "type": "string" } }, "type": "object" } .. _プロパティ-116: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable seconds_p0,number,false,none,なし seconds_p100,number,false,none,なし seconds_p50,number,false,none,なし time,string(date-time),false,none,なし EmbeddingModel ^^^^^^^^^^^^^^ .. code:: json { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" } .. _プロパティ-117: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-12: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,text-embedding-ada-002 *anonymous*,text-embedding-3-small 資格 ^^^^ .. code:: json { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" } .. _プロパティ-118: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-13: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,FREE *anonymous*,PAID *anonymous*,PARTNER *anonymous*,UNPAID *anonymous*,EXPIRED エントリー ^^^^^^^^^^ .. code:: json { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" } .. _プロパティ-119: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable id,string,true,none,なし meta,:ref:`メタ<メタ>` ,false,none,なし namespace,string,false,none,なし score,number(float),true,none,なし vector,[number],false,none,なし EnvVar ^^^^^^ .. code:: json { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" } .. _プロパティ-120: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし source,:ref:`EnvVarSource` ,false,none,なし value,string,true,none,なし EnvVarSource ^^^^^^^^^^^^ .. code:: json { "enum": [ "secret_ref", "manual" ], "type": "string" } .. _プロパティ-121: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-14: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,secret_ref *anonymous*,manual エラー ^^^^^^ .. code:: json { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" } .. _プロパティ-122: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable message,string,true,none,なし path,string,false,none,なし type,string,true,none,なし ErrorRateGauge ^^^^^^^^^^^^^^ .. code:: json { "properties": { "error_type_counts": { "items": { "properties": { "count": { "type": "number" }, "error_type": { "type": "string" } }, "type": "object" }, "type": "array" }, "rate": { "format": "float", "type": "number" } }, "type": "object" } .. _プロパティ-123: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable error_type_counts,\ :ref:`[ErrorTypeCount <.#tocs_errortypecount>` ],false,none,なし rate,number(float),false,none,なし ErrorTypeCount ^^^^^^^^^^^^^^ .. code:: json { "properties": { "count": { "type": "number" }, "error_type": { "type": "string" } }, "type": "object" } .. _プロパティ-124: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,false,none,なし error_type,string,false,none,なし イベントの詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "created_at", "event_id", "origin", "payload", "structure_run_id", "timestamp", "type" ], "type": "object" } .. _プロパティ-125: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし event_id,string,true,none,なし origin,string,true,none,なし payload,any,true,none,なし structure_run_id,string,true,none,なし timestamp,number(double),true,none,なし type,string,true,none,なし EventInput ^^^^^^^^^^ .. code:: json { "properties": { "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "timestamp", "type" ], "type": "object" } .. _プロパティ-126: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable payload,any,false,none,なし timestamp,number(double),true,none,なし type,string,true,none,なし ファンクションコード ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] } .. _プロパティ-127: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github,:ref:`GithubFunctionCode` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeファンクションコード` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » default,:ref:`デフォルトファンクションコード<デフォルトファンクションコード>` ,true,none,なし ファンクション展開の詳細 ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {} }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "function_id", "status" ], "type": "object" } .. _プロパティ-128: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし function_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし ファンクションの詳細 ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-129: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし function_config_file,string,false,none,なし function_id,string,true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし FunctionRunDetail ^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "function_id", "function_run_id", "input", "runtime_path", "started_at", "status", "updated_at" ], "type": "object" } .. _プロパティ-130: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし function_id,string,true,none,なし function_run_id,string,true,none,なし input,any,true,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし runtime_path,string,true,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`FunctionRunStatus` ,true,none,なし status_detail,any,false,none,なし updated_at,string(date-time),true,none,なし FunctionRunStatus ^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _プロパティ-131: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-15: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED GTCHybidSQLPGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } .. _プロパティ-132: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,true,none,なし query_schema,any,true,none,なし structured_columns,\ :ref:`[StructuredColumnDetail <.#tocs_structuredcolumndetail>` ],true,none,なし unstructured_columns,\ :ref:`[UnstructuredColumnDetail <.#tocs_unstructuredcolumndetail>` ],true,none,なし use_default_embedding_model,boolean,true,none,なし GTCHybidSQLPGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } .. _プロパティ-133: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,false,none,なし structured_columns,\ :ref:`[StructuredColumnInput <.#tocs_structuredcolumninput>` ],true,none,なし unstructured_columns,\ :ref:`[UnstructuredColumnInput <.#tocs_unstructuredcolumninput>` ],true,none,なし use_default_embedding_model,boolean,false,none,なし GTCPGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } .. _プロパティ-134: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,true,none,なし query_schema,any,true,none,なし use_default_embedding_model,boolean,true,none,なし GTCPGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } .. _プロパティ-135: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable embedding_model,string,false,none,なし use_default_embedding_model,boolean,false,none,なし GetApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-136: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,なし api_key_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetAssetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-137: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,なし contents,any,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし size,number,false,none,なし updated_at,string(date-time),true,none,なし GetAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-138: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし structure_ids,[string],true,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし GetAssistantRunEventsSSEOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "format": "byte", "type": "string" } .. _プロパティ-139: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string(byte),false,none,なし GetAssistantRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-140: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし assistant_id,string,true,none,なし assistant_run_id,string,true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし output,any,false,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし status,:ref:`AssistantRunStatus` ,true,none,なし status_detail,any,false,none,なし stream,boolean,true,none,なし structure_ids,[string],true,none,なし thread_id,string,false,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし GetBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-141: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetConfigResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "data_lake_s3_bucket": { "type": "string" }, "data_lake_s3_region": { "type": "string" }, "data_lake_s3_url": { "type": "string" }, "google_drive_data_connector_client_id": { "type": "string" } }, "required": [ "data_lake_s3_bucket", "data_lake_s3_region", "data_lake_s3_url", "google_drive_data_connector_client_id" ], "type": "object" } .. _プロパティ-142: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_lake_s3_bucket,string,true,none,なし data_lake_s3_region,string,true,none,なし data_lake_s3_url,string,true,none,なし google_drive_data_connector_client_id,string,true,none,なし GetDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "type": "string" }, "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-143: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,false,none,なし config,:ref:`DataConnectorConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし GetDataJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" } .. _プロパティ-144: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし status,:ref:`データジョブステータス<データジョブステータス>` ,true,none,なし status_detail,any,false,none,なし GetDeploymentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status" ], "type": "object" } .. _プロパティ-145: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし function_id,string,false,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,false,none,なし tool_id,string,false,none,なし GetEventResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "created_at", "event_id", "origin", "payload", "structure_run_id", "timestamp", "type" ], "type": "object" } .. _プロパティ-146: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし event_id,string,true,none,なし origin,string,true,none,なし payload,any,true,none,なし structure_run_id,string,true,none,なし timestamp,number(double),true,none,なし type,string,true,none,なし GetFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-147: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし function_config_file,string,false,none,なし function_id,string,true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetFunctionRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "function_id", "function_run_id", "input", "runtime_path", "started_at", "status", "updated_at" ], "type": "object" } .. _プロパティ-148: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし function_id,string,true,none,なし function_run_id,string,true,none,なし input,any,true,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし runtime_path,string,true,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`FunctionRunStatus` ,true,none,なし status_detail,any,false,none,なし updated_at,string(date-time),true,none,なし GetIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _プロパティ-149: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,なし config,:ref:`IntegrationConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし integration_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_ids,[string],true,none,なし type,:ref:`統合タイプ<統合タイプ>` ,true,none,なし updated_at,string(date-time),true,none,なし GetInviteResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" } .. _プロパティ-150: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし email,string,true,none,なし expires_at,string(date-time),true,none,なし invite_id,string,true,none,なし organization_id,string,true,none,なし responded_at,string(date-time),false,none,なし status,:ref:`InviteStatus` ,true,none,なし GetKnowledgeBaseJobResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _プロパティ-151: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし knowledge_base_id,string,true,none,なし knowledge_base_job_id,string,true,none,なし status,:ref:`KnowledgeBaseJobStatus` ,true,none,なし status_detail,any,false,none,なし GetKnowledgeBaseQueryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" } .. _プロパティ-152: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_query_id,string,true,none,なし query,string,true,none,なし GetKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-153: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,なし config,:ref:`KnowledgeBaseConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし knowledge_base_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし use_default_embedding_model,boolean,false,none,なし GetKnowledgeBaseSearchResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" } .. _プロパティ-154: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_search_id,string,true,none,なし query,string,true,none,なし result,string,true,none,なし GetLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-155: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_ids,[string],true,none,なし library_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-156: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし index,number,true,none,なし input,string,true,none,なし message_id,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし output,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-157: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし default_bucket_id,string,true,none,なし description,string,true,none,なし entitlement,any,true,none,なし すべての .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`資格<資格>` ,false,none,なし そして .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,なし 続き .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-158: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_component_id,string,true,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし GetRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-159: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,なし retriever_components_schema,any,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _プロパティ-160: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule,string,true,none,なし rule_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _プロパティ-161: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule_ids,[string],true,none,なし ruleset_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _プロパティ-162: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし secret_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-163: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし GetStructureRunEventsSSEOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "format": "byte", "type": "string" } .. _プロパティ-164: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string(byte),false,none,なし GetStructureRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _プロパティ-165: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`StructureRunStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし structure_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetStructuresDashboardResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "deployment_count_gauge": { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" }, "deployment_duration_gauge": { "properties": { "total_seconds": { "type": "number" } }, "type": "object" }, "deployment_error_rate_gauge": { "properties": { "rate": { "format": "float", "type": "number" } }, "type": "object" }, "duration_plot": { "properties": { "seconds_avg": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "timeseries": { "items": { "properties": { "seconds_p0": { "type": "number" }, "seconds_p100": { "type": "number" }, "seconds_p50": { "type": "number" }, "time": { "format": "date-time", "type": "string" } }, "type": "object" }, "type": "array" } }, "type": "object" }, "error_rate_gauge": { "properties": { "error_type_counts": { "items": { "properties": { "count": { "type": "number" }, "error_type": { "type": "string" } }, "type": "object" }, "type": "array" }, "rate": { "format": "float", "type": "number" } }, "type": "object" }, "run_count_gauge": { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" }, "run_duration_gauge": { "properties": { "activity_durations": { "items": { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" }, "type": "array" }, "total_seconds": { "type": "number" } }, "type": "object" }, "token_count_gauge": { "properties": { "by_model": { "additionalProperties": { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" }, "type": "object" }, "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" } }, "type": "object" } .. _プロパティ-166: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployment_count_gauge,:ref:`DeploymentCountGauge` ,false,none,なし deployment_duration_gauge,:ref:`DeploymentDurationゲージ` ,false,none,なし deployment_error_rate_gauge,:ref:`DeploymentErrorRateGauge` ,false,none,なし duration_plot,:ref:`期間プロット<期間プロット>` ,false,none,なし error_rate_gauge,:ref:`DeploymentErrorRateGauge` ,false,none,なし run_count_gauge,:ref:`RunCountGauge` ,false,none,なし run_duration_gauge,:ref:`RunDurationGauge` ,false,none,なし token_count_gauge,:ref:`TokenCountGauge` ,false,none,なし GetThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-167: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetTokenResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "type": "string" } }, "required": [ "access_token" ], "type": "object" } .. _プロパティ-168: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,true,none,なし GetToolOpenApiRunOutputPayload ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json {} .. _プロパティ-169: プロパティ ^^^^^^^^^^ *なし* GetToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _プロパティ-170: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし tool_config_file,string,false,none,なし tool_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetToolRunResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "input", "runtime_path", "started_at", "status", "tool_id", "tool_run_id", "updated_at" ], "type": "object" } .. _プロパティ-171: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし input,any,true,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし runtime_path,string,true,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`ツール実行ステータス<ツール実行ステータス>` ,true,none,なし status_detail,any,false,none,なし tool_id,string,true,none,なし tool_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし GetUsageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "bytes_ingested_limit": { "type": "number" }, "rag_queries": { "type": "number" }, "rag_queries_limit": { "type": "number" }, "runtime_seconds": { "type": "number" }, "runtime_seconds_limit": { "type": "number" }, "usage_period_end": { "format": "date-time", "type": "string" }, "usage_period_start": { "format": "date-time", "type": "string" } }, "required": [ "bytes_ingested", "bytes_ingested_limit", "rag_queries", "rag_queries_limit", "runtime_seconds", "runtime_seconds_limit", "usage_period_end", "usage_period_start" ], "type": "object" } .. _プロパティ-172: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,true,none,なし bytes_ingested_limit,number,true,none,なし rag_queries,number,true,none,なし rag_queries_limit,number,true,none,なし runtime_seconds,number,true,none,なし runtime_seconds_limit,number,true,none,なし usage_period_end,string(date-time),true,none,なし usage_period_start,string(date-time),true,none,なし GetUserResponseContent ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "organizations": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "created_at", "email", "organizations", "updated_at", "user_id" ], "type": "object" } .. _プロパティ-173: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし email,string,true,none,なし name,string,false,none,なし organizations,[string],true,none,なし updated_at,string(date-time),true,none,なし user_id,string,true,none,なし GitHubAppDetail ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } .. _プロパティ-174: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_id,string,true,none,なし integration_endpoint,string,true,none,なし private_key_secret_ref,string,true,none,なし webhook_secret_ref,string,true,none,なし GitHubAppInput ^^^^^^^^^^^^^^ .. code:: json { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } .. _プロパティ-175: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_id,string,false,none,なし private_key_secret_ref,string,false,none,なし webhook_secret_ref,string,false,none,なし GitHubCredentials入力 ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "auth_code": { "type": "string" } }, "required": [ "auth_code" ], "type": "object" } .. _プロパティ-176: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable auth_code,string,true,none,なし GithubCodeSource ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-177: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable commit_sha,string,false,none,なし GithubCodeSourceInput ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "maxLength": 1000, "minLength": 1, "type": "string" }, "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-178: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,false,none,なし commit_sha,string,false,none,なし GithubFunctionCode ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } .. _プロパティ-179: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし owner,string,true,none,なし push,:ref:`GithubFunctionCodePushConfig` ,true,none,なし GithubFunctionCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _プロパティ-180: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,なし tag,string,false,none,なし GithubStructureCode ^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } .. _プロパティ-181: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし owner,string,true,none,なし push,:ref:`GithubStructureCodePushConfig` ,true,none,なし GithubStructureCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _プロパティ-182: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,なし tag,string,false,none,なし GithubToolCode ^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } .. _プロパティ-183: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,true,none,なし owner,string,true,none,なし push,:ref:`GithubToolCodePushConfig` ,true,none,なし GithubToolCodePushConfig ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } .. _プロパティ-184: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable branch,string,true,none,なし tag,string,false,none,なし GoogleDriveの詳細 ^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } .. _プロパティ-185: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable access_token,string,true,none,なし file_ids,[string],true,none,なし GoogleDriveInput ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } .. _プロパティ-186: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable auth_code,string,true,none,なし file_ids,[string],true,none,なし IntegrationConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] } .. _プロパティ-187: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » slack,:ref:`SlackInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github_app,:ref:`GitHubAppInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » webhook,:ref:`Webhook入力` ,true,none,なし IntegrationConfigUnion ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] } .. _プロパティ-188: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » slack,:ref:`Slackの詳細` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github_app,:ref:`GitHubAppDetail` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » webhook,:ref:`Webhook詳細` ,true,none,なし 統合の詳細 ^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _プロパティ-189: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,なし config,:ref:`IntegrationConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし integration_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_ids,[string],true,none,なし type,:ref:`統合タイプ<統合タイプ>` ,true,none,なし updated_at,string(date-time),true,none,なし 統合タイプ ^^^^^^^^^^ .. code:: json { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } .. _プロパティ-190: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-16: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,slack *anonymous*,github_app *anonymous*,webhook InviteDetail ^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" } .. _プロパティ-191: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし email,string,true,none,なし expires_at,string(date-time),true,none,なし invite_id,string,true,none,なし organization_id,string,true,none,なし responded_at,string(date-time),false,none,なし status,:ref:`InviteStatus` ,true,none,なし InviteResponseステータス ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } .. _プロパティ-192: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-17: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,ACCEPTED *anonymous*,REJECTED InviteStatus ^^^^^^^^^^^^ .. code:: json { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } .. _プロパティ-193: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-18: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,ACCEPTED *anonymous*,EXPIRED *anonymous*,PENDING *anonymous*,REJECTED InvokeStructureWebhookGetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-194: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし InvokeStructureWebhookPostResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-195: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし JsonSchema ^^^^^^^^^^ .. code:: json { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "id": { "type": "string" }, "properties": { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "schema": { "type": "string" }, "title": { "type": "string" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "id", "properties", "required", "schema", "title", "type" ], "type": "object" } .. _プロパティ-196: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additionalProperties,boolean,true,none,なし description,string,true,none,なし id,string,true,none,なし properties,:ref:`JsonSchemaプロパティ` ,true,none,なし required,[string],true,none,なし schema,string,true,none,なし title,string,true,none,なし type,string,true,none,なし JsonSchemaプロパティ ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "member": { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": "[Circular]", "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } }, "type": "object" } .. _プロパティ-197: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable member,:ref:`JsonSchemaプロパティ` ,false,none,なし .. _jsonschemaプロパティ-1: JsonSchemaプロパティ ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "additionalProperties": { "type": "boolean" }, "description": { "type": "string" }, "properties": { "properties": { "member": "[Circular]" }, "type": "object" }, "required": { "items": { "type": "string" }, "type": "array" }, "type": { "type": "string" } }, "required": [ "additionalProperties", "description", "properties", "required", "type" ], "type": "object" } .. _プロパティ-198: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable additionalProperties,boolean,true,none,なし description,string,true,none,なし properties,:ref:`JsonSchemaプロパティ` ,true,none,なし required,[string],true,none,なし type,string,true,none,なし KnowledgeBaseConfigInputUnion ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] } .. _プロパティ-199: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » gtc_pg_vector,:ref:`GTCPGVectorKnowledgeBaseInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » gtc_hybrid_sql_pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseInput` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » pgai_knowledge_base,:ref:`PGAIKnowledgeBaseKnowledgeBase入力` ,true,none,なし KnowledgeBaseConfigUnion ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] } .. _プロパティ-200: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseDetail` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » gtc_pg_vector,:ref:`GTCPGVectorKnowledgeBaseDetail` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » gtc_hybrid_sql_pg_vector,:ref:`GTCHybidSQLPGVectorKnowledgeBaseDetail` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » pgai_knowledge_base,:ref:`PGAIKnowledgeBaseKnowledgeBaseDetail` ,true,none,なし ナレッジベースの詳細 ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-201: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,なし config,:ref:`KnowledgeBaseConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし knowledge_base_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし use_default_embedding_model,boolean,false,none,なし KnowledgeBaseJobDetail ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" } .. _プロパティ-202: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bytes_ingested,number,false,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし errors,\ :ref:`[Error <.#tocs_error>` ],false,none,なし knowledge_base_id,string,true,none,なし knowledge_base_job_id,string,true,none,なし status,:ref:`KnowledgeBaseJobStatus` ,true,none,なし status_detail,any,false,none,なし KnowledgeBaseJobStatus ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" } .. _プロパティ-203: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-19: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,CANCELLED KnowledgeBaseQueryDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" } .. _プロパティ-204: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_query_id,string,true,none,なし query,string,true,none,なし KnowledgeBaseSearchDetail ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" } .. _プロパティ-205: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_search_id,string,true,none,なし query,string,true,none,なし result,string,true,none,なし ライブラリの詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-206: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_ids,[string],true,none,なし library_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし ListApiKeysResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "api_keys": { "items": { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "api_keys", "pagination" ], "type": "object" } .. _プロパティ-207: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable api_keys,\ :ref:`tool_id ` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListAssetsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assets": { "items": { "properties": { "bucket_id": { "type": "string" }, "contents": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "size": { "type": "number" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "postfix": { "type": "string" }, "prefix": { "type": "string" } }, "required": [ "assets", "pagination" ], "type": "object" } .. _プロパティ-208: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assets,\ :ref:`[AssetDetail <.#tocs_assetdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし postfix,string,false,none,なし prefix,string,false,none,なし ListAssistantEventsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "count": { "type": "number" }, "events": { "items": { "properties": { "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "assistant_run_id", "created_at", "event_id", "origin", "payload", "timestamp", "type" ], "type": "object" }, "type": "array" }, "limit": { "type": "number" }, "next_offset": { "type": "number" }, "offset": { "type": "number" }, "total_count": { "type": "number" } }, "required": [ "count", "events", "limit", "next_offset", "offset", "total_count" ], "type": "object" } .. _プロパティ-209: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,true,none,なし events,\ :ref:`[AssistantEventDetail <.#tocs_assistanteventdetail>` ],true,none,なし limit,number,true,none,なし next_offset,number,true,none,なし offset,number,true,none,なし total_count,number,true,none,なし ListAssistantRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_runs": { "items": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "assistant_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "output": {}, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "stream": { "type": "boolean" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "assistant_id", "assistant_run_id", "completed_at", "created_at", "created_by", "knowledge_base_ids", "retriever_ids", "ruleset_ids", "status", "stream", "structure_ids", "tool_ids", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "assistant_runs", "pagination" ], "type": "object" } .. _プロパティ-210: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_runs,\ :ref:`[AssistantRunDetail <.#tocs_assistantrundetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListAssistantsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistants": { "items": { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "assistants", "pagination" ], "type": "object" } .. _プロパティ-211: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistants,\ :ref:`[AssistantDetail <.#tocs_assistantdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListBucketsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "buckets": { "items": { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "buckets", "pagination" ], "type": "object" } .. _プロパティ-212: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable buckets,\ :ref:`[BucketDetail <.#tocs_bucketdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListConnectionsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "connections": { "items": { "properties": { "connection_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "connection_id", "created_at", "created_by", "name", "type", "updated_at" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-213: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connections,\ :ref:`[ConnectionDetail <.#tocs_connectiondetail>` ],false,none,なし ListDataConnectorsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "data_connectors": { "items": { "properties": { "bucket_id": { "type": "string" }, "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "data_connectors", "pagination" ], "type": "object" } .. _プロパティ-214: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connectors,\ :ref:`[DataConnectorDetail <.#tocs_dataconnectordetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListDataJobsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "data_jobs": { "items": { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "data_connector_id", "data_job_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "data_jobs", "pagination" ], "type": "object" } .. _プロパティ-215: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_jobs,\ :ref:`[DataJobDetail <.#tocs_datajobdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListEventsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "count": { "type": "number" }, "events": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "event_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "origin": { "type": "string" }, "payload": {}, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "timestamp": { "format": "double", "type": "number" }, "type": { "type": "string" } }, "required": [ "created_at", "event_id", "origin", "payload", "structure_run_id", "timestamp", "type" ], "type": "object" }, "type": "array" }, "limit": { "type": "number" }, "next_offset": { "type": "number" }, "offset": { "type": "number" }, "total_count": { "type": "number" } }, "required": [ "count", "events", "limit", "next_offset", "offset", "total_count" ], "type": "object" } .. _プロパティ-216: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable count,number,true,none,なし events,\ :ref:`[EventDetail <.#tocs_eventdetail>` ],true,none,なし limit,number,true,none,なし next_offset,number,true,none,なし offset,number,true,none,なし total_count,number,true,none,なし ListFunctionDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {} }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "function_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _プロパティ-217: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[FunctionDeploymentDetail <.#tocs_functiondeploymentdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListFunctionRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _プロパティ-218: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,なし ListFunctionRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "function_runs": { "items": { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "function_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "function_id", "function_run_id", "input", "runtime_path", "started_at", "status", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "function_runs", "pagination" ], "type": "object" } .. _プロパティ-219: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable function_runs,\ :ref:`[FunctionRunDetail <.#tocs_functionrundetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListFunctionsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "functions": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "functions", "pagination" ], "type": "object" } .. _プロパティ-220: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable functions,\ :ref:`[FunctionDetail <.#tocs_functiondetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListIntegrationsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "integrations": { "items": { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "integrations", "pagination" ], "type": "object" } .. _プロパティ-221: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable integrations,\ :ref:`[IntegrationDetail <.#tocs_integrationdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListInvitesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "invites": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "invites", "pagination" ], "type": "object" } .. _プロパティ-222: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable invites,\ :ref:`[InviteDetail <.#tocs_invitedetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListKnowledgeBaseJobsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_base_jobs": { "items": { "properties": { "bytes_ingested": { "type": "number" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "errors": { "items": { "properties": { "message": { "type": "string" }, "path": { "type": "string" }, "type": { "type": "string" } }, "required": [ "message", "type" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "RUNNING", "SUCCEEDED", "FAILED", "CANCELLED" ], "type": "string" }, "status_detail": {} }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_job_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "knowledge_base_jobs", "pagination" ], "type": "object" } .. _プロパティ-223: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_jobs,\ :ref:`[KnowledgeBaseJobDetail <.#tocs_knowledgebasejobdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListKnowledgeBaseQueriesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_base_queries": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-224: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_queries,\ :ref:`[KnowledgeBaseQueryDetail <.#tocs_knowledgebasequerydetail>` ],false,none,なし ListKnowledgeBaseSearchesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_base_searches": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-225: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_searches,\ :ref:`[KnowledgeBaseSearchDetail <.#tocs_knowledgebasesearchdetail>` ],false,none,なし ListKnowledgeBasesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_bases": { "items": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "knowledge_bases", "pagination" ], "type": "object" } .. _プロパティ-226: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_bases,\ :ref:`[KnowledgeBaseDetail <.#tocs_knowledgebasedetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListLibrariesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "libraries": { "items": { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "libraries", "pagination" ], "type": "object" } .. _プロパティ-227: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable libraries,\ :ref:`[LibraryDetail <.#tocs_librarydetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListMessagesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "messages": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "messages", "pagination" ], "type": "object" } .. _プロパティ-228: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable messages,\ :ref:`[MessageDetail <.#tocs_messagedetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListModelsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "models": { "items": { "properties": { "default": { "type": "boolean" }, "description": { "type": "string" }, "model_name": { "type": "string" }, "model_type": { "enum": [ "chat", "embedding", "rerank", "image_generation", "unknown" ], "type": "string" } }, "required": [ "default", "model_name", "model_type" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "models", "pagination" ], "type": "object" } .. _プロパティ-229: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable models,\ :ref:`[ModelDetail <.#tocs_modeldetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListOrganizationApiKeysResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "api_keys": { "items": { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "api_keys", "pagination" ], "type": "object" } .. _プロパティ-230: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable api_keys,\ :ref:`tool_id ` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListOrganizationUsersResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "users": { "items": { "properties": { "email": { "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "email", "user_id" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "users" ], "type": "object" } .. _プロパティ-231: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし users,\ :ref:`[OrganizationUserDetail <.#tocs_organizationuserdetail>` ],true,none,なし ListOrganizationsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "organizations": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-232: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable organizations,\ :ref:`[OrganizationDetail <.#tocs_organizationdetail>` ],false,none,なし ListRetrieverComponentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "retriever_components" ], "type": "object" } .. _プロパティ-233: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,なし ListRetrieversResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "retrievers": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "retrievers" ], "type": "object" } .. _プロパティ-234: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし retrievers,\ :ref:`[RetrieverDetail <.#tocs_retrieverdetail>` ],true,none,なし ListRulesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "rules": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "rules" ], "type": "object" } .. _プロパティ-235: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし rules,\ :ref:`[RuleDetail <.#tocs_ruledetail>` ],true,none,なし ListRulesetsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "rulesets": { "items": { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "rulesets" ], "type": "object" } .. _プロパティ-236: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし rulesets,\ :ref:`tool_id ` ],true,none,なし ListSecretsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "secrets": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "secrets" ], "type": "object" } .. _プロパティ-237: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし secrets,\ :ref:`[SecretDetail <.#tocs_secretdetail>` ],true,none,なし ListSpansResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "page": { "type": "number" }, "spans": { "items": { "properties": { "attributes": {}, "end_time": { "format": "date-time", "type": "string" }, "events": { "properties": { "attributes": {}, "name": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "required": [ "attributes", "name", "timestamp" ], "type": "object" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "span_id": { "type": "string" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "enum": [ "UNSET", "OK", "ERROR" ], "type": "string" }, "trace_id": { "type": "string" } }, "required": [ "attributes", "end_time", "events", "name", "span_id", "start_time", "status", "trace_id" ], "type": "object" }, "type": "array" } }, "required": [ "spans" ], "type": "object" } .. _プロパティ-238: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable page,number,false,none,なし spans,\ :ref:`[SpanDetail <.#tocs_spandetail>` ],true,none,なし ListStructureDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "structure_id" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _プロパティ-239: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[StructureDeploymentDetail <.#tocs_structuredeploymentdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListStructureRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _プロパティ-240: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,なし ListStructureRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "structure_runs": { "items": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "structure_runs" ], "type": "object" } .. _プロパティ-241: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし structure_runs,\ :ref:`[StructureRunDetail <.#tocs_structurerundetail>` ],true,none,なし ListStructuresResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "structures": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "structures" ], "type": "object" } .. _プロパティ-242: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし structures,\ :ref:`[StructureDetail <.#tocs_structuredetail>` ],true,none,なし ListThreadsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "threads": { "items": { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "threads" ], "type": "object" } .. _プロパティ-243: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし threads,\ :ref:`[ThreadDetail <.#tocs_threaddetail>` ],true,none,なし ListToolDeploymentsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "deployments": { "items": { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "tool_id" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "deployments", "pagination" ], "type": "object" } .. _プロパティ-244: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable deployments,\ :ref:`[ToolDeploymentDetail <.#tocs_tooldeploymentdetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListToolRunLogsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "logs": { "items": { "type": "string" }, "type": "array" } }, "required": [ "logs" ], "type": "object" } .. _プロパティ-245: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable logs,[string],true,none,なし ListToolRunsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "tool_runs": { "items": { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "input", "runtime_path", "started_at", "status", "tool_id", "tool_run_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "tool_runs" ], "type": "object" } .. _プロパティ-246: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし tool_runs,\ :ref:`[ToolRunDetail <.#tocs_toolrundetail>` ],true,none,なし ListToolsResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" }, "tools": { "items": { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" }, "type": "array" } }, "required": [ "pagination", "tools" ], "type": "object" } .. _プロパティ-247: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし tools,\ :ref:`[ToolDetail <.#tocs_tooldetail>` ],true,none,なし ListUserInvitesResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "invites": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "email": { "type": "string" }, "expires_at": { "format": "date-time", "type": "string" }, "invite_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "responded_at": { "format": "date-time", "type": "string" }, "status": { "enum": [ "ACCEPTED", "EXPIRED", "PENDING", "REJECTED" ], "type": "string" } }, "required": [ "created_at", "created_by", "email", "expires_at", "invite_id", "organization_id", "status" ], "type": "object" }, "type": "array" }, "pagination": { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } }, "required": [ "invites", "pagination" ], "type": "object" } .. _プロパティ-248: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable invites,\ :ref:`[InviteDetail <.#tocs_invitedetail>` ],true,none,なし pagination,:ref:`ページネーション<ページネーション>` ,true,none,なし ListUsersResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "users": { "items": { "properties": { "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "organizations": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "created_at", "email", "organizations", "updated_at", "user_id" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-249: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable users,\ :ref:`[UserDetail <.#tocs_userdetail>` ],false,none,なし メッセージコンテンツ ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" } .. _プロパティ-250: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable artifact,:ref:`アーティファクト<アーティファクト>` ,true,none,なし type,string,true,none,なし メッセージ詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-251: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし index,number,true,none,なし input,string,true,none,なし message_id,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし output,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし メッセージ入力 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" } .. _プロパティ-252: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし output,string,true,none,なし メタ ^^^^ .. code:: json { "additionalProperties": { "type": "string" }, "type": "object" } .. _プロパティ-253: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,string,false,none,なし メタデータ ^^^^^^^^^^ .. code:: json { "additionalProperties": {}, "type": "object" } .. _プロパティ-254: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,any,false,none,なし モデルの詳細 ^^^^^^^^^^^^ .. code:: json { "properties": { "default": { "type": "boolean" }, "description": { "type": "string" }, "model_name": { "type": "string" }, "model_type": { "enum": [ "chat", "embedding", "rerank", "image_generation", "unknown" ], "type": "string" } }, "required": [ "default", "model_name", "model_type" ], "type": "object" } .. _プロパティ-255: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable default,boolean,true,none,なし description,string,false,none,なし model_name,string,true,none,なし model_type,:ref:`モデルタイプ<モデルタイプ>` ,true,none,なし ModelTokenCounts ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" } .. _プロパティ-256: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,number(float),false,none,なし output,number(float),false,none,なし ModelTokenCountsMap ^^^^^^^^^^^^^^^^^^^ .. code:: json { "additionalProperties": { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" }, "type": "object" } .. _プロパティ-257: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable **additionalProperties** ,:ref:`ModelTokenCounts` ,false,none,なし モデルタイプ ^^^^^^^^^^^^ .. code:: json { "enum": [ "chat", "embedding", "rerank", "image_generation", "unknown" ], "type": "string" } .. _プロパティ-258: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-20: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,chat *anonymous*,embedding *anonymous*,rerank *anonymous*,image_generation *anonymous*,unknown オブザーバビリティイベント ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "attributes": {}, "name": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "required": [ "attributes", "name", "timestamp" ], "type": "object" } .. _プロパティ-259: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable attributes,any,true,none,なし name,string,true,none,なし timestamp,string(date-time),true,none,なし 組織の詳細 ^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-260: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし default_bucket_id,string,true,none,なし description,string,true,none,なし entitlement,any,true,none,なし すべての .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`資格<資格>` ,false,none,なし そして .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,なし 続き .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし OrganizationModelConfig ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" } .. _プロパティ-261: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable default_chat_model,string,false,none,なし default_embedding_model,string,false,none,なし default_image_generation_model,string,false,none,なし default_rerank_model,string,false,none,なし 組織ユーザーの詳細 ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "email": { "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "email", "user_id" ], "type": "object" } .. _プロパティ-262: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable email,string,true,none,なし user_id,string,true,none,なし PGAIKnowledgeBaseKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } .. _プロパティ-263: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable knowledge_base_name,string,true,none,なし query_schema,any,true,none,なし PGAIKnowledgeBaseKnowledgeBase入力 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "type": "object" } .. _プロパティ-264: プロパティ ^^^^^^^^^^ *なし* PGVectorKnowledgeBaseDetail ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } .. _プロパティ-265: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_string,string,true,none,なし embedding_model,string,true,none,なし query_schema,any,true,none,なし use_default_embedding_model,boolean,true,none,なし PGVectorKnowledgeBaseInput ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } .. _プロパティ-266: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable connection_string,string,true,none,なし embedding_model,string,false,none,なし password,string,true,none,なし use_default_embedding_model,boolean,false,none,なし ページネーション ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "next_page": { "type": "number" }, "page_number": { "type": "number" }, "page_size": { "type": "number" }, "previous_page": { "type": "number" }, "total_count": { "type": "number" }, "total_pages": { "type": "number" } }, "required": [ "page_number", "page_size", "total_count", "total_pages" ], "type": "object" } .. _プロパティ-267: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable next_page,number,false,none,なし page_number,number,true,none,なし page_size,number,true,none,なし previous_page,number,false,none,なし total_count,number,true,none,なし total_pages,number,true,none,なし 期間 ^^^^ .. code:: json { "enum": [ "1m", "1h", "1d", "1w" ], "type": "string" } .. _プロパティ-268: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-21: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,1m *anonymous*,1h *anonymous*,1d *anonymous*,1w QueryKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "type": "object" } .. _プロパティ-269: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,false,none,なし query_args,any,false,none,なし QueryKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "entries": { "items": { "properties": { "id": { "type": "string" }, "meta": { "additionalProperties": { "type": "string" }, "type": "object" }, "namespace": { "type": "string" }, "score": { "format": "float", "type": "number" }, "vector": { "items": { "format": "float", "type": "number" }, "type": "array" } }, "required": [ "id", "score" ], "type": "object" }, "type": "array" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_query_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" } }, "required": [ "created_at", "created_by", "entries", "knowledge_base_id", "knowledge_base_query_id", "query" ], "type": "object" } .. _プロパティ-270: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし entries,\ :ref:`[Entry <.#tocs_entry>` ],true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_query_id,string,true,none,なし query,string,true,none,なし QueryRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "retriever_components_query_args": {} }, "required": [ "query" ], "type": "object" } .. _プロパティ-271: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,true,none,なし retriever_components_query_args,any,false,none,なし QueryRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "outputs": { "items": {}, "type": "array" } }, "required": [ "outputs" ], "type": "object" } .. _プロパティ-272: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable outputs,[any],true,none,なし RespondToInviteRequestコンテンツ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "response": { "enum": [ "ACCEPTED", "REJECTED" ], "type": "string" } }, "required": [ "response" ], "type": "object" } .. _プロパティ-273: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable response,:ref:`InviteResponseステータス` ,true,none,なし Retrieverコンポーネントの詳細 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-274: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_component_id,string,true,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし RetrieverComponentInput ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" } .. _プロパティ-275: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,false,none,なし description,string,false,none,なし name,string,true,none,なし type,string,true,none,なし レトリバーの詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-276: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,なし retriever_components_schema,any,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし ルールの詳細 ^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _プロパティ-277: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule,string,true,none,なし rule_id,string,true,none,なし updated_at,string(date-time),true,none,なし ルールセットの詳細 ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _プロパティ-278: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule_ids,[string],true,none,なし ruleset_id,string,true,none,なし updated_at,string(date-time),true,none,なし RunCountGauge ^^^^^^^^^^^^^ .. code:: json { "properties": { "active_count": { "type": "number" }, "total_count": { "type": "number" } }, "type": "object" } .. _プロパティ-279: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active_count,number,false,none,なし total_count,number,false,none,なし RunDurationGauge ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "activity_durations": { "items": { "properties": { "activity_type": { "type": "string" }, "seconds": { "type": "number" } }, "type": "object" }, "type": "array" }, "total_seconds": { "type": "number" } }, "type": "object" } .. _プロパティ-280: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable activity_durations,\ :ref:`[ActivityDuration <.#tocs_activityduration>` ],false,none,なし total_seconds,number,false,none,なし S3コネクタの詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } .. _プロパティ-281: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable aws_access_key_id,string,true,none,なし uris,[string],true,none,なし S3ConnectorInput ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } .. _プロパティ-282: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable aws_access_key_id,string,true,none,なし aws_secret_access_key,string,true,none,なし uris,[string],true,none,なし SearchKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "query": { "type": "string" }, "query_args": {} }, "required": [ "query" ], "type": "object" } .. _プロパティ-283: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable query,string,true,none,なし query_args,any,false,none,なし SearchKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "knowledge_base_search_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "query": { "type": "string" }, "result": { "type": "string" } }, "required": [ "created_at", "created_by", "knowledge_base_id", "knowledge_base_search_id", "query", "result" ], "type": "object" } .. _プロパティ-284: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし knowledge_base_id,string,true,none,なし knowledge_base_search_id,string,true,none,なし query,string,true,none,なし result,string,true,none,なし SecretDetail ^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _プロパティ-285: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし secret_id,string,true,none,なし updated_at,string(date-time),true,none,なし ServiceErrorResponseコンテンツ ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "errors": { "items": {}, "type": "array" }, "type": { "type": "string" } }, "required": [ "type" ], "type": "object" } .. _プロパティ-286: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable errors,[any],false,none,なし type,string,true,none,なし Slackの詳細 ^^^^^^^^^^^ .. code:: json { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } .. _プロパティ-287: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_description,string,true,none,なし app_display_name,string,true,none,なし app_manifest,any,true,none,なし app_name,string,true,none,なし bot_token_secret_ref,string,true,none,なし signing_secret_secret_ref,string,true,none,なし SlackInput ^^^^^^^^^^ .. code:: json { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } .. _プロパティ-288: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable app_description,string,true,none,なし app_display_name,string,true,none,なし app_name,string,true,none,なし bot_token_secret_ref,string,false,none,なし signing_secret_secret_ref,string,false,none,なし SpanDetail ^^^^^^^^^^ .. code:: json { "properties": { "attributes": {}, "end_time": { "format": "date-time", "type": "string" }, "events": { "properties": { "attributes": {}, "name": { "type": "string" }, "timestamp": { "format": "date-time", "type": "string" } }, "required": [ "attributes", "name", "timestamp" ], "type": "object" }, "name": { "type": "string" }, "parent_id": { "type": "string" }, "span_id": { "type": "string" }, "start_time": { "format": "date-time", "type": "string" }, "status": { "enum": [ "UNSET", "OK", "ERROR" ], "type": "string" }, "trace_id": { "type": "string" } }, "required": [ "attributes", "end_time", "events", "name", "span_id", "start_time", "status", "trace_id" ], "type": "object" } .. _プロパティ-289: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable attributes,any,true,none,なし end_time,string(date-time),true,none,なし events,:ref:`オブザーバビリティイベント<オブザーバビリティイベント>` ,true,none,なし name,string,true,none,なし parent_id,string,false,none,なし span_id,string,true,none,なし start_time,string(date-time),true,none,なし status,:ref:`スパンステータス<スパンステータス>` ,true,none,なし trace_id,string,true,none,なし スパンステータス ^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "UNSET", "OK", "ERROR" ], "type": "string" } .. _プロパティ-290: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-22: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,UNSET *anonymous*,OK *anonymous*,ERROR StreamMessageContent ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "artifact": { "properties": { "id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "meta": {}, "name": { "type": "string" }, "reference": { "type": "string" }, "type": { "type": "string" }, "value": { "type": "string" } }, "required": [ "id", "name", "type", "value" ], "type": "object" }, "type": { "type": "string" } }, "required": [ "artifact", "type" ], "type": "object" } .. _プロパティ-291: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable artifact,:ref:`アーティファクト<アーティファクト>` ,true,none,なし type,string,true,none,なし 構造コード ^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] } .. _プロパティ-292: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github,:ref:`GithubStructureCode` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeStructureCode` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » default,:ref:`DefaultStructureCode` ,true,none,なし StructureConnectorDetail ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } .. _プロパティ-293: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],false,none,なし structure_id,string,true,none,なし StructureConnectorInput ^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } .. _プロパティ-294: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],false,none,なし structure_id,string,true,none,なし 構造展開詳細 ^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "structure_id" ], "type": "object" } .. _プロパティ-295: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし 構造の詳細 ^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-296: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし StructureRunDetail ^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "args", "completed_at", "created_at", "created_by", "started_at", "status", "structure_id", "structure_run_id", "updated_at" ], "type": "object" } .. _プロパティ-297: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable args,[string],true,none,なし completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`StructureRunStatus` ,true,none,なし status_detail,any,false,none,なし structure_id,string,true,none,なし structure_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし StructureRunStatus ^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _プロパティ-298: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-23: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED StructuredColumnDetail ^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" } .. _プロパティ-299: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,なし sql_type,string,true,none,なし StructuredColumnInput ^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" } .. _プロパティ-300: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,なし description,string,true,none,なし sql_type,string,true,none,なし ThreadDetail ^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-301: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし TokenCountGauge ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "by_model": { "additionalProperties": { "properties": { "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" }, "type": "object" }, "input": { "format": "float", "type": "number" }, "output": { "format": "float", "type": "number" } }, "type": "object" } .. _プロパティ-302: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable by_model,:ref:`ModelTokenCountsMap` ,false,none,なし input,number(float),false,none,なし output,number(float),false,none,なし ツールコード ^^^^^^^^^^^^ .. code:: json { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] } .. _プロパティ-303: プロパティ ^^^^^^^^^^ oneOf .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » github,:ref:`GithubToolCode` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » data_lake,:ref:`DataLakeToolCode` ,true,none,なし xor .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,object,false,none,なし » default,:ref:`DefaultToolCode` ,true,none,なし ツール展開の詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code_source": { "oneOf": [ { "properties": { "github": { "properties": { "commit_sha": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "status": { "enum": [ "QUEUED", "DEPLOYING", "SUCCEEDED", "FAILED", "ERROR" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "code_source", "created_at", "created_by", "deployment_id", "status", "tool_id" ], "type": "object" } .. _プロパティ-304: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code_source,:ref:`コードソース<コードソース>` ,true,none,なし completed_at,string(date-time)¦null,false,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,true,none,なし status,:ref:`DeploymentStatus` ,true,none,なし status_detail,any,false,none,なし tool_id,string,true,none,なし ツールの詳細 ^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _プロパティ-305: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし tool_config_file,string,false,none,なし tool_id,string,true,none,なし updated_at,string(date-time),true,none,なし ToolRunDetail ^^^^^^^^^^^^^ .. code:: json { "properties": { "completed_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "input": {}, "output": {}, "output_timestamp": { "format": "double", "type": "number" }, "runtime_path": { "type": "string" }, "started_at": { "default": null, "format": "date-time", "type": "string", "nullable": true }, "status": { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" }, "status_detail": {}, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_run_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "completed_at", "created_at", "created_by", "input", "runtime_path", "started_at", "status", "tool_id", "tool_run_id", "updated_at" ], "type": "object" } .. _プロパティ-306: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable completed_at,string(date-time)¦null,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし deployment_id,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし input,any,true,none,なし output,any,false,none,なし output_timestamp,number(double),false,none,なし runtime_path,string,true,none,なし started_at,string(date-time)¦null,true,none,なし status,:ref:`ツール実行ステータス<ツール実行ステータス>` ,true,none,なし status_detail,any,false,none,なし tool_id,string,true,none,なし tool_run_id,string,true,none,なし updated_at,string(date-time),true,none,なし ツール実行ステータス ^^^^^^^^^^^^^^^^^^^^ .. code:: json { "enum": [ "QUEUED", "STARTING", "RUNNING", "SUCCEEDED", "FAILED", "ERROR", "CANCELLED" ], "type": "string" } .. _プロパティ-307: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable *anonymous*,string,false,none,なし .. _列挙値-24: 列挙値 '''''' .. csv-table:: :header: Property,Value :widths: 10,30 :align: left :class: longtable *anonymous*,QUEUED *anonymous*,STARTING *anonymous*,RUNNING *anonymous*,SUCCEEDED *anonymous*,FAILED *anonymous*,ERROR *anonymous*,CANCELLED TransformDetail ^^^^^^^^^^^^^^^ .. code:: json { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" } .. _プロパティ-308: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable structure,:ref:`StructureConnectorDetail` ,false,none,なし TransformInput ^^^^^^^^^^^^^^ .. code:: json { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "type": "object" } .. _プロパティ-309: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable structure,:ref:`StructureConnectorInput` ,true,none,なし 非構造化列の詳細 ^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" } .. _プロパティ-310: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,なし 非構造化列入力 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" } .. _プロパティ-311: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable column_name,string,true,none,なし description,string,true,none,なし UpdateApiKeyRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-312: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,なし UpdateApiKeyResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "active": { "type": "boolean" }, "api_key_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "active", "api_key_id", "created_at", "created_by", "last_used", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-313: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable active,boolean,true,none,なし api_key_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateAssistantRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _プロパティ-314: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,なし input,string,false,none,なし knowledge_base_ids,[string],false,none,なし name,string,false,none,なし ruleset_ids,[string],false,none,なし structure_ids,[string],false,none,なし tool_ids,[string],false,none,なし UpdateAssistantResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "input": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "tool_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "description", "knowledge_base_ids", "name", "organization_id", "retriever_ids", "ruleset_ids", "structure_ids", "tool_ids", "updated_at" ], "type": "object" } .. _プロパティ-315: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし input,string,false,none,なし knowledge_base_ids,[string],true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_ids,[string],true,none,なし ruleset_ids,[string],true,none,なし structure_ids,[string],true,none,なし tool_ids,[string],true,none,なし updated_at,string(date-time),true,none,なし UpdateBucketRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 256, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-316: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,なし UpdateBucketResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "bucket_id", "created_at", "created_by", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-317: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable bucket_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateDataConnectorRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_api_token": { "type": "string" }, "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_api_token", "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "auth_code": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "auth_code", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "aws_secret_access_key": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "aws_secret_access_key", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-318: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigInputUnion` ,false,none,なし description,string,false,none,なし name,string,false,none,なし schedule_expression,string,false,none,なし UpdateDataConnectorResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": { "oneOf": [ { "properties": { "confluence": { "properties": { "atlassian_email": { "type": "string" }, "domain": { "type": "string" } }, "required": [ "atlassian_email", "domain" ], "type": "object" } }, "required": [ "confluence" ], "title": "confluence", "type": "object" }, { "properties": { "google_drive": { "properties": { "access_token": { "type": "string" }, "file_ids": { "items": { "type": "string" }, "type": "array" } }, "required": [ "access_token", "file_ids" ], "type": "object" } }, "required": [ "google_drive" ], "title": "google_drive", "type": "object" }, { "properties": { "webscraper": { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } }, "required": [ "webscraper" ], "title": "webscraper", "type": "object" }, { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "required": [ "structure" ], "title": "structure", "type": "object" }, { "properties": { "s3": { "properties": { "aws_access_key_id": { "type": "string" }, "uris": { "items": { "type": "string" }, "type": "array" } }, "required": [ "aws_access_key_id", "uris" ], "type": "object" } }, "required": [ "s3" ], "title": "s3", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "bucket_id": { "type": "string" } }, "required": [ "asset_paths", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "data_job_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "data_connector_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-319: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,:ref:`DataConnectorConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_id,string,true,none,なし data_job_id,string,false,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateFunctionRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-320: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし function_config_file,string,false,none,なし name,string,false,none,なし UpdateFunctionResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "function_config_file": { "type": "string" }, "function_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "function_id", "latest_deployment_id", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-321: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeファンクションコード` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし function_config_file,string,false,none,なし function_id,string,true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateIntegrationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_name" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" } }, "type": "object" } .. _プロパティ-322: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],false,none,なし config,:ref:`IntegrationConfigInputUnion` ,false,none,なし description,string,false,none,なし name,string,false,none,なし structure_ids,[string],false,none,なし type,:ref:`統合タイプ<統合タイプ>` ,false,none,なし UpdateIntegrationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "slack": { "properties": { "app_description": { "type": "string" }, "app_display_name": { "type": "string" }, "app_manifest": {}, "app_name": { "type": "string" }, "bot_token_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "signing_secret_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_description", "app_display_name", "app_manifest", "app_name", "bot_token_secret_ref", "signing_secret_secret_ref" ], "type": "object" } }, "required": [ "slack" ], "title": "slack", "type": "object" }, { "properties": { "github_app": { "properties": { "app_id": { "type": "string" }, "integration_endpoint": { "type": "string" }, "private_key_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "webhook_secret_ref": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "app_id", "integration_endpoint", "private_key_secret_ref", "webhook_secret_ref" ], "type": "object" } }, "required": [ "github_app" ], "title": "github_app", "type": "object" }, { "properties": { "webhook": { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } }, "required": [ "webhook" ], "title": "webhook", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "integration_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "type": { "enum": [ "slack", "github_app", "webhook" ], "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_ids", "config", "created_at", "created_by", "description", "integration_id", "name", "organization_id", "structure_ids", "type", "updated_at" ], "type": "object" } .. _プロパティ-323: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_ids,[string],true,none,なし config,:ref:`IntegrationConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし integration_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_ids,[string],true,none,なし type,:ref:`統合タイプ<統合タイプ>` ,true,none,なし updated_at,string(date-time),true,none,なし UpdateKnowledgeBaseRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "config", "type" ], "type": "object" } .. _プロパティ-324: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],false,none,なし config,:ref:`KnowledgeBaseConfigInputUnion` ,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし name,string,false,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし use_default_embedding_model,boolean,false,none,なし UpdateKnowledgeBaseResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "asset_paths": { "items": { "type": "string" }, "type": "array" }, "config": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "query_schema": {}, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" } }, "required": [ "column_name" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "embedding_model", "query_schema", "structured_columns", "unstructured_columns", "use_default_embedding_model" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "properties": { "knowledge_base_name": { "type": "string" }, "query_schema": {} }, "required": [ "knowledge_base_name", "query_schema" ], "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "embedding_model": { "enum": [ "text-embedding-ada-002", "text-embedding-3-small" ], "type": "string" }, "knowledge_base_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "schedule_expression": { "maxLength": 200, "minLength": 1, "type": "string" }, "transforms": { "items": { "properties": { "structure": { "properties": { "args": { "items": { "type": "string" }, "type": "array" }, "structure_id": { "type": "string" } }, "required": [ "structure_id" ], "type": "object" } }, "type": "object" }, "type": "array" }, "type": { "maxLength": 200, "minLength": 1, "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "asset_paths", "config", "created_at", "created_by", "knowledge_base_id", "name", "organization_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-325: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable asset_paths,[string],true,none,なし config,:ref:`KnowledgeBaseConfigUnion` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし embedding_model,:ref:`EmbeddingModel` ,false,none,なし knowledge_base_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし schedule_expression,string,false,none,なし transforms,\ :ref:`[TransformDetail <.#tocs_transformdetail>` ],false,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし use_default_embedding_model,boolean,false,none,なし UpdateLibraryRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "knowledge_base_configs": { "items": { "oneOf": [ { "properties": { "pg_vector": { "properties": { "connection_string": { "type": "string" }, "embedding_model": { "type": "string" }, "password": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "connection_string", "password" ], "type": "object" } }, "required": [ "pg_vector" ], "title": "pg_vector", "type": "object" }, { "properties": { "gtc_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "use_default_embedding_model": { "type": "boolean" } }, "type": "object" } }, "required": [ "gtc_pg_vector" ], "title": "gtc_pg_vector", "type": "object" }, { "properties": { "gtc_hybrid_sql_pg_vector": { "properties": { "embedding_model": { "type": "string" }, "structured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" }, "sql_type": { "type": "string" } }, "required": [ "column_name", "description", "sql_type" ], "type": "object" }, "type": "array" }, "unstructured_columns": { "items": { "properties": { "column_name": { "type": "string" }, "description": { "type": "string" } }, "required": [ "column_name", "description" ], "type": "object" }, "type": "array" }, "use_default_embedding_model": { "type": "boolean" } }, "required": [ "structured_columns", "unstructured_columns" ], "type": "object" } }, "required": [ "gtc_hybrid_sql_pg_vector" ], "title": "gtc_hybrid_sql_pg_vector", "type": "object" }, { "properties": { "pgai_knowledge_base": { "type": "object" } }, "required": [ "pgai_knowledge_base" ], "title": "pgai_knowledge_base", "type": "object" } ] }, "type": "array" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" } }, "required": [ "data_connector_ids", "knowledge_base_configs", "name" ], "type": "object" } .. _プロパティ-326: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_configs,\ :ref:`[KnowledgeBaseConfigInputUnion <.#tocs_knowledgebaseconfiginputunion>` ],true,none,なし name,string,true,none,なし UpdateLibraryResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "assistant_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "data_connector_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "description": { "type": "string" }, "knowledge_base_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "library_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "assistant_id", "created_at", "created_by", "data_connector_ids", "knowledge_base_ids", "library_id", "name", "organization_id", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-327: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable assistant_id,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし data_connector_ids,[string],true,none,なし description,string,false,none,なし knowledge_base_ids,[string],true,none,なし library_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateMessageRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "type": "object" } .. _プロパティ-328: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable input,string,false,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし output,string,false,none,なし UpdateMessageResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "index": { "type": "number" }, "input": { "type": "string" }, "message_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "index", "input", "message_id", "metadata", "output", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-329: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし index,number,true,none,なし input,string,true,none,なし message_id,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし output,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateOrganizationRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-330: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,なし name,string,false,none,なし UpdateOrganizationResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "default_bucket_id": { "type": "string" }, "description": { "maxLength": 2000, "type": "string" }, "entitlement": { "allOf": [ { "enum": [ "FREE", "PAID", "PARTNER", "UNPAID", "EXPIRED" ], "type": "string" }, { "default": "FREE" } ] }, "model_config": { "properties": { "default_chat_model": { "type": "string" }, "default_embedding_model": { "type": "string" }, "default_image_generation_model": { "type": "string" }, "default_rerank_model": { "type": "string" } }, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "default_bucket_id", "description", "entitlement", "name", "organization_id", "updated_at" ], "type": "object" } .. _プロパティ-331: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし default_bucket_id,string,true,none,なし description,string,true,none,なし entitlement,any,true,none,なし すべての .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,:ref:`資格<資格>` ,false,none,なし そして .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable » *anonymous*,any,false,none,なし 続き .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable model_config,:ref:`OrganizationModelConfig` ,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateRetrieverComponentRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "config", "type" ], "type": "object" } .. _プロパティ-332: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし description,string,false,none,なし name,string,false,none,なし type,string,true,none,なし UpdateRetrieverComponentResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" } .. _プロパティ-333: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable config,any,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_component_id,string,true,none,なし type,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateRetrieverRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "retriever_component_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "retriever_components": { "items": { "properties": { "config": {}, "description": { "maxLength": 256, "minLength": 1, "type": "string" }, "name": { "maxLength": 64, "minLength": 1, "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "type" ], "type": "object" }, "type": "array" } }, "type": "object" } .. _プロパティ-334: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable description,string,false,none,なし name,string,false,none,なし retriever_component_ids,[string],false,none,なし retriever_components,\ :ref:`[RetrieverComponentInput <.#tocs_retrievercomponentinput>` ],false,none,なし UpdateRetrieverResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_components": { "items": { "properties": { "config": {}, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "retriever_component_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": { "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "config", "created_at", "created_by", "name", "organization_id", "retriever_component_id", "type", "updated_at" ], "type": "object" }, "type": "array" }, "retriever_components_schema": {}, "retriever_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "name", "organization_id", "retriever_components", "retriever_components_schema", "retriever_id", "updated_at" ], "type": "object" } .. _プロパティ-335: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,false,none,なし name,string,true,none,なし organization_id,string,true,none,なし retriever_components,\ :ref:`[RetrieverComponentDetail <.#tocs_retrievercomponentdetail>` ],true,none,なし retriever_components_schema,any,true,none,なし retriever_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateRuleRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule": { "maxLength": 2000, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-336: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,false,none,なし rule,string,false,none,なし UpdateRuleResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule": { "type": "string" }, "rule_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "created_by", "metadata", "name", "organization_id", "rule", "rule_id", "updated_at" ], "type": "object" } .. _プロパティ-337: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule,string,true,none,なし rule_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateRulesetRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" } }, "type": "object" } .. _プロパティ-338: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,なし description,string,false,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,false,none,なし rule_ids,[string],false,none,なし UpdateRulesetResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "rule_ids": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "ruleset_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "description", "metadata", "name", "organization_id", "rule_ids", "ruleset_id", "updated_at" ], "type": "object" } .. _プロパティ-339: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし rule_ids,[string],true,none,なし ruleset_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateSecretRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "value": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-340: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable name,string,false,none,なし value,string,false,none,なし UpdateSecretResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "last_used": { "format": "date-time", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "secret_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "created_at", "last_used", "name", "organization_id", "secret_id", "updated_at" ], "type": "object" } .. _プロパティ-341: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし last_used,string(date-time),true,none,なし name,string,true,none,なし organization_id,string,true,none,なし secret_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateStructureRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "structure_config_file": { "maxLength": 200, "minLength": 1, "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "type": "object" } .. _プロパティ-342: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし name,string,false,none,なし structure_config_file,string,false,none,なし webhook_enabled,boolean,false,none,なし UpdateStructureResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "structure_config_file": { "type": "string" }, "structure_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" }, "webhook_enabled": { "type": "boolean" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "structure_id", "updated_at", "webhook_enabled" ], "type": "object" } .. _プロパティ-343: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeStructureCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし structure_config_file,string,false,none,なし structure_id,string,true,none,なし updated_at,string(date-time),true,none,なし webhook_enabled,boolean,true,none,なし UpdateThreadRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "maxLength": 200, "minLength": 1, "type": "string" }, "messages": { "items": { "properties": { "input": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "output": { "type": "string" } }, "required": [ "input", "output" ], "type": "object" }, "type": "array" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-344: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,false,none,なし messages,\ :ref:`[MessageInput <.#tocs_messageinput>` ],false,none,なし metadata,:ref:`メタデータ<メタデータ>` ,false,none,なし name,string,false,none,なし UpdateThreadResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "alias": { "type": "string" }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "metadata": { "additionalProperties": {}, "type": "object" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "thread_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "alias", "created_at", "created_by", "metadata", "name", "organization_id", "thread_id", "updated_at" ], "type": "object" } .. _プロパティ-345: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable alias,string,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし metadata,:ref:`メタデータ<メタデータ>` ,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし thread_id,string,true,none,なし updated_at,string(date-time),true,none,なし UpdateToolRequestContent ^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "description": { "maxLength": 200, "minLength": 1, "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "tool_config_file": { "maxLength": 200, "minLength": 1, "type": "string" } }, "type": "object" } .. _プロパティ-346: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,false,none,なし description,string,false,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],false,none,なし name,string,false,none,なし tool_config_file,string,false,none,なし UpdateToolResponseContent ^^^^^^^^^^^^^^^^^^^^^^^^^ .. code:: json { "properties": { "code": { "oneOf": [ { "properties": { "github": { "properties": { "name": { "maxLength": 200, "minLength": 1, "type": "string" }, "owner": { "maxLength": 200, "minLength": 1, "type": "string" }, "push": { "properties": { "branch": { "maxLength": 200, "minLength": 1, "type": "string" }, "tag": { "maxLength": 200, "minLength": 1, "type": "string" } }, "required": [ "branch" ], "type": "object" } }, "required": [ "name", "owner", "push" ], "type": "object" } }, "required": [ "github" ], "title": "github", "type": "object" }, { "properties": { "data_lake": { "properties": { "asset_path": { "type": "string" }, "bucket_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "asset_path", "bucket_id" ], "type": "object" } }, "required": [ "data_lake" ], "title": "data_lake", "type": "object" }, { "properties": { "default": { "type": "object" } }, "required": [ "default" ], "title": "default", "type": "object" } ] }, "created_at": { "format": "date-time", "type": "string" }, "created_by": { "type": "string" }, "description": { "type": "string" }, "env_vars": { "items": { "properties": { "name": { "type": "string" }, "source": { "enum": [ "secret_ref", "manual" ], "type": "string" }, "value": { "type": "string" } }, "required": [ "name", "value" ], "type": "object" }, "type": "array" }, "latest_deployment_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "name": { "type": "string" }, "organization_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "tool_config_file": { "type": "string" }, "tool_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "updated_at": { "format": "date-time", "type": "string" } }, "required": [ "code", "created_at", "created_by", "description", "env_vars", "latest_deployment_id", "name", "organization_id", "tool_id", "updated_at" ], "type": "object" } .. _プロパティ-347: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable code,:ref:`DataLakeToolCode` ,true,none,なし created_at,string(date-time),true,none,なし created_by,string,true,none,なし description,string,true,none,なし env_vars,\ :ref:`[EnvVar <.#tocs_envvar>` ],true,none,なし latest_deployment_id,string,true,none,なし name,string,true,none,なし organization_id,string,true,none,なし tool_config_file,string,false,none,なし tool_id,string,true,none,なし updated_at,string(date-time),true,none,なし ユーザーの詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "created_at": { "format": "date-time", "type": "string" }, "email": { "type": "string" }, "name": { "type": "string" }, "organizations": { "items": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" }, "type": "array" }, "updated_at": { "format": "date-time", "type": "string" }, "user_id": { "pattern": "^[0-9(a-f|A-F)]{8}-[0-9(a-f|A-F)]{4}-4[0-9(a-f|A-F)]{3}-[89ab][0-9(a-f|A-F)]{3}-[0-9(a-f|A-F)]{12}$", "type": "string" } }, "required": [ "created_at", "email", "organizations", "updated_at", "user_id" ], "type": "object" } .. _プロパティ-348: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable created_at,string(date-time),true,none,なし email,string,true,none,なし name,string,false,none,なし organizations,[string],true,none,なし updated_at,string(date-time),true,none,なし user_id,string,true,none,なし Webhook詳細 ^^^^^^^^^^^ .. code:: json { "properties": { "disable_api_key_param": { "type": "boolean" }, "integration_endpoint": { "type": "string" } }, "required": [ "disable_api_key_param", "integration_endpoint" ], "type": "object" } .. _プロパティ-349: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable disable_api_key_param,boolean,true,none,なし integration_endpoint,string,true,none,なし Webhook入力 ^^^^^^^^^^^ .. code:: json { "properties": { "disable_api_key_param": { "type": "boolean" } }, "type": "object" } .. _プロパティ-350: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable disable_api_key_param,boolean,false,none,なし Webscraper詳細 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } .. _プロパティ-351: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable urls,[string],true,none,なし Webscraper入力 ^^^^^^^^^^^^^^ .. code:: json { "properties": { "urls": { "items": { "type": "string" }, "type": "array" } }, "required": [ "urls" ], "type": "object" } .. _プロパティ-352: プロパティ ^^^^^^^^^^ .. csv-table:: :header: Name,Type,Required,Restrictions,Description :widths: auto :align: left :class: longtable urls,[string],true,none,なし