API

認証

• HTTP認証、スキーム Bearer HTTP Bearer認証

デフォルト

ListUsers

GET /users

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListUsers 200レスポンス	ListUsersResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ApiKeys

DeleteApiKey

DELETE /api-keys/{api_key_id}

パラメーター

Name	In	Type	Required	Description
api_key_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteApiKey 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetApiKey

GET /api-keys/{api_key_id}

パラメーター

Name	In	Type	Required	Description
api_key_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetApiKey 200レスポンス	GetApiKeyResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateApiKey

PATCH /api-keys/{api_key_id}

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
api_key_id	path	string	true	なし
body	body	UpdateApiKeyRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateApiKey 200レスポンス	UpdateApiKeyResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListOrganizationApiKeys

GET /organizations/{organization_id}/api-keys

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListOrganizationApiKeys 200レスポンス	ListOrganizationApiKeysResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateOrganizationApiKey

POST /organizations/{organization_id}/api-keys

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
body	body	CreateOrganizationApiKeyRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateOrganizationApiKey 201レスポンス	CreateOrganizationApiKeyResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListApiKeys

GET /users/{user_id}/api-keys

パラメーター

Name	In	Type	Required	Description
user_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListApiKeys 200レスポンス	ListApiKeysResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateApiKey

POST /users/{user_id}/api-keys

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
user_id	path	string	true	なし
body	body	CreateApiKeyRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateApiKey 201レスポンス	CreateApiKeyResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

AssistantRuns

GetAssistantRun

GET /assistant-runs/{assistant_run_id}

パラメーター

Name	In	Type	Required	Description
assistant_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetAssistantRun 200レスポンス	GetAssistantRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CancelAssistantRun

POST /assistant-runs/{assistant_run_id}/cancel

パラメーター

Name	In	Type	Required	Description
assistant_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	CancelAssistantRun 200レスポンス	CancelAssistantRunResponseコンテンツ
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListAssistantRuns

GET /assistants/{assistant_id}/runs

パラメーター

Name	In	Type	Required	Description
assistant_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングする実行ステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListAssistantRuns 200レスポンス	ListAssistantRunsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateAssistantRun

POST /assistants/{assistant_id}/runs

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
assistant_id	path	string	true	なし
body	body	CreateAssistantRunRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAssistantRun 201レスポンス	CreateAssistantRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

イベント

ListAssistantEvents

GET /assistant-runs/{assistant_run_id}/events

パラメーター

Name	In	Type	Required	Description
assistant_run_id	path	string	true	なし
limit	query	string	false	なし
offset	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListAssistantEvents 200応答	ListAssistantEventsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetAssistantRunEventsSSE

GET /assistant-runs/{assistant_run_id}/events/stream

パラメーター

Name	In	Type	Required	Description
assistant_run_id	path	string	true	なし

応答例

400 レスポンス

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetAssistantRunEventsSSE 200レスポンス	GetAssistantRunEventsSSEOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetEvent

GET /events/{event_id}

パラメーター

Name	In	Type	Required	Description
event_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetEvent 200レスポンス	GetEventResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListEvents

GET /structure-runs/{structure_run_id}/events

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし
limit	query	string	false	なし
offset	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListEvents 200レスポンス	ListEventsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateEvents

POST /structure-runs/{structure_run_id}/events

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし
body	body	CreateEventsRequestContent	false	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateEvents 202レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetStructureRunEventsSSE

GET /structure-runs/{structure_run_id}/events/stream

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし

応答例

400 レスポンス

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetStructureRunEventsSSE 200レスポンス	GetStructureRunEventsSSEOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アシスタント

リストアシスタント

GET /assistants

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListAssistants 200の応答	ListAssistantsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateAssistant

POST /assistants

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateAssistantRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAssistant 201応答	CreateAssistantResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteAssistant

DELETE /assistants/{assistant_id}

パラメーター

Name	In	Type	Required	Description
assistant_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteAssistant 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetAssistant

GET /assistants/{assistant_id}

パラメーター

Name	In	Type	Required	Description
assistant_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetAssistant 200レスポンス	GetAssistantResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アップデートアシスタント

