@athenaintel/sdk 4.3.308 → 4.3.310
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +117 -9
- package/dist/cjs/BaseClient.d.ts +14 -1
- package/dist/cjs/BaseClient.js +59 -0
- package/dist/cjs/Client.d.ts +24 -23
- package/dist/cjs/Client.js +10 -51
- package/dist/cjs/api/errors/BadRequestError.d.ts +1 -1
- package/dist/cjs/api/errors/ContentTooLargeError.d.ts +2 -2
- package/dist/cjs/api/errors/ForbiddenError.d.ts +1 -1
- package/dist/cjs/api/errors/InternalServerError.d.ts +1 -1
- package/dist/cjs/api/errors/NotFoundError.d.ts +1 -1
- package/dist/cjs/api/errors/NotImplementedError.d.ts +1 -1
- package/dist/cjs/api/errors/ServiceUnavailableError.d.ts +1 -1
- package/dist/cjs/api/errors/UnauthorizedError.d.ts +1 -1
- package/dist/cjs/api/errors/UnprocessableEntityError.d.ts +1 -1
- package/dist/cjs/api/errors/UnsupportedMediaTypeError.d.ts +2 -2
- package/dist/cjs/api/errors/index.d.ts +5 -5
- package/dist/cjs/api/errors/index.js +5 -5
- package/dist/cjs/api/index.d.ts +1 -1
- package/dist/cjs/api/index.js +1 -1
- package/dist/cjs/api/resources/agents/client/Client.d.ts +20 -20
- package/dist/cjs/api/resources/agents/client/Client.js +29 -26
- package/dist/cjs/api/resources/agents/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/resources/drive/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/agents/resources/drive/client/Client.js +20 -17
- package/dist/cjs/api/resources/agents/resources/drive/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/drive/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/resources/general/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/agents/resources/general/client/Client.js +42 -23
- package/dist/cjs/api/resources/agents/resources/index.d.ts +3 -3
- package/dist/cjs/api/resources/agents/resources/index.js +6 -6
- package/dist/cjs/api/resources/agents/resources/research/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/agents/resources/research/client/Client.js +20 -17
- package/dist/cjs/api/resources/agents/resources/research/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/research/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/agents/resources/sql/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/agents/resources/sql/client/Client.js +20 -17
- package/dist/cjs/api/resources/agents/resources/sql/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/agents/resources/sql/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/aop/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/aop/client/Client.js +31 -20
- package/dist/cjs/api/resources/assets/client/Client.d.ts +14 -14
- package/dist/cjs/api/resources/assets/client/Client.js +62 -35
- package/dist/cjs/api/resources/assets/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/assets/client/requests/CreateAssetRequestIn.d.ts +1 -1
- package/dist/cjs/api/resources/assets/client/requests/index.d.ts +3 -3
- package/dist/cjs/api/resources/databases/client/Client.d.ts +36 -32
- package/dist/cjs/api/resources/databases/client/Client.js +149 -81
- package/dist/cjs/api/resources/databases/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/databases/client/requests/DatabasesDeleteRequest.d.ts +15 -0
- package/dist/cjs/api/resources/databases/client/requests/DatabasesDeleteRequest.js +3 -0
- package/dist/cjs/api/resources/databases/client/requests/UpdateDataRequest.d.ts +3 -0
- package/dist/cjs/api/resources/databases/client/requests/index.d.ts +4 -3
- package/dist/cjs/api/resources/index.d.ts +8 -8
- package/dist/cjs/api/resources/index.js +12 -12
- package/dist/cjs/api/resources/query/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/query/client/Client.js +34 -23
- package/dist/cjs/api/resources/query/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/query/client/requests/QueryExecuteRequest.d.ts +1 -1
- package/dist/cjs/api/resources/query/client/requests/index.d.ts +2 -2
- package/dist/cjs/api/resources/query/index.d.ts +1 -1
- package/dist/cjs/api/resources/query/index.js +1 -1
- package/dist/cjs/api/resources/threads/client/Client.d.ts +8 -8
- package/dist/cjs/api/resources/threads/client/Client.js +25 -22
- package/dist/cjs/api/resources/tools/client/Client.d.ts +33 -33
- package/dist/cjs/api/resources/tools/client/Client.js +106 -55
- package/dist/cjs/api/resources/tools/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/client/requests/BodySaveAssetApiV0ToolsFileSavePost.d.ts +2 -2
- package/dist/cjs/api/resources/tools/client/requests/ToolsDataFrameRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/client/requests/index.d.ts +7 -7
- package/dist/cjs/api/resources/tools/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/index.js +1 -1
- package/dist/cjs/api/resources/tools/resources/calendar/client/Client.d.ts +9 -9
- package/dist/cjs/api/resources/tools/resources/calendar/client/Client.js +30 -19
- package/dist/cjs/api/resources/tools/resources/email/client/Client.d.ts +11 -11
- package/dist/cjs/api/resources/tools/resources/email/client/Client.js +41 -22
- package/dist/cjs/api/resources/tools/resources/index.d.ts +3 -3
- package/dist/cjs/api/resources/tools/resources/index.js +3 -3
- package/dist/cjs/api/resources/tools/resources/sheets/client/Client.d.ts +39 -39
- package/dist/cjs/api/resources/tools/resources/sheets/client/Client.js +196 -65
- package/dist/cjs/api/resources/tools/resources/sheets/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/sheets/client/requests/CreateNewSheetTabRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/sheets/client/requests/FormatSheetRangeRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/sheets/client/requests/InsertTableRowRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/sheets/client/requests/UpdateSheetRangeRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/sheets/client/requests/index.d.ts +17 -17
- package/dist/cjs/api/resources/tools/resources/structuredDataExtractor/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/tools/resources/structuredDataExtractor/client/Client.js +20 -17
- package/dist/cjs/api/resources/tools/resources/structuredDataExtractor/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/structuredDataExtractor/client/requests/StructuredDataExtractorRequest.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/structuredDataExtractor/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/resources/tools/resources/tasks/client/Client.d.ts +7 -7
- package/dist/cjs/api/resources/tools/resources/tasks/client/Client.js +20 -17
- package/dist/cjs/api/resources/tools/resources/tasks/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/tools/resources/tasks/client/requests/index.d.ts +1 -1
- package/dist/cjs/api/types/AopExecuteResponseOut.d.ts +1 -1
- package/dist/cjs/api/types/AssetNode.d.ts +1 -1
- package/dist/cjs/api/types/BorderModel.d.ts +1 -1
- package/dist/cjs/api/types/BordersModel.d.ts +1 -1
- package/dist/cjs/api/types/CellFormat.d.ts +1 -1
- package/dist/cjs/api/types/Chunk.d.ts +1 -1
- package/dist/cjs/api/types/ChunkContentItem.d.ts +1 -1
- package/dist/cjs/api/types/ConversationAssetInfo.d.ts +1 -1
- package/dist/cjs/api/types/ConversationMessage.d.ts +1 -1
- package/dist/cjs/api/types/ConversationResult.d.ts +1 -1
- package/dist/cjs/api/types/DatabaseTableSchemaResponse.d.ts +1 -1
- package/dist/cjs/api/types/DatabaseTablesResponse.d.ts +1 -1
- package/dist/cjs/api/types/FolderResponse.d.ts +1 -1
- package/dist/cjs/api/types/GeneralAgentRequest.d.ts +1 -1
- package/dist/cjs/api/types/GeneralAgentResponse.d.ts +1 -1
- package/dist/cjs/api/types/GeneralAgentResponseMessage.d.ts +1 -1
- package/dist/cjs/api/types/GeneralAgentResponseMessageKwargs.d.ts +1 -1
- package/dist/cjs/api/types/InputMessage.d.ts +1 -1
- package/dist/cjs/api/types/InputMessageContentItem.d.ts +1 -1
- package/dist/cjs/api/types/NumberFormatModel.d.ts +1 -1
- package/dist/cjs/api/types/PaginatedAssetsOut.d.ts +1 -1
- package/dist/cjs/api/types/Sheet.d.ts +1 -1
- package/dist/cjs/api/types/StructuredDataExtractorResponse.d.ts +1 -1
- package/dist/cjs/api/types/TextFormatModel.d.ts +1 -1
- package/dist/cjs/api/types/ThreadStatusResponseOut.d.ts +1 -1
- package/dist/cjs/api/types/index.d.ts +5 -5
- package/dist/cjs/api/types/index.js +5 -5
- package/dist/cjs/auth/HeaderAuthProvider.d.ts +14 -0
- package/dist/cjs/auth/HeaderAuthProvider.js +71 -0
- package/dist/cjs/auth/index.d.ts +1 -0
- package/dist/cjs/auth/index.js +5 -0
- package/dist/cjs/core/auth/AuthProvider.d.ts +7 -0
- package/dist/cjs/core/auth/AuthProvider.js +2 -0
- package/dist/cjs/core/auth/AuthRequest.d.ts +9 -0
- package/dist/cjs/core/auth/AuthRequest.js +2 -0
- package/dist/cjs/core/auth/BasicAuth.d.ts +8 -0
- package/dist/cjs/core/auth/BasicAuth.js +27 -0
- package/dist/cjs/core/auth/BearerToken.d.ts +7 -0
- package/dist/cjs/core/auth/BearerToken.js +16 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.d.ts +5 -0
- package/dist/cjs/core/auth/NoOpAuthProvider.js +9 -0
- package/dist/cjs/core/auth/index.d.ts +5 -0
- package/dist/cjs/core/auth/index.js +9 -0
- package/dist/cjs/core/base64.d.ts +2 -0
- package/dist/cjs/core/base64.js +26 -0
- package/dist/cjs/core/exports.d.ts +1 -0
- package/dist/cjs/core/exports.js +1 -0
- package/dist/cjs/core/fetcher/BinaryResponse.d.ts +6 -7
- package/dist/cjs/core/fetcher/EndpointSupplier.d.ts +1 -1
- package/dist/cjs/core/fetcher/Fetcher.d.ts +9 -2
- package/dist/cjs/core/fetcher/Fetcher.js +204 -9
- package/dist/cjs/core/fetcher/getErrorResponseBody.js +2 -1
- package/dist/cjs/core/fetcher/getRequestBody.d.ts +1 -1
- package/dist/cjs/core/fetcher/getRequestBody.js +4 -0
- package/dist/cjs/core/fetcher/getResponseBody.js +21 -7
- package/dist/cjs/core/fetcher/makeRequest.d.ts +1 -1
- package/dist/cjs/core/fetcher/makeRequest.js +2 -4
- package/dist/cjs/core/fetcher/requestWithRetries.js +3 -12
- package/dist/cjs/core/fetcher/signals.d.ts +1 -7
- package/dist/cjs/core/fetcher/signals.js +0 -12
- package/dist/cjs/core/file/file.d.ts +5 -0
- package/dist/cjs/core/file/file.js +25 -7
- package/dist/cjs/core/form-data-utils/FormDataWrapper.d.ts +2 -3
- package/dist/cjs/core/form-data-utils/FormDataWrapper.js +62 -85
- package/dist/cjs/core/headers.js +6 -4
- package/dist/cjs/core/index.d.ts +5 -2
- package/dist/cjs/core/index.js +6 -3
- package/dist/cjs/core/logging/exports.d.ts +18 -0
- package/dist/cjs/core/logging/exports.js +45 -0
- package/dist/cjs/core/logging/index.d.ts +1 -0
- package/dist/cjs/core/logging/index.js +17 -0
- package/dist/cjs/core/logging/logger.d.ts +126 -0
- package/dist/cjs/core/logging/logger.js +144 -0
- package/dist/cjs/core/runtime/runtime.js +11 -10
- package/dist/cjs/core/url/encodePathParam.d.ts +1 -0
- package/dist/cjs/core/url/encodePathParam.js +21 -0
- package/dist/cjs/core/url/index.d.ts +1 -0
- package/dist/cjs/core/url/index.js +3 -1
- package/dist/cjs/core/url/join.js +3 -4
- package/dist/cjs/errors/AthenaIntelligenceError.d.ts +1 -1
- package/dist/cjs/errors/AthenaIntelligenceError.js +1 -1
- package/dist/cjs/index.d.ts +2 -2
- package/dist/cjs/index.js +4 -4
- package/dist/cjs/version.d.ts +1 -1
- package/dist/cjs/version.js +1 -1
- package/dist/esm/BaseClient.d.mts +14 -1
- package/dist/esm/BaseClient.mjs +23 -1
- package/dist/esm/Client.d.mts +24 -23
- package/dist/esm/Client.mjs +17 -26
- package/dist/esm/api/errors/BadRequestError.d.mts +1 -1
- package/dist/esm/api/errors/BadRequestError.mjs +0 -1
- package/dist/esm/api/errors/ContentTooLargeError.d.mts +2 -2
- package/dist/esm/api/errors/ContentTooLargeError.mjs +0 -2
- package/dist/esm/api/errors/ForbiddenError.d.mts +1 -1
- package/dist/esm/api/errors/ForbiddenError.mjs +0 -1
- package/dist/esm/api/errors/InternalServerError.d.mts +1 -1
- package/dist/esm/api/errors/InternalServerError.mjs +0 -1
- package/dist/esm/api/errors/NotFoundError.d.mts +1 -1
- package/dist/esm/api/errors/NotFoundError.mjs +0 -1
- package/dist/esm/api/errors/NotImplementedError.d.mts +1 -1
- package/dist/esm/api/errors/NotImplementedError.mjs +0 -1
- package/dist/esm/api/errors/ServiceUnavailableError.d.mts +1 -1
- package/dist/esm/api/errors/ServiceUnavailableError.mjs +0 -1
- package/dist/esm/api/errors/UnauthorizedError.d.mts +1 -1
- package/dist/esm/api/errors/UnauthorizedError.mjs +0 -1
- package/dist/esm/api/errors/UnprocessableEntityError.d.mts +1 -1
- package/dist/esm/api/errors/UnprocessableEntityError.mjs +0 -1
- package/dist/esm/api/errors/UnsupportedMediaTypeError.d.mts +2 -2
- package/dist/esm/api/errors/UnsupportedMediaTypeError.mjs +0 -2
- package/dist/esm/api/errors/index.d.mts +5 -5
- package/dist/esm/api/errors/index.mjs +5 -5
- package/dist/esm/api/index.d.mts +1 -1
- package/dist/esm/api/index.mjs +1 -1
- package/dist/esm/api/resources/agents/client/Client.d.mts +20 -20
- package/dist/esm/api/resources/agents/client/Client.mjs +31 -28
- package/dist/esm/api/resources/agents/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/agents/resources/drive/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/agents/resources/drive/client/Client.mjs +18 -15
- package/dist/esm/api/resources/agents/resources/drive/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/drive/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/resources/drive/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/agents/resources/general/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/agents/resources/general/client/Client.mjs +40 -21
- package/dist/esm/api/resources/agents/resources/index.d.mts +3 -3
- package/dist/esm/api/resources/agents/resources/index.mjs +3 -3
- package/dist/esm/api/resources/agents/resources/research/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/agents/resources/research/client/Client.mjs +18 -15
- package/dist/esm/api/resources/agents/resources/research/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/research/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/resources/research/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/agents/resources/sql/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/agents/resources/sql/client/Client.mjs +18 -15
- package/dist/esm/api/resources/agents/resources/sql/client/index.d.mts +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/index.mjs +0 -1
- package/dist/esm/api/resources/agents/resources/sql/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/agents/resources/sql/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/aop/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/aop/client/Client.mjs +29 -18
- package/dist/esm/api/resources/assets/client/Client.d.mts +14 -14
- package/dist/esm/api/resources/assets/client/Client.mjs +60 -33
- package/dist/esm/api/resources/assets/client/index.d.mts +0 -1
- package/dist/esm/api/resources/assets/client/index.mjs +0 -1
- package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.d.mts +1 -1
- package/dist/esm/api/resources/assets/client/requests/CreateAssetRequestIn.mjs +1 -1
- package/dist/esm/api/resources/assets/client/requests/index.d.mts +3 -3
- package/dist/esm/api/resources/assets/client/requests/index.mjs +1 -3
- package/dist/esm/api/resources/databases/client/Client.d.mts +36 -32
- package/dist/esm/api/resources/databases/client/Client.mjs +147 -79
- package/dist/esm/api/resources/databases/client/index.d.mts +0 -1
- package/dist/esm/api/resources/databases/client/index.mjs +0 -1
- package/dist/esm/api/resources/databases/client/requests/DatabasesDeleteRequest.d.mts +15 -0
- package/dist/esm/api/resources/databases/client/requests/DatabasesDeleteRequest.mjs +2 -0
- package/dist/esm/api/resources/databases/client/requests/UpdateDataRequest.d.mts +3 -0
- package/dist/esm/api/resources/databases/client/requests/index.d.mts +4 -3
- package/dist/esm/api/resources/databases/client/requests/index.mjs +1 -3
- package/dist/esm/api/resources/index.d.mts +8 -8
- package/dist/esm/api/resources/index.mjs +8 -8
- package/dist/esm/api/resources/query/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/query/client/Client.mjs +32 -21
- package/dist/esm/api/resources/query/client/index.d.mts +0 -1
- package/dist/esm/api/resources/query/client/index.mjs +0 -1
- package/dist/esm/api/resources/query/client/requests/QueryExecuteRequest.d.mts +1 -1
- package/dist/esm/api/resources/query/client/requests/QueryExecuteRequest.mjs +1 -1
- package/dist/esm/api/resources/query/client/requests/index.d.mts +2 -2
- package/dist/esm/api/resources/query/client/requests/index.mjs +1 -2
- package/dist/esm/api/resources/query/index.d.mts +1 -1
- package/dist/esm/api/resources/query/index.mjs +1 -1
- package/dist/esm/api/resources/threads/client/Client.d.mts +8 -8
- package/dist/esm/api/resources/threads/client/Client.mjs +23 -20
- package/dist/esm/api/resources/tools/client/Client.d.mts +33 -33
- package/dist/esm/api/resources/tools/client/Client.mjs +109 -59
- package/dist/esm/api/resources/tools/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/client/requests/BodySaveAssetApiV0ToolsFileSavePost.d.mts +2 -2
- package/dist/esm/api/resources/tools/client/requests/BodySaveAssetApiV0ToolsFileSavePost.mjs +1 -2
- package/dist/esm/api/resources/tools/client/requests/ToolsDataFrameRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/client/requests/ToolsDataFrameRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/client/requests/index.d.mts +7 -7
- package/dist/esm/api/resources/tools/client/requests/index.mjs +1 -7
- package/dist/esm/api/resources/tools/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/calendar/client/Client.d.mts +9 -9
- package/dist/esm/api/resources/tools/resources/calendar/client/Client.mjs +28 -17
- package/dist/esm/api/resources/tools/resources/email/client/Client.d.mts +11 -11
- package/dist/esm/api/resources/tools/resources/email/client/Client.mjs +39 -20
- package/dist/esm/api/resources/tools/resources/index.d.mts +3 -3
- package/dist/esm/api/resources/tools/resources/index.mjs +3 -3
- package/dist/esm/api/resources/tools/resources/sheets/client/Client.d.mts +39 -39
- package/dist/esm/api/resources/tools/resources/sheets/client/Client.mjs +194 -63
- package/dist/esm/api/resources/tools/resources/sheets/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/CreateNewSheetTabRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/CreateNewSheetTabRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/FormatSheetRangeRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/FormatSheetRangeRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/InsertTableRowRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/InsertTableRowRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/UpdateSheetRangeRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/UpdateSheetRangeRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/index.d.mts +17 -17
- package/dist/esm/api/resources/tools/resources/sheets/client/requests/index.mjs +1 -17
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/Client.mjs +18 -15
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/StructuredDataExtractorRequest.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/StructuredDataExtractorRequest.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/structuredDataExtractor/client/requests/index.mjs +1 -1
- package/dist/esm/api/resources/tools/resources/tasks/client/Client.d.mts +7 -7
- package/dist/esm/api/resources/tools/resources/tasks/client/Client.mjs +18 -15
- package/dist/esm/api/resources/tools/resources/tasks/client/index.d.mts +0 -1
- package/dist/esm/api/resources/tools/resources/tasks/client/index.mjs +0 -1
- package/dist/esm/api/resources/tools/resources/tasks/client/requests/index.d.mts +1 -1
- package/dist/esm/api/resources/tools/resources/tasks/client/requests/index.mjs +1 -1
- package/dist/esm/api/types/AopExecuteResponseOut.d.mts +1 -1
- package/dist/esm/api/types/AopExecuteResponseOut.mjs +1 -1
- package/dist/esm/api/types/AssetNode.d.mts +1 -1
- package/dist/esm/api/types/AssetNode.mjs +1 -1
- package/dist/esm/api/types/BorderModel.d.mts +1 -1
- package/dist/esm/api/types/BorderModel.mjs +1 -1
- package/dist/esm/api/types/BordersModel.d.mts +1 -1
- package/dist/esm/api/types/BordersModel.mjs +1 -1
- package/dist/esm/api/types/CellFormat.d.mts +1 -1
- package/dist/esm/api/types/CellFormat.mjs +0 -1
- package/dist/esm/api/types/Chunk.d.mts +1 -1
- package/dist/esm/api/types/Chunk.mjs +1 -1
- package/dist/esm/api/types/ChunkContentItem.d.mts +1 -1
- package/dist/esm/api/types/ChunkContentItem.mjs +1 -1
- package/dist/esm/api/types/ConversationAssetInfo.d.mts +1 -1
- package/dist/esm/api/types/ConversationAssetInfo.mjs +1 -1
- package/dist/esm/api/types/ConversationMessage.d.mts +1 -1
- package/dist/esm/api/types/ConversationMessage.mjs +1 -1
- package/dist/esm/api/types/ConversationResult.d.mts +1 -1
- package/dist/esm/api/types/ConversationResult.mjs +1 -1
- package/dist/esm/api/types/DatabaseTableSchemaResponse.d.mts +1 -1
- package/dist/esm/api/types/DatabaseTableSchemaResponse.mjs +1 -1
- package/dist/esm/api/types/DatabaseTablesResponse.d.mts +1 -1
- package/dist/esm/api/types/DatabaseTablesResponse.mjs +1 -1
- package/dist/esm/api/types/FolderResponse.d.mts +1 -1
- package/dist/esm/api/types/FolderResponse.mjs +1 -1
- package/dist/esm/api/types/GeneralAgentRequest.d.mts +1 -1
- package/dist/esm/api/types/GeneralAgentRequest.mjs +1 -1
- package/dist/esm/api/types/GeneralAgentResponse.d.mts +1 -1
- package/dist/esm/api/types/GeneralAgentResponse.mjs +1 -1
- package/dist/esm/api/types/GeneralAgentResponseMessage.d.mts +1 -1
- package/dist/esm/api/types/GeneralAgentResponseMessage.mjs +1 -1
- package/dist/esm/api/types/GeneralAgentResponseMessageKwargs.d.mts +1 -1
- package/dist/esm/api/types/GeneralAgentResponseMessageKwargs.mjs +1 -1
- package/dist/esm/api/types/InputMessage.d.mts +1 -1
- package/dist/esm/api/types/InputMessage.mjs +1 -1
- package/dist/esm/api/types/InputMessageContentItem.d.mts +1 -1
- package/dist/esm/api/types/InputMessageContentItem.mjs +1 -1
- package/dist/esm/api/types/NumberFormatModel.d.mts +1 -1
- package/dist/esm/api/types/NumberFormatModel.mjs +1 -1
- package/dist/esm/api/types/PaginatedAssetsOut.d.mts +1 -1
- package/dist/esm/api/types/PaginatedAssetsOut.mjs +1 -1
- package/dist/esm/api/types/Sheet.d.mts +1 -1
- package/dist/esm/api/types/Sheet.mjs +1 -1
- package/dist/esm/api/types/StructuredDataExtractorResponse.d.mts +1 -1
- package/dist/esm/api/types/StructuredDataExtractorResponse.mjs +1 -1
- package/dist/esm/api/types/TextFormatModel.d.mts +1 -1
- package/dist/esm/api/types/TextFormatModel.mjs +1 -1
- package/dist/esm/api/types/ThreadStatusResponseOut.d.mts +1 -1
- package/dist/esm/api/types/ThreadStatusResponseOut.mjs +1 -1
- package/dist/esm/api/types/index.d.mts +5 -5
- package/dist/esm/api/types/index.mjs +5 -5
- package/dist/esm/auth/HeaderAuthProvider.d.mts +14 -0
- package/dist/esm/auth/HeaderAuthProvider.mjs +34 -0
- package/dist/esm/auth/index.d.mts +1 -0
- package/dist/esm/auth/index.mjs +1 -0
- package/dist/esm/core/auth/AuthProvider.d.mts +7 -0
- package/dist/esm/core/auth/AuthProvider.mjs +1 -0
- package/dist/esm/core/auth/AuthRequest.d.mts +9 -0
- package/dist/esm/core/auth/AuthRequest.mjs +1 -0
- package/dist/esm/core/auth/BasicAuth.d.mts +8 -0
- package/dist/esm/core/auth/BasicAuth.mjs +24 -0
- package/dist/esm/core/auth/BearerToken.d.mts +7 -0
- package/dist/esm/core/auth/BearerToken.mjs +13 -0
- package/dist/esm/core/auth/NoOpAuthProvider.d.mts +5 -0
- package/dist/esm/core/auth/NoOpAuthProvider.mjs +5 -0
- package/dist/esm/core/auth/index.d.mts +5 -0
- package/dist/esm/core/auth/index.mjs +3 -0
- package/dist/esm/core/base64.d.mts +2 -0
- package/dist/esm/core/base64.mjs +22 -0
- package/dist/esm/core/exports.d.mts +1 -0
- package/dist/esm/core/exports.mjs +1 -0
- package/dist/esm/core/fetcher/BinaryResponse.d.mts +6 -7
- package/dist/esm/core/fetcher/EndpointSupplier.d.mts +1 -1
- package/dist/esm/core/fetcher/EndpointSupplier.mjs +0 -1
- package/dist/esm/core/fetcher/Fetcher.d.mts +9 -2
- package/dist/esm/core/fetcher/Fetcher.mjs +204 -9
- package/dist/esm/core/fetcher/getErrorResponseBody.mjs +2 -1
- package/dist/esm/core/fetcher/getRequestBody.d.mts +1 -1
- package/dist/esm/core/fetcher/getRequestBody.mjs +4 -0
- package/dist/esm/core/fetcher/getResponseBody.mjs +21 -7
- package/dist/esm/core/fetcher/makeRequest.d.mts +1 -1
- package/dist/esm/core/fetcher/makeRequest.mjs +2 -4
- package/dist/esm/core/fetcher/requestWithRetries.mjs +3 -12
- package/dist/esm/core/fetcher/signals.d.mts +1 -7
- package/dist/esm/core/fetcher/signals.mjs +0 -12
- package/dist/esm/core/file/file.d.mts +5 -0
- package/dist/esm/core/file/file.mjs +24 -7
- package/dist/esm/core/form-data-utils/FormDataWrapper.d.mts +2 -3
- package/dist/esm/core/form-data-utils/FormDataWrapper.mjs +59 -82
- package/dist/esm/core/headers.mjs +6 -4
- package/dist/esm/core/index.d.mts +5 -2
- package/dist/esm/core/index.mjs +5 -2
- package/dist/esm/core/logging/exports.d.mts +18 -0
- package/dist/esm/core/logging/exports.mjs +9 -0
- package/dist/esm/core/logging/index.d.mts +1 -0
- package/dist/esm/core/logging/index.mjs +1 -0
- package/dist/esm/core/logging/logger.d.mts +126 -0
- package/dist/esm/core/logging/logger.mjs +138 -0
- package/dist/esm/core/runtime/runtime.mjs +11 -10
- package/dist/esm/core/url/encodePathParam.d.mts +1 -0
- package/dist/esm/core/url/encodePathParam.mjs +18 -0
- package/dist/esm/core/url/index.d.mts +1 -0
- package/dist/esm/core/url/index.mjs +1 -0
- package/dist/esm/core/url/join.mjs +3 -4
- package/dist/esm/errors/AthenaIntelligenceError.d.mts +1 -1
- package/dist/esm/errors/AthenaIntelligenceError.mjs +1 -2
- package/dist/esm/index.d.mts +2 -2
- package/dist/esm/index.mjs +1 -2
- package/dist/esm/version.d.mts +1 -1
- package/dist/esm/version.mjs +1 -1
- package/package.json +11 -5
- package/reference.md +455 -491
- package/dist/cjs/core/fetcher/ResponseWithBody.d.ts +0 -4
- package/dist/cjs/core/fetcher/ResponseWithBody.js +0 -6
- package/dist/esm/core/fetcher/ResponseWithBody.d.mts +0 -4
- package/dist/esm/core/fetcher/ResponseWithBody.mjs +0 -3
package/reference.md
CHANGED
|
@@ -1,8 +1,6 @@
|
|
|
1
1
|
# Reference
|
|
2
|
-
|
|
3
2
|
## Agents
|
|
4
|
-
|
|
5
|
-
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">invokeById</a>(agentId, { ...params }) -> AthenaIntelligence.CustomAgentResponse</code></summary>
|
|
3
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">invokeById</a>(agent_id, { ...params }) -> AthenaIntelligence.CustomAgentResponse</code></summary>
|
|
6
4
|
<dl>
|
|
7
5
|
<dd>
|
|
8
6
|
|
|
@@ -21,7 +19,6 @@ Invoke a custom agent created in [spaces](https://resources.athenaintel.com/docs
|
|
|
21
19
|
Custom agents can be created and configured in spaces to perform specialized tasks.
|
|
22
20
|
Refer to the specific agent's documentation for details on configuration options
|
|
23
21
|
and expected responses.
|
|
24
|
-
|
|
25
22
|
</dd>
|
|
26
23
|
</dl>
|
|
27
24
|
</dd>
|
|
@@ -38,16 +35,14 @@ and expected responses.
|
|
|
38
35
|
```typescript
|
|
39
36
|
await client.agents.invokeById("agent_id", {
|
|
40
37
|
config: {
|
|
41
|
-
key: "value"
|
|
38
|
+
"key": "value"
|
|
42
39
|
},
|
|
43
|
-
messages: [
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
},
|
|
47
|
-
],
|
|
40
|
+
messages: [{
|
|
41
|
+
"key": "value"
|
|
42
|
+
}]
|
|
48
43
|
});
|
|
49
|
-
```
|
|
50
44
|
|
|
45
|
+
```
|
|
51
46
|
</dd>
|
|
52
47
|
</dl>
|
|
53
48
|
</dd>
|
|
@@ -61,35 +56,35 @@ await client.agents.invokeById("agent_id", {
|
|
|
61
56
|
<dl>
|
|
62
57
|
<dd>
|
|
63
58
|
|
|
64
|
-
**
|
|
65
|
-
|
|
59
|
+
**agent_id:** `string` — The ID of the custom agent to invoke. Create custom agents in [spaces](https://resources.athenaintel.com/docs/agents/create-your-agent).
|
|
60
|
+
|
|
66
61
|
</dd>
|
|
67
62
|
</dl>
|
|
68
63
|
|
|
69
64
|
<dl>
|
|
70
65
|
<dd>
|
|
71
66
|
|
|
72
|
-
**request:** `AthenaIntelligence.CustomAgentRequest`
|
|
73
|
-
|
|
67
|
+
**request:** `AthenaIntelligence.CustomAgentRequest`
|
|
68
|
+
|
|
74
69
|
</dd>
|
|
75
70
|
</dl>
|
|
76
71
|
|
|
77
72
|
<dl>
|
|
78
73
|
<dd>
|
|
79
74
|
|
|
80
|
-
**requestOptions:** `
|
|
81
|
-
|
|
75
|
+
**requestOptions:** `AgentsClient.RequestOptions`
|
|
76
|
+
|
|
82
77
|
</dd>
|
|
83
78
|
</dl>
|
|
84
79
|
</dd>
|
|
85
80
|
</dl>
|
|
86
81
|
|
|
82
|
+
|
|
87
83
|
</dd>
|
|
88
84
|
</dl>
|
|
89
85
|
</details>
|
|
90
86
|
|
|
91
87
|
## Aop
|
|
92
|
-
|
|
93
88
|
<details><summary><code>client.aop.<a href="/src/api/resources/aop/client/Client.ts">execute</a>({ ...params }) -> AthenaIntelligence.AopExecuteResponseOut</code></summary>
|
|
94
89
|
<dl>
|
|
95
90
|
<dd>
|
|
@@ -103,7 +98,6 @@ await client.agents.invokeById("agent_id", {
|
|
|
103
98
|
<dd>
|
|
104
99
|
|
|
105
100
|
DEPRECATED: This endpoint is deprecated. Please use /aop/execute-async instead for better performance and reliability. Execute an existing Agent Operating Procedure (AOP) asset with optional user inputs. AOPs are pre-configured AI workflows that can perform complex tasks like research, analysis, and content generation.
|
|
106
|
-
|
|
107
101
|
</dd>
|
|
108
102
|
</dl>
|
|
109
103
|
</dd>
|
|
@@ -121,12 +115,12 @@ DEPRECATED: This endpoint is deprecated. Please use /aop/execute-async instead f
|
|
|
121
115
|
await client.aop.execute({
|
|
122
116
|
asset_id: "asset_9249292-d118-42d3-95b4-00eccfe0754f",
|
|
123
117
|
user_inputs: {
|
|
124
|
-
company: "Acme Corp",
|
|
125
|
-
quarter: "Q1 2024"
|
|
126
|
-
}
|
|
118
|
+
"company": "Acme Corp",
|
|
119
|
+
"quarter": "Q1 2024"
|
|
120
|
+
}
|
|
127
121
|
});
|
|
128
|
-
```
|
|
129
122
|
|
|
123
|
+
```
|
|
130
124
|
</dd>
|
|
131
125
|
</dl>
|
|
132
126
|
</dd>
|
|
@@ -140,21 +134,22 @@ await client.aop.execute({
|
|
|
140
134
|
<dl>
|
|
141
135
|
<dd>
|
|
142
136
|
|
|
143
|
-
**request:** `AthenaIntelligence.AopExecuteRequestIn`
|
|
144
|
-
|
|
137
|
+
**request:** `AthenaIntelligence.AopExecuteRequestIn`
|
|
138
|
+
|
|
145
139
|
</dd>
|
|
146
140
|
</dl>
|
|
147
141
|
|
|
148
142
|
<dl>
|
|
149
143
|
<dd>
|
|
150
144
|
|
|
151
|
-
**requestOptions:** `
|
|
152
|
-
|
|
145
|
+
**requestOptions:** `AopClient.RequestOptions`
|
|
146
|
+
|
|
153
147
|
</dd>
|
|
154
148
|
</dl>
|
|
155
149
|
</dd>
|
|
156
150
|
</dl>
|
|
157
151
|
|
|
152
|
+
|
|
158
153
|
</dd>
|
|
159
154
|
</dl>
|
|
160
155
|
</details>
|
|
@@ -172,7 +167,6 @@ await client.aop.execute({
|
|
|
172
167
|
<dd>
|
|
173
168
|
|
|
174
169
|
Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Returns immediately with a thread_id for tracking execution progress without waiting for completion.
|
|
175
|
-
|
|
176
170
|
</dd>
|
|
177
171
|
</dl>
|
|
178
172
|
</dd>
|
|
@@ -190,12 +184,12 @@ Start execution of an Agent Operating Procedure (AOP) asset asynchronously. Retu
|
|
|
190
184
|
await client.aop.executeAsync({
|
|
191
185
|
asset_id: "asset_9249292-d118-42d3-95b4-00eccfe0754f",
|
|
192
186
|
user_inputs: {
|
|
193
|
-
company: "Acme Corp",
|
|
194
|
-
quarter: "Q1 2024"
|
|
195
|
-
}
|
|
187
|
+
"company": "Acme Corp",
|
|
188
|
+
"quarter": "Q1 2024"
|
|
189
|
+
}
|
|
196
190
|
});
|
|
197
|
-
```
|
|
198
191
|
|
|
192
|
+
```
|
|
199
193
|
</dd>
|
|
200
194
|
</dl>
|
|
201
195
|
</dd>
|
|
@@ -209,27 +203,27 @@ await client.aop.executeAsync({
|
|
|
209
203
|
<dl>
|
|
210
204
|
<dd>
|
|
211
205
|
|
|
212
|
-
**request:** `AthenaIntelligence.AopExecuteRequestIn`
|
|
213
|
-
|
|
206
|
+
**request:** `AthenaIntelligence.AopExecuteRequestIn`
|
|
207
|
+
|
|
214
208
|
</dd>
|
|
215
209
|
</dl>
|
|
216
210
|
|
|
217
211
|
<dl>
|
|
218
212
|
<dd>
|
|
219
213
|
|
|
220
|
-
**requestOptions:** `
|
|
221
|
-
|
|
214
|
+
**requestOptions:** `AopClient.RequestOptions`
|
|
215
|
+
|
|
222
216
|
</dd>
|
|
223
217
|
</dl>
|
|
224
218
|
</dd>
|
|
225
219
|
</dl>
|
|
226
220
|
|
|
221
|
+
|
|
227
222
|
</dd>
|
|
228
223
|
</dl>
|
|
229
224
|
</details>
|
|
230
225
|
|
|
231
226
|
## Assets
|
|
232
|
-
|
|
233
227
|
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">list</a>({ ...params }) -> AthenaIntelligence.PaginatedAssetsOut</code></summary>
|
|
234
228
|
<dl>
|
|
235
229
|
<dd>
|
|
@@ -243,7 +237,6 @@ await client.aop.executeAsync({
|
|
|
243
237
|
<dd>
|
|
244
238
|
|
|
245
239
|
Retrieve a paginated list of assets with optional filtering and sorting. Assets include documents, presentations, spreadsheets, images, videos, and other file types managed by Athena Intelligence.
|
|
246
|
-
|
|
247
240
|
</dd>
|
|
248
241
|
</dl>
|
|
249
242
|
</dd>
|
|
@@ -262,10 +255,10 @@ await client.assets.list({
|
|
|
262
255
|
limit: 1,
|
|
263
256
|
offset: 1,
|
|
264
257
|
filters: "filters",
|
|
265
|
-
sort: "sort"
|
|
258
|
+
sort: "sort"
|
|
266
259
|
});
|
|
267
|
-
```
|
|
268
260
|
|
|
261
|
+
```
|
|
269
262
|
</dd>
|
|
270
263
|
</dl>
|
|
271
264
|
</dd>
|
|
@@ -279,21 +272,22 @@ await client.assets.list({
|
|
|
279
272
|
<dl>
|
|
280
273
|
<dd>
|
|
281
274
|
|
|
282
|
-
**request:** `AthenaIntelligence.AssetsListRequest`
|
|
283
|
-
|
|
275
|
+
**request:** `AthenaIntelligence.AssetsListRequest`
|
|
276
|
+
|
|
284
277
|
</dd>
|
|
285
278
|
</dl>
|
|
286
279
|
|
|
287
280
|
<dl>
|
|
288
281
|
<dd>
|
|
289
282
|
|
|
290
|
-
**requestOptions:** `
|
|
291
|
-
|
|
283
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
284
|
+
|
|
292
285
|
</dd>
|
|
293
286
|
</dl>
|
|
294
287
|
</dd>
|
|
295
288
|
</dl>
|
|
296
289
|
|
|
290
|
+
|
|
297
291
|
</dd>
|
|
298
292
|
</dl>
|
|
299
293
|
</details>
|
|
@@ -311,7 +305,6 @@ await client.assets.list({
|
|
|
311
305
|
<dd>
|
|
312
306
|
|
|
313
307
|
Create a new asset such as a spreadsheet, document, or folder in your workspace. This endpoint uses internal GraphQL mutations to create assets with proper permissions and workspace integration.
|
|
314
|
-
|
|
315
308
|
</dd>
|
|
316
309
|
</dl>
|
|
317
310
|
</dd>
|
|
@@ -329,10 +322,10 @@ Create a new asset such as a spreadsheet, document, or folder in your workspace.
|
|
|
329
322
|
await client.assets.create({
|
|
330
323
|
asset_type: "spreadsheet",
|
|
331
324
|
parent_folder_id: "asset_folder_12345",
|
|
332
|
-
title: "My New Spreadsheet"
|
|
325
|
+
title: "My New Spreadsheet"
|
|
333
326
|
});
|
|
334
|
-
```
|
|
335
327
|
|
|
328
|
+
```
|
|
336
329
|
</dd>
|
|
337
330
|
</dl>
|
|
338
331
|
</dd>
|
|
@@ -346,21 +339,22 @@ await client.assets.create({
|
|
|
346
339
|
<dl>
|
|
347
340
|
<dd>
|
|
348
341
|
|
|
349
|
-
**request:** `AthenaIntelligence.CreateAssetRequestIn`
|
|
350
|
-
|
|
342
|
+
**request:** `AthenaIntelligence.CreateAssetRequestIn`
|
|
343
|
+
|
|
351
344
|
</dd>
|
|
352
345
|
</dl>
|
|
353
346
|
|
|
354
347
|
<dl>
|
|
355
348
|
<dd>
|
|
356
349
|
|
|
357
|
-
**requestOptions:** `
|
|
358
|
-
|
|
350
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
351
|
+
|
|
359
352
|
</dd>
|
|
360
353
|
</dl>
|
|
361
354
|
</dd>
|
|
362
355
|
</dl>
|
|
363
356
|
|
|
357
|
+
|
|
364
358
|
</dd>
|
|
365
359
|
</dl>
|
|
366
360
|
</details>
|
|
@@ -378,7 +372,6 @@ await client.assets.create({
|
|
|
378
372
|
<dd>
|
|
379
373
|
|
|
380
374
|
Create a new project with custom metadata. Projects can be typed (e.g., 'candidate', 'user', 'company') and include flexible custom metadata for storing additional information.
|
|
381
|
-
|
|
382
375
|
</dd>
|
|
383
376
|
</dl>
|
|
384
377
|
</dd>
|
|
@@ -395,20 +388,20 @@ Create a new project with custom metadata. Projects can be typed (e.g., 'candida
|
|
|
395
388
|
```typescript
|
|
396
389
|
await client.assets.createProject({
|
|
397
390
|
custom_metadata: {
|
|
398
|
-
email: "john.doe@example.com",
|
|
399
|
-
phone: "+1-555-0123",
|
|
400
|
-
source: "linkedin",
|
|
401
|
-
status: "active"
|
|
391
|
+
"email": "john.doe@example.com",
|
|
392
|
+
"phone": "+1-555-0123",
|
|
393
|
+
"source": "linkedin",
|
|
394
|
+
"status": "active"
|
|
402
395
|
},
|
|
403
396
|
description: "Candidate profile for senior software engineer position",
|
|
404
397
|
parent_folder_id: "asset_folder_123",
|
|
405
398
|
project_type: "candidate",
|
|
406
399
|
share_with_emails: ["colleague@example.com", "manager@example.com"],
|
|
407
400
|
tags: ["engineering", "senior", "active"],
|
|
408
|
-
title: "John Doe - Software Engineer"
|
|
401
|
+
title: "John Doe - Software Engineer"
|
|
409
402
|
});
|
|
410
|
-
```
|
|
411
403
|
|
|
404
|
+
```
|
|
412
405
|
</dd>
|
|
413
406
|
</dl>
|
|
414
407
|
</dd>
|
|
@@ -422,26 +415,27 @@ await client.assets.createProject({
|
|
|
422
415
|
<dl>
|
|
423
416
|
<dd>
|
|
424
417
|
|
|
425
|
-
**request:** `AthenaIntelligence.CreateProjectRequestIn`
|
|
426
|
-
|
|
418
|
+
**request:** `AthenaIntelligence.CreateProjectRequestIn`
|
|
419
|
+
|
|
427
420
|
</dd>
|
|
428
421
|
</dl>
|
|
429
422
|
|
|
430
423
|
<dl>
|
|
431
424
|
<dd>
|
|
432
425
|
|
|
433
|
-
**requestOptions:** `
|
|
434
|
-
|
|
426
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
427
|
+
|
|
435
428
|
</dd>
|
|
436
429
|
</dl>
|
|
437
430
|
</dd>
|
|
438
431
|
</dl>
|
|
439
432
|
|
|
433
|
+
|
|
440
434
|
</dd>
|
|
441
435
|
</dl>
|
|
442
436
|
</details>
|
|
443
437
|
|
|
444
|
-
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(
|
|
438
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">get</a>(asset_id) -> AthenaIntelligence.PublicAssetOut</code></summary>
|
|
445
439
|
<dl>
|
|
446
440
|
<dd>
|
|
447
441
|
|
|
@@ -454,7 +448,6 @@ await client.assets.createProject({
|
|
|
454
448
|
<dd>
|
|
455
449
|
|
|
456
450
|
Retrieve a single asset by its ID. Returns comprehensive metadata including creation info, tags, timestamps, media type, and AI-generated summary.
|
|
457
|
-
|
|
458
451
|
</dd>
|
|
459
452
|
</dl>
|
|
460
453
|
</dd>
|
|
@@ -470,8 +463,8 @@ Retrieve a single asset by its ID. Returns comprehensive metadata including crea
|
|
|
470
463
|
|
|
471
464
|
```typescript
|
|
472
465
|
await client.assets.get("asset_id");
|
|
473
|
-
```
|
|
474
466
|
|
|
467
|
+
```
|
|
475
468
|
</dd>
|
|
476
469
|
</dl>
|
|
477
470
|
</dd>
|
|
@@ -485,28 +478,28 @@ await client.assets.get("asset_id");
|
|
|
485
478
|
<dl>
|
|
486
479
|
<dd>
|
|
487
480
|
|
|
488
|
-
**
|
|
489
|
-
|
|
481
|
+
**asset_id:** `string`
|
|
482
|
+
|
|
490
483
|
</dd>
|
|
491
484
|
</dl>
|
|
492
485
|
|
|
493
486
|
<dl>
|
|
494
487
|
<dd>
|
|
495
488
|
|
|
496
|
-
**requestOptions:** `
|
|
497
|
-
|
|
489
|
+
**requestOptions:** `AssetsClient.RequestOptions`
|
|
490
|
+
|
|
498
491
|
</dd>
|
|
499
492
|
</dl>
|
|
500
493
|
</dd>
|
|
501
494
|
</dl>
|
|
502
495
|
|
|
496
|
+
|
|
503
497
|
</dd>
|
|
504
498
|
</dl>
|
|
505
499
|
</details>
|
|
506
500
|
|
|
507
501
|
## Databases
|
|
508
|
-
|
|
509
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">listTables</a>(assetId) -> AthenaIntelligence.DatabaseTablesResponse</code></summary>
|
|
502
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">listTables</a>(asset_id) -> AthenaIntelligence.DatabaseTablesResponse</code></summary>
|
|
510
503
|
<dl>
|
|
511
504
|
<dd>
|
|
512
505
|
|
|
@@ -519,7 +512,6 @@ await client.assets.get("asset_id");
|
|
|
519
512
|
<dd>
|
|
520
513
|
|
|
521
514
|
Get a list of all tables in the database with optional row counts.
|
|
522
|
-
|
|
523
515
|
</dd>
|
|
524
516
|
</dl>
|
|
525
517
|
</dd>
|
|
@@ -535,8 +527,8 @@ Get a list of all tables in the database with optional row counts.
|
|
|
535
527
|
|
|
536
528
|
```typescript
|
|
537
529
|
await client.databases.listTables("asset_id");
|
|
538
|
-
```
|
|
539
530
|
|
|
531
|
+
```
|
|
540
532
|
</dd>
|
|
541
533
|
</dl>
|
|
542
534
|
</dd>
|
|
@@ -550,26 +542,27 @@ await client.databases.listTables("asset_id");
|
|
|
550
542
|
<dl>
|
|
551
543
|
<dd>
|
|
552
544
|
|
|
553
|
-
**
|
|
554
|
-
|
|
545
|
+
**asset_id:** `string`
|
|
546
|
+
|
|
555
547
|
</dd>
|
|
556
548
|
</dl>
|
|
557
549
|
|
|
558
550
|
<dl>
|
|
559
551
|
<dd>
|
|
560
552
|
|
|
561
|
-
**requestOptions:** `
|
|
562
|
-
|
|
553
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
554
|
+
|
|
563
555
|
</dd>
|
|
564
556
|
</dl>
|
|
565
557
|
</dd>
|
|
566
558
|
</dl>
|
|
567
559
|
|
|
560
|
+
|
|
568
561
|
</dd>
|
|
569
562
|
</dl>
|
|
570
563
|
</details>
|
|
571
564
|
|
|
572
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">select</a>(
|
|
565
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">select</a>(asset_id, table_name, { ...params }) -> AthenaIntelligence.DatabaseDataResponse</code></summary>
|
|
573
566
|
<dl>
|
|
574
567
|
<dd>
|
|
575
568
|
|
|
@@ -584,7 +577,6 @@ await client.databases.listTables("asset_id");
|
|
|
584
577
|
Query rows from a table in the database. Supports filtering, ordering, and pagination using PostgREST-style query parameters.
|
|
585
578
|
|
|
586
579
|
**Filter Syntax:**
|
|
587
|
-
|
|
588
580
|
- `?column=eq.value` - Equal
|
|
589
581
|
- `?column=neq.value` - Not equal
|
|
590
582
|
- `?column=gt.value` - Greater than
|
|
@@ -595,10 +587,10 @@ Query rows from a table in the database. Supports filtering, ordering, and pagin
|
|
|
595
587
|
- `?column=ilike.*pattern*` - ILIKE (case-insensitive)
|
|
596
588
|
- `?column=in.(a,b,c)` - IN list
|
|
597
589
|
- `?column=is.null` - IS NULL
|
|
598
|
-
|
|
599
|
-
|
|
600
|
-
|
|
601
|
-
|
|
590
|
+
</dd>
|
|
591
|
+
</dl>
|
|
592
|
+
</dd>
|
|
593
|
+
</dl>
|
|
602
594
|
|
|
603
595
|
#### 🔌 Usage
|
|
604
596
|
|
|
@@ -613,10 +605,10 @@ await client.databases.select("asset_id", "table_name", {
|
|
|
613
605
|
select: "select",
|
|
614
606
|
order: "order",
|
|
615
607
|
limit: 1,
|
|
616
|
-
offset: 1
|
|
608
|
+
offset: 1
|
|
617
609
|
});
|
|
618
|
-
```
|
|
619
610
|
|
|
611
|
+
```
|
|
620
612
|
</dd>
|
|
621
613
|
</dl>
|
|
622
614
|
</dd>
|
|
@@ -630,42 +622,43 @@ await client.databases.select("asset_id", "table_name", {
|
|
|
630
622
|
<dl>
|
|
631
623
|
<dd>
|
|
632
624
|
|
|
633
|
-
**
|
|
634
|
-
|
|
625
|
+
**asset_id:** `string`
|
|
626
|
+
|
|
635
627
|
</dd>
|
|
636
628
|
</dl>
|
|
637
629
|
|
|
638
630
|
<dl>
|
|
639
631
|
<dd>
|
|
640
632
|
|
|
641
|
-
**
|
|
642
|
-
|
|
633
|
+
**table_name:** `string`
|
|
634
|
+
|
|
643
635
|
</dd>
|
|
644
636
|
</dl>
|
|
645
637
|
|
|
646
638
|
<dl>
|
|
647
639
|
<dd>
|
|
648
640
|
|
|
649
|
-
**request:** `AthenaIntelligence.DatabasesSelectRequest`
|
|
650
|
-
|
|
641
|
+
**request:** `AthenaIntelligence.DatabasesSelectRequest`
|
|
642
|
+
|
|
651
643
|
</dd>
|
|
652
644
|
</dl>
|
|
653
645
|
|
|
654
646
|
<dl>
|
|
655
647
|
<dd>
|
|
656
648
|
|
|
657
|
-
**requestOptions:** `
|
|
658
|
-
|
|
649
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
650
|
+
|
|
659
651
|
</dd>
|
|
660
652
|
</dl>
|
|
661
653
|
</dd>
|
|
662
654
|
</dl>
|
|
663
655
|
|
|
656
|
+
|
|
664
657
|
</dd>
|
|
665
658
|
</dl>
|
|
666
659
|
</details>
|
|
667
660
|
|
|
668
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">insert</a>(
|
|
661
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">insert</a>(asset_id, table_name, { ...params }) -> AthenaIntelligence.DatabaseMutationResponse</code></summary>
|
|
669
662
|
<dl>
|
|
670
663
|
<dd>
|
|
671
664
|
|
|
@@ -678,7 +671,6 @@ await client.databases.select("asset_id", "table_name", {
|
|
|
678
671
|
<dd>
|
|
679
672
|
|
|
680
673
|
Insert one or more rows into a table.
|
|
681
|
-
|
|
682
674
|
</dd>
|
|
683
675
|
</dl>
|
|
684
676
|
</dd>
|
|
@@ -695,13 +687,13 @@ Insert one or more rows into a table.
|
|
|
695
687
|
```typescript
|
|
696
688
|
await client.databases.insert("asset_id", "table_name", {
|
|
697
689
|
data: {
|
|
698
|
-
email: "alice@example.com",
|
|
699
|
-
name: "Alice"
|
|
690
|
+
"email": "alice@example.com",
|
|
691
|
+
"name": "Alice"
|
|
700
692
|
},
|
|
701
|
-
return_representation: true
|
|
693
|
+
return_representation: true
|
|
702
694
|
});
|
|
703
|
-
```
|
|
704
695
|
|
|
696
|
+
```
|
|
705
697
|
</dd>
|
|
706
698
|
</dl>
|
|
707
699
|
</dd>
|
|
@@ -715,42 +707,43 @@ await client.databases.insert("asset_id", "table_name", {
|
|
|
715
707
|
<dl>
|
|
716
708
|
<dd>
|
|
717
709
|
|
|
718
|
-
**
|
|
719
|
-
|
|
710
|
+
**asset_id:** `string`
|
|
711
|
+
|
|
720
712
|
</dd>
|
|
721
713
|
</dl>
|
|
722
714
|
|
|
723
715
|
<dl>
|
|
724
716
|
<dd>
|
|
725
717
|
|
|
726
|
-
**
|
|
727
|
-
|
|
718
|
+
**table_name:** `string`
|
|
719
|
+
|
|
728
720
|
</dd>
|
|
729
721
|
</dl>
|
|
730
722
|
|
|
731
723
|
<dl>
|
|
732
724
|
<dd>
|
|
733
725
|
|
|
734
|
-
**request:** `AthenaIntelligence.InsertDataRequest`
|
|
735
|
-
|
|
726
|
+
**request:** `AthenaIntelligence.InsertDataRequest`
|
|
727
|
+
|
|
736
728
|
</dd>
|
|
737
729
|
</dl>
|
|
738
730
|
|
|
739
731
|
<dl>
|
|
740
732
|
<dd>
|
|
741
733
|
|
|
742
|
-
**requestOptions:** `
|
|
743
|
-
|
|
734
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
735
|
+
|
|
744
736
|
</dd>
|
|
745
737
|
</dl>
|
|
746
738
|
</dd>
|
|
747
739
|
</dl>
|
|
748
740
|
|
|
741
|
+
|
|
749
742
|
</dd>
|
|
750
743
|
</dl>
|
|
751
744
|
</details>
|
|
752
745
|
|
|
753
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">delete</a>(
|
|
746
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">delete</a>(asset_id, table_name, { ...params }) -> AthenaIntelligence.DatabaseMutationResponse</code></summary>
|
|
754
747
|
<dl>
|
|
755
748
|
<dd>
|
|
756
749
|
|
|
@@ -764,8 +757,7 @@ await client.databases.insert("asset_id", "table_name", {
|
|
|
764
757
|
|
|
765
758
|
Delete rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax (e.g., `?id=eq.5`).
|
|
766
759
|
|
|
767
|
-
**
|
|
768
|
-
|
|
760
|
+
**Safety:** Filters are required by default to prevent accidental bulk deletes. To delete all rows intentionally, pass `?force=true`.
|
|
769
761
|
</dd>
|
|
770
762
|
</dl>
|
|
771
763
|
</dd>
|
|
@@ -781,10 +773,13 @@ Delete rows matching the filter conditions. Filter conditions are passed as quer
|
|
|
781
773
|
|
|
782
774
|
```typescript
|
|
783
775
|
await client.databases.delete("asset_id", "table_name", {
|
|
784
|
-
|
|
776
|
+
force: true,
|
|
777
|
+
body: {
|
|
778
|
+
return_representation: false
|
|
779
|
+
}
|
|
785
780
|
});
|
|
786
|
-
```
|
|
787
781
|
|
|
782
|
+
```
|
|
788
783
|
</dd>
|
|
789
784
|
</dl>
|
|
790
785
|
</dd>
|
|
@@ -798,42 +793,43 @@ await client.databases.delete("asset_id", "table_name", {
|
|
|
798
793
|
<dl>
|
|
799
794
|
<dd>
|
|
800
795
|
|
|
801
|
-
**
|
|
802
|
-
|
|
796
|
+
**asset_id:** `string`
|
|
797
|
+
|
|
803
798
|
</dd>
|
|
804
799
|
</dl>
|
|
805
800
|
|
|
806
801
|
<dl>
|
|
807
802
|
<dd>
|
|
808
803
|
|
|
809
|
-
**
|
|
810
|
-
|
|
804
|
+
**table_name:** `string`
|
|
805
|
+
|
|
811
806
|
</dd>
|
|
812
807
|
</dl>
|
|
813
808
|
|
|
814
809
|
<dl>
|
|
815
810
|
<dd>
|
|
816
811
|
|
|
817
|
-
**request:** `AthenaIntelligence.
|
|
818
|
-
|
|
812
|
+
**request:** `AthenaIntelligence.DatabasesDeleteRequest`
|
|
813
|
+
|
|
819
814
|
</dd>
|
|
820
815
|
</dl>
|
|
821
816
|
|
|
822
817
|
<dl>
|
|
823
818
|
<dd>
|
|
824
819
|
|
|
825
|
-
**requestOptions:** `
|
|
826
|
-
|
|
820
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
821
|
+
|
|
827
822
|
</dd>
|
|
828
823
|
</dl>
|
|
829
824
|
</dd>
|
|
830
825
|
</dl>
|
|
831
826
|
|
|
827
|
+
|
|
832
828
|
</dd>
|
|
833
829
|
</dl>
|
|
834
830
|
</details>
|
|
835
831
|
|
|
836
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">update</a>(
|
|
832
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">update</a>(asset_id, table_name, { ...params }) -> AthenaIntelligence.DatabaseMutationResponse</code></summary>
|
|
837
833
|
<dl>
|
|
838
834
|
<dd>
|
|
839
835
|
|
|
@@ -847,8 +843,7 @@ await client.databases.delete("asset_id", "table_name", {
|
|
|
847
843
|
|
|
848
844
|
Update rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax (e.g., `?id=eq.5`).
|
|
849
845
|
|
|
850
|
-
**
|
|
851
|
-
|
|
846
|
+
**Safety:** Filters are required by default to prevent accidental bulk updates. To update all rows intentionally, pass `?force=true`.
|
|
852
847
|
</dd>
|
|
853
848
|
</dl>
|
|
854
849
|
</dd>
|
|
@@ -864,14 +859,15 @@ Update rows matching the filter conditions. Filter conditions are passed as quer
|
|
|
864
859
|
|
|
865
860
|
```typescript
|
|
866
861
|
await client.databases.update("asset_id", "table_name", {
|
|
862
|
+
force: true,
|
|
867
863
|
data: {
|
|
868
|
-
email: "alice.smith@example.com",
|
|
869
|
-
name: "Alice Smith"
|
|
864
|
+
"email": "alice.smith@example.com",
|
|
865
|
+
"name": "Alice Smith"
|
|
870
866
|
},
|
|
871
|
-
return_representation: true
|
|
867
|
+
return_representation: true
|
|
872
868
|
});
|
|
873
|
-
```
|
|
874
869
|
|
|
870
|
+
```
|
|
875
871
|
</dd>
|
|
876
872
|
</dl>
|
|
877
873
|
</dd>
|
|
@@ -885,42 +881,43 @@ await client.databases.update("asset_id", "table_name", {
|
|
|
885
881
|
<dl>
|
|
886
882
|
<dd>
|
|
887
883
|
|
|
888
|
-
**
|
|
889
|
-
|
|
884
|
+
**asset_id:** `string`
|
|
885
|
+
|
|
890
886
|
</dd>
|
|
891
887
|
</dl>
|
|
892
888
|
|
|
893
889
|
<dl>
|
|
894
890
|
<dd>
|
|
895
891
|
|
|
896
|
-
**
|
|
897
|
-
|
|
892
|
+
**table_name:** `string`
|
|
893
|
+
|
|
898
894
|
</dd>
|
|
899
895
|
</dl>
|
|
900
896
|
|
|
901
897
|
<dl>
|
|
902
898
|
<dd>
|
|
903
899
|
|
|
904
|
-
**request:** `AthenaIntelligence.UpdateDataRequest`
|
|
905
|
-
|
|
900
|
+
**request:** `AthenaIntelligence.UpdateDataRequest`
|
|
901
|
+
|
|
906
902
|
</dd>
|
|
907
903
|
</dl>
|
|
908
904
|
|
|
909
905
|
<dl>
|
|
910
906
|
<dd>
|
|
911
907
|
|
|
912
|
-
**requestOptions:** `
|
|
913
|
-
|
|
908
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
909
|
+
|
|
914
910
|
</dd>
|
|
915
911
|
</dl>
|
|
916
912
|
</dd>
|
|
917
913
|
</dl>
|
|
918
914
|
|
|
915
|
+
|
|
919
916
|
</dd>
|
|
920
917
|
</dl>
|
|
921
918
|
</details>
|
|
922
919
|
|
|
923
|
-
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">getTableSchema</a>(
|
|
920
|
+
<details><summary><code>client.databases.<a href="/src/api/resources/databases/client/Client.ts">getTableSchema</a>(asset_id, table_name) -> AthenaIntelligence.DatabaseTableSchemaResponse</code></summary>
|
|
924
921
|
<dl>
|
|
925
922
|
<dd>
|
|
926
923
|
|
|
@@ -933,7 +930,6 @@ await client.databases.update("asset_id", "table_name", {
|
|
|
933
930
|
<dd>
|
|
934
931
|
|
|
935
932
|
Get the schema for a specific table, including column names, types, nullability, and default values. Useful for agent tooling and dynamic form generation.
|
|
936
|
-
|
|
937
933
|
</dd>
|
|
938
934
|
</dl>
|
|
939
935
|
</dd>
|
|
@@ -949,8 +945,8 @@ Get the schema for a specific table, including column names, types, nullability,
|
|
|
949
945
|
|
|
950
946
|
```typescript
|
|
951
947
|
await client.databases.getTableSchema("asset_id", "table_name");
|
|
952
|
-
```
|
|
953
948
|
|
|
949
|
+
```
|
|
954
950
|
</dd>
|
|
955
951
|
</dl>
|
|
956
952
|
</dd>
|
|
@@ -964,35 +960,35 @@ await client.databases.getTableSchema("asset_id", "table_name");
|
|
|
964
960
|
<dl>
|
|
965
961
|
<dd>
|
|
966
962
|
|
|
967
|
-
**
|
|
968
|
-
|
|
963
|
+
**asset_id:** `string`
|
|
964
|
+
|
|
969
965
|
</dd>
|
|
970
966
|
</dl>
|
|
971
967
|
|
|
972
968
|
<dl>
|
|
973
969
|
<dd>
|
|
974
970
|
|
|
975
|
-
**
|
|
976
|
-
|
|
971
|
+
**table_name:** `string`
|
|
972
|
+
|
|
977
973
|
</dd>
|
|
978
974
|
</dl>
|
|
979
975
|
|
|
980
976
|
<dl>
|
|
981
977
|
<dd>
|
|
982
978
|
|
|
983
|
-
**requestOptions:** `
|
|
984
|
-
|
|
979
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
980
|
+
|
|
985
981
|
</dd>
|
|
986
982
|
</dl>
|
|
987
983
|
</dd>
|
|
988
984
|
</dl>
|
|
989
985
|
|
|
986
|
+
|
|
990
987
|
</dd>
|
|
991
988
|
</dl>
|
|
992
989
|
</details>
|
|
993
990
|
|
|
994
991
|
## Query
|
|
995
|
-
|
|
996
992
|
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">execute</a>({ ...params }) -> AthenaIntelligence.DataFrameRequestOut</code></summary>
|
|
997
993
|
<dl>
|
|
998
994
|
<dd>
|
|
@@ -1006,7 +1002,6 @@ await client.databases.getTableSchema("asset_id", "table_name");
|
|
|
1006
1002
|
<dd>
|
|
1007
1003
|
|
|
1008
1004
|
Get the result of an SQL query over given assets.
|
|
1009
|
-
|
|
1010
1005
|
</dd>
|
|
1011
1006
|
</dl>
|
|
1012
1007
|
</dd>
|
|
@@ -1023,10 +1018,10 @@ Get the result of an SQL query over given assets.
|
|
|
1023
1018
|
```typescript
|
|
1024
1019
|
await client.query.execute({
|
|
1025
1020
|
sql_command: "sql_command",
|
|
1026
|
-
database_asset_ids: "database_asset_ids"
|
|
1021
|
+
database_asset_ids: "database_asset_ids"
|
|
1027
1022
|
});
|
|
1028
|
-
```
|
|
1029
1023
|
|
|
1024
|
+
```
|
|
1030
1025
|
</dd>
|
|
1031
1026
|
</dl>
|
|
1032
1027
|
</dd>
|
|
@@ -1040,21 +1035,22 @@ await client.query.execute({
|
|
|
1040
1035
|
<dl>
|
|
1041
1036
|
<dd>
|
|
1042
1037
|
|
|
1043
|
-
**request:** `AthenaIntelligence.QueryExecuteRequest`
|
|
1044
|
-
|
|
1038
|
+
**request:** `AthenaIntelligence.QueryExecuteRequest`
|
|
1039
|
+
|
|
1045
1040
|
</dd>
|
|
1046
1041
|
</dl>
|
|
1047
1042
|
|
|
1048
1043
|
<dl>
|
|
1049
1044
|
<dd>
|
|
1050
1045
|
|
|
1051
|
-
**requestOptions:** `
|
|
1052
|
-
|
|
1046
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
1047
|
+
|
|
1053
1048
|
</dd>
|
|
1054
1049
|
</dl>
|
|
1055
1050
|
</dd>
|
|
1056
1051
|
</dl>
|
|
1057
1052
|
|
|
1053
|
+
|
|
1058
1054
|
</dd>
|
|
1059
1055
|
</dl>
|
|
1060
1056
|
</details>
|
|
@@ -1072,7 +1068,6 @@ await client.query.execute({
|
|
|
1072
1068
|
<dd>
|
|
1073
1069
|
|
|
1074
1070
|
Get the result of an SQL query over given assets.
|
|
1075
|
-
|
|
1076
1071
|
</dd>
|
|
1077
1072
|
</dl>
|
|
1078
1073
|
</dd>
|
|
@@ -1088,10 +1083,10 @@ Get the result of an SQL query over given assets.
|
|
|
1088
1083
|
|
|
1089
1084
|
```typescript
|
|
1090
1085
|
await client.query.executeSnippet({
|
|
1091
|
-
snippet_asset_id: "snippet_asset_id"
|
|
1086
|
+
snippet_asset_id: "snippet_asset_id"
|
|
1092
1087
|
});
|
|
1093
|
-
```
|
|
1094
1088
|
|
|
1089
|
+
```
|
|
1095
1090
|
</dd>
|
|
1096
1091
|
</dl>
|
|
1097
1092
|
</dd>
|
|
@@ -1105,28 +1100,28 @@ await client.query.executeSnippet({
|
|
|
1105
1100
|
<dl>
|
|
1106
1101
|
<dd>
|
|
1107
1102
|
|
|
1108
|
-
**request:** `AthenaIntelligence.QueryExecuteSnippetRequest`
|
|
1109
|
-
|
|
1103
|
+
**request:** `AthenaIntelligence.QueryExecuteSnippetRequest`
|
|
1104
|
+
|
|
1110
1105
|
</dd>
|
|
1111
1106
|
</dl>
|
|
1112
1107
|
|
|
1113
1108
|
<dl>
|
|
1114
1109
|
<dd>
|
|
1115
1110
|
|
|
1116
|
-
**requestOptions:** `
|
|
1117
|
-
|
|
1111
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
1112
|
+
|
|
1118
1113
|
</dd>
|
|
1119
1114
|
</dl>
|
|
1120
1115
|
</dd>
|
|
1121
1116
|
</dl>
|
|
1122
1117
|
|
|
1118
|
+
|
|
1123
1119
|
</dd>
|
|
1124
1120
|
</dl>
|
|
1125
1121
|
</details>
|
|
1126
1122
|
|
|
1127
1123
|
## Threads
|
|
1128
|
-
|
|
1129
|
-
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">getStatus</a>(threadId) -> AthenaIntelligence.ThreadStatusResponseOut</code></summary>
|
|
1124
|
+
<details><summary><code>client.threads.<a href="/src/api/resources/threads/client/Client.ts">getStatus</a>(thread_id) -> AthenaIntelligence.ThreadStatusResponseOut</code></summary>
|
|
1130
1125
|
<dl>
|
|
1131
1126
|
<dd>
|
|
1132
1127
|
|
|
@@ -1139,7 +1134,6 @@ await client.query.executeSnippet({
|
|
|
1139
1134
|
<dd>
|
|
1140
1135
|
|
|
1141
1136
|
Check the status of a thread execution by thread ID. Returns thread status and associated conversation asset information for tracking progress.
|
|
1142
|
-
|
|
1143
1137
|
</dd>
|
|
1144
1138
|
</dl>
|
|
1145
1139
|
</dd>
|
|
@@ -1155,8 +1149,8 @@ Check the status of a thread execution by thread ID. Returns thread status and a
|
|
|
1155
1149
|
|
|
1156
1150
|
```typescript
|
|
1157
1151
|
await client.threads.getStatus("thread_id");
|
|
1158
|
-
```
|
|
1159
1152
|
|
|
1153
|
+
```
|
|
1160
1154
|
</dd>
|
|
1161
1155
|
</dl>
|
|
1162
1156
|
</dd>
|
|
@@ -1170,27 +1164,27 @@ await client.threads.getStatus("thread_id");
|
|
|
1170
1164
|
<dl>
|
|
1171
1165
|
<dd>
|
|
1172
1166
|
|
|
1173
|
-
**
|
|
1174
|
-
|
|
1167
|
+
**thread_id:** `string` — The unique thread ID to check status for
|
|
1168
|
+
|
|
1175
1169
|
</dd>
|
|
1176
1170
|
</dl>
|
|
1177
1171
|
|
|
1178
1172
|
<dl>
|
|
1179
1173
|
<dd>
|
|
1180
1174
|
|
|
1181
|
-
**requestOptions:** `
|
|
1182
|
-
|
|
1175
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
1176
|
+
|
|
1183
1177
|
</dd>
|
|
1184
1178
|
</dl>
|
|
1185
1179
|
</dd>
|
|
1186
1180
|
</dl>
|
|
1187
1181
|
|
|
1182
|
+
|
|
1188
1183
|
</dd>
|
|
1189
1184
|
</dl>
|
|
1190
1185
|
</details>
|
|
1191
1186
|
|
|
1192
1187
|
## Tools
|
|
1193
|
-
|
|
1194
1188
|
<details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">getAssetChunks</a>({ ...params }) -> unknown</code></summary>
|
|
1195
1189
|
<dl>
|
|
1196
1190
|
<dd>
|
|
@@ -1204,7 +1198,6 @@ await client.threads.getStatus("thread_id");
|
|
|
1204
1198
|
<dd>
|
|
1205
1199
|
|
|
1206
1200
|
Get the chunks of a file.
|
|
1207
|
-
|
|
1208
1201
|
</dd>
|
|
1209
1202
|
</dl>
|
|
1210
1203
|
</dd>
|
|
@@ -1220,10 +1213,10 @@ Get the chunks of a file.
|
|
|
1220
1213
|
|
|
1221
1214
|
```typescript
|
|
1222
1215
|
await client.tools.getAssetChunks({
|
|
1223
|
-
asset_ids: ["asset_9249292-d118-42d3-96b4-00eccfe0754f", "asset_9249292-d118-42d3-95b4-01eccfe0754f"]
|
|
1216
|
+
asset_ids: ["asset_9249292-d118-42d3-96b4-00eccfe0754f", "asset_9249292-d118-42d3-95b4-01eccfe0754f"]
|
|
1224
1217
|
});
|
|
1225
|
-
```
|
|
1226
1218
|
|
|
1219
|
+
```
|
|
1227
1220
|
</dd>
|
|
1228
1221
|
</dl>
|
|
1229
1222
|
</dd>
|
|
@@ -1237,21 +1230,22 @@ await client.tools.getAssetChunks({
|
|
|
1237
1230
|
<dl>
|
|
1238
1231
|
<dd>
|
|
1239
1232
|
|
|
1240
|
-
**request:** `AthenaIntelligence.FileChunkRequestIn`
|
|
1241
|
-
|
|
1233
|
+
**request:** `AthenaIntelligence.FileChunkRequestIn`
|
|
1234
|
+
|
|
1242
1235
|
</dd>
|
|
1243
1236
|
</dl>
|
|
1244
1237
|
|
|
1245
1238
|
<dl>
|
|
1246
1239
|
<dd>
|
|
1247
1240
|
|
|
1248
|
-
**requestOptions:** `
|
|
1249
|
-
|
|
1241
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1242
|
+
|
|
1250
1243
|
</dd>
|
|
1251
1244
|
</dl>
|
|
1252
1245
|
</dd>
|
|
1253
1246
|
</dl>
|
|
1254
1247
|
|
|
1248
|
+
|
|
1255
1249
|
</dd>
|
|
1256
1250
|
</dl>
|
|
1257
1251
|
</details>
|
|
@@ -1269,7 +1263,6 @@ await client.tools.getAssetChunks({
|
|
|
1269
1263
|
<dd>
|
|
1270
1264
|
|
|
1271
1265
|
Get the content of an asset.
|
|
1272
|
-
|
|
1273
1266
|
</dd>
|
|
1274
1267
|
</dl>
|
|
1275
1268
|
</dd>
|
|
@@ -1285,10 +1278,10 @@ Get the content of an asset.
|
|
|
1285
1278
|
|
|
1286
1279
|
```typescript
|
|
1287
1280
|
await client.tools.getAssetContent({
|
|
1288
|
-
asset_id: "asset_id"
|
|
1281
|
+
asset_id: "asset_id"
|
|
1289
1282
|
});
|
|
1290
|
-
```
|
|
1291
1283
|
|
|
1284
|
+
```
|
|
1292
1285
|
</dd>
|
|
1293
1286
|
</dl>
|
|
1294
1287
|
</dd>
|
|
@@ -1302,21 +1295,22 @@ await client.tools.getAssetContent({
|
|
|
1302
1295
|
<dl>
|
|
1303
1296
|
<dd>
|
|
1304
1297
|
|
|
1305
|
-
**request:** `AthenaIntelligence.ToolsGetAssetContentRequest`
|
|
1306
|
-
|
|
1298
|
+
**request:** `AthenaIntelligence.ToolsGetAssetContentRequest`
|
|
1299
|
+
|
|
1307
1300
|
</dd>
|
|
1308
1301
|
</dl>
|
|
1309
1302
|
|
|
1310
1303
|
<dl>
|
|
1311
1304
|
<dd>
|
|
1312
1305
|
|
|
1313
|
-
**requestOptions:** `
|
|
1314
|
-
|
|
1306
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1307
|
+
|
|
1315
1308
|
</dd>
|
|
1316
1309
|
</dl>
|
|
1317
1310
|
</dd>
|
|
1318
1311
|
</dl>
|
|
1319
1312
|
|
|
1313
|
+
|
|
1320
1314
|
</dd>
|
|
1321
1315
|
</dl>
|
|
1322
1316
|
</details>
|
|
@@ -1334,7 +1328,6 @@ await client.tools.getAssetContent({
|
|
|
1334
1328
|
<dd>
|
|
1335
1329
|
|
|
1336
1330
|
Get a screenshot of a specific page from an asset.
|
|
1337
|
-
|
|
1338
1331
|
</dd>
|
|
1339
1332
|
</dl>
|
|
1340
1333
|
</dd>
|
|
@@ -1351,10 +1344,10 @@ Get a screenshot of a specific page from an asset.
|
|
|
1351
1344
|
```typescript
|
|
1352
1345
|
await client.tools.getAssetScreenshot({
|
|
1353
1346
|
asset_id: "asset_id",
|
|
1354
|
-
page_number: 1
|
|
1347
|
+
page_number: 1
|
|
1355
1348
|
});
|
|
1356
|
-
```
|
|
1357
1349
|
|
|
1350
|
+
```
|
|
1358
1351
|
</dd>
|
|
1359
1352
|
</dl>
|
|
1360
1353
|
</dd>
|
|
@@ -1368,21 +1361,22 @@ await client.tools.getAssetScreenshot({
|
|
|
1368
1361
|
<dl>
|
|
1369
1362
|
<dd>
|
|
1370
1363
|
|
|
1371
|
-
**request:** `AthenaIntelligence.ToolsGetAssetScreenshotRequest`
|
|
1372
|
-
|
|
1364
|
+
**request:** `AthenaIntelligence.ToolsGetAssetScreenshotRequest`
|
|
1365
|
+
|
|
1373
1366
|
</dd>
|
|
1374
1367
|
</dl>
|
|
1375
1368
|
|
|
1376
1369
|
<dl>
|
|
1377
1370
|
<dd>
|
|
1378
1371
|
|
|
1379
|
-
**requestOptions:** `
|
|
1380
|
-
|
|
1372
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1373
|
+
|
|
1381
1374
|
</dd>
|
|
1382
1375
|
</dl>
|
|
1383
1376
|
</dd>
|
|
1384
1377
|
</dl>
|
|
1385
1378
|
|
|
1379
|
+
|
|
1386
1380
|
</dd>
|
|
1387
1381
|
</dl>
|
|
1388
1382
|
</details>
|
|
@@ -1400,7 +1394,6 @@ await client.tools.getAssetScreenshot({
|
|
|
1400
1394
|
<dd>
|
|
1401
1395
|
|
|
1402
1396
|
List contents of an asset (Folder, Collection, Project) or entire workspace in a tree structure.
|
|
1403
|
-
|
|
1404
1397
|
</dd>
|
|
1405
1398
|
</dl>
|
|
1406
1399
|
</dd>
|
|
@@ -1418,10 +1411,10 @@ List contents of an asset (Folder, Collection, Project) or entire workspace in a
|
|
|
1418
1411
|
await client.tools.listContents({
|
|
1419
1412
|
asset_id: "asset_id",
|
|
1420
1413
|
include_asset_details: true,
|
|
1421
|
-
include_system_files: true
|
|
1414
|
+
include_system_files: true
|
|
1422
1415
|
});
|
|
1423
|
-
```
|
|
1424
1416
|
|
|
1417
|
+
```
|
|
1425
1418
|
</dd>
|
|
1426
1419
|
</dl>
|
|
1427
1420
|
</dd>
|
|
@@ -1435,21 +1428,22 @@ await client.tools.listContents({
|
|
|
1435
1428
|
<dl>
|
|
1436
1429
|
<dd>
|
|
1437
1430
|
|
|
1438
|
-
**request:** `AthenaIntelligence.ToolsListContentsRequest`
|
|
1439
|
-
|
|
1431
|
+
**request:** `AthenaIntelligence.ToolsListContentsRequest`
|
|
1432
|
+
|
|
1440
1433
|
</dd>
|
|
1441
1434
|
</dl>
|
|
1442
1435
|
|
|
1443
1436
|
<dl>
|
|
1444
1437
|
<dd>
|
|
1445
1438
|
|
|
1446
|
-
**requestOptions:** `
|
|
1447
|
-
|
|
1439
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1440
|
+
|
|
1448
1441
|
</dd>
|
|
1449
1442
|
</dl>
|
|
1450
1443
|
</dd>
|
|
1451
1444
|
</dl>
|
|
1452
1445
|
|
|
1446
|
+
|
|
1453
1447
|
</dd>
|
|
1454
1448
|
</dl>
|
|
1455
1449
|
</details>
|
|
@@ -1472,10 +1466,10 @@ await client.tools.dataFrame({
|
|
|
1472
1466
|
row_limit: 1,
|
|
1473
1467
|
index_column: 1,
|
|
1474
1468
|
sheet_name: "sheet_name",
|
|
1475
|
-
separator: "separator"
|
|
1469
|
+
separator: "separator"
|
|
1476
1470
|
});
|
|
1477
|
-
```
|
|
1478
1471
|
|
|
1472
|
+
```
|
|
1479
1473
|
</dd>
|
|
1480
1474
|
</dl>
|
|
1481
1475
|
</dd>
|
|
@@ -1489,21 +1483,22 @@ await client.tools.dataFrame({
|
|
|
1489
1483
|
<dl>
|
|
1490
1484
|
<dd>
|
|
1491
1485
|
|
|
1492
|
-
**request:** `AthenaIntelligence.ToolsDataFrameRequest`
|
|
1493
|
-
|
|
1486
|
+
**request:** `AthenaIntelligence.ToolsDataFrameRequest`
|
|
1487
|
+
|
|
1494
1488
|
</dd>
|
|
1495
1489
|
</dl>
|
|
1496
1490
|
|
|
1497
1491
|
<dl>
|
|
1498
1492
|
<dd>
|
|
1499
1493
|
|
|
1500
|
-
**requestOptions:** `
|
|
1501
|
-
|
|
1494
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1495
|
+
|
|
1502
1496
|
</dd>
|
|
1503
1497
|
</dl>
|
|
1504
1498
|
</dd>
|
|
1505
1499
|
</dl>
|
|
1506
1500
|
|
|
1501
|
+
|
|
1507
1502
|
</dd>
|
|
1508
1503
|
</dl>
|
|
1509
1504
|
</details>
|
|
@@ -1521,7 +1516,6 @@ await client.tools.dataFrame({
|
|
|
1521
1516
|
<dd>
|
|
1522
1517
|
|
|
1523
1518
|
Get the raw file data for given asset.
|
|
1524
|
-
|
|
1525
1519
|
</dd>
|
|
1526
1520
|
</dl>
|
|
1527
1521
|
</dd>
|
|
@@ -1537,10 +1531,10 @@ Get the raw file data for given asset.
|
|
|
1537
1531
|
|
|
1538
1532
|
```typescript
|
|
1539
1533
|
await client.tools.rawData({
|
|
1540
|
-
asset_id: "asset_id"
|
|
1534
|
+
asset_id: "asset_id"
|
|
1541
1535
|
});
|
|
1542
|
-
```
|
|
1543
1536
|
|
|
1537
|
+
```
|
|
1544
1538
|
</dd>
|
|
1545
1539
|
</dl>
|
|
1546
1540
|
</dd>
|
|
@@ -1554,21 +1548,22 @@ await client.tools.rawData({
|
|
|
1554
1548
|
<dl>
|
|
1555
1549
|
<dd>
|
|
1556
1550
|
|
|
1557
|
-
**request:** `AthenaIntelligence.ToolsRawDataRequest`
|
|
1558
|
-
|
|
1551
|
+
**request:** `AthenaIntelligence.ToolsRawDataRequest`
|
|
1552
|
+
|
|
1559
1553
|
</dd>
|
|
1560
1554
|
</dl>
|
|
1561
1555
|
|
|
1562
1556
|
<dl>
|
|
1563
1557
|
<dd>
|
|
1564
1558
|
|
|
1565
|
-
**requestOptions:** `
|
|
1566
|
-
|
|
1559
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1560
|
+
|
|
1567
1561
|
</dd>
|
|
1568
1562
|
</dl>
|
|
1569
1563
|
</dd>
|
|
1570
1564
|
</dl>
|
|
1571
1565
|
|
|
1566
|
+
|
|
1572
1567
|
</dd>
|
|
1573
1568
|
</dl>
|
|
1574
1569
|
</details>
|
|
@@ -1586,7 +1581,6 @@ await client.tools.rawData({
|
|
|
1586
1581
|
<dd>
|
|
1587
1582
|
|
|
1588
1583
|
Save a file as an asset in the user's workspace.
|
|
1589
|
-
|
|
1590
1584
|
</dd>
|
|
1591
1585
|
</dl>
|
|
1592
1586
|
</dd>
|
|
@@ -1603,10 +1597,10 @@ Save a file as an asset in the user's workspace.
|
|
|
1603
1597
|
```typescript
|
|
1604
1598
|
await client.tools.saveAsset({
|
|
1605
1599
|
file: fs.createReadStream("/path/to/your/file"),
|
|
1606
|
-
parent_folder_id: "parent_folder_id"
|
|
1600
|
+
parent_folder_id: "parent_folder_id"
|
|
1607
1601
|
});
|
|
1608
|
-
```
|
|
1609
1602
|
|
|
1603
|
+
```
|
|
1610
1604
|
</dd>
|
|
1611
1605
|
</dl>
|
|
1612
1606
|
</dd>
|
|
@@ -1620,27 +1614,27 @@ await client.tools.saveAsset({
|
|
|
1620
1614
|
<dl>
|
|
1621
1615
|
<dd>
|
|
1622
1616
|
|
|
1623
|
-
**request:** `AthenaIntelligence.BodySaveAssetApiV0ToolsFileSavePost`
|
|
1624
|
-
|
|
1617
|
+
**request:** `AthenaIntelligence.BodySaveAssetApiV0ToolsFileSavePost`
|
|
1618
|
+
|
|
1625
1619
|
</dd>
|
|
1626
1620
|
</dl>
|
|
1627
1621
|
|
|
1628
1622
|
<dl>
|
|
1629
1623
|
<dd>
|
|
1630
1624
|
|
|
1631
|
-
**requestOptions:** `
|
|
1632
|
-
|
|
1625
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1626
|
+
|
|
1633
1627
|
</dd>
|
|
1634
1628
|
</dl>
|
|
1635
1629
|
</dd>
|
|
1636
1630
|
</dl>
|
|
1637
1631
|
|
|
1632
|
+
|
|
1638
1633
|
</dd>
|
|
1639
1634
|
</dl>
|
|
1640
1635
|
</details>
|
|
1641
1636
|
|
|
1642
1637
|
## Agents Drive
|
|
1643
|
-
|
|
1644
1638
|
<details><summary><code>client.agents.drive.<a href="/src/api/resources/agents/resources/drive/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.DriveAgentResponse</code></summary>
|
|
1645
1639
|
<dl>
|
|
1646
1640
|
<dd>
|
|
@@ -1654,7 +1648,6 @@ await client.tools.saveAsset({
|
|
|
1654
1648
|
<dd>
|
|
1655
1649
|
|
|
1656
1650
|
Coming soon! Manage folders and search for files in the internal drive.
|
|
1657
|
-
|
|
1658
1651
|
</dd>
|
|
1659
1652
|
</dl>
|
|
1660
1653
|
</dd>
|
|
@@ -1671,16 +1664,14 @@ Coming soon! Manage folders and search for files in the internal drive.
|
|
|
1671
1664
|
```typescript
|
|
1672
1665
|
await client.agents.drive.invoke({
|
|
1673
1666
|
config: {
|
|
1674
|
-
key: "value"
|
|
1667
|
+
"key": "value"
|
|
1675
1668
|
},
|
|
1676
|
-
messages: [
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
},
|
|
1680
|
-
],
|
|
1669
|
+
messages: [{
|
|
1670
|
+
"key": "value"
|
|
1671
|
+
}]
|
|
1681
1672
|
});
|
|
1682
|
-
```
|
|
1683
1673
|
|
|
1674
|
+
```
|
|
1684
1675
|
</dd>
|
|
1685
1676
|
</dl>
|
|
1686
1677
|
</dd>
|
|
@@ -1694,27 +1685,27 @@ await client.agents.drive.invoke({
|
|
|
1694
1685
|
<dl>
|
|
1695
1686
|
<dd>
|
|
1696
1687
|
|
|
1697
|
-
**request:** `AthenaIntelligence.agents.DriveAgentRequest`
|
|
1698
|
-
|
|
1688
|
+
**request:** `AthenaIntelligence.agents.DriveAgentRequest`
|
|
1689
|
+
|
|
1699
1690
|
</dd>
|
|
1700
1691
|
</dl>
|
|
1701
1692
|
|
|
1702
1693
|
<dl>
|
|
1703
1694
|
<dd>
|
|
1704
1695
|
|
|
1705
|
-
**requestOptions:** `
|
|
1706
|
-
|
|
1696
|
+
**requestOptions:** `DriveClient.RequestOptions`
|
|
1697
|
+
|
|
1707
1698
|
</dd>
|
|
1708
1699
|
</dl>
|
|
1709
1700
|
</dd>
|
|
1710
1701
|
</dl>
|
|
1711
1702
|
|
|
1703
|
+
|
|
1712
1704
|
</dd>
|
|
1713
1705
|
</dl>
|
|
1714
1706
|
</details>
|
|
1715
1707
|
|
|
1716
1708
|
## Agents General
|
|
1717
|
-
|
|
1718
1709
|
<details><summary><code>client.agents.general.<a href="/src/api/resources/agents/resources/general/client/Client.ts">batch</a>({ ...params }) -> AthenaIntelligence.GeneralAgentResponse[]</code></summary>
|
|
1719
1710
|
<dl>
|
|
1720
1711
|
<dd>
|
|
@@ -1728,7 +1719,6 @@ await client.agents.drive.invoke({
|
|
|
1728
1719
|
<dd>
|
|
1729
1720
|
|
|
1730
1721
|
Coming soon! Call the general agent with batched requests and return the results.
|
|
1731
|
-
|
|
1732
1722
|
</dd>
|
|
1733
1723
|
</dl>
|
|
1734
1724
|
</dd>
|
|
@@ -1743,21 +1733,17 @@ Coming soon! Call the general agent with batched requests and return the results
|
|
|
1743
1733
|
<dd>
|
|
1744
1734
|
|
|
1745
1735
|
```typescript
|
|
1746
|
-
await client.agents.general.batch([
|
|
1747
|
-
{
|
|
1736
|
+
await client.agents.general.batch([{
|
|
1748
1737
|
config: {
|
|
1749
|
-
enabled_tools: ["search"]
|
|
1738
|
+
enabled_tools: ["search"]
|
|
1750
1739
|
},
|
|
1751
|
-
messages: [
|
|
1752
|
-
{
|
|
1740
|
+
messages: [{
|
|
1753
1741
|
content: "Please call the search tool for AAPL news.",
|
|
1754
|
-
role: "user"
|
|
1755
|
-
}
|
|
1756
|
-
|
|
1757
|
-
},
|
|
1758
|
-
]);
|
|
1759
|
-
```
|
|
1742
|
+
role: "user"
|
|
1743
|
+
}]
|
|
1744
|
+
}]);
|
|
1760
1745
|
|
|
1746
|
+
```
|
|
1761
1747
|
</dd>
|
|
1762
1748
|
</dl>
|
|
1763
1749
|
</dd>
|
|
@@ -1771,21 +1757,22 @@ await client.agents.general.batch([
|
|
|
1771
1757
|
<dl>
|
|
1772
1758
|
<dd>
|
|
1773
1759
|
|
|
1774
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest[]`
|
|
1775
|
-
|
|
1760
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest[]`
|
|
1761
|
+
|
|
1776
1762
|
</dd>
|
|
1777
1763
|
</dl>
|
|
1778
1764
|
|
|
1779
1765
|
<dl>
|
|
1780
1766
|
<dd>
|
|
1781
1767
|
|
|
1782
|
-
**requestOptions:** `
|
|
1783
|
-
|
|
1768
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1769
|
+
|
|
1784
1770
|
</dd>
|
|
1785
1771
|
</dl>
|
|
1786
1772
|
</dd>
|
|
1787
1773
|
</dl>
|
|
1788
1774
|
|
|
1775
|
+
|
|
1789
1776
|
</dd>
|
|
1790
1777
|
</dl>
|
|
1791
1778
|
</details>
|
|
@@ -1806,7 +1793,6 @@ Call the general Athena agent synchronously.
|
|
|
1806
1793
|
|
|
1807
1794
|
Call the agent with the messages list, wait for the agent to complete,
|
|
1808
1795
|
and return the result.
|
|
1809
|
-
|
|
1810
1796
|
</dd>
|
|
1811
1797
|
</dl>
|
|
1812
1798
|
</dd>
|
|
@@ -1823,17 +1809,15 @@ and return the result.
|
|
|
1823
1809
|
```typescript
|
|
1824
1810
|
await client.agents.general.invoke({
|
|
1825
1811
|
config: {
|
|
1826
|
-
enabled_tools: ["search"]
|
|
1812
|
+
enabled_tools: ["search"]
|
|
1827
1813
|
},
|
|
1828
|
-
messages: [
|
|
1829
|
-
{
|
|
1814
|
+
messages: [{
|
|
1830
1815
|
content: "Please call the search tool for AAPL news.",
|
|
1831
|
-
role: "user"
|
|
1832
|
-
}
|
|
1833
|
-
],
|
|
1816
|
+
role: "user"
|
|
1817
|
+
}]
|
|
1834
1818
|
});
|
|
1835
|
-
```
|
|
1836
1819
|
|
|
1820
|
+
```
|
|
1837
1821
|
</dd>
|
|
1838
1822
|
</dl>
|
|
1839
1823
|
</dd>
|
|
@@ -1847,21 +1831,22 @@ await client.agents.general.invoke({
|
|
|
1847
1831
|
<dl>
|
|
1848
1832
|
<dd>
|
|
1849
1833
|
|
|
1850
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1851
|
-
|
|
1834
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1835
|
+
|
|
1852
1836
|
</dd>
|
|
1853
1837
|
</dl>
|
|
1854
1838
|
|
|
1855
1839
|
<dl>
|
|
1856
1840
|
<dd>
|
|
1857
1841
|
|
|
1858
|
-
**requestOptions:** `
|
|
1859
|
-
|
|
1842
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1843
|
+
|
|
1860
1844
|
</dd>
|
|
1861
1845
|
</dl>
|
|
1862
1846
|
</dd>
|
|
1863
1847
|
</dl>
|
|
1864
1848
|
|
|
1849
|
+
|
|
1865
1850
|
</dd>
|
|
1866
1851
|
</dl>
|
|
1867
1852
|
</details>
|
|
@@ -1879,7 +1864,6 @@ await client.agents.general.invoke({
|
|
|
1879
1864
|
<dd>
|
|
1880
1865
|
|
|
1881
1866
|
Coming soon! Call the general agent and stream events for real-time chat applications.
|
|
1882
|
-
|
|
1883
1867
|
</dd>
|
|
1884
1868
|
</dl>
|
|
1885
1869
|
</dd>
|
|
@@ -1896,17 +1880,15 @@ Coming soon! Call the general agent and stream events for real-time chat applica
|
|
|
1896
1880
|
```typescript
|
|
1897
1881
|
await client.agents.general.streamEvents({
|
|
1898
1882
|
config: {
|
|
1899
|
-
enabled_tools: ["search"]
|
|
1883
|
+
enabled_tools: ["search"]
|
|
1900
1884
|
},
|
|
1901
|
-
messages: [
|
|
1902
|
-
{
|
|
1885
|
+
messages: [{
|
|
1903
1886
|
content: "Please call the search tool for AAPL news.",
|
|
1904
|
-
role: "user"
|
|
1905
|
-
}
|
|
1906
|
-
],
|
|
1887
|
+
role: "user"
|
|
1888
|
+
}]
|
|
1907
1889
|
});
|
|
1908
|
-
```
|
|
1909
1890
|
|
|
1891
|
+
```
|
|
1910
1892
|
</dd>
|
|
1911
1893
|
</dl>
|
|
1912
1894
|
</dd>
|
|
@@ -1920,27 +1902,27 @@ await client.agents.general.streamEvents({
|
|
|
1920
1902
|
<dl>
|
|
1921
1903
|
<dd>
|
|
1922
1904
|
|
|
1923
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1924
|
-
|
|
1905
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1906
|
+
|
|
1925
1907
|
</dd>
|
|
1926
1908
|
</dl>
|
|
1927
1909
|
|
|
1928
1910
|
<dl>
|
|
1929
1911
|
<dd>
|
|
1930
1912
|
|
|
1931
|
-
**requestOptions:** `
|
|
1932
|
-
|
|
1913
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1914
|
+
|
|
1933
1915
|
</dd>
|
|
1934
1916
|
</dl>
|
|
1935
1917
|
</dd>
|
|
1936
1918
|
</dl>
|
|
1937
1919
|
|
|
1920
|
+
|
|
1938
1921
|
</dd>
|
|
1939
1922
|
</dl>
|
|
1940
1923
|
</details>
|
|
1941
1924
|
|
|
1942
1925
|
## Agents Research
|
|
1943
|
-
|
|
1944
1926
|
<details><summary><code>client.agents.research.<a href="/src/api/resources/agents/resources/research/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.ResearchAgentResponse</code></summary>
|
|
1945
1927
|
<dl>
|
|
1946
1928
|
<dd>
|
|
@@ -1954,7 +1936,6 @@ await client.agents.general.streamEvents({
|
|
|
1954
1936
|
<dd>
|
|
1955
1937
|
|
|
1956
1938
|
Coming soon! Conduct research using web and other sources.
|
|
1957
|
-
|
|
1958
1939
|
</dd>
|
|
1959
1940
|
</dl>
|
|
1960
1941
|
</dd>
|
|
@@ -1971,16 +1952,14 @@ Coming soon! Conduct research using web and other sources.
|
|
|
1971
1952
|
```typescript
|
|
1972
1953
|
await client.agents.research.invoke({
|
|
1973
1954
|
config: {
|
|
1974
|
-
key: "value"
|
|
1955
|
+
"key": "value"
|
|
1975
1956
|
},
|
|
1976
|
-
messages: [
|
|
1977
|
-
|
|
1978
|
-
|
|
1979
|
-
},
|
|
1980
|
-
],
|
|
1957
|
+
messages: [{
|
|
1958
|
+
"key": "value"
|
|
1959
|
+
}]
|
|
1981
1960
|
});
|
|
1982
|
-
```
|
|
1983
1961
|
|
|
1962
|
+
```
|
|
1984
1963
|
</dd>
|
|
1985
1964
|
</dl>
|
|
1986
1965
|
</dd>
|
|
@@ -1994,27 +1973,27 @@ await client.agents.research.invoke({
|
|
|
1994
1973
|
<dl>
|
|
1995
1974
|
<dd>
|
|
1996
1975
|
|
|
1997
|
-
**request:** `AthenaIntelligence.agents.ResearchAgentRequest`
|
|
1998
|
-
|
|
1976
|
+
**request:** `AthenaIntelligence.agents.ResearchAgentRequest`
|
|
1977
|
+
|
|
1999
1978
|
</dd>
|
|
2000
1979
|
</dl>
|
|
2001
1980
|
|
|
2002
1981
|
<dl>
|
|
2003
1982
|
<dd>
|
|
2004
1983
|
|
|
2005
|
-
**requestOptions:** `
|
|
2006
|
-
|
|
1984
|
+
**requestOptions:** `ResearchClient.RequestOptions`
|
|
1985
|
+
|
|
2007
1986
|
</dd>
|
|
2008
1987
|
</dl>
|
|
2009
1988
|
</dd>
|
|
2010
1989
|
</dl>
|
|
2011
1990
|
|
|
1991
|
+
|
|
2012
1992
|
</dd>
|
|
2013
1993
|
</dl>
|
|
2014
1994
|
</details>
|
|
2015
1995
|
|
|
2016
1996
|
## Agents Sql
|
|
2017
|
-
|
|
2018
1997
|
<details><summary><code>client.agents.sql.<a href="/src/api/resources/agents/resources/sql/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.SqlAgentResponse</code></summary>
|
|
2019
1998
|
<dl>
|
|
2020
1999
|
<dd>
|
|
@@ -2028,7 +2007,6 @@ await client.agents.research.invoke({
|
|
|
2028
2007
|
<dd>
|
|
2029
2008
|
|
|
2030
2009
|
Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for the query object.
|
|
2031
|
-
|
|
2032
2010
|
</dd>
|
|
2033
2011
|
</dl>
|
|
2034
2012
|
</dd>
|
|
@@ -2045,16 +2023,14 @@ Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for th
|
|
|
2045
2023
|
```typescript
|
|
2046
2024
|
await client.agents.sql.invoke({
|
|
2047
2025
|
config: {
|
|
2048
|
-
key: "value"
|
|
2026
|
+
"key": "value"
|
|
2049
2027
|
},
|
|
2050
|
-
messages: [
|
|
2051
|
-
|
|
2052
|
-
|
|
2053
|
-
},
|
|
2054
|
-
],
|
|
2028
|
+
messages: [{
|
|
2029
|
+
"key": "value"
|
|
2030
|
+
}]
|
|
2055
2031
|
});
|
|
2056
|
-
```
|
|
2057
2032
|
|
|
2033
|
+
```
|
|
2058
2034
|
</dd>
|
|
2059
2035
|
</dl>
|
|
2060
2036
|
</dd>
|
|
@@ -2068,27 +2044,27 @@ await client.agents.sql.invoke({
|
|
|
2068
2044
|
<dl>
|
|
2069
2045
|
<dd>
|
|
2070
2046
|
|
|
2071
|
-
**request:** `AthenaIntelligence.agents.SqlAgentRequest`
|
|
2072
|
-
|
|
2047
|
+
**request:** `AthenaIntelligence.agents.SqlAgentRequest`
|
|
2048
|
+
|
|
2073
2049
|
</dd>
|
|
2074
2050
|
</dl>
|
|
2075
2051
|
|
|
2076
2052
|
<dl>
|
|
2077
2053
|
<dd>
|
|
2078
2054
|
|
|
2079
|
-
**requestOptions:** `
|
|
2080
|
-
|
|
2055
|
+
**requestOptions:** `SqlClient.RequestOptions`
|
|
2056
|
+
|
|
2081
2057
|
</dd>
|
|
2082
2058
|
</dl>
|
|
2083
2059
|
</dd>
|
|
2084
2060
|
</dl>
|
|
2085
2061
|
|
|
2062
|
+
|
|
2086
2063
|
</dd>
|
|
2087
2064
|
</dl>
|
|
2088
2065
|
</details>
|
|
2089
2066
|
|
|
2090
2067
|
## Tools Calendar
|
|
2091
|
-
|
|
2092
2068
|
<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>() -> unknown</code></summary>
|
|
2093
2069
|
<dl>
|
|
2094
2070
|
<dd>
|
|
@@ -2102,7 +2078,6 @@ await client.agents.sql.invoke({
|
|
|
2102
2078
|
<dd>
|
|
2103
2079
|
|
|
2104
2080
|
Coming soon! List calendar events with optional filtering.
|
|
2105
|
-
|
|
2106
2081
|
</dd>
|
|
2107
2082
|
</dl>
|
|
2108
2083
|
</dd>
|
|
@@ -2118,8 +2093,8 @@ Coming soon! List calendar events with optional filtering.
|
|
|
2118
2093
|
|
|
2119
2094
|
```typescript
|
|
2120
2095
|
await client.tools.calendar.listEvents();
|
|
2121
|
-
```
|
|
2122
2096
|
|
|
2097
|
+
```
|
|
2123
2098
|
</dd>
|
|
2124
2099
|
</dl>
|
|
2125
2100
|
</dd>
|
|
@@ -2133,13 +2108,14 @@ await client.tools.calendar.listEvents();
|
|
|
2133
2108
|
<dl>
|
|
2134
2109
|
<dd>
|
|
2135
2110
|
|
|
2136
|
-
**requestOptions:** `
|
|
2137
|
-
|
|
2111
|
+
**requestOptions:** `CalendarClient.RequestOptions`
|
|
2112
|
+
|
|
2138
2113
|
</dd>
|
|
2139
2114
|
</dl>
|
|
2140
2115
|
</dd>
|
|
2141
2116
|
</dl>
|
|
2142
2117
|
|
|
2118
|
+
|
|
2143
2119
|
</dd>
|
|
2144
2120
|
</dl>
|
|
2145
2121
|
</details>
|
|
@@ -2157,7 +2133,6 @@ await client.tools.calendar.listEvents();
|
|
|
2157
2133
|
<dd>
|
|
2158
2134
|
|
|
2159
2135
|
Coming soon! Create new calendar events.
|
|
2160
|
-
|
|
2161
2136
|
</dd>
|
|
2162
2137
|
</dl>
|
|
2163
2138
|
</dd>
|
|
@@ -2173,8 +2148,8 @@ Coming soon! Create new calendar events.
|
|
|
2173
2148
|
|
|
2174
2149
|
```typescript
|
|
2175
2150
|
await client.tools.calendar.createEvent();
|
|
2176
|
-
```
|
|
2177
2151
|
|
|
2152
|
+
```
|
|
2178
2153
|
</dd>
|
|
2179
2154
|
</dl>
|
|
2180
2155
|
</dd>
|
|
@@ -2188,19 +2163,19 @@ await client.tools.calendar.createEvent();
|
|
|
2188
2163
|
<dl>
|
|
2189
2164
|
<dd>
|
|
2190
2165
|
|
|
2191
|
-
**requestOptions:** `
|
|
2192
|
-
|
|
2166
|
+
**requestOptions:** `CalendarClient.RequestOptions`
|
|
2167
|
+
|
|
2193
2168
|
</dd>
|
|
2194
2169
|
</dl>
|
|
2195
2170
|
</dd>
|
|
2196
2171
|
</dl>
|
|
2197
2172
|
|
|
2173
|
+
|
|
2198
2174
|
</dd>
|
|
2199
2175
|
</dl>
|
|
2200
2176
|
</details>
|
|
2201
2177
|
|
|
2202
2178
|
## Tools Email
|
|
2203
|
-
|
|
2204
2179
|
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>() -> unknown</code></summary>
|
|
2205
2180
|
<dl>
|
|
2206
2181
|
<dd>
|
|
@@ -2214,7 +2189,6 @@ await client.tools.calendar.createEvent();
|
|
|
2214
2189
|
<dd>
|
|
2215
2190
|
|
|
2216
2191
|
Coming soon! Create email drafts with specified content and recipients.
|
|
2217
|
-
|
|
2218
2192
|
</dd>
|
|
2219
2193
|
</dl>
|
|
2220
2194
|
</dd>
|
|
@@ -2230,8 +2204,8 @@ Coming soon! Create email drafts with specified content and recipients.
|
|
|
2230
2204
|
|
|
2231
2205
|
```typescript
|
|
2232
2206
|
await client.tools.email.createDraft();
|
|
2233
|
-
```
|
|
2234
2207
|
|
|
2208
|
+
```
|
|
2235
2209
|
</dd>
|
|
2236
2210
|
</dl>
|
|
2237
2211
|
</dd>
|
|
@@ -2245,13 +2219,14 @@ await client.tools.email.createDraft();
|
|
|
2245
2219
|
<dl>
|
|
2246
2220
|
<dd>
|
|
2247
2221
|
|
|
2248
|
-
**requestOptions:** `
|
|
2249
|
-
|
|
2222
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2223
|
+
|
|
2250
2224
|
</dd>
|
|
2251
2225
|
</dl>
|
|
2252
2226
|
</dd>
|
|
2253
2227
|
</dl>
|
|
2254
2228
|
|
|
2229
|
+
|
|
2255
2230
|
</dd>
|
|
2256
2231
|
</dl>
|
|
2257
2232
|
</details>
|
|
@@ -2269,7 +2244,6 @@ await client.tools.email.createDraft();
|
|
|
2269
2244
|
<dd>
|
|
2270
2245
|
|
|
2271
2246
|
Coming soon! Search through emails with configurable filters.
|
|
2272
|
-
|
|
2273
2247
|
</dd>
|
|
2274
2248
|
</dl>
|
|
2275
2249
|
</dd>
|
|
@@ -2285,8 +2259,8 @@ Coming soon! Search through emails with configurable filters.
|
|
|
2285
2259
|
|
|
2286
2260
|
```typescript
|
|
2287
2261
|
await client.tools.email.search();
|
|
2288
|
-
```
|
|
2289
2262
|
|
|
2263
|
+
```
|
|
2290
2264
|
</dd>
|
|
2291
2265
|
</dl>
|
|
2292
2266
|
</dd>
|
|
@@ -2300,13 +2274,14 @@ await client.tools.email.search();
|
|
|
2300
2274
|
<dl>
|
|
2301
2275
|
<dd>
|
|
2302
2276
|
|
|
2303
|
-
**requestOptions:** `
|
|
2304
|
-
|
|
2277
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2278
|
+
|
|
2305
2279
|
</dd>
|
|
2306
2280
|
</dl>
|
|
2307
2281
|
</dd>
|
|
2308
2282
|
</dl>
|
|
2309
2283
|
|
|
2284
|
+
|
|
2310
2285
|
</dd>
|
|
2311
2286
|
</dl>
|
|
2312
2287
|
</details>
|
|
@@ -2324,7 +2299,6 @@ await client.tools.email.search();
|
|
|
2324
2299
|
<dd>
|
|
2325
2300
|
|
|
2326
2301
|
Coming soon! Send emails to specified recipients.
|
|
2327
|
-
|
|
2328
2302
|
</dd>
|
|
2329
2303
|
</dl>
|
|
2330
2304
|
</dd>
|
|
@@ -2340,8 +2314,8 @@ Coming soon! Send emails to specified recipients.
|
|
|
2340
2314
|
|
|
2341
2315
|
```typescript
|
|
2342
2316
|
await client.tools.email.send();
|
|
2343
|
-
```
|
|
2344
2317
|
|
|
2318
|
+
```
|
|
2345
2319
|
</dd>
|
|
2346
2320
|
</dl>
|
|
2347
2321
|
</dd>
|
|
@@ -2355,19 +2329,19 @@ await client.tools.email.send();
|
|
|
2355
2329
|
<dl>
|
|
2356
2330
|
<dd>
|
|
2357
2331
|
|
|
2358
|
-
**requestOptions:** `
|
|
2359
|
-
|
|
2332
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2333
|
+
|
|
2360
2334
|
</dd>
|
|
2361
2335
|
</dl>
|
|
2362
2336
|
</dd>
|
|
2363
2337
|
</dl>
|
|
2364
2338
|
|
|
2339
|
+
|
|
2365
2340
|
</dd>
|
|
2366
2341
|
</dl>
|
|
2367
2342
|
</details>
|
|
2368
2343
|
|
|
2369
2344
|
## Tools Sheets
|
|
2370
|
-
|
|
2371
2345
|
<details><summary><code>client.tools.sheets.<a href="/src/api/resources/tools/resources/sheets/client/Client.ts">updateCell</a>({ ...params }) -> AthenaIntelligence.SheetOperationResponse</code></summary>
|
|
2372
2346
|
<dl>
|
|
2373
2347
|
<dd>
|
|
@@ -2381,7 +2355,6 @@ await client.tools.email.send();
|
|
|
2381
2355
|
<dd>
|
|
2382
2356
|
|
|
2383
2357
|
Update a single cell in an Athena spreadsheet.
|
|
2384
|
-
|
|
2385
2358
|
</dd>
|
|
2386
2359
|
</dl>
|
|
2387
2360
|
</dd>
|
|
@@ -2400,10 +2373,10 @@ await client.tools.sheets.updateCell({
|
|
|
2400
2373
|
asset_id: "asset_id",
|
|
2401
2374
|
column: 1,
|
|
2402
2375
|
row: 1,
|
|
2403
|
-
value: "value"
|
|
2376
|
+
value: "value"
|
|
2404
2377
|
});
|
|
2405
|
-
```
|
|
2406
2378
|
|
|
2379
|
+
```
|
|
2407
2380
|
</dd>
|
|
2408
2381
|
</dl>
|
|
2409
2382
|
</dd>
|
|
@@ -2417,21 +2390,22 @@ await client.tools.sheets.updateCell({
|
|
|
2417
2390
|
<dl>
|
|
2418
2391
|
<dd>
|
|
2419
2392
|
|
|
2420
|
-
**request:** `AthenaIntelligence.tools.UpdateSheetCellRequest`
|
|
2421
|
-
|
|
2393
|
+
**request:** `AthenaIntelligence.tools.UpdateSheetCellRequest`
|
|
2394
|
+
|
|
2422
2395
|
</dd>
|
|
2423
2396
|
</dl>
|
|
2424
2397
|
|
|
2425
2398
|
<dl>
|
|
2426
2399
|
<dd>
|
|
2427
2400
|
|
|
2428
|
-
**requestOptions:** `
|
|
2429
|
-
|
|
2401
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2402
|
+
|
|
2430
2403
|
</dd>
|
|
2431
2404
|
</dl>
|
|
2432
2405
|
</dd>
|
|
2433
2406
|
</dl>
|
|
2434
2407
|
|
|
2408
|
+
|
|
2435
2409
|
</dd>
|
|
2436
2410
|
</dl>
|
|
2437
2411
|
</details>
|
|
@@ -2449,7 +2423,6 @@ await client.tools.sheets.updateCell({
|
|
|
2449
2423
|
<dd>
|
|
2450
2424
|
|
|
2451
2425
|
Delete cells from an Athena spreadsheet.
|
|
2452
|
-
|
|
2453
2426
|
</dd>
|
|
2454
2427
|
</dl>
|
|
2455
2428
|
</dd>
|
|
@@ -2469,10 +2442,10 @@ await client.tools.sheets.deleteCells({
|
|
|
2469
2442
|
end_column_index: 1,
|
|
2470
2443
|
end_row_index: 1,
|
|
2471
2444
|
start_column_index: 1,
|
|
2472
|
-
start_row_index: 1
|
|
2445
|
+
start_row_index: 1
|
|
2473
2446
|
});
|
|
2474
|
-
```
|
|
2475
2447
|
|
|
2448
|
+
```
|
|
2476
2449
|
</dd>
|
|
2477
2450
|
</dl>
|
|
2478
2451
|
</dd>
|
|
@@ -2486,21 +2459,22 @@ await client.tools.sheets.deleteCells({
|
|
|
2486
2459
|
<dl>
|
|
2487
2460
|
<dd>
|
|
2488
2461
|
|
|
2489
|
-
**request:** `AthenaIntelligence.tools.DeleteCellsRequest`
|
|
2490
|
-
|
|
2462
|
+
**request:** `AthenaIntelligence.tools.DeleteCellsRequest`
|
|
2463
|
+
|
|
2491
2464
|
</dd>
|
|
2492
2465
|
</dl>
|
|
2493
2466
|
|
|
2494
2467
|
<dl>
|
|
2495
2468
|
<dd>
|
|
2496
2469
|
|
|
2497
|
-
**requestOptions:** `
|
|
2498
|
-
|
|
2470
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2471
|
+
|
|
2499
2472
|
</dd>
|
|
2500
2473
|
</dl>
|
|
2501
2474
|
</dd>
|
|
2502
2475
|
</dl>
|
|
2503
2476
|
|
|
2477
|
+
|
|
2504
2478
|
</dd>
|
|
2505
2479
|
</dl>
|
|
2506
2480
|
</details>
|
|
@@ -2518,7 +2492,6 @@ await client.tools.sheets.deleteCells({
|
|
|
2518
2492
|
<dd>
|
|
2519
2493
|
|
|
2520
2494
|
Delete columns from an Athena spreadsheet.
|
|
2521
|
-
|
|
2522
2495
|
</dd>
|
|
2523
2496
|
</dl>
|
|
2524
2497
|
</dd>
|
|
@@ -2535,10 +2508,10 @@ Delete columns from an Athena spreadsheet.
|
|
|
2535
2508
|
```typescript
|
|
2536
2509
|
await client.tools.sheets.deleteColumn({
|
|
2537
2510
|
asset_id: "asset_id",
|
|
2538
|
-
column_indexes: [1]
|
|
2511
|
+
column_indexes: [1]
|
|
2539
2512
|
});
|
|
2540
|
-
```
|
|
2541
2513
|
|
|
2514
|
+
```
|
|
2542
2515
|
</dd>
|
|
2543
2516
|
</dl>
|
|
2544
2517
|
</dd>
|
|
@@ -2552,21 +2525,22 @@ await client.tools.sheets.deleteColumn({
|
|
|
2552
2525
|
<dl>
|
|
2553
2526
|
<dd>
|
|
2554
2527
|
|
|
2555
|
-
**request:** `AthenaIntelligence.tools.DeleteColumnRequest`
|
|
2556
|
-
|
|
2528
|
+
**request:** `AthenaIntelligence.tools.DeleteColumnRequest`
|
|
2529
|
+
|
|
2557
2530
|
</dd>
|
|
2558
2531
|
</dl>
|
|
2559
2532
|
|
|
2560
2533
|
<dl>
|
|
2561
2534
|
<dd>
|
|
2562
2535
|
|
|
2563
|
-
**requestOptions:** `
|
|
2564
|
-
|
|
2536
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2537
|
+
|
|
2565
2538
|
</dd>
|
|
2566
2539
|
</dl>
|
|
2567
2540
|
</dd>
|
|
2568
2541
|
</dl>
|
|
2569
2542
|
|
|
2543
|
+
|
|
2570
2544
|
</dd>
|
|
2571
2545
|
</dl>
|
|
2572
2546
|
</details>
|
|
@@ -2584,7 +2558,6 @@ await client.tools.sheets.deleteColumn({
|
|
|
2584
2558
|
<dd>
|
|
2585
2559
|
|
|
2586
2560
|
Insert a column in an Athena spreadsheet.
|
|
2587
|
-
|
|
2588
2561
|
</dd>
|
|
2589
2562
|
</dl>
|
|
2590
2563
|
</dd>
|
|
@@ -2601,10 +2574,10 @@ Insert a column in an Athena spreadsheet.
|
|
|
2601
2574
|
```typescript
|
|
2602
2575
|
await client.tools.sheets.insertColumn({
|
|
2603
2576
|
asset_id: "asset_id",
|
|
2604
|
-
reference_column_index: 1
|
|
2577
|
+
reference_column_index: 1
|
|
2605
2578
|
});
|
|
2606
|
-
```
|
|
2607
2579
|
|
|
2580
|
+
```
|
|
2608
2581
|
</dd>
|
|
2609
2582
|
</dl>
|
|
2610
2583
|
</dd>
|
|
@@ -2618,21 +2591,22 @@ await client.tools.sheets.insertColumn({
|
|
|
2618
2591
|
<dl>
|
|
2619
2592
|
<dd>
|
|
2620
2593
|
|
|
2621
|
-
**request:** `AthenaIntelligence.tools.InsertColumnRequest`
|
|
2622
|
-
|
|
2594
|
+
**request:** `AthenaIntelligence.tools.InsertColumnRequest`
|
|
2595
|
+
|
|
2623
2596
|
</dd>
|
|
2624
2597
|
</dl>
|
|
2625
2598
|
|
|
2626
2599
|
<dl>
|
|
2627
2600
|
<dd>
|
|
2628
2601
|
|
|
2629
|
-
**requestOptions:** `
|
|
2630
|
-
|
|
2602
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2603
|
+
|
|
2631
2604
|
</dd>
|
|
2632
2605
|
</dl>
|
|
2633
2606
|
</dd>
|
|
2634
2607
|
</dl>
|
|
2635
2608
|
|
|
2609
|
+
|
|
2636
2610
|
</dd>
|
|
2637
2611
|
</dl>
|
|
2638
2612
|
</details>
|
|
@@ -2650,7 +2624,6 @@ await client.tools.sheets.insertColumn({
|
|
|
2650
2624
|
<dd>
|
|
2651
2625
|
|
|
2652
2626
|
Clear formatting from cells in an Athena spreadsheet.
|
|
2653
|
-
|
|
2654
2627
|
</dd>
|
|
2655
2628
|
</dl>
|
|
2656
2629
|
</dd>
|
|
@@ -2670,10 +2643,10 @@ await client.tools.sheets.clearFormatting({
|
|
|
2670
2643
|
end_column_index: 1,
|
|
2671
2644
|
end_row_index: 1,
|
|
2672
2645
|
start_column_index: 1,
|
|
2673
|
-
start_row_index: 1
|
|
2646
|
+
start_row_index: 1
|
|
2674
2647
|
});
|
|
2675
|
-
```
|
|
2676
2648
|
|
|
2649
|
+
```
|
|
2677
2650
|
</dd>
|
|
2678
2651
|
</dl>
|
|
2679
2652
|
</dd>
|
|
@@ -2687,21 +2660,22 @@ await client.tools.sheets.clearFormatting({
|
|
|
2687
2660
|
<dl>
|
|
2688
2661
|
<dd>
|
|
2689
2662
|
|
|
2690
|
-
**request:** `AthenaIntelligence.tools.ClearFormattingRequest`
|
|
2691
|
-
|
|
2663
|
+
**request:** `AthenaIntelligence.tools.ClearFormattingRequest`
|
|
2664
|
+
|
|
2692
2665
|
</dd>
|
|
2693
2666
|
</dl>
|
|
2694
2667
|
|
|
2695
2668
|
<dl>
|
|
2696
2669
|
<dd>
|
|
2697
2670
|
|
|
2698
|
-
**requestOptions:** `
|
|
2699
|
-
|
|
2671
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2672
|
+
|
|
2700
2673
|
</dd>
|
|
2701
2674
|
</dl>
|
|
2702
2675
|
</dd>
|
|
2703
2676
|
</dl>
|
|
2704
2677
|
|
|
2678
|
+
|
|
2705
2679
|
</dd>
|
|
2706
2680
|
</dl>
|
|
2707
2681
|
</details>
|
|
@@ -2719,7 +2693,6 @@ await client.tools.sheets.clearFormatting({
|
|
|
2719
2693
|
<dd>
|
|
2720
2694
|
|
|
2721
2695
|
Clear a range of cells in an Athena spreadsheet.
|
|
2722
|
-
|
|
2723
2696
|
</dd>
|
|
2724
2697
|
</dl>
|
|
2725
2698
|
</dd>
|
|
@@ -2739,10 +2712,10 @@ await client.tools.sheets.clearRange({
|
|
|
2739
2712
|
num_columns: 1,
|
|
2740
2713
|
num_rows: 1,
|
|
2741
2714
|
start_column: 1,
|
|
2742
|
-
start_row: 1
|
|
2715
|
+
start_row: 1
|
|
2743
2716
|
});
|
|
2744
|
-
```
|
|
2745
2717
|
|
|
2718
|
+
```
|
|
2746
2719
|
</dd>
|
|
2747
2720
|
</dl>
|
|
2748
2721
|
</dd>
|
|
@@ -2756,21 +2729,22 @@ await client.tools.sheets.clearRange({
|
|
|
2756
2729
|
<dl>
|
|
2757
2730
|
<dd>
|
|
2758
2731
|
|
|
2759
|
-
**request:** `AthenaIntelligence.tools.ClearSheetRangeRequest`
|
|
2760
|
-
|
|
2732
|
+
**request:** `AthenaIntelligence.tools.ClearSheetRangeRequest`
|
|
2733
|
+
|
|
2761
2734
|
</dd>
|
|
2762
2735
|
</dl>
|
|
2763
2736
|
|
|
2764
2737
|
<dl>
|
|
2765
2738
|
<dd>
|
|
2766
2739
|
|
|
2767
|
-
**requestOptions:** `
|
|
2768
|
-
|
|
2740
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2741
|
+
|
|
2769
2742
|
</dd>
|
|
2770
2743
|
</dl>
|
|
2771
2744
|
</dd>
|
|
2772
2745
|
</dl>
|
|
2773
2746
|
|
|
2747
|
+
|
|
2774
2748
|
</dd>
|
|
2775
2749
|
</dl>
|
|
2776
2750
|
</details>
|
|
@@ -2788,7 +2762,6 @@ await client.tools.sheets.clearRange({
|
|
|
2788
2762
|
<dd>
|
|
2789
2763
|
|
|
2790
2764
|
Apply formatting to a range of cells in an Athena spreadsheet.
|
|
2791
|
-
|
|
2792
2765
|
</dd>
|
|
2793
2766
|
</dl>
|
|
2794
2767
|
</dd>
|
|
@@ -2809,10 +2782,10 @@ await client.tools.sheets.formatRange({
|
|
|
2809
2782
|
end_row: 1,
|
|
2810
2783
|
formatting: {},
|
|
2811
2784
|
start_column: 1,
|
|
2812
|
-
start_row: 1
|
|
2785
|
+
start_row: 1
|
|
2813
2786
|
});
|
|
2814
|
-
```
|
|
2815
2787
|
|
|
2788
|
+
```
|
|
2816
2789
|
</dd>
|
|
2817
2790
|
</dl>
|
|
2818
2791
|
</dd>
|
|
@@ -2826,21 +2799,22 @@ await client.tools.sheets.formatRange({
|
|
|
2826
2799
|
<dl>
|
|
2827
2800
|
<dd>
|
|
2828
2801
|
|
|
2829
|
-
**request:** `AthenaIntelligence.tools.FormatSheetRangeRequest`
|
|
2830
|
-
|
|
2802
|
+
**request:** `AthenaIntelligence.tools.FormatSheetRangeRequest`
|
|
2803
|
+
|
|
2831
2804
|
</dd>
|
|
2832
2805
|
</dl>
|
|
2833
2806
|
|
|
2834
2807
|
<dl>
|
|
2835
2808
|
<dd>
|
|
2836
2809
|
|
|
2837
|
-
**requestOptions:** `
|
|
2838
|
-
|
|
2810
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2811
|
+
|
|
2839
2812
|
</dd>
|
|
2840
2813
|
</dl>
|
|
2841
2814
|
</dd>
|
|
2842
2815
|
</dl>
|
|
2843
2816
|
|
|
2817
|
+
|
|
2844
2818
|
</dd>
|
|
2845
2819
|
</dl>
|
|
2846
2820
|
</details>
|
|
@@ -2858,7 +2832,6 @@ await client.tools.sheets.formatRange({
|
|
|
2858
2832
|
<dd>
|
|
2859
2833
|
|
|
2860
2834
|
Update a range of cells in an Athena spreadsheet.
|
|
2861
|
-
|
|
2862
2835
|
</dd>
|
|
2863
2836
|
</dl>
|
|
2864
2837
|
</dd>
|
|
@@ -2877,10 +2850,10 @@ await client.tools.sheets.updateRange({
|
|
|
2877
2850
|
asset_id: "asset_id",
|
|
2878
2851
|
start_column: 1,
|
|
2879
2852
|
start_row: 1,
|
|
2880
|
-
values: [[]]
|
|
2853
|
+
values: [[]]
|
|
2881
2854
|
});
|
|
2882
|
-
```
|
|
2883
2855
|
|
|
2856
|
+
```
|
|
2884
2857
|
</dd>
|
|
2885
2858
|
</dl>
|
|
2886
2859
|
</dd>
|
|
@@ -2894,21 +2867,22 @@ await client.tools.sheets.updateRange({
|
|
|
2894
2867
|
<dl>
|
|
2895
2868
|
<dd>
|
|
2896
2869
|
|
|
2897
|
-
**request:** `AthenaIntelligence.tools.UpdateSheetRangeRequest`
|
|
2898
|
-
|
|
2870
|
+
**request:** `AthenaIntelligence.tools.UpdateSheetRangeRequest`
|
|
2871
|
+
|
|
2899
2872
|
</dd>
|
|
2900
2873
|
</dl>
|
|
2901
2874
|
|
|
2902
2875
|
<dl>
|
|
2903
2876
|
<dd>
|
|
2904
2877
|
|
|
2905
|
-
**requestOptions:** `
|
|
2906
|
-
|
|
2878
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2879
|
+
|
|
2907
2880
|
</dd>
|
|
2908
2881
|
</dl>
|
|
2909
2882
|
</dd>
|
|
2910
2883
|
</dl>
|
|
2911
2884
|
|
|
2885
|
+
|
|
2912
2886
|
</dd>
|
|
2913
2887
|
</dl>
|
|
2914
2888
|
</details>
|
|
@@ -2926,7 +2900,6 @@ await client.tools.sheets.updateRange({
|
|
|
2926
2900
|
<dd>
|
|
2927
2901
|
|
|
2928
2902
|
Insert a row in an Athena spreadsheet.
|
|
2929
|
-
|
|
2930
2903
|
</dd>
|
|
2931
2904
|
</dl>
|
|
2932
2905
|
</dd>
|
|
@@ -2943,10 +2916,10 @@ Insert a row in an Athena spreadsheet.
|
|
|
2943
2916
|
```typescript
|
|
2944
2917
|
await client.tools.sheets.insertRow({
|
|
2945
2918
|
asset_id: "asset_id",
|
|
2946
|
-
reference_row_index: 1
|
|
2919
|
+
reference_row_index: 1
|
|
2947
2920
|
});
|
|
2948
|
-
```
|
|
2949
2921
|
|
|
2922
|
+
```
|
|
2950
2923
|
</dd>
|
|
2951
2924
|
</dl>
|
|
2952
2925
|
</dd>
|
|
@@ -2960,21 +2933,22 @@ await client.tools.sheets.insertRow({
|
|
|
2960
2933
|
<dl>
|
|
2961
2934
|
<dd>
|
|
2962
2935
|
|
|
2963
|
-
**request:** `AthenaIntelligence.tools.InsertRowRequest`
|
|
2964
|
-
|
|
2936
|
+
**request:** `AthenaIntelligence.tools.InsertRowRequest`
|
|
2937
|
+
|
|
2965
2938
|
</dd>
|
|
2966
2939
|
</dl>
|
|
2967
2940
|
|
|
2968
2941
|
<dl>
|
|
2969
2942
|
<dd>
|
|
2970
2943
|
|
|
2971
|
-
**requestOptions:** `
|
|
2972
|
-
|
|
2944
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2945
|
+
|
|
2973
2946
|
</dd>
|
|
2974
2947
|
</dl>
|
|
2975
2948
|
</dd>
|
|
2976
2949
|
</dl>
|
|
2977
2950
|
|
|
2951
|
+
|
|
2978
2952
|
</dd>
|
|
2979
2953
|
</dl>
|
|
2980
2954
|
</details>
|
|
@@ -2992,7 +2966,6 @@ await client.tools.sheets.insertRow({
|
|
|
2992
2966
|
<dd>
|
|
2993
2967
|
|
|
2994
2968
|
Duplicate an existing sheet in an Athena spreadsheet.
|
|
2995
|
-
|
|
2996
2969
|
</dd>
|
|
2997
2970
|
</dl>
|
|
2998
2971
|
</dd>
|
|
@@ -3008,10 +2981,10 @@ Duplicate an existing sheet in an Athena spreadsheet.
|
|
|
3008
2981
|
|
|
3009
2982
|
```typescript
|
|
3010
2983
|
await client.tools.sheets.duplicateSheet({
|
|
3011
|
-
asset_id: "asset_id"
|
|
2984
|
+
asset_id: "asset_id"
|
|
3012
2985
|
});
|
|
3013
|
-
```
|
|
3014
2986
|
|
|
2987
|
+
```
|
|
3015
2988
|
</dd>
|
|
3016
2989
|
</dl>
|
|
3017
2990
|
</dd>
|
|
@@ -3025,21 +2998,22 @@ await client.tools.sheets.duplicateSheet({
|
|
|
3025
2998
|
<dl>
|
|
3026
2999
|
<dd>
|
|
3027
3000
|
|
|
3028
|
-
**request:** `AthenaIntelligence.tools.DuplicateSheetRequest`
|
|
3029
|
-
|
|
3001
|
+
**request:** `AthenaIntelligence.tools.DuplicateSheetRequest`
|
|
3002
|
+
|
|
3030
3003
|
</dd>
|
|
3031
3004
|
</dl>
|
|
3032
3005
|
|
|
3033
3006
|
<dl>
|
|
3034
3007
|
<dd>
|
|
3035
3008
|
|
|
3036
|
-
**requestOptions:** `
|
|
3037
|
-
|
|
3009
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3010
|
+
|
|
3038
3011
|
</dd>
|
|
3039
3012
|
</dl>
|
|
3040
3013
|
</dd>
|
|
3041
3014
|
</dl>
|
|
3042
3015
|
|
|
3016
|
+
|
|
3043
3017
|
</dd>
|
|
3044
3018
|
</dl>
|
|
3045
3019
|
</details>
|
|
@@ -3057,7 +3031,6 @@ await client.tools.sheets.duplicateSheet({
|
|
|
3057
3031
|
<dd>
|
|
3058
3032
|
|
|
3059
3033
|
Create a new tab in an Athena spreadsheet.
|
|
3060
|
-
|
|
3061
3034
|
</dd>
|
|
3062
3035
|
</dl>
|
|
3063
3036
|
</dd>
|
|
@@ -3079,11 +3052,11 @@ await client.tools.sheets.createTab({
|
|
|
3079
3052
|
index: 1,
|
|
3080
3053
|
rowCount: 1,
|
|
3081
3054
|
sheetId: 1,
|
|
3082
|
-
title: "title"
|
|
3083
|
-
}
|
|
3055
|
+
title: "title"
|
|
3056
|
+
}
|
|
3084
3057
|
});
|
|
3085
|
-
```
|
|
3086
3058
|
|
|
3059
|
+
```
|
|
3087
3060
|
</dd>
|
|
3088
3061
|
</dl>
|
|
3089
3062
|
</dd>
|
|
@@ -3097,21 +3070,22 @@ await client.tools.sheets.createTab({
|
|
|
3097
3070
|
<dl>
|
|
3098
3071
|
<dd>
|
|
3099
3072
|
|
|
3100
|
-
**request:** `AthenaIntelligence.tools.CreateNewSheetTabRequest`
|
|
3101
|
-
|
|
3073
|
+
**request:** `AthenaIntelligence.tools.CreateNewSheetTabRequest`
|
|
3074
|
+
|
|
3102
3075
|
</dd>
|
|
3103
3076
|
</dl>
|
|
3104
3077
|
|
|
3105
3078
|
<dl>
|
|
3106
3079
|
<dd>
|
|
3107
3080
|
|
|
3108
|
-
**requestOptions:** `
|
|
3109
|
-
|
|
3081
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3082
|
+
|
|
3110
3083
|
</dd>
|
|
3111
3084
|
</dl>
|
|
3112
3085
|
</dd>
|
|
3113
3086
|
</dl>
|
|
3114
3087
|
|
|
3088
|
+
|
|
3115
3089
|
</dd>
|
|
3116
3090
|
</dl>
|
|
3117
3091
|
</details>
|
|
@@ -3129,7 +3103,6 @@ await client.tools.sheets.createTab({
|
|
|
3129
3103
|
<dd>
|
|
3130
3104
|
|
|
3131
3105
|
Delete a column from a table within an Athena spreadsheet.
|
|
3132
|
-
|
|
3133
3106
|
</dd>
|
|
3134
3107
|
</dl>
|
|
3135
3108
|
</dd>
|
|
@@ -3147,10 +3120,10 @@ Delete a column from a table within an Athena spreadsheet.
|
|
|
3147
3120
|
await client.tools.sheets.deleteTableColumn({
|
|
3148
3121
|
asset_id: "asset_id",
|
|
3149
3122
|
dimension_index: 1,
|
|
3150
|
-
table_id: "table_id"
|
|
3123
|
+
table_id: "table_id"
|
|
3151
3124
|
});
|
|
3152
|
-
```
|
|
3153
3125
|
|
|
3126
|
+
```
|
|
3154
3127
|
</dd>
|
|
3155
3128
|
</dl>
|
|
3156
3129
|
</dd>
|
|
@@ -3164,21 +3137,22 @@ await client.tools.sheets.deleteTableColumn({
|
|
|
3164
3137
|
<dl>
|
|
3165
3138
|
<dd>
|
|
3166
3139
|
|
|
3167
|
-
**request:** `AthenaIntelligence.tools.DeleteTableColumnRequest`
|
|
3168
|
-
|
|
3140
|
+
**request:** `AthenaIntelligence.tools.DeleteTableColumnRequest`
|
|
3141
|
+
|
|
3169
3142
|
</dd>
|
|
3170
3143
|
</dl>
|
|
3171
3144
|
|
|
3172
3145
|
<dl>
|
|
3173
3146
|
<dd>
|
|
3174
3147
|
|
|
3175
|
-
**requestOptions:** `
|
|
3176
|
-
|
|
3148
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3149
|
+
|
|
3177
3150
|
</dd>
|
|
3178
3151
|
</dl>
|
|
3179
3152
|
</dd>
|
|
3180
3153
|
</dl>
|
|
3181
3154
|
|
|
3155
|
+
|
|
3182
3156
|
</dd>
|
|
3183
3157
|
</dl>
|
|
3184
3158
|
</details>
|
|
@@ -3196,7 +3170,6 @@ await client.tools.sheets.deleteTableColumn({
|
|
|
3196
3170
|
<dd>
|
|
3197
3171
|
|
|
3198
3172
|
Insert a column in a table within an Athena spreadsheet.
|
|
3199
|
-
|
|
3200
3173
|
</dd>
|
|
3201
3174
|
</dl>
|
|
3202
3175
|
</dd>
|
|
@@ -3215,10 +3188,10 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3215
3188
|
asset_id: "asset_id",
|
|
3216
3189
|
dimension_index: 1,
|
|
3217
3190
|
direction: "direction",
|
|
3218
|
-
table_id: "table_id"
|
|
3191
|
+
table_id: "table_id"
|
|
3219
3192
|
});
|
|
3220
|
-
```
|
|
3221
3193
|
|
|
3194
|
+
```
|
|
3222
3195
|
</dd>
|
|
3223
3196
|
</dl>
|
|
3224
3197
|
</dd>
|
|
@@ -3232,21 +3205,22 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3232
3205
|
<dl>
|
|
3233
3206
|
<dd>
|
|
3234
3207
|
|
|
3235
|
-
**request:** `AthenaIntelligence.tools.InsertTableColumnRequest`
|
|
3236
|
-
|
|
3208
|
+
**request:** `AthenaIntelligence.tools.InsertTableColumnRequest`
|
|
3209
|
+
|
|
3237
3210
|
</dd>
|
|
3238
3211
|
</dl>
|
|
3239
3212
|
|
|
3240
3213
|
<dl>
|
|
3241
3214
|
<dd>
|
|
3242
3215
|
|
|
3243
|
-
**requestOptions:** `
|
|
3244
|
-
|
|
3216
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3217
|
+
|
|
3245
3218
|
</dd>
|
|
3246
3219
|
</dl>
|
|
3247
3220
|
</dd>
|
|
3248
3221
|
</dl>
|
|
3249
3222
|
|
|
3223
|
+
|
|
3250
3224
|
</dd>
|
|
3251
3225
|
</dl>
|
|
3252
3226
|
</details>
|
|
@@ -3264,7 +3238,6 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3264
3238
|
<dd>
|
|
3265
3239
|
|
|
3266
3240
|
Create a table in an Athena spreadsheet.
|
|
3267
|
-
|
|
3268
3241
|
</dd>
|
|
3269
3242
|
</dl>
|
|
3270
3243
|
</dd>
|
|
@@ -3286,10 +3259,10 @@ await client.tools.sheets.createTable({
|
|
|
3286
3259
|
start_column_index: 1,
|
|
3287
3260
|
start_row_index: 1,
|
|
3288
3261
|
table_id: "table_id",
|
|
3289
|
-
table_name: "table_name"
|
|
3262
|
+
table_name: "table_name"
|
|
3290
3263
|
});
|
|
3291
|
-
```
|
|
3292
3264
|
|
|
3265
|
+
```
|
|
3293
3266
|
</dd>
|
|
3294
3267
|
</dl>
|
|
3295
3268
|
</dd>
|
|
@@ -3303,21 +3276,22 @@ await client.tools.sheets.createTable({
|
|
|
3303
3276
|
<dl>
|
|
3304
3277
|
<dd>
|
|
3305
3278
|
|
|
3306
|
-
**request:** `AthenaIntelligence.tools.CreateTableRequest`
|
|
3307
|
-
|
|
3279
|
+
**request:** `AthenaIntelligence.tools.CreateTableRequest`
|
|
3280
|
+
|
|
3308
3281
|
</dd>
|
|
3309
3282
|
</dl>
|
|
3310
3283
|
|
|
3311
3284
|
<dl>
|
|
3312
3285
|
<dd>
|
|
3313
3286
|
|
|
3314
|
-
**requestOptions:** `
|
|
3315
|
-
|
|
3287
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3288
|
+
|
|
3316
3289
|
</dd>
|
|
3317
3290
|
</dl>
|
|
3318
3291
|
</dd>
|
|
3319
3292
|
</dl>
|
|
3320
3293
|
|
|
3294
|
+
|
|
3321
3295
|
</dd>
|
|
3322
3296
|
</dl>
|
|
3323
3297
|
</details>
|
|
@@ -3335,7 +3309,6 @@ await client.tools.sheets.createTable({
|
|
|
3335
3309
|
<dd>
|
|
3336
3310
|
|
|
3337
3311
|
Retrieve table data from an Athena spreadsheet.
|
|
3338
|
-
|
|
3339
3312
|
</dd>
|
|
3340
3313
|
</dl>
|
|
3341
3314
|
</dd>
|
|
@@ -3352,10 +3325,10 @@ Retrieve table data from an Athena spreadsheet.
|
|
|
3352
3325
|
```typescript
|
|
3353
3326
|
await client.tools.sheets.getTable({
|
|
3354
3327
|
asset_id: "asset_id",
|
|
3355
|
-
table_name: "table_name"
|
|
3328
|
+
table_name: "table_name"
|
|
3356
3329
|
});
|
|
3357
|
-
```
|
|
3358
3330
|
|
|
3331
|
+
```
|
|
3359
3332
|
</dd>
|
|
3360
3333
|
</dl>
|
|
3361
3334
|
</dd>
|
|
@@ -3369,21 +3342,22 @@ await client.tools.sheets.getTable({
|
|
|
3369
3342
|
<dl>
|
|
3370
3343
|
<dd>
|
|
3371
3344
|
|
|
3372
|
-
**request:** `AthenaIntelligence.tools.GetTableRequest`
|
|
3373
|
-
|
|
3345
|
+
**request:** `AthenaIntelligence.tools.GetTableRequest`
|
|
3346
|
+
|
|
3374
3347
|
</dd>
|
|
3375
3348
|
</dl>
|
|
3376
3349
|
|
|
3377
3350
|
<dl>
|
|
3378
3351
|
<dd>
|
|
3379
3352
|
|
|
3380
|
-
**requestOptions:** `
|
|
3381
|
-
|
|
3353
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3354
|
+
|
|
3382
3355
|
</dd>
|
|
3383
3356
|
</dl>
|
|
3384
3357
|
</dd>
|
|
3385
3358
|
</dl>
|
|
3386
3359
|
|
|
3360
|
+
|
|
3387
3361
|
</dd>
|
|
3388
3362
|
</dl>
|
|
3389
3363
|
</details>
|
|
@@ -3401,7 +3375,6 @@ await client.tools.sheets.getTable({
|
|
|
3401
3375
|
<dd>
|
|
3402
3376
|
|
|
3403
3377
|
Insert rows into a table in an Athena spreadsheet.
|
|
3404
|
-
|
|
3405
3378
|
</dd>
|
|
3406
3379
|
</dl>
|
|
3407
3380
|
</dd>
|
|
@@ -3418,15 +3391,13 @@ Insert rows into a table in an Athena spreadsheet.
|
|
|
3418
3391
|
```typescript
|
|
3419
3392
|
await client.tools.sheets.insertTableRow({
|
|
3420
3393
|
asset_id: "asset_id",
|
|
3421
|
-
row_data: [
|
|
3422
|
-
|
|
3423
|
-
|
|
3424
|
-
|
|
3425
|
-
],
|
|
3426
|
-
table_name: "table_name",
|
|
3394
|
+
row_data: [{
|
|
3395
|
+
"key": "value"
|
|
3396
|
+
}],
|
|
3397
|
+
table_name: "table_name"
|
|
3427
3398
|
});
|
|
3428
|
-
```
|
|
3429
3399
|
|
|
3400
|
+
```
|
|
3430
3401
|
</dd>
|
|
3431
3402
|
</dl>
|
|
3432
3403
|
</dd>
|
|
@@ -3440,21 +3411,22 @@ await client.tools.sheets.insertTableRow({
|
|
|
3440
3411
|
<dl>
|
|
3441
3412
|
<dd>
|
|
3442
3413
|
|
|
3443
|
-
**request:** `AthenaIntelligence.tools.InsertTableRowRequest`
|
|
3444
|
-
|
|
3414
|
+
**request:** `AthenaIntelligence.tools.InsertTableRowRequest`
|
|
3415
|
+
|
|
3445
3416
|
</dd>
|
|
3446
3417
|
</dl>
|
|
3447
3418
|
|
|
3448
3419
|
<dl>
|
|
3449
3420
|
<dd>
|
|
3450
3421
|
|
|
3451
|
-
**requestOptions:** `
|
|
3452
|
-
|
|
3422
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3423
|
+
|
|
3453
3424
|
</dd>
|
|
3454
3425
|
</dl>
|
|
3455
3426
|
</dd>
|
|
3456
3427
|
</dl>
|
|
3457
3428
|
|
|
3429
|
+
|
|
3458
3430
|
</dd>
|
|
3459
3431
|
</dl>
|
|
3460
3432
|
</details>
|
|
@@ -3472,7 +3444,6 @@ await client.tools.sheets.insertTableRow({
|
|
|
3472
3444
|
<dd>
|
|
3473
3445
|
|
|
3474
3446
|
Update an existing table in an Athena spreadsheet.
|
|
3475
|
-
|
|
3476
3447
|
</dd>
|
|
3477
3448
|
</dl>
|
|
3478
3449
|
</dd>
|
|
@@ -3494,10 +3465,10 @@ await client.tools.sheets.updateTable({
|
|
|
3494
3465
|
start_column_index: 1,
|
|
3495
3466
|
start_row_index: 1,
|
|
3496
3467
|
table_id: "table_id",
|
|
3497
|
-
table_name: "table_name"
|
|
3468
|
+
table_name: "table_name"
|
|
3498
3469
|
});
|
|
3499
|
-
```
|
|
3500
3470
|
|
|
3471
|
+
```
|
|
3501
3472
|
</dd>
|
|
3502
3473
|
</dl>
|
|
3503
3474
|
</dd>
|
|
@@ -3511,27 +3482,27 @@ await client.tools.sheets.updateTable({
|
|
|
3511
3482
|
<dl>
|
|
3512
3483
|
<dd>
|
|
3513
3484
|
|
|
3514
|
-
**request:** `AthenaIntelligence.tools.UpdateTableRequest`
|
|
3515
|
-
|
|
3485
|
+
**request:** `AthenaIntelligence.tools.UpdateTableRequest`
|
|
3486
|
+
|
|
3516
3487
|
</dd>
|
|
3517
3488
|
</dl>
|
|
3518
3489
|
|
|
3519
3490
|
<dl>
|
|
3520
3491
|
<dd>
|
|
3521
3492
|
|
|
3522
|
-
**requestOptions:** `
|
|
3523
|
-
|
|
3493
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3494
|
+
|
|
3524
3495
|
</dd>
|
|
3525
3496
|
</dl>
|
|
3526
3497
|
</dd>
|
|
3527
3498
|
</dl>
|
|
3528
3499
|
|
|
3500
|
+
|
|
3529
3501
|
</dd>
|
|
3530
3502
|
</dl>
|
|
3531
3503
|
</details>
|
|
3532
3504
|
|
|
3533
3505
|
## Tools StructuredDataExtractor
|
|
3534
|
-
|
|
3535
3506
|
<details><summary><code>client.tools.structuredDataExtractor.<a href="/src/api/resources/tools/resources/structuredDataExtractor/client/Client.ts">invoke</a>({ ...params }) -> AthenaIntelligence.StructuredDataExtractorResponse</code></summary>
|
|
3536
3507
|
<dl>
|
|
3537
3508
|
<dd>
|
|
@@ -3547,7 +3518,6 @@ await client.tools.sheets.updateTable({
|
|
|
3547
3518
|
Extract structured data.
|
|
3548
3519
|
|
|
3549
3520
|
tl;dr:
|
|
3550
|
-
|
|
3551
3521
|
- pass a valid JSON schema in `json_schema`
|
|
3552
3522
|
- pass the page chunks as a list of `Chunk` objects, by default: `{"type": "text", "content": "..."}`
|
|
3553
3523
|
- leave all other fields as default
|
|
@@ -3562,11 +3532,10 @@ In some applications, you may not want to:
|
|
|
3562
3532
|
|
|
3563
3533
|
- map (if your input asset is small enough)
|
|
3564
3534
|
- reduce (if your output object is large enough that it will overflow the output length;
|
|
3565
|
-
|
|
3566
|
-
|
|
3535
|
+
if you're extracting a long list of entities; if youre )
|
|
3536
|
+
to extract all instances of the schema).
|
|
3567
3537
|
|
|
3568
3538
|
You can configure these behaviors with the `map` and `reduce` fields.
|
|
3569
|
-
|
|
3570
3539
|
</dd>
|
|
3571
3540
|
</dl>
|
|
3572
3541
|
</dd>
|
|
@@ -3582,46 +3551,41 @@ You can configure these behaviors with the `map` and `reduce` fields.
|
|
|
3582
3551
|
|
|
3583
3552
|
```typescript
|
|
3584
3553
|
await client.tools.structuredDataExtractor.invoke({
|
|
3585
|
-
chunks: [
|
|
3586
|
-
{
|
|
3554
|
+
chunks: [{
|
|
3587
3555
|
chunk_id: "1",
|
|
3588
|
-
content: [
|
|
3589
|
-
{
|
|
3556
|
+
content: [{
|
|
3590
3557
|
type: "text",
|
|
3591
|
-
text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
|
|
3592
|
-
}
|
|
3593
|
-
|
|
3594
|
-
},
|
|
3595
|
-
{
|
|
3558
|
+
text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
|
|
3559
|
+
}]
|
|
3560
|
+
}, {
|
|
3596
3561
|
chunk_id: "2",
|
|
3597
|
-
content: [
|
|
3598
|
-
{
|
|
3562
|
+
content: [{
|
|
3599
3563
|
type: "text",
|
|
3600
|
-
text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
|
|
3601
|
-
}
|
|
3602
|
-
|
|
3603
|
-
},
|
|
3604
|
-
],
|
|
3564
|
+
text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
|
|
3565
|
+
}]
|
|
3566
|
+
}],
|
|
3605
3567
|
json_schema: {
|
|
3606
|
-
description: "A person",
|
|
3607
|
-
properties: {
|
|
3608
|
-
age: {
|
|
3609
|
-
type: "integer"
|
|
3610
|
-
},
|
|
3611
|
-
email: {
|
|
3612
|
-
type: "string",
|
|
3568
|
+
"description": "A person",
|
|
3569
|
+
"properties": {
|
|
3570
|
+
"age": {
|
|
3571
|
+
"type": "integer"
|
|
3613
3572
|
},
|
|
3614
|
-
|
|
3615
|
-
type: "string"
|
|
3573
|
+
"email": {
|
|
3574
|
+
"type": "string"
|
|
3616
3575
|
},
|
|
3576
|
+
"name": {
|
|
3577
|
+
"type": "string"
|
|
3578
|
+
}
|
|
3617
3579
|
},
|
|
3618
|
-
required: [
|
|
3619
|
-
|
|
3620
|
-
|
|
3621
|
-
|
|
3580
|
+
"required": [
|
|
3581
|
+
"name"
|
|
3582
|
+
],
|
|
3583
|
+
"title": "Person",
|
|
3584
|
+
"type": "object"
|
|
3585
|
+
}
|
|
3622
3586
|
});
|
|
3623
|
-
```
|
|
3624
3587
|
|
|
3588
|
+
```
|
|
3625
3589
|
</dd>
|
|
3626
3590
|
</dl>
|
|
3627
3591
|
</dd>
|
|
@@ -3635,27 +3599,27 @@ await client.tools.structuredDataExtractor.invoke({
|
|
|
3635
3599
|
<dl>
|
|
3636
3600
|
<dd>
|
|
3637
3601
|
|
|
3638
|
-
**request:** `AthenaIntelligence.tools.StructuredDataExtractorRequest`
|
|
3639
|
-
|
|
3602
|
+
**request:** `AthenaIntelligence.tools.StructuredDataExtractorRequest`
|
|
3603
|
+
|
|
3640
3604
|
</dd>
|
|
3641
3605
|
</dl>
|
|
3642
3606
|
|
|
3643
3607
|
<dl>
|
|
3644
3608
|
<dd>
|
|
3645
3609
|
|
|
3646
|
-
**requestOptions:** `
|
|
3647
|
-
|
|
3610
|
+
**requestOptions:** `StructuredDataExtractorClient.RequestOptions`
|
|
3611
|
+
|
|
3648
3612
|
</dd>
|
|
3649
3613
|
</dl>
|
|
3650
3614
|
</dd>
|
|
3651
3615
|
</dl>
|
|
3652
3616
|
|
|
3617
|
+
|
|
3653
3618
|
</dd>
|
|
3654
3619
|
</dl>
|
|
3655
3620
|
</details>
|
|
3656
3621
|
|
|
3657
3622
|
## Tools Tasks
|
|
3658
|
-
|
|
3659
3623
|
<details><summary><code>client.tools.tasks.<a href="/src/api/resources/tools/resources/tasks/client/Client.ts">runTask</a>({ ...params }) -> AthenaIntelligence.RunTaskResponse</code></summary>
|
|
3660
3624
|
<dl>
|
|
3661
3625
|
<dd>
|
|
@@ -3671,7 +3635,6 @@ await client.tools.structuredDataExtractor.invoke({
|
|
|
3671
3635
|
Run a [task](https://resources.athenaintel.com/docs/task-studio/home) and wait for the result.
|
|
3672
3636
|
|
|
3673
3637
|
Executes a Windmill script or flow synchronously. Server handles polling internally.
|
|
3674
|
-
|
|
3675
3638
|
</dd>
|
|
3676
3639
|
</dl>
|
|
3677
3640
|
</dd>
|
|
@@ -3687,10 +3650,10 @@ Executes a Windmill script or flow synchronously. Server handles polling interna
|
|
|
3687
3650
|
|
|
3688
3651
|
```typescript
|
|
3689
3652
|
await client.tools.tasks.runTask({
|
|
3690
|
-
task_id: "task_id"
|
|
3653
|
+
task_id: "task_id"
|
|
3691
3654
|
});
|
|
3692
|
-
```
|
|
3693
3655
|
|
|
3656
|
+
```
|
|
3694
3657
|
</dd>
|
|
3695
3658
|
</dl>
|
|
3696
3659
|
</dd>
|
|
@@ -3704,21 +3667,22 @@ await client.tools.tasks.runTask({
|
|
|
3704
3667
|
<dl>
|
|
3705
3668
|
<dd>
|
|
3706
3669
|
|
|
3707
|
-
**request:** `AthenaIntelligence.tools.RunTaskRequest`
|
|
3708
|
-
|
|
3670
|
+
**request:** `AthenaIntelligence.tools.RunTaskRequest`
|
|
3671
|
+
|
|
3709
3672
|
</dd>
|
|
3710
3673
|
</dl>
|
|
3711
3674
|
|
|
3712
3675
|
<dl>
|
|
3713
3676
|
<dd>
|
|
3714
3677
|
|
|
3715
|
-
**requestOptions:** `
|
|
3716
|
-
|
|
3678
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
3679
|
+
|
|
3717
3680
|
</dd>
|
|
3718
3681
|
</dl>
|
|
3719
3682
|
</dd>
|
|
3720
3683
|
</dl>
|
|
3721
3684
|
|
|
3685
|
+
|
|
3722
3686
|
</dd>
|
|
3723
3687
|
</dl>
|
|
3724
3688
|
</details>
|