PATCH /assistants/{assistant_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
assistant_id	path	string	true	なし
body	body	UpdateAssistantRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateAssistant 200の応答	UpdateAssistantResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

Billing

CreateCheckoutSession

POST /billing/checkout-session

ボディパラメーター

{
  "properties": {
    "price_lookup_key": {
      "type": "string"
    }
  },
  "required": [
    "price_lookup_key"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateCheckoutSessionRequestContent	true	なし

応答例

{
  "properties": {
    "redirect_url": {
      "type": "string"
    }
  },
  "required": [
    "redirect_url"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateCheckoutSession 201レスポンス	CreateCheckoutSessionResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateBillingManagementUrl

POST /billing/management-url

応答例

{
  "properties": {
    "billing_management_url": {
      "type": "string"
    }
  },
  "required": [
    "billing_management_url"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateBillingManagementUrl 201レスポンス	CreateBillingManagementUrlResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

バケット

リストバケット

GET /buckets

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListBuckets 200レスポンス	ListBucketsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateBucket

POST /buckets

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateBucketRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateBucket 201レスポンス	CreateBucketResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteBucket

DELETE /buckets/{bucket_id}

パラメーター

Name	In	Type	Required	Description
bucket_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteBucket 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetBucket

GET /buckets/{bucket_id}

パラメーター

Name	In	Type	Required	Description
bucket_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetBucket 200レスポンス	GetBucketResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateBucket

PATCH /buckets/{bucket_id}

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
bucket_id	path	string	true	なし
body	body	UpdateBucketRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateBucket 200レスポンス	UpdateBucketResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アセット

CreateAssetUrl

POST /buckets/{bucket_id}/asset-urls/{name}

ボディパラメーター

{
  "properties": {
    "operation": {
      "enum": [
        "PUT",
        "GET"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
name	path	string	true	なし
bucket_id	path	string	true	なし
body	body	CreateAssetUrlRequestContent	false	なし

応答例

{
  "properties": {
    "headers": {
      "additionalProperties": {},
      "type": "object"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "headers",
    "url"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	CreateAssetUrl 200レスポンス	CreateAssetUrlResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListAssets

GET /buckets/{bucket_id}/assets

パラメーター

Name	In	Type	Required	Description
bucket_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
prefix	query	string	false	なし
postfix	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListAssets 200レスポンス	ListAssetsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateAsset

PUT /buckets/{bucket_id}/assets

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
bucket_id	path	string	true	なし
body	body	CreateAssetRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateAsset 201レスポンス	CreateAssetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アセットの削除

DELETE /buckets/{bucket_id}/assets/{name}

パラメーター

Name	In	Type	Required	Description
name	path	string	true	なし
bucket_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteAsset 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetAsset

GET /buckets/{bucket_id}/assets/{name}

パラメーター

Name	In	Type	Required	Description
name	path	string	true	なし
bucket_id	path	string	true	なし
include_contents	query	boolean	false	アセットのコンテンツを含めるにはtrue/false。

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetAsset 200レスポンス	GetAssetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

チャットメッセージ

CreateChatMessage

POST /chat/messages

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateChatMessageRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateChatMessage 201応答	CreateChatMessageResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateChatMessageStream

POST /chat/messages/stream

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateChatMessageStreamRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateChatMessageStream 201応答	CreateChatMessageStreamResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

構成

GetConfig

GET /config

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetConfig 200レスポンス	GetConfigResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

接続

ListConnections

GET /connections

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし
type	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListConnections 200応答	ListConnectionsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateConnection

POST /connections

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateConnectionRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateConnection 201応答	CreateConnectionResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteConnection

DELETE /connections/{connection_id}

パラメーター

Name	In	Type	Required	Description
connection_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteConnection 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetToken

GET /connections/{connection_id}/access-token

パラメーター

Name	In	Type	Required	Description
connection_id	path	string	true	なし

応答例

{
  "properties": {
    "access_token": {
      "type": "string"
    }
  },
  "required": [
    "access_token"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetToken 200レスポンス	GetTokenResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

構造体

GetStructuresダッシュボード

GET /dashboards/structures

パラメーター

Name	In	Type	Required	Description
start_time	query	string(date-time)	false	なし
end_time	query	string(date-time)	false	なし
period	query	期間	false	なし
structure_ids	query	string	false	なし

列挙値

Parameter	Value
period	1m
period	1h
period	1d
period	1w

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetStructuresDashboard 200レスポンス	GetStructuresDashboardResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

リスト構造

GET /structures

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListStructures 200レスポンス	ListStructuresResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateStructure

POST /structures

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateStructureRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateStructure 201レスポンス	CreateStructureResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteStructure

DELETE /structures/{structure_id}

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteStructure 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetStructure

GET /structures/{structure_id}

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetStructure 200レスポンス	GetStructureResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ストラクチャの更新

PATCH /structures/{structure_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
body	body	UpdateStructureRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateStructure 200レスポンス	UpdateStructureResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

InvokeStructureWebhookGet

GET /structures/{structure_id}/webhook

ストラクチャーのWebhookを呼び出します。 webhook_enabled フラグをtrue に設定する必要があります。

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
api_key	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	InvokeStructureWebhookGet 200レスポンス	InvokeStructureWebhookGetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

InvokeStructureWebhookPost

POST /structures/{structure_id}/webhook

構造体のWebhookを呼び出し、最初の構造体引数としてPOST本文を送信します。 webhook_enabled フラグをtrue に設定する必要があります。

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
api_key	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	InvokeStructureWebhookPost200レスポンス	InvokeStructureWebhookPostResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

データコネクター

ListDataConnectors

GET /data-connectors

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListDataConnectors 200応答	ListDataConnectorsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateDataConnector

POST /data-connectors

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateDataConnectorRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateDataConnector 201レスポンス	CreateDataConnectorResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteDataConnector

DELETE /data-connectors/{data_connector_id}

パラメーター

Name	In	Type	Required	Description
data_connector_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteDataConnector 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetDataConnector

GET /data-connectors/{data_connector_id}

パラメーター

Name	In	Type	Required	Description
data_connector_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetDataConnector 200レスポンス	GetDataConnectorResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateDataConnector

PATCH /data-connectors/{data_connector_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
data_connector_id	path	string	true	なし
body	body	UpdateDataConnectorRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateDataConnector 200応答	UpdateDataConnectorResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

データジョブ

ListDataJobs

GET /data-connectors/{data_connector_id}/data-jobs

パラメーター

Name	In	Type	Required	Description
data_connector_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングするステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	RUNNING
status	SUCCEEDED
status	FAILED
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListDataJobs 200レスポンス	ListDataJobsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateDataJob

POST /data-connectors/{data_connector_id}/data-jobs

パラメーター

Name	In	Type	Required	Description
data_connector_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateDataJob 202レスポンス	CreateDataJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetDataJob

GET /data-jobs/{data_job_id}

パラメーター

Name	In	Type	Required	Description
data_job_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetDataJob 200レスポンス	GetDataJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CancelDataJob

POST /data-jobs/{data_job_id}/cancel

パラメーター

Name	In	Type	Required	Description
data_job_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	CancelDataJob 200レスポンス	CancelDataJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

展開

GetDeployment

GET /deployments/{deployment_id}

パラメーター

Name	In	Type	Required	Description
deployment_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetDeployment 200レスポンス	GetDeploymentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListFunctionDeployments

GET /functions/{function_id}/deployments

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListFunctionDeployments 200レスポンス	ListFunctionDeploymentsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateFunctionDeployment

POST /functions/{function_id}/deployments

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし
body	body	CreateFunctionDeploymentRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateFunctionDeployment 202レスポンス	CreateFunctionDeploymentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListStructureDeployments

GET /structures/{structure_id}/deployments

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングする展開ステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	DEPLOYING
status	SUCCEEDED
status	FAILED
status	ERROR

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListStructureDeployments 200レスポンス	ListStructureDeploymentsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateStructureDeployment

POST /structures/{structure_id}/deployments

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
body	body	CreateStructureDeploymentRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateStructureDeployment 202レスポンス	CreateStructureDeploymentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListToolDeployments

GET /tools/{tool_id}/deployments

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListToolDeployments 200レスポンス	ListToolDeploymentsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateToolDeployment

POST /tools/{tool_id}/deployments

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし
body	body	CreateToolDeploymentRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateToolDeployment 202レスポンス	CreateToolDeploymentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

FunctionRuns

GetFunctionRun

GET /function-runs/{function_run_id}

パラメーター

Name	In	Type	Required	Description
function_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetFunctionRun 200レスポンス	GetFunctionRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListFunctionRunLogs

GET /function-runs/{function_run_id}/logs

パラメーター

Name	In	Type	Required	Description
function_run_id	path	string	true	なし

応答例

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListFunctionRunLogs 200応答	ListFunctionRunLogsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListFunctionRuns

GET /functions/{function_id}/runs

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングする実行ステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListFunctionRuns200レスポンス	ListFunctionRunsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ファンクション

リストファンクション

GET /functions

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListFunctions 200応答	ListFunctionsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateFunction

POST /functions

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateFunctionRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateFunction 201レスポンス	CreateFunctionResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteFunction

DELETE /functions/{function_id}

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteFunction 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetFunction

GET /functions/{function_id}

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetFunction 200レスポンス	GetFunctionResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

Updateファンクション

PATCH /functions/{function_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし
body	body	UpdateFunctionRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateFunction 200応答	UpdateFunctionResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

FunctionExecute

CreateFunctionExecutionGet

GET /functions/{function_id}/execute

指定された入力でファンクションを実行します。クエリパラメーターは、 ’query_params’としてファンクションに渡されます。

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし

応答例

{}

応答

Status	Meaning	Description	Schema
200	GetToken	CreateFunctionExecutionGet 200レスポンス	CreateFunctionExecutionGetOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateFunctionExecutionPost

POST /functions/{function_id}/execute

指定された入力でファンクションを実行します。入力本文は「body」としてファンクションに渡されます。クエリパラメーターは’query_params’として渡されます。

ボディパラメーター

{}

パラメーター

Name	In	Type	Required	Description
function_id	path	string	true	なし
body	body	CreateFunctionExecutionPostInputPayload	false	なし

応答例

{}

応答

Status	Meaning	Description	Schema
200	GetToken	CreateFunctionExecutionPost 200レスポンス	CreateFunctionExecutionPostOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

統合

リストインテグレーション

GET /integrations

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListIntegrations 200応答	ListIntegrationsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateIntegration

POST /integrations

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateIntegrationRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateIntegration 201レスポンス	CreateIntegrationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteIntegration

DELETE /integrations/{integration_id}

パラメーター

Name	In	Type	Required	Description
integration_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteIntegration 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetIntegration

GET /integrations/{integration_id}

パラメーター

Name	In	Type	Required	Description
integration_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetIntegration 200レスポンス	GetIntegrationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

Update統合

PATCH /integrations/{integration_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
integration_id	path	string	true	なし
body	body	UpdateIntegrationRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateIntegration 200レスポンス	UpdateIntegrationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

招待者

ListUserInvites

GET /invites

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListUserInvites 200 レスポンス	ListUserInvitesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteInvite

DELETE /invites/{invite_id}

パラメーター

Name	In	Type	Required	Description
invite_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteInvite 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetInvite

GET /invites/{invite_id}

パラメーター

Name	In	Type	Required	Description
invite_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetInvite 200レスポンス	GetInviteResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

RespondToInvite

POST /invites/{invite_id}/response

ボディパラメーター

{
  "properties": {
    "response": {
      "enum": [
        "ACCEPTED",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "response"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
invite_id	path	string	true	なし
body	body	RespondToInviteRequestコンテンツ	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	RespondToInvite 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListInvites

GET /organizations/{organization_id}/invites

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListInvites 200 レスポンス	ListInvitesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateInvite

POST /organizations/{organization_id}/invites

ボディパラメーター

{
  "properties": {
    "email": {
      "maxLength": 254,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
body	body	CreateInviteRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateInvite 201レスポンス	CreateInviteResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

KnowledgeBaseJobs

GetKnowledgeBaseJob

GET /knowledge-base-jobs/{knowledge_base_job_id}

パラメーター

Name	In	Type	Required	Description
knowledge_base_job_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseJob 200レスポンス	GetKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CancelKnowledgeBaseJob

POST /knowledge-base-jobs/{knowledge_base_job_id}/cancel

パラメーター

Name	In	Type	Required	Description
knowledge_base_job_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	CancelKnowledgeBaseJob 200レスポンス	CancelKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListKnowledgeBaseJobs

GET /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングするステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	RUNNING
status	SUCCEEDED
status	FAILED
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseJobs 200レスポンス	ListKnowledgeBaseJobsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateKnowledgeBaseJob

POST /knowledge-bases/{knowledge_base_id}/knowledge-base-jobs

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
202	Accepted	CreateKnowledgeBaseJob 202レスポンス	CreateKnowledgeBaseJobResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ナレッジベース

GetKnowledgeBaseQuery

GET /knowledge-base-queries/{knowledge_base_query_id}

パラメーター

Name	In	Type	Required	Description
knowledge_base_query_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseQuery 200レスポンス	GetKnowledgeBaseQueryResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetKnowledgeBaseSearch

GET /knowledge-base-searches/{knowledge_base_search_id}

パラメーター

Name	In	Type	Required	Description
knowledge_base_search_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBaseSearch 200レスポンス	GetKnowledgeBaseSearchResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListKnowledgeBases

GET /knowledge-bases

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBases 200 レスポンス	ListKnowledgeBasesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateKnowledgeBase

POST /knowledge-bases

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateKnowledgeBaseRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateKnowledgeBase 201レスポンス	CreateKnowledgeBaseResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteKnowledgeBase

DELETE /knowledge-bases/{knowledge_base_id}

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	KnowledgeBase 204レスポンスの削除	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetKnowledgeBase

GET /knowledge-bases/{knowledge_base_id}

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetKnowledgeBase 200レスポンス	GetKnowledgeBaseResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ナレッジベースの更新

PATCH /knowledge-bases/{knowledge_base_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
body	body	UpdateKnowledgeBaseRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateKnowledgeBase 200レスポンス	UpdateKnowledgeBaseResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListKnowledgeBaseQueries

GET /knowledge-bases/{knowledge_base_id}/queries

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseQueries 200レスポンス	ListKnowledgeBaseQueriesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

QueryKnowledgeBase

POST /knowledge-bases/{knowledge_base_id}/query

ボディパラメーター

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
body	body	QueryKnowledgeBaseRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	QueryKnowledgeBase 200レスポンス	QueryKnowledgeBaseResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

SearchKnowledgeBase

POST /knowledge-bases/{knowledge_base_id}/search

ボディパラメーター

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
body	body	SearchKnowledgeBaseRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	SearchKnowledgeBase 200レスポンス	SearchKnowledgeBaseResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListKnowledgeBaseSearches

GET /knowledge-bases/{knowledge_base_id}/searches

パラメーター

Name	In	Type	Required	Description
knowledge_base_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListKnowledgeBaseSearches 200 レスポンス	ListKnowledgeBaseSearchesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ライブラリ

リストライブラリ

GET /libraries

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListLibraries 200応答	ListLibrariesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateLibrary

POST /libraries

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateLibraryRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateLibrary 201レスポンス	CreateLibraryResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteLibrary

DELETE /libraries/{library_id}

パラメーター

Name	In	Type	Required	Description
library_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteLibrary 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetLibrary

GET /libraries/{library_id}

パラメーター

Name	In	Type	Required	Description
library_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetLibrary 200レスポンス	GetLibraryResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateLibrary

PATCH /libraries/{library_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
library_id	path	string	true	なし
body	body	UpdateLibraryRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateLibrary 200レスポンス	UpdateLibraryResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

メッセージ

DeleteMessage

DELETE /messages/{message_id}

パラメーター

Name	In	Type	Required	Description
message_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteMessage 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetMessage

GET /messages/{message_id}

パラメーター

Name	In	Type	Required	Description
message_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetMessage 200応答	GetMessageResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アップデートメッセージ

PATCH /messages/{message_id}

ボディパラメーター

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
message_id	path	string	true	なし
body	body	UpdateMessageRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateMessage 200応答	UpdateMessageResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

リストメッセージ

GET /threads/{thread_id}/messages

パラメーター

Name	In	Type	Required	Description
thread_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListMessages 200応答	ListMessagesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateMessage

POST /threads/{thread_id}/messages

ボディパラメーター

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
thread_id	path	string	true	なし
body	body	CreateMessageRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateMessage 201応答	CreateMessageResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

モデル

ListModels

GET /models

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし
model_type	query	string	false	なし
default	query	boolean	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListModels 200レスポンス	ListModelsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

組織

リスト組織

GET /organizations

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListOrganizations 200 応答	ListOrganizationsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateOrganization

POST /organizations

ボディパラメーター

{
  "properties": {
    "description": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateOrganizationRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateOrganization 201レスポンス	CreateOrganizationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

組織の削除

DELETE /organizations/{organization_id}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteOrganization 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetOrganization

GET /organizations/{organization_id}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetOrganization 200レスポンス	GetOrganizationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateOrganization

PATCH /organizations/{organization_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
body	body	UpdateOrganizationRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateOrganization 200レスポンス	UpdateOrganizationResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListOrganizationUsers

GET /organizations/{organization_id}/users

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListOrganizationUsers 200レスポンス	ListOrganizationUsersResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteOrganizationUser

DELETE /organizations/{organization_id}/users/{user_id}

パラメーター

Name	In	Type	Required	Description
organization_id	path	string	true	なし
user_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteOrganizationUser 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

Retrieverコンポーネント

ListRetrieverコンポーネント

GET /retriever-components

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListRetrieverComponents 200レスポンス	ListRetrieverComponentsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateRetrieverComponent

POST /retriever-components

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateRetrieverComponentRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRetrieverComponent 201レスポンス	CreateRetrieverComponentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteRetrieverComponent

DELETE /retriever-components/{retriever_component_id}

パラメーター

Name	In	Type	Required	Description
retriever_component_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteRetrieverComponent 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetRetrieverComponent

GET /retriever-components/{retriever_component_id}

パラメーター

Name	In	Type	Required	Description
retriever_component_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetRetrieverComponent 200レスポンス	GetRetrieverComponentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateRetrieverComponent

PATCH /retriever-components/{retriever_component_id}

ボディパラメーター

{
  "properties": {
    "config": {},
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "config",
    "type"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
retriever_component_id	path	string	true	なし
body	body	UpdateRetrieverComponentRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateRetrieverComponent 200レスポンス	UpdateRetrieverComponentResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

レトリバー

ListRetrievers

GET /retrievers

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListRetrievers 200 応答	ListRetrieversResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateRetriever

POST /retrievers

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateRetrieverRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRetriever 201レスポンス	CreateRetrieverResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteRetriever

DELETE /retrievers/{retriever_id}

パラメーター

Name	In	Type	Required	Description
retriever_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteRetriever 204応答	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetRetriever

GET /retrievers/{retriever_id}

パラメーター

Name	In	Type	Required	Description
retriever_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetRetriever 200レスポンス	GetRetrieverResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateRetriever

PATCH /retrievers/{retriever_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
retriever_id	path	string	true	なし
body	body	UpdateRetrieverRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateRetriever 200レスポンス	UpdateRetrieverResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

QueryRetriever

POST /retrievers/{retriever_id}/query

ボディパラメーター

{
  "properties": {
    "query": {
      "type": "string"
    },
    "retriever_components_query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
retriever_id	path	string	true	なし
body	body	QueryRetrieverRequestContent	true	なし

応答例

{
  "properties": {
    "outputs": {
      "items": {},
      "type": "array"
    }
  },
  "required": [
    "outputs"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	QueryRetriever 200応答	QueryRetrieverResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ルール

ListRules

GET /rules

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし
ruleset_id	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListRules 200レスポンス	ListRulesResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateRule

POST /rules

ボディパラメーター

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "rule"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateRuleRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRule 201レスポンス	CreateRuleResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteRule

DELETE /rules/{rule_id}

パラメーター

Name	In	Type	Required	Description
rule_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteRule 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetRule

GET /rules/{rule_id}

パラメーター

Name	In	Type	Required	Description
rule_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetRule 200レスポンス	GetRuleResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateRule

PATCH /rules/{rule_id}

ボディパラメーター

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
rule_id	path	string	true	なし
body	body	UpdateRuleRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateRule 200レスポンス	UpdateRuleResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ルールセット

リストルールセット

GET /rulesets

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし
alias	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListRulesets 200レスポンス	ListRulesetsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateRuleset

POST /rulesets

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateRulesetRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateRuleset 201レスポンス	CreateRulesetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteRuleset

DELETE /rulesets/{ruleset_id}

パラメーター

Name	In	Type	Required	Description
ruleset_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteRuleset 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetRuleset

GET /rulesets/{ruleset_id}

パラメーター

Name	In	Type	Required	Description
ruleset_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetRuleset 200レスポンス	GetRulesetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

Updateルールセット

PATCH /rulesets/{ruleset_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
ruleset_id	path	string	true	なし
body	body	UpdateRulesetRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateRuleset 200レスポンス	UpdateRulesetResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

シークレット

ListSecrets

GET /secrets

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListSecrets 200 レスポンス	ListSecretsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateSecret

POST /secrets

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateSecretRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateSecret 201レスポンス	CreateSecretResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteSecret

DELETE /secrets/{secret_id}

パラメーター

Name	In	Type	Required	Description
secret_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteSecret 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetSecret

GET /secrets/{secret_id}

パラメーター

Name	In	Type	Required	Description
secret_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetSecret 200レスポンス	GetSecretResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

UpdateSecret

PATCH /secrets/{secret_id}

ボディパラメーター

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

パラメーター

Name	In	Type	Required	Description
secret_id	path	string	true	なし
body	body	UpdateSecretRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateSecret 200レスポンス	UpdateSecretResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

StructureRuns

GetStructureRun

GET /structure-runs/{structure_run_id}

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetStructureRun 200レスポンス	GetStructureRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CancelStructureRun

POST /structure-runs/{structure_run_id}/cancel

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	CancelStructureRun 200レスポンス	CancelStructureRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListStructureRunLogs

GET /structure-runs/{structure_run_id}/logs

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし

応答例

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListStructureRunLogs 200レスポンス	ListStructureRunLogsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListStructureRuns

GET /structures/{structure_id}/runs

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングする実行ステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListStructureRuns 200レスポンス	ListStructureRunsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateStructureRun

POST /structures/{structure_id}/runs

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
structure_id	path	string	true	なし
body	body	CreateStructureRunRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateStructureRun 201レスポンス	CreateStructureRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

スパン

リストスパン

GET /structure-runs/{structure_run_id}/spans

パラメーター

Name	In	Type	Required	Description
structure_run_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListSpans 200レスポンス	ListSpansResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

スレッド

リストスレッド

GET /threads

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし
alias	query	string	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListThreads 200応答	ListThreadsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateThread

POST /threads

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateThreadRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateThread 201レスポンス	CreateThreadResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

スレッドの削除

DELETE /threads/{thread_id}

パラメーター

Name	In	Type	Required	Description
thread_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteThread 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetThread

GET /threads/{thread_id}

パラメーター

Name	In	Type	Required	Description
thread_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetThread 200レスポンス	GetThreadResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

更新スレッド

PATCH /threads/{thread_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
thread_id	path	string	true	なし
body	body	UpdateThreadRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateThread 200レスポンス	UpdateThreadResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ツール実行

GetToolRun

GET /tool-runs/{tool_run_id}

パラメーター

Name	In	Type	Required	Description
tool_run_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetToolRun 200レスポンス	GetToolRunResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListToolRunLogs

GET /tool-runs/{tool_run_id}/logs

パラメーター

Name	In	Type	Required	Description
tool_run_id	path	string	true	なし

応答例

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListToolRunLogs 200 レスポンス	ListToolRunLogsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ListToolRuns

GET /tools/{tool_id}/runs

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし
page	query	number	false	なし
page_size	query	number	false	なし
status	query	array[string]	false	フィルタリングする実行ステータスのコンマ区切りリスト。

列挙値

Parameter	Value
status	QUEUED
status	STARTING
status	RUNNING
status	SUCCEEDED
status	FAILED
status	ERROR
status	CANCELLED

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListToolRuns 200レスポンス	ListToolRunsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ツール

リストツール

GET /tools

パラメーター

Name	In	Type	Required	Description
page	query	number	false	なし
page_size	query	number	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	ListTools 200レスポンス	ListToolsResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

CreateTool

POST /tools

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
body	body	CreateToolRequestContent	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
201	CreateDataConnector	CreateTool 201レスポンス	CreateToolResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

DeleteTool

DELETE /tools/{tool_id}

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし

応答例

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

応答

Status	Meaning	Description	Schema
204	No Content	DeleteTool 204レスポンス	None
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetTool

GET /tools/{tool_id}

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetTool 200レスポンス	GetToolResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

アップデートツール

PATCH /tools/{tool_id}

ボディパラメーター

{
  "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"
}

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし
body	body	UpdateToolRequestContent	false	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	UpdateTool 200レスポンス	UpdateToolResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ToolInvoke

CreateToolActivityRun

POST /tools/{tool_id}/activities/{activity_path}

ボディパラメーター

{}

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし
activity_path	path	string	true	なし
body	body	CreateToolActivityRunInputPayload	false	なし

応答例

{}

応答

Status	Meaning	Description	Schema
200	GetToken	CreateToolActivityRun 200レスポンス	CreateToolActivityRunOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

GetToolOpenApiRun

GET /tools/{tool_id}/openapi

パラメーター

Name	In	Type	Required	Description
tool_id	path	string	true	なし

応答例

{}

応答

Status	Meaning	Description	Schema
200	GetToken	GetToolOpenApiRun 200レスポンス	GetToolOpenApiRunOutputPayload
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

使用法

GetUsage

GET /usage

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetUsage 200レスポンス	GetUsageResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

ユーザー

GetUser

GET /users/{user_id}

パラメーター

Name	In	Type	Required	Description
user_id	path	string	true	なし

応答例

{
  "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"
}

応答

Status	Meaning	Description	Schema
200	GetToken	GetUser 200レスポンス	GetUserResponseContent
400	Bad Request	ClientError 400応答	ClientErrorResponseコンテンツ
500	Internal Server Error	ServiceError 500応答	ServiceErrorResponseコンテンツ

警告

この操作を実行するには、次のいずれかの方法で認証される必要があります。smithy.api.httpBearerAuth

スキーマ

アクティビティ期間

{
  "properties": {
    "activity_type": {
      "type": "string"
    },
    "seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
activity_type	string	false	none	なし
seconds	number	false	none	なし

ApiKeyDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

アーティファクト

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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オペレーション

{
  "enum": [
    "PUT",
    "GET"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	PUT
anonymous	GET

アセットの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

アシスタント詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

アシスタントイベントの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	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

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

バケットの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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コンテンツ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
status	データジョブステータス	true	none	なし
status_detail	any	false	none	なし

CancelKnowledgeBaseJobResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_job_id	string	true	none	なし
status	KnowledgeBaseJobStatus	true	none	なし
status_detail	any	false	none	なし

CancelStructureRunResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[EnvVar ]	false	none	なし
output	any	false	none	なし
output_timestamp	number(double)	false	none	なし
started_at	string(date-time)¦null	true	none	なし
status	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メッセージドライバーの構成

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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メッセージ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
content	[MessageContent ]	true	none	なし
role	string	true	none	なし
usage	Chatメッセージの使用状況	true	none	なし

Chatメッセージツール

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
activities	[ChatMessageToolActivity ]	true	none	なし
name	string	true	none	なし

ChatMessageToolアクティビティ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
description	string	true	none	なし
json_schema	JsonSchema	true	none	なし
name	string	true	none	なし

Chatメッセージの使用状況

{
  "properties": {
    "input_tokens": {
      "type": "number"
    },
    "output_tokens": {
      "type": "number"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "input_tokens",
    "output_tokens",
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
input_tokens	number	true	none	なし
output_tokens	number	true	none	なし
type	string	true	none	なし

ClientErrorResponseコンテンツ

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
errors	[any]	false	none	なし
type	string	true	none	なし

コードソース

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github	GithubCodeSource	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeCodeSource	true	none	なし

コードソース入力

{
  "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"
    }
  ]
}

プロパティ

Name	Type	Required	Restrictions	Description
github	GithubCodeSourceInput	true	none	なし

Confluence詳細

{
  "properties": {
    "atlassian_email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "atlassian_email",
    "domain"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
atlassian_email	string	true	none	なし
domain	string	true	none	なし

ConfluenceInput

{
  "properties": {
    "atlassian_api_token": {
      "type": "string"
    },
    "atlassian_email": {
      "type": "string"
    },
    "domain": {
      "type": "string"
    }
  },
  "required": [
    "atlassian_api_token",
    "atlassian_email",
    "domain"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
atlassian_api_token	string	true	none	なし
atlassian_email	string	true	none	なし
domain	string	true	none	なし

ConnectionCredentials入力

{
  "oneOf": [
    {
      "properties": {
        "github": {
          "properties": {
            "auth_code": {
              "type": "string"
            }
          },
          "required": [
            "auth_code"
          ],
          "type": "object"
        }
      },
      "required": [
        "github"
      ],
      "title": "github",
      "type": "object"
    }
  ]
}

プロパティ

Name	Type	Required	Restrictions	Description
github	GitHubCredentials入力	true	none	なし

接続の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし

CreateApiKeyResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし

CreateAssetResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "operation": {
      "enum": [
        "PUT",
        "GET"
      ],
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
operation	AssertUrlオペレーション	false	none	なし

CreateAssetUrlResponseContent

{
  "properties": {
    "headers": {
      "additionalProperties": {},
      "type": "object"
    },
    "url": {
      "type": "string"
    }
  },
  "required": [
    "headers",
    "url"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
headers	メタデータ	true	none	なし
url	string	true	none	なし

CreateAssistantRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	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

{
  "properties": {
    "billing_management_url": {
      "type": "string"
    }
  },
  "required": [
    "billing_management_url"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
billing_management_url	string	true	none	なし

CreateBucketRequestContent

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし

CreateBucketResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
driver_configuration	Chatメッセージドライバーの構成	true	none	なし
messages	[ChatMessageMessage ]	true	none	なし
output_schema	JsonSchema	true	none	なし
tools	[ChatMessageTool ]	true	none	なし

CreateChatMessageResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
content	[MessageContent ]	true	none	なし
role	string	true	none	なし
type	string	true	none	なし
usage	Chatメッセージの使用状況	true	none	なし

CreateChatMessageStreamRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
driver_configuration	Chatメッセージドライバーの構成	true	none	なし
messages	[ChatMessageMessage ]	true	none	なし
output_schema	JsonSchema	true	none	なし
tools	[ChatMessageTool ]	true	none	なし

CreateChatMessageStreamResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
content	[StreamMessageContent ]	true	none	なし
role	string	true	none	なし
type	string	true	none	なし
usage	Chatメッセージの使用状況	false	none	なし

CreateCheckoutSessionRequestContent

{
  "properties": {
    "price_lookup_key": {
      "type": "string"
    }
  },
  "required": [
    "price_lookup_key"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
price_lookup_key	string	true	none	なし

CreateCheckoutSessionResponseContent

{
  "properties": {
    "redirect_url": {
      "type": "string"
    }
  },
  "required": [
    "redirect_url"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
redirect_url	string	true	none	なし

CreateConnectionRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
credentials	ConnectionCredentials入力	true	none	なし
name	string	false	none	なし
type	string	true	none	なし

CreateConnectionResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	DataConnectorConfigInputUnion	true	none	なし
description	string	false	none	なし
name	string	true	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformInput ]	false	none	なし
type	string	true	none	なし

CreateDataConnectorResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
status	データジョブステータス	true	none	なし
status_detail	any	false	none	なし

CreateEventsRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
events	[EventInput ]	false	none	なし

CreateFunctionDeploymentRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース入力	false	none	なし
force	boolean	false	none	なし

CreateFunctionDeploymentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし

CreateFunctionExecutionGetOutputPayload

{}

プロパティ

なし

CreateFunctionExecutionPostInputPayload

{}

プロパティ

なし

CreateFunctionExecutionPostOutputPayload

{}

プロパティ

なし

CreateFunctionRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
function_config_file	string	false	none	なし
name	string	true	none	なし

CreateFunctionResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	false	none	なし
config	IntegrationConfigInputUnion	true	none	なし
description	string	false	none	なし
name	string	true	none	なし
structure_ids	[string]	false	none	なし
type	統合タイプ	true	none	なし

CreateIntegrationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	なし
config	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	統合タイプ	true	none	なし
updated_at	string(date-time)	true	none	なし

CreateInviteRequestContent

{
  "properties": {
    "email": {
      "maxLength": 254,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "email"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
email	string	true	none	なし

CreateInviteResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	なし

CreateKnowledgeBaseJobResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_job_id	string	true	none	なし
status	KnowledgeBaseJobStatus	true	none	なし
status_detail	any	false	none	なし

CreateKnowledgeBaseRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	なし
config	KnowledgeBaseConfigInputUnion	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
name	string	true	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
use_default_embedding_model	boolean	false	none	なし

CreateKnowledgeBaseResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	なし
config	KnowledgeBaseConfigUnion	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
knowledge_base_id	string	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし
use_default_embedding_model	boolean	false	none	なし

CreateLibraryRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
data_connector_ids	[string]	true	none	なし
description	string	false	none	なし
knowledge_base_configs	[KnowledgeBaseConfigInputUnion ]	true	none	なし
name	string	true	none	なし

CreateLibraryResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
input	string	true	none	なし
metadata	メタデータ	false	none	なし
output	string	true	none	なし

CreateMessageResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	メタデータ	true	none	なし
output	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

CreateOrganizationApiKeyRequestContent

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし

CreateOrganizationApiKeyResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "description": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
description	string	false	none	なし
name	string	true	none	なし

CreateOrganizationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

すべての

Name	Type	Required	Restrictions	Description
» anonymous	資格	false	none	なし

そして

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	なし

続き

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

CreateRetrieverComponentRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	any	true	none	なし
description	string	false	none	なし
name	string	true	none	なし
type	string	true	none	なし

CreateRetrieverComponentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
description	string	false	none	なし
name	string	true	none	なし
retriever_component_ids	[string]	false	none	なし
retriever_components	[RetrieverComponentInput ]	false	none	なし

CreateRetrieverResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[RetrieverComponentDetail ]	true	none	なし
retriever_components_schema	any	true	none	なし
retriever_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

CreateRuleRequestContent

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "rule"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
metadata	メタデータ	false	none	なし
name	string	true	none	なし
rule	string	true	none	なし

CreateRuleResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	false	none	なし
description	string	false	none	なし
metadata	メタデータ	false	none	なし
name	string	true	none	なし
rule_ids	[string]	false	none	なし

CreateRulesetResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
metadata	メタデータ	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし
value	string	true	none	なし

CreateSecretResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース入力	false	none	なし
force	boolean	false	none	なし

CreateStructureDeploymentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし
structure_id	string	true	none	なし

CreateStructureRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
name	string	true	none	なし
structure_config_file	string	false	none	なし
webhook_enabled	boolean	false	none	なし

CreateStructureResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
args	[string]	true	none	なし
env_vars	[EnvVar ]	false	none	なし

CreateStructureRunResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[EnvVar ]	false	none	なし
output	any	false	none	なし
output_timestamp	number(double)	false	none	なし
started_at	string(date-time)¦null	true	none	なし
status	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	false	none	なし
messages	[MessageInput ]	false	none	なし
metadata	メタデータ	false	none	なし
name	string	true	none	なし

CreateThreadResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

CreateToolActivityRunInputPayload

{}

プロパティ

なし

CreateToolActivityRunOutputPayload

{}

プロパティ

なし

CreateToolDeploymentRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース入力	false	none	なし
force	boolean	false	none	なし

CreateToolDeploymentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし
tool_id	string	true	none	なし

CreateToolRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
name	string	true	none	なし
tool_config_file	string	false	none	なし

CreateToolResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» confluence	ConfluenceInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» google_drive	GoogleDriveInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» webscraper	Webscraper入力	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» structure	StructureConnectorInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» s3	S3ConnectorInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeConnectorInput	true	none	なし

DataConnectorConfigUnion

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» confluence	Confluence詳細	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» google_drive	GoogleDriveの詳細	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» webscraper	Webscraper詳細	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» structure	StructureConnectorDetail	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» s3	S3コネクタの詳細	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeConnectorDetail	true	none	なし

DataConnectorDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
bucket_id	string	false	none	なし
config	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	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし

DataJobDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
status	データジョブステータス	true	none	なし
status_detail	any	false	none	なし

データジョブステータス

{
  "enum": [
    "QUEUED",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	CANCELLED

DataLakeCodeSource

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	なし
bucket_id	string	true	none	なし

DataLakeConnectorDetail

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "bucket_id": {
      "type": "string"
    }
  },
  "required": [
    "asset_paths",
    "bucket_id"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	なし
bucket_id	string	true	none	なし

DataLakeConnectorInput

{
  "properties": {
    "asset_paths": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "bucket_id": {
      "type": "string"
    }
  },
  "required": [
    "bucket_id"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	なし
bucket_id	string	true	none	なし

DataLakeファンクションコード

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	なし
bucket_id	string	true	none	なし

DataLakeStructureCode

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	なし
bucket_id	string	true	none	なし

DataLakeToolCode

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_path	string	true	none	なし
bucket_id	string	true	none	なし

デフォルトファンクションコード

{
  "type": "object"
}

プロパティ

なし

DefaultStructureCode

{
  "type": "object"
}

プロパティ

なし

DefaultToolCode

{
  "type": "object"
}

プロパティ

なし

DeploymentCountGauge

{
  "properties": {
    "active_count": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
active_count	number	false	none	なし
total_count	number	false	none	なし

DeploymentDurationゲージ

{
  "properties": {
    "total_seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
total_seconds	number	false	none	なし

DeploymentErrorRateGauge

{
  "properties": {
    "rate": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
rate	number(float)	false	none	なし

DeploymentStatus

{
  "enum": [
    "QUEUED",
    "DEPLOYING",
    "SUCCEEDED",
    "FAILED",
    "ERROR"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	DEPLOYING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR

期間プロット

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
seconds_avg	number	false	none	なし
seconds_p100	number	false	none	なし
seconds_p50	number	false	none	なし
timeseries	[DurationTimeseriesElement ]	false	none	なし

Timeseries要素

{
  "properties": {
    "seconds_p0": {
      "type": "number"
    },
    "seconds_p100": {
      "type": "number"
    },
    "seconds_p50": {
      "type": "number"
    },
    "time": {
      "format": "date-time",
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
seconds_p0	number	false	none	なし
seconds_p100	number	false	none	なし
seconds_p50	number	false	none	なし
time	string(date-time)	false	none	なし

EmbeddingModel

{
  "enum": [
    "text-embedding-ada-002",
    "text-embedding-3-small"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	text-embedding-ada-002
anonymous	text-embedding-3-small

資格

{
  "enum": [
    "FREE",
    "PAID",
    "PARTNER",
    "UNPAID",
    "EXPIRED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	FREE
anonymous	PAID
anonymous	PARTNER
anonymous	UNPAID
anonymous	EXPIRED

エントリー

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
id	string	true	none	なし
meta	メタ	false	none	なし
namespace	string	false	none	なし
score	number(float)	true	none	なし
vector	[number]	false	none	なし

EnvVar

{
  "properties": {
    "name": {
      "type": "string"
    },
    "source": {
      "enum": [
        "secret_ref",
        "manual"
      ],
      "type": "string"
    },
    "value": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "value"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし
source	EnvVarSource	false	none	なし
value	string	true	none	なし

EnvVarSource

{
  "enum": [
    "secret_ref",
    "manual"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	secret_ref
anonymous	manual

エラー

{
  "properties": {
    "message": {
      "type": "string"
    },
    "path": {
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "message",
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
message	string	true	none	なし
path	string	false	none	なし
type	string	true	none	なし

ErrorRateGauge

{
  "properties": {
    "error_type_counts": {
      "items": {
        "properties": {
          "count": {
            "type": "number"
          },
          "error_type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "rate": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
error_type_counts	[ErrorTypeCount ]	false	none	なし
rate	number(float)	false	none	なし

ErrorTypeCount

{
  "properties": {
    "count": {
      "type": "number"
    },
    "error_type": {
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
count	number	false	none	なし
error_type	string	false	none	なし

イベントの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "payload": {},
    "timestamp": {
      "format": "double",
      "type": "number"
    },
    "type": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "timestamp",
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
payload	any	false	none	なし
timestamp	number(double)	true	none	なし
type	string	true	none	なし

ファンクションコード

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github	GithubFunctionCode	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeファンクションコード	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» default	デフォルトファンクションコード	true	none	なし

ファンクション展開の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし

ファンクションの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[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	FunctionRunStatus	true	none	なし
status_detail	any	false	none	なし
updated_at	string(date-time)	true	none	なし

FunctionRunStatus

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

GTCHybidSQLPGVectorKnowledgeBaseDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
embedding_model	string	true	none	なし
query_schema	any	true	none	なし
structured_columns	[StructuredColumnDetail ]	true	none	なし
unstructured_columns	[UnstructuredColumnDetail ]	true	none	なし
use_default_embedding_model	boolean	true	none	なし

GTCHybidSQLPGVectorKnowledgeBaseInput

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
embedding_model	string	false	none	なし
structured_columns	[StructuredColumnInput ]	true	none	なし
unstructured_columns	[UnstructuredColumnInput ]	true	none	なし
use_default_embedding_model	boolean	false	none	なし

GTCPGVectorKnowledgeBaseDetail

{
  "properties": {
    "embedding_model": {
      "type": "string"
    },
    "query_schema": {},
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "embedding_model",
    "query_schema",
    "use_default_embedding_model"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
embedding_model	string	true	none	なし
query_schema	any	true	none	なし
use_default_embedding_model	boolean	true	none	なし

GTCPGVectorKnowledgeBaseInput

{
  "properties": {
    "embedding_model": {
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
embedding_model	string	false	none	なし
use_default_embedding_model	boolean	false	none	なし

GetApiKeyResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "format": "byte",
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string(byte)	false	none	なし

GetAssistantRunResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
bucket_id	string	false	none	なし
config	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	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし

GetDataJobResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
status	データジョブステータス	true	none	なし
status_detail	any	false	none	なし

GetDeploymentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし
structure_id	string	false	none	なし
tool_id	string	false	none	なし

GetEventResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[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	FunctionRunStatus	true	none	なし
status_detail	any	false	none	なし
updated_at	string(date-time)	true	none	なし

GetIntegrationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	なし
config	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	統合タイプ	true	none	なし
updated_at	string(date-time)	true	none	なし

GetInviteResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	なし

GetKnowledgeBaseJobResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_job_id	string	true	none	なし
status	KnowledgeBaseJobStatus	true	none	なし
status_detail	any	false	none	なし

GetKnowledgeBaseQueryResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
entries	[Entry ]	true	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_query_id	string	true	none	なし
query	string	true	none	なし

GetKnowledgeBaseResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	なし
config	KnowledgeBaseConfigUnion	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
knowledge_base_id	string	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし
use_default_embedding_model	boolean	false	none	なし

GetKnowledgeBaseSearchResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	メタデータ	true	none	なし
output	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

GetOrganizationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

すべての

Name	Type	Required	Restrictions	Description
» anonymous	資格	false	none	なし

そして

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	なし

続き

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

GetRetrieverComponentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[RetrieverComponentDetail ]	true	none	なし
retriever_components_schema	any	true	none	なし
retriever_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

GetRuleResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
metadata	メタデータ	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "format": "byte",
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string(byte)	false	none	なし

GetStructureRunResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[EnvVar ]	false	none	なし
output	any	false	none	なし
output_timestamp	number(double)	false	none	なし
started_at	string(date-time)¦null	true	none	なし
status	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
deployment_count_gauge	DeploymentCountGauge	false	none	なし
deployment_duration_gauge	DeploymentDurationゲージ	false	none	なし
deployment_error_rate_gauge	DeploymentErrorRateGauge	false	none	なし
duration_plot	期間プロット	false	none	なし
error_rate_gauge	DeploymentErrorRateGauge	false	none	なし
run_count_gauge	RunCountGauge	false	none	なし
run_duration_gauge	RunDurationGauge	false	none	なし
token_count_gauge	TokenCountGauge	false	none	なし

GetThreadResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

GetTokenResponseContent

{
  "properties": {
    "access_token": {
      "type": "string"
    }
  },
  "required": [
    "access_token"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
access_token	string	true	none	なし

GetToolOpenApiRunOutputPayload

{}

プロパティ

なし

GetToolResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[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	ツール実行ステータス	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
app_id	string	true	none	なし
integration_endpoint	string	true	none	なし
private_key_secret_ref	string	true	none	なし
webhook_secret_ref	string	true	none	なし

GitHubAppInput

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
app_id	string	false	none	なし
private_key_secret_ref	string	false	none	なし
webhook_secret_ref	string	false	none	なし

GitHubCredentials入力

{
  "properties": {
    "auth_code": {
      "type": "string"
    }
  },
  "required": [
    "auth_code"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
auth_code	string	true	none	なし

GithubCodeSource

{
  "properties": {
    "commit_sha": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
commit_sha	string	false	none	なし

GithubCodeSourceInput

{
  "properties": {
    "access_token": {
      "maxLength": 1000,
      "minLength": 1,
      "type": "string"
    },
    "commit_sha": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
access_token	string	false	none	なし
commit_sha	string	false	none	なし

GithubFunctionCode

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし
owner	string	true	none	なし
push	GithubFunctionCodePushConfig	true	none	なし

GithubFunctionCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
branch	string	true	none	なし
tag	string	false	none	なし

GithubStructureCode

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし
owner	string	true	none	なし
push	GithubStructureCodePushConfig	true	none	なし

GithubStructureCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
branch	string	true	none	なし
tag	string	false	none	なし

GithubToolCode

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	true	none	なし
owner	string	true	none	なし
push	GithubToolCodePushConfig	true	none	なし

GithubToolCodePushConfig

{
  "properties": {
    "branch": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "tag": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "required": [
    "branch"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
branch	string	true	none	なし
tag	string	false	none	なし

GoogleDriveの詳細

{
  "properties": {
    "access_token": {
      "type": "string"
    },
    "file_ids": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "access_token",
    "file_ids"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
access_token	string	true	none	なし
file_ids	[string]	true	none	なし

GoogleDriveInput

{
  "properties": {
    "auth_code": {
      "type": "string"
    },
    "file_ids": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "auth_code",
    "file_ids"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
auth_code	string	true	none	なし
file_ids	[string]	true	none	なし

IntegrationConfigInputUnion

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» slack	SlackInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github_app	GitHubAppInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» webhook	Webhook入力	true	none	なし

IntegrationConfigUnion

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» slack	Slackの詳細	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github_app	GitHubAppDetail	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» webhook	Webhook詳細	true	none	なし

統合の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	なし
config	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	統合タイプ	true	none	なし
updated_at	string(date-time)	true	none	なし

統合タイプ

{
  "enum": [
    "slack",
    "github_app",
    "webhook"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	slack
anonymous	github_app
anonymous	webhook

InviteDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	InviteStatus	true	none	なし

InviteResponseステータス

{
  "enum": [
    "ACCEPTED",
    "REJECTED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	ACCEPTED
anonymous	REJECTED

InviteStatus

{
  "enum": [
    "ACCEPTED",
    "EXPIRED",
    "PENDING",
    "REJECTED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	ACCEPTED
anonymous	EXPIRED
anonymous	PENDING
anonymous	REJECTED

InvokeStructureWebhookGetResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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	Required	Restrictions	Description
additionalProperties	boolean	true	none	なし
description	string	true	none	なし
id	string	true	none	なし
properties	JsonSchemaプロパティ	true	none	なし
required	[string]	true	none	なし
schema	string	true	none	なし
title	string	true	none	なし
type	string	true	none	なし

JsonSchemaプロパティ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
member	JsonSchemaプロパティ	false	none	なし

JsonSchemaプロパティ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
additionalProperties	boolean	true	none	なし
description	string	true	none	なし
properties	JsonSchemaプロパティ	true	none	なし
required	[string]	true	none	なし
type	string	true	none	なし

KnowledgeBaseConfigInputUnion

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» pg_vector	GTCHybidSQLPGVectorKnowledgeBaseInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» gtc_pg_vector	GTCPGVectorKnowledgeBaseInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» gtc_hybrid_sql_pg_vector	GTCHybidSQLPGVectorKnowledgeBaseInput	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» pgai_knowledge_base	PGAIKnowledgeBaseKnowledgeBase入力	true	none	なし

KnowledgeBaseConfigUnion

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» pg_vector	GTCHybidSQLPGVectorKnowledgeBaseDetail	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» gtc_pg_vector	GTCPGVectorKnowledgeBaseDetail	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» gtc_hybrid_sql_pg_vector	GTCHybidSQLPGVectorKnowledgeBaseDetail	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» pgai_knowledge_base	PGAIKnowledgeBaseKnowledgeBaseDetail	true	none	なし

ナレッジベースの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	なし
config	KnowledgeBaseConfigUnion	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
knowledge_base_id	string	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし
use_default_embedding_model	boolean	false	none	なし

KnowledgeBaseJobDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[Error ]	false	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_job_id	string	true	none	なし
status	KnowledgeBaseJobStatus	true	none	なし
status_detail	any	false	none	なし

KnowledgeBaseJobStatus

{
  "enum": [
    "QUEUED",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	CANCELLED

KnowledgeBaseQueryDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
entries	[Entry ]	true	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_query_id	string	true	none	なし
query	string	true	none	なし

KnowledgeBaseSearchDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

ライブラリの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
api_keys	tool_id ]	true	none	なし
pagination	ページネーション	true	none	なし

ListAssetsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assets	[AssetDetail ]	true	none	なし
pagination	ページネーション	true	none	なし
postfix	string	false	none	なし
prefix	string	false	none	なし

ListAssistantEventsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
count	number	true	none	なし
events	[AssistantEventDetail ]	true	none	なし
limit	number	true	none	なし
next_offset	number	true	none	なし
offset	number	true	none	なし
total_count	number	true	none	なし

ListAssistantRunsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_runs	[AssistantRunDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListAssistantsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistants	[AssistantDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListBucketsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
buckets	[BucketDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListConnectionsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
connections	[ConnectionDetail ]	false	none	なし

ListDataConnectorsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
data_connectors	[DataConnectorDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListDataJobsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
data_jobs	[DataJobDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListEventsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
count	number	true	none	なし
events	[EventDetail ]	true	none	なし
limit	number	true	none	なし
next_offset	number	true	none	なし
offset	number	true	none	なし
total_count	number	true	none	なし

ListFunctionDeploymentsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
deployments	[FunctionDeploymentDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListFunctionRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	なし

ListFunctionRunsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
function_runs	[FunctionRunDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListFunctionsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
functions	[FunctionDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListIntegrationsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
integrations	[IntegrationDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListInvitesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
invites	[InviteDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListKnowledgeBaseJobsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
knowledge_base_jobs	[KnowledgeBaseJobDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListKnowledgeBaseQueriesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
knowledge_base_queries	[KnowledgeBaseQueryDetail ]	false	none	なし

ListKnowledgeBaseSearchesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
knowledge_base_searches	[KnowledgeBaseSearchDetail ]	false	none	なし

ListKnowledgeBasesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
knowledge_bases	[KnowledgeBaseDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListLibrariesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
libraries	[LibraryDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListMessagesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
messages	[MessageDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListModelsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
models	[ModelDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListOrganizationApiKeysResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
api_keys	tool_id ]	true	none	なし
pagination	ページネーション	true	none	なし

ListOrganizationUsersResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
users	[OrganizationUserDetail ]	true	none	なし

ListOrganizationsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
organizations	[OrganizationDetail ]	false	none	なし

ListRetrieverComponentsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
retriever_components	[RetrieverComponentDetail ]	true	none	なし

ListRetrieversResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
retrievers	[RetrieverDetail ]	true	none	なし

ListRulesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
rules	[RuleDetail ]	true	none	なし

ListRulesetsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
rulesets	tool_id ]	true	none	なし

ListSecretsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
secrets	[SecretDetail ]	true	none	なし

ListSpansResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
page	number	false	none	なし
spans	[SpanDetail ]	true	none	なし

ListStructureDeploymentsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
deployments	[StructureDeploymentDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListStructureRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	なし

ListStructureRunsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
structure_runs	[StructureRunDetail ]	true	none	なし

ListStructuresResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
structures	[StructureDetail ]	true	none	なし

ListThreadsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
threads	[ThreadDetail ]	true	none	なし

ListToolDeploymentsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
deployments	[ToolDeploymentDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListToolRunLogsResponseContent

{
  "properties": {
    "logs": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "logs"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
logs	[string]	true	none	なし

ListToolRunsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
tool_runs	[ToolRunDetail ]	true	none	なし

ListToolsResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
pagination	ページネーション	true	none	なし
tools	[ToolDetail ]	true	none	なし

ListUserInvitesResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
invites	[InviteDetail ]	true	none	なし
pagination	ページネーション	true	none	なし

ListUsersResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
users	[UserDetail ]	false	none	なし

メッセージコンテンツ

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
artifact	アーティファクト	true	none	なし
type	string	true	none	なし

メッセージ詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	メタデータ	true	none	なし
output	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

メッセージ入力

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "required": [
    "input",
    "output"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
input	string	true	none	なし
metadata	メタデータ	false	none	なし
output	string	true	none	なし

メタ

{
  "additionalProperties": {
    "type": "string"
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
additionalProperties	string	false	none	なし

メタデータ

{
  "additionalProperties": {},
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
additionalProperties	any	false	none	なし

モデルの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
default	boolean	true	none	なし
description	string	false	none	なし
model_name	string	true	none	なし
model_type	モデルタイプ	true	none	なし

ModelTokenCounts

{
  "properties": {
    "input": {
      "format": "float",
      "type": "number"
    },
    "output": {
      "format": "float",
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
input	number(float)	false	none	なし
output	number(float)	false	none	なし

ModelTokenCountsMap

{
  "additionalProperties": {
    "properties": {
      "input": {
        "format": "float",
        "type": "number"
      },
      "output": {
        "format": "float",
        "type": "number"
      }
    },
    "type": "object"
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
additionalProperties	ModelTokenCounts	false	none	なし

モデルタイプ

{
  "enum": [
    "chat",
    "embedding",
    "rerank",
    "image_generation",
    "unknown"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	chat
anonymous	embedding
anonymous	rerank
anonymous	image_generation
anonymous	unknown

オブザーバビリティイベント

{
  "properties": {
    "attributes": {},
    "name": {
      "type": "string"
    },
    "timestamp": {
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "attributes",
    "name",
    "timestamp"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
attributes	any	true	none	なし
name	string	true	none	なし
timestamp	string(date-time)	true	none	なし

組織の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

すべての

Name	Type	Required	Restrictions	Description
» anonymous	資格	false	none	なし

そして

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	なし

続き

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

OrganizationModelConfig

{
  "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	Required	Restrictions	Description
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	なし

組織ユーザーの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
email	string	true	none	なし
user_id	string	true	none	なし

PGAIKnowledgeBaseKnowledgeBaseDetail

{
  "properties": {
    "knowledge_base_name": {
      "type": "string"
    },
    "query_schema": {}
  },
  "required": [
    "knowledge_base_name",
    "query_schema"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
knowledge_base_name	string	true	none	なし
query_schema	any	true	none	なし

PGAIKnowledgeBaseKnowledgeBase入力

{
  "type": "object"
}

プロパティ

なし

PGVectorKnowledgeBaseDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
connection_string	string	true	none	なし
embedding_model	string	true	none	なし
query_schema	any	true	none	なし
use_default_embedding_model	boolean	true	none	なし

PGVectorKnowledgeBaseInput

{
  "properties": {
    "connection_string": {
      "type": "string"
    },
    "embedding_model": {
      "type": "string"
    },
    "password": {
      "type": "string"
    },
    "use_default_embedding_model": {
      "type": "boolean"
    }
  },
  "required": [
    "connection_string",
    "password"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
connection_string	string	true	none	なし
embedding_model	string	false	none	なし
password	string	true	none	なし
use_default_embedding_model	boolean	false	none	なし

ページネーション

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

期間

{
  "enum": [
    "1m",
    "1h",
    "1d",
    "1w"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	1m
anonymous	1h
anonymous	1d
anonymous	1w

QueryKnowledgeBaseRequestContent

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
query	string	false	none	なし
query_args	any	false	none	なし

QueryKnowledgeBaseResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
entries	[Entry ]	true	none	なし
knowledge_base_id	string	true	none	なし
knowledge_base_query_id	string	true	none	なし
query	string	true	none	なし

QueryRetrieverRequestContent

{
  "properties": {
    "query": {
      "type": "string"
    },
    "retriever_components_query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
query	string	true	none	なし
retriever_components_query_args	any	false	none	なし

QueryRetrieverResponseContent

{
  "properties": {
    "outputs": {
      "items": {},
      "type": "array"
    }
  },
  "required": [
    "outputs"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
outputs	[any]	true	none	なし

RespondToInviteRequestコンテンツ

{
  "properties": {
    "response": {
      "enum": [
        "ACCEPTED",
        "REJECTED"
      ],
      "type": "string"
    }
  },
  "required": [
    "response"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
response	InviteResponseステータス	true	none	なし

Retrieverコンポーネントの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "config": {},
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "name",
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	any	false	none	なし
description	string	false	none	なし
name	string	true	none	なし
type	string	true	none	なし

レトリバーの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[RetrieverComponentDetail ]	true	none	なし
retriever_components_schema	any	true	none	なし
retriever_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

ルールの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	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	なし

ルールセットの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
metadata	メタデータ	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

{
  "properties": {
    "active_count": {
      "type": "number"
    },
    "total_count": {
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
active_count	number	false	none	なし
total_count	number	false	none	なし

RunDurationGauge

{
  "properties": {
    "activity_durations": {
      "items": {
        "properties": {
          "activity_type": {
            "type": "string"
          },
          "seconds": {
            "type": "number"
          }
        },
        "type": "object"
      },
      "type": "array"
    },
    "total_seconds": {
      "type": "number"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
activity_durations	[ActivityDuration ]	false	none	なし
total_seconds	number	false	none	なし

S3コネクタの詳細

{
  "properties": {
    "aws_access_key_id": {
      "type": "string"
    },
    "uris": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "aws_access_key_id",
    "uris"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
aws_access_key_id	string	true	none	なし
uris	[string]	true	none	なし

S3ConnectorInput

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
aws_access_key_id	string	true	none	なし
aws_secret_access_key	string	true	none	なし
uris	[string]	true	none	なし

SearchKnowledgeBaseRequestContent

{
  "properties": {
    "query": {
      "type": "string"
    },
    "query_args": {}
  },
  "required": [
    "query"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
query	string	true	none	なし
query_args	any	false	none	なし

SearchKnowledgeBaseResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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コンテンツ

{
  "properties": {
    "errors": {
      "items": {},
      "type": "array"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
errors	[any]	false	none	なし
type	string	true	none	なし

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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
attributes	any	true	none	なし
end_time	string(date-time)	true	none	なし
events	オブザーバビリティイベント	true	none	なし
name	string	true	none	なし
parent_id	string	false	none	なし
span_id	string	true	none	なし
start_time	string(date-time)	true	none	なし
status	スパンステータス	true	none	なし
trace_id	string	true	none	なし

スパンステータス

{
  "enum": [
    "UNSET",
    "OK",
    "ERROR"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	UNSET
anonymous	OK
anonymous	ERROR

StreamMessageContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
artifact	アーティファクト	true	none	なし
type	string	true	none	なし

構造コード

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github	GithubStructureCode	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeStructureCode	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» default	DefaultStructureCode	true	none	なし

StructureConnectorDetail

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "structure_id": {
      "type": "string"
    }
  },
  "required": [
    "structure_id"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
args	[string]	false	none	なし
structure_id	string	true	none	なし

StructureConnectorInput

{
  "properties": {
    "args": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "structure_id": {
      "type": "string"
    }
  },
  "required": [
    "structure_id"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
args	[string]	false	none	なし
structure_id	string	true	none	なし

構造展開詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし
structure_id	string	true	none	なし

構造の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[EnvVar ]	false	none	なし
output	any	false	none	なし
output_timestamp	number(double)	false	none	なし
started_at	string(date-time)¦null	true	none	なし
status	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

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

StructuredColumnDetail

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "sql_type": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "sql_type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
column_name	string	true	none	なし
sql_type	string	true	none	なし

StructuredColumnInput

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    },
    "sql_type": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "description",
    "sql_type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
column_name	string	true	none	なし
description	string	true	none	なし
sql_type	string	true	none	なし

ThreadDetail

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

TokenCountGauge

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
by_model	ModelTokenCountsMap	false	none	なし
input	number(float)	false	none	なし
output	number(float)	false	none	なし

ツールコード

{
  "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"
    }
  ]
}

プロパティ

oneOf

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» github	GithubToolCode	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» data_lake	DataLakeToolCode	true	none	なし

xor

Name	Type	Required	Restrictions	Description
anonymous	object	false	none	なし
» default	DefaultToolCode	true	none	なし

ツール展開の詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code_source	コードソース	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	DeploymentStatus	true	none	なし
status_detail	any	false	none	なし
tool_id	string	true	none	なし

ツールの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[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	ツール実行ステータス	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	なし

ツール実行ステータス

{
  "enum": [
    "QUEUED",
    "STARTING",
    "RUNNING",
    "SUCCEEDED",
    "FAILED",
    "ERROR",
    "CANCELLED"
  ],
  "type": "string"
}

プロパティ

Name	Type	Required	Restrictions	Description
anonymous	string	false	none	なし

列挙値

Property	Value
anonymous	QUEUED
anonymous	STARTING
anonymous	RUNNING
anonymous	SUCCEEDED
anonymous	FAILED
anonymous	ERROR
anonymous	CANCELLED

TransformDetail

{
  "properties": {
    "structure": {
      "properties": {
        "args": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "structure_id": {
          "type": "string"
        }
      },
      "required": [
        "structure_id"
      ],
      "type": "object"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
structure	StructureConnectorDetail	false	none	なし

TransformInput

{
  "properties": {
    "structure": {
      "properties": {
        "args": {
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "structure_id": {
          "type": "string"
        }
      },
      "required": [
        "structure_id"
      ],
      "type": "object"
    }
  },
  "required": [
    "structure"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
structure	StructureConnectorInput	true	none	なし

非構造化列の詳細

{
  "properties": {
    "column_name": {
      "type": "string"
    }
  },
  "required": [
    "column_name"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
column_name	string	true	none	なし

非構造化列入力

{
  "properties": {
    "column_name": {
      "type": "string"
    },
    "description": {
      "type": "string"
    }
  },
  "required": [
    "column_name",
    "description"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
column_name	string	true	none	なし
description	string	true	none	なし

UpdateApiKeyRequestContent

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	false	none	なし

UpdateApiKeyResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "name": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	false	none	なし

UpdateBucketResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	DataConnectorConfigInputUnion	false	none	なし
description	string	false	none	なし
name	string	false	none	なし
schedule_expression	string	false	none	なし

UpdateDataConnectorResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	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	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateFunctionRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
function_config_file	string	false	none	なし
name	string	false	none	なし

UpdateFunctionResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeファンクションコード	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	false	none	なし
config	IntegrationConfigInputUnion	false	none	なし
description	string	false	none	なし
name	string	false	none	なし
structure_ids	[string]	false	none	なし
type	統合タイプ	false	none	なし

UpdateIntegrationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
assistant_ids	[string]	true	none	なし
config	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	統合タイプ	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateKnowledgeBaseRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	false	none	なし
config	KnowledgeBaseConfigInputUnion	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
name	string	false	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
use_default_embedding_model	boolean	false	none	なし

UpdateKnowledgeBaseResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
asset_paths	[string]	true	none	なし
config	KnowledgeBaseConfigUnion	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	false	none	なし
embedding_model	EmbeddingModel	false	none	なし
knowledge_base_id	string	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
schedule_expression	string	false	none	なし
transforms	[TransformDetail ]	false	none	なし
type	string	true	none	なし
updated_at	string(date-time)	true	none	なし
use_default_embedding_model	boolean	false	none	なし

UpdateLibraryRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
data_connector_ids	[string]	true	none	なし
description	string	false	none	なし
knowledge_base_configs	[KnowledgeBaseConfigInputUnion ]	true	none	なし
name	string	true	none	なし

UpdateLibraryResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "properties": {
    "input": {
      "type": "string"
    },
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "output": {
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
input	string	false	none	なし
metadata	メタデータ	false	none	なし
output	string	false	none	なし

UpdateMessageResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	メタデータ	true	none	なし
output	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateOrganizationRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	なし
name	string	false	none	なし

UpdateOrganizationResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	なし

すべての

Name	Type	Required	Restrictions	Description
» anonymous	資格	false	none	なし

そして

Name	Type	Required	Restrictions	Description
» anonymous	any	false	none	なし

続き

Name	Type	Required	Restrictions	Description
model_config	OrganizationModelConfig	false	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateRetrieverComponentRequestContent

{
  "properties": {
    "config": {},
    "description": {
      "maxLength": 256,
      "minLength": 1,
      "type": "string"
    },
    "name": {
      "maxLength": 64,
      "minLength": 1,
      "type": "string"
    },
    "type": {
      "type": "string"
    }
  },
  "required": [
    "config",
    "type"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
config	any	true	none	なし
description	string	false	none	なし
name	string	false	none	なし
type	string	true	none	なし

UpdateRetrieverComponentResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
description	string	false	none	なし
name	string	false	none	なし
retriever_component_ids	[string]	false	none	なし
retriever_components	[RetrieverComponentInput ]	false	none	なし

UpdateRetrieverResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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	[RetrieverComponentDetail ]	true	none	なし
retriever_components_schema	any	true	none	なし
retriever_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateRuleRequestContent

{
  "properties": {
    "metadata": {
      "additionalProperties": {},
      "type": "object"
    },
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "rule": {
      "maxLength": 2000,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
metadata	メタデータ	false	none	なし
name	string	false	none	なし
rule	string	false	none	なし

UpdateRuleResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	false	none	なし
description	string	false	none	なし
metadata	メタデータ	false	none	なし
name	string	false	none	なし
rule_ids	[string]	false	none	なし

UpdateRulesetResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
metadata	メタデータ	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

{
  "properties": {
    "name": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    },
    "value": {
      "maxLength": 200,
      "minLength": 1,
      "type": "string"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
name	string	false	none	なし
value	string	false	none	なし

UpdateSecretResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
name	string	false	none	なし
structure_config_file	string	false	none	なし
webhook_enabled	boolean	false	none	なし

UpdateStructureResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeStructureCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	false	none	なし
messages	[MessageInput ]	false	none	なし
metadata	メタデータ	false	none	なし
name	string	false	none	なし

UpdateThreadResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
alias	string	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
metadata	メタデータ	true	none	なし
name	string	true	none	なし
organization_id	string	true	none	なし
thread_id	string	true	none	なし
updated_at	string(date-time)	true	none	なし

UpdateToolRequestContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	false	none	なし
description	string	false	none	なし
env_vars	[EnvVar ]	false	none	なし
name	string	false	none	なし
tool_config_file	string	false	none	なし

UpdateToolResponseContent

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
code	DataLakeToolCode	true	none	なし
created_at	string(date-time)	true	none	なし
created_by	string	true	none	なし
description	string	true	none	なし
env_vars	[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	なし

ユーザーの詳細

{
  "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"
}

プロパティ

Name	Type	Required	Restrictions	Description
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詳細

{
  "properties": {
    "disable_api_key_param": {
      "type": "boolean"
    },
    "integration_endpoint": {
      "type": "string"
    }
  },
  "required": [
    "disable_api_key_param",
    "integration_endpoint"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
disable_api_key_param	boolean	true	none	なし
integration_endpoint	string	true	none	なし

Webhook入力

{
  "properties": {
    "disable_api_key_param": {
      "type": "boolean"
    }
  },
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
disable_api_key_param	boolean	false	none	なし

Webscraper詳細

{
  "properties": {
    "urls": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "urls"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
urls	[string]	true	none	なし

Webscraper入力

{
  "properties": {
    "urls": {
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "urls"
  ],
  "type": "object"
}

プロパティ

Name	Type	Required	Restrictions	Description
urls	[string]	true	none	なし