@athenaintel/sdk 4.3.309 → 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 +28 -28
- package/dist/cjs/api/resources/databases/client/Client.js +118 -75
- package/dist/cjs/api/resources/databases/client/index.d.ts +0 -1
- package/dist/cjs/api/resources/databases/client/requests/DatabasesDeleteRequest.d.ts +1 -1
- package/dist/cjs/api/resources/databases/client/requests/index.d.ts +4 -4
- 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 +28 -28
- package/dist/esm/api/resources/databases/client/Client.mjs +116 -73
- 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 +1 -1
- package/dist/esm/api/resources/databases/client/requests/DatabasesDeleteRequest.mjs +1 -1
- package/dist/esm/api/resources/databases/client/requests/index.d.mts +4 -4
- package/dist/esm/api/resources/databases/client/requests/index.mjs +1 -4
- 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 +450 -490
- 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
|
|
|
@@ -765,7 +758,6 @@ await client.databases.insert("asset_id", "table_name", {
|
|
|
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
760
|
**Safety:** Filters are required by default to prevent accidental bulk deletes. To delete all rows intentionally, pass `?force=true`.
|
|
768
|
-
|
|
769
761
|
</dd>
|
|
770
762
|
</dl>
|
|
771
763
|
</dd>
|
|
@@ -783,11 +775,11 @@ Delete rows matching the filter conditions. Filter conditions are passed as quer
|
|
|
783
775
|
await client.databases.delete("asset_id", "table_name", {
|
|
784
776
|
force: true,
|
|
785
777
|
body: {
|
|
786
|
-
return_representation: false
|
|
787
|
-
}
|
|
778
|
+
return_representation: false
|
|
779
|
+
}
|
|
788
780
|
});
|
|
789
|
-
```
|
|
790
781
|
|
|
782
|
+
```
|
|
791
783
|
</dd>
|
|
792
784
|
</dl>
|
|
793
785
|
</dd>
|
|
@@ -801,42 +793,43 @@ await client.databases.delete("asset_id", "table_name", {
|
|
|
801
793
|
<dl>
|
|
802
794
|
<dd>
|
|
803
795
|
|
|
804
|
-
**
|
|
805
|
-
|
|
796
|
+
**asset_id:** `string`
|
|
797
|
+
|
|
806
798
|
</dd>
|
|
807
799
|
</dl>
|
|
808
800
|
|
|
809
801
|
<dl>
|
|
810
802
|
<dd>
|
|
811
803
|
|
|
812
|
-
**
|
|
813
|
-
|
|
804
|
+
**table_name:** `string`
|
|
805
|
+
|
|
814
806
|
</dd>
|
|
815
807
|
</dl>
|
|
816
808
|
|
|
817
809
|
<dl>
|
|
818
810
|
<dd>
|
|
819
811
|
|
|
820
|
-
**request:** `AthenaIntelligence.DatabasesDeleteRequest`
|
|
821
|
-
|
|
812
|
+
**request:** `AthenaIntelligence.DatabasesDeleteRequest`
|
|
813
|
+
|
|
822
814
|
</dd>
|
|
823
815
|
</dl>
|
|
824
816
|
|
|
825
817
|
<dl>
|
|
826
818
|
<dd>
|
|
827
819
|
|
|
828
|
-
**requestOptions:** `
|
|
829
|
-
|
|
820
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
821
|
+
|
|
830
822
|
</dd>
|
|
831
823
|
</dl>
|
|
832
824
|
</dd>
|
|
833
825
|
</dl>
|
|
834
826
|
|
|
827
|
+
|
|
835
828
|
</dd>
|
|
836
829
|
</dl>
|
|
837
830
|
</details>
|
|
838
831
|
|
|
839
|
-
<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>
|
|
840
833
|
<dl>
|
|
841
834
|
<dd>
|
|
842
835
|
|
|
@@ -851,7 +844,6 @@ await client.databases.delete("asset_id", "table_name", {
|
|
|
851
844
|
Update rows matching the filter conditions. Filter conditions are passed as query parameters using PostgREST syntax (e.g., `?id=eq.5`).
|
|
852
845
|
|
|
853
846
|
**Safety:** Filters are required by default to prevent accidental bulk updates. To update all rows intentionally, pass `?force=true`.
|
|
854
|
-
|
|
855
847
|
</dd>
|
|
856
848
|
</dl>
|
|
857
849
|
</dd>
|
|
@@ -869,13 +861,13 @@ Update rows matching the filter conditions. Filter conditions are passed as quer
|
|
|
869
861
|
await client.databases.update("asset_id", "table_name", {
|
|
870
862
|
force: true,
|
|
871
863
|
data: {
|
|
872
|
-
email: "alice.smith@example.com",
|
|
873
|
-
name: "Alice Smith"
|
|
864
|
+
"email": "alice.smith@example.com",
|
|
865
|
+
"name": "Alice Smith"
|
|
874
866
|
},
|
|
875
|
-
return_representation: true
|
|
867
|
+
return_representation: true
|
|
876
868
|
});
|
|
877
|
-
```
|
|
878
869
|
|
|
870
|
+
```
|
|
879
871
|
</dd>
|
|
880
872
|
</dl>
|
|
881
873
|
</dd>
|
|
@@ -889,42 +881,43 @@ await client.databases.update("asset_id", "table_name", {
|
|
|
889
881
|
<dl>
|
|
890
882
|
<dd>
|
|
891
883
|
|
|
892
|
-
**
|
|
893
|
-
|
|
884
|
+
**asset_id:** `string`
|
|
885
|
+
|
|
894
886
|
</dd>
|
|
895
887
|
</dl>
|
|
896
888
|
|
|
897
889
|
<dl>
|
|
898
890
|
<dd>
|
|
899
891
|
|
|
900
|
-
**
|
|
901
|
-
|
|
892
|
+
**table_name:** `string`
|
|
893
|
+
|
|
902
894
|
</dd>
|
|
903
895
|
</dl>
|
|
904
896
|
|
|
905
897
|
<dl>
|
|
906
898
|
<dd>
|
|
907
899
|
|
|
908
|
-
**request:** `AthenaIntelligence.UpdateDataRequest`
|
|
909
|
-
|
|
900
|
+
**request:** `AthenaIntelligence.UpdateDataRequest`
|
|
901
|
+
|
|
910
902
|
</dd>
|
|
911
903
|
</dl>
|
|
912
904
|
|
|
913
905
|
<dl>
|
|
914
906
|
<dd>
|
|
915
907
|
|
|
916
|
-
**requestOptions:** `
|
|
917
|
-
|
|
908
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
909
|
+
|
|
918
910
|
</dd>
|
|
919
911
|
</dl>
|
|
920
912
|
</dd>
|
|
921
913
|
</dl>
|
|
922
914
|
|
|
915
|
+
|
|
923
916
|
</dd>
|
|
924
917
|
</dl>
|
|
925
918
|
</details>
|
|
926
919
|
|
|
927
|
-
<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>
|
|
928
921
|
<dl>
|
|
929
922
|
<dd>
|
|
930
923
|
|
|
@@ -937,7 +930,6 @@ await client.databases.update("asset_id", "table_name", {
|
|
|
937
930
|
<dd>
|
|
938
931
|
|
|
939
932
|
Get the schema for a specific table, including column names, types, nullability, and default values. Useful for agent tooling and dynamic form generation.
|
|
940
|
-
|
|
941
933
|
</dd>
|
|
942
934
|
</dl>
|
|
943
935
|
</dd>
|
|
@@ -953,8 +945,8 @@ Get the schema for a specific table, including column names, types, nullability,
|
|
|
953
945
|
|
|
954
946
|
```typescript
|
|
955
947
|
await client.databases.getTableSchema("asset_id", "table_name");
|
|
956
|
-
```
|
|
957
948
|
|
|
949
|
+
```
|
|
958
950
|
</dd>
|
|
959
951
|
</dl>
|
|
960
952
|
</dd>
|
|
@@ -968,35 +960,35 @@ await client.databases.getTableSchema("asset_id", "table_name");
|
|
|
968
960
|
<dl>
|
|
969
961
|
<dd>
|
|
970
962
|
|
|
971
|
-
**
|
|
972
|
-
|
|
963
|
+
**asset_id:** `string`
|
|
964
|
+
|
|
973
965
|
</dd>
|
|
974
966
|
</dl>
|
|
975
967
|
|
|
976
968
|
<dl>
|
|
977
969
|
<dd>
|
|
978
970
|
|
|
979
|
-
**
|
|
980
|
-
|
|
971
|
+
**table_name:** `string`
|
|
972
|
+
|
|
981
973
|
</dd>
|
|
982
974
|
</dl>
|
|
983
975
|
|
|
984
976
|
<dl>
|
|
985
977
|
<dd>
|
|
986
978
|
|
|
987
|
-
**requestOptions:** `
|
|
988
|
-
|
|
979
|
+
**requestOptions:** `DatabasesClient.RequestOptions`
|
|
980
|
+
|
|
989
981
|
</dd>
|
|
990
982
|
</dl>
|
|
991
983
|
</dd>
|
|
992
984
|
</dl>
|
|
993
985
|
|
|
986
|
+
|
|
994
987
|
</dd>
|
|
995
988
|
</dl>
|
|
996
989
|
</details>
|
|
997
990
|
|
|
998
991
|
## Query
|
|
999
|
-
|
|
1000
992
|
<details><summary><code>client.query.<a href="/src/api/resources/query/client/Client.ts">execute</a>({ ...params }) -> AthenaIntelligence.DataFrameRequestOut</code></summary>
|
|
1001
993
|
<dl>
|
|
1002
994
|
<dd>
|
|
@@ -1010,7 +1002,6 @@ await client.databases.getTableSchema("asset_id", "table_name");
|
|
|
1010
1002
|
<dd>
|
|
1011
1003
|
|
|
1012
1004
|
Get the result of an SQL query over given assets.
|
|
1013
|
-
|
|
1014
1005
|
</dd>
|
|
1015
1006
|
</dl>
|
|
1016
1007
|
</dd>
|
|
@@ -1027,10 +1018,10 @@ Get the result of an SQL query over given assets.
|
|
|
1027
1018
|
```typescript
|
|
1028
1019
|
await client.query.execute({
|
|
1029
1020
|
sql_command: "sql_command",
|
|
1030
|
-
database_asset_ids: "database_asset_ids"
|
|
1021
|
+
database_asset_ids: "database_asset_ids"
|
|
1031
1022
|
});
|
|
1032
|
-
```
|
|
1033
1023
|
|
|
1024
|
+
```
|
|
1034
1025
|
</dd>
|
|
1035
1026
|
</dl>
|
|
1036
1027
|
</dd>
|
|
@@ -1044,21 +1035,22 @@ await client.query.execute({
|
|
|
1044
1035
|
<dl>
|
|
1045
1036
|
<dd>
|
|
1046
1037
|
|
|
1047
|
-
**request:** `AthenaIntelligence.QueryExecuteRequest`
|
|
1048
|
-
|
|
1038
|
+
**request:** `AthenaIntelligence.QueryExecuteRequest`
|
|
1039
|
+
|
|
1049
1040
|
</dd>
|
|
1050
1041
|
</dl>
|
|
1051
1042
|
|
|
1052
1043
|
<dl>
|
|
1053
1044
|
<dd>
|
|
1054
1045
|
|
|
1055
|
-
**requestOptions:** `
|
|
1056
|
-
|
|
1046
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
1047
|
+
|
|
1057
1048
|
</dd>
|
|
1058
1049
|
</dl>
|
|
1059
1050
|
</dd>
|
|
1060
1051
|
</dl>
|
|
1061
1052
|
|
|
1053
|
+
|
|
1062
1054
|
</dd>
|
|
1063
1055
|
</dl>
|
|
1064
1056
|
</details>
|
|
@@ -1076,7 +1068,6 @@ await client.query.execute({
|
|
|
1076
1068
|
<dd>
|
|
1077
1069
|
|
|
1078
1070
|
Get the result of an SQL query over given assets.
|
|
1079
|
-
|
|
1080
1071
|
</dd>
|
|
1081
1072
|
</dl>
|
|
1082
1073
|
</dd>
|
|
@@ -1092,10 +1083,10 @@ Get the result of an SQL query over given assets.
|
|
|
1092
1083
|
|
|
1093
1084
|
```typescript
|
|
1094
1085
|
await client.query.executeSnippet({
|
|
1095
|
-
snippet_asset_id: "snippet_asset_id"
|
|
1086
|
+
snippet_asset_id: "snippet_asset_id"
|
|
1096
1087
|
});
|
|
1097
|
-
```
|
|
1098
1088
|
|
|
1089
|
+
```
|
|
1099
1090
|
</dd>
|
|
1100
1091
|
</dl>
|
|
1101
1092
|
</dd>
|
|
@@ -1109,28 +1100,28 @@ await client.query.executeSnippet({
|
|
|
1109
1100
|
<dl>
|
|
1110
1101
|
<dd>
|
|
1111
1102
|
|
|
1112
|
-
**request:** `AthenaIntelligence.QueryExecuteSnippetRequest`
|
|
1113
|
-
|
|
1103
|
+
**request:** `AthenaIntelligence.QueryExecuteSnippetRequest`
|
|
1104
|
+
|
|
1114
1105
|
</dd>
|
|
1115
1106
|
</dl>
|
|
1116
1107
|
|
|
1117
1108
|
<dl>
|
|
1118
1109
|
<dd>
|
|
1119
1110
|
|
|
1120
|
-
**requestOptions:** `
|
|
1121
|
-
|
|
1111
|
+
**requestOptions:** `QueryClient.RequestOptions`
|
|
1112
|
+
|
|
1122
1113
|
</dd>
|
|
1123
1114
|
</dl>
|
|
1124
1115
|
</dd>
|
|
1125
1116
|
</dl>
|
|
1126
1117
|
|
|
1118
|
+
|
|
1127
1119
|
</dd>
|
|
1128
1120
|
</dl>
|
|
1129
1121
|
</details>
|
|
1130
1122
|
|
|
1131
1123
|
## Threads
|
|
1132
|
-
|
|
1133
|
-
<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>
|
|
1134
1125
|
<dl>
|
|
1135
1126
|
<dd>
|
|
1136
1127
|
|
|
@@ -1143,7 +1134,6 @@ await client.query.executeSnippet({
|
|
|
1143
1134
|
<dd>
|
|
1144
1135
|
|
|
1145
1136
|
Check the status of a thread execution by thread ID. Returns thread status and associated conversation asset information for tracking progress.
|
|
1146
|
-
|
|
1147
1137
|
</dd>
|
|
1148
1138
|
</dl>
|
|
1149
1139
|
</dd>
|
|
@@ -1159,8 +1149,8 @@ Check the status of a thread execution by thread ID. Returns thread status and a
|
|
|
1159
1149
|
|
|
1160
1150
|
```typescript
|
|
1161
1151
|
await client.threads.getStatus("thread_id");
|
|
1162
|
-
```
|
|
1163
1152
|
|
|
1153
|
+
```
|
|
1164
1154
|
</dd>
|
|
1165
1155
|
</dl>
|
|
1166
1156
|
</dd>
|
|
@@ -1174,27 +1164,27 @@ await client.threads.getStatus("thread_id");
|
|
|
1174
1164
|
<dl>
|
|
1175
1165
|
<dd>
|
|
1176
1166
|
|
|
1177
|
-
**
|
|
1178
|
-
|
|
1167
|
+
**thread_id:** `string` — The unique thread ID to check status for
|
|
1168
|
+
|
|
1179
1169
|
</dd>
|
|
1180
1170
|
</dl>
|
|
1181
1171
|
|
|
1182
1172
|
<dl>
|
|
1183
1173
|
<dd>
|
|
1184
1174
|
|
|
1185
|
-
**requestOptions:** `
|
|
1186
|
-
|
|
1175
|
+
**requestOptions:** `ThreadsClient.RequestOptions`
|
|
1176
|
+
|
|
1187
1177
|
</dd>
|
|
1188
1178
|
</dl>
|
|
1189
1179
|
</dd>
|
|
1190
1180
|
</dl>
|
|
1191
1181
|
|
|
1182
|
+
|
|
1192
1183
|
</dd>
|
|
1193
1184
|
</dl>
|
|
1194
1185
|
</details>
|
|
1195
1186
|
|
|
1196
1187
|
## Tools
|
|
1197
|
-
|
|
1198
1188
|
<details><summary><code>client.tools.<a href="/src/api/resources/tools/client/Client.ts">getAssetChunks</a>({ ...params }) -> unknown</code></summary>
|
|
1199
1189
|
<dl>
|
|
1200
1190
|
<dd>
|
|
@@ -1208,7 +1198,6 @@ await client.threads.getStatus("thread_id");
|
|
|
1208
1198
|
<dd>
|
|
1209
1199
|
|
|
1210
1200
|
Get the chunks of a file.
|
|
1211
|
-
|
|
1212
1201
|
</dd>
|
|
1213
1202
|
</dl>
|
|
1214
1203
|
</dd>
|
|
@@ -1224,10 +1213,10 @@ Get the chunks of a file.
|
|
|
1224
1213
|
|
|
1225
1214
|
```typescript
|
|
1226
1215
|
await client.tools.getAssetChunks({
|
|
1227
|
-
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"]
|
|
1228
1217
|
});
|
|
1229
|
-
```
|
|
1230
1218
|
|
|
1219
|
+
```
|
|
1231
1220
|
</dd>
|
|
1232
1221
|
</dl>
|
|
1233
1222
|
</dd>
|
|
@@ -1241,21 +1230,22 @@ await client.tools.getAssetChunks({
|
|
|
1241
1230
|
<dl>
|
|
1242
1231
|
<dd>
|
|
1243
1232
|
|
|
1244
|
-
**request:** `AthenaIntelligence.FileChunkRequestIn`
|
|
1245
|
-
|
|
1233
|
+
**request:** `AthenaIntelligence.FileChunkRequestIn`
|
|
1234
|
+
|
|
1246
1235
|
</dd>
|
|
1247
1236
|
</dl>
|
|
1248
1237
|
|
|
1249
1238
|
<dl>
|
|
1250
1239
|
<dd>
|
|
1251
1240
|
|
|
1252
|
-
**requestOptions:** `
|
|
1253
|
-
|
|
1241
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1242
|
+
|
|
1254
1243
|
</dd>
|
|
1255
1244
|
</dl>
|
|
1256
1245
|
</dd>
|
|
1257
1246
|
</dl>
|
|
1258
1247
|
|
|
1248
|
+
|
|
1259
1249
|
</dd>
|
|
1260
1250
|
</dl>
|
|
1261
1251
|
</details>
|
|
@@ -1273,7 +1263,6 @@ await client.tools.getAssetChunks({
|
|
|
1273
1263
|
<dd>
|
|
1274
1264
|
|
|
1275
1265
|
Get the content of an asset.
|
|
1276
|
-
|
|
1277
1266
|
</dd>
|
|
1278
1267
|
</dl>
|
|
1279
1268
|
</dd>
|
|
@@ -1289,10 +1278,10 @@ Get the content of an asset.
|
|
|
1289
1278
|
|
|
1290
1279
|
```typescript
|
|
1291
1280
|
await client.tools.getAssetContent({
|
|
1292
|
-
asset_id: "asset_id"
|
|
1281
|
+
asset_id: "asset_id"
|
|
1293
1282
|
});
|
|
1294
|
-
```
|
|
1295
1283
|
|
|
1284
|
+
```
|
|
1296
1285
|
</dd>
|
|
1297
1286
|
</dl>
|
|
1298
1287
|
</dd>
|
|
@@ -1306,21 +1295,22 @@ await client.tools.getAssetContent({
|
|
|
1306
1295
|
<dl>
|
|
1307
1296
|
<dd>
|
|
1308
1297
|
|
|
1309
|
-
**request:** `AthenaIntelligence.ToolsGetAssetContentRequest`
|
|
1310
|
-
|
|
1298
|
+
**request:** `AthenaIntelligence.ToolsGetAssetContentRequest`
|
|
1299
|
+
|
|
1311
1300
|
</dd>
|
|
1312
1301
|
</dl>
|
|
1313
1302
|
|
|
1314
1303
|
<dl>
|
|
1315
1304
|
<dd>
|
|
1316
1305
|
|
|
1317
|
-
**requestOptions:** `
|
|
1318
|
-
|
|
1306
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1307
|
+
|
|
1319
1308
|
</dd>
|
|
1320
1309
|
</dl>
|
|
1321
1310
|
</dd>
|
|
1322
1311
|
</dl>
|
|
1323
1312
|
|
|
1313
|
+
|
|
1324
1314
|
</dd>
|
|
1325
1315
|
</dl>
|
|
1326
1316
|
</details>
|
|
@@ -1338,7 +1328,6 @@ await client.tools.getAssetContent({
|
|
|
1338
1328
|
<dd>
|
|
1339
1329
|
|
|
1340
1330
|
Get a screenshot of a specific page from an asset.
|
|
1341
|
-
|
|
1342
1331
|
</dd>
|
|
1343
1332
|
</dl>
|
|
1344
1333
|
</dd>
|
|
@@ -1355,10 +1344,10 @@ Get a screenshot of a specific page from an asset.
|
|
|
1355
1344
|
```typescript
|
|
1356
1345
|
await client.tools.getAssetScreenshot({
|
|
1357
1346
|
asset_id: "asset_id",
|
|
1358
|
-
page_number: 1
|
|
1347
|
+
page_number: 1
|
|
1359
1348
|
});
|
|
1360
|
-
```
|
|
1361
1349
|
|
|
1350
|
+
```
|
|
1362
1351
|
</dd>
|
|
1363
1352
|
</dl>
|
|
1364
1353
|
</dd>
|
|
@@ -1372,21 +1361,22 @@ await client.tools.getAssetScreenshot({
|
|
|
1372
1361
|
<dl>
|
|
1373
1362
|
<dd>
|
|
1374
1363
|
|
|
1375
|
-
**request:** `AthenaIntelligence.ToolsGetAssetScreenshotRequest`
|
|
1376
|
-
|
|
1364
|
+
**request:** `AthenaIntelligence.ToolsGetAssetScreenshotRequest`
|
|
1365
|
+
|
|
1377
1366
|
</dd>
|
|
1378
1367
|
</dl>
|
|
1379
1368
|
|
|
1380
1369
|
<dl>
|
|
1381
1370
|
<dd>
|
|
1382
1371
|
|
|
1383
|
-
**requestOptions:** `
|
|
1384
|
-
|
|
1372
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1373
|
+
|
|
1385
1374
|
</dd>
|
|
1386
1375
|
</dl>
|
|
1387
1376
|
</dd>
|
|
1388
1377
|
</dl>
|
|
1389
1378
|
|
|
1379
|
+
|
|
1390
1380
|
</dd>
|
|
1391
1381
|
</dl>
|
|
1392
1382
|
</details>
|
|
@@ -1404,7 +1394,6 @@ await client.tools.getAssetScreenshot({
|
|
|
1404
1394
|
<dd>
|
|
1405
1395
|
|
|
1406
1396
|
List contents of an asset (Folder, Collection, Project) or entire workspace in a tree structure.
|
|
1407
|
-
|
|
1408
1397
|
</dd>
|
|
1409
1398
|
</dl>
|
|
1410
1399
|
</dd>
|
|
@@ -1422,10 +1411,10 @@ List contents of an asset (Folder, Collection, Project) or entire workspace in a
|
|
|
1422
1411
|
await client.tools.listContents({
|
|
1423
1412
|
asset_id: "asset_id",
|
|
1424
1413
|
include_asset_details: true,
|
|
1425
|
-
include_system_files: true
|
|
1414
|
+
include_system_files: true
|
|
1426
1415
|
});
|
|
1427
|
-
```
|
|
1428
1416
|
|
|
1417
|
+
```
|
|
1429
1418
|
</dd>
|
|
1430
1419
|
</dl>
|
|
1431
1420
|
</dd>
|
|
@@ -1439,21 +1428,22 @@ await client.tools.listContents({
|
|
|
1439
1428
|
<dl>
|
|
1440
1429
|
<dd>
|
|
1441
1430
|
|
|
1442
|
-
**request:** `AthenaIntelligence.ToolsListContentsRequest`
|
|
1443
|
-
|
|
1431
|
+
**request:** `AthenaIntelligence.ToolsListContentsRequest`
|
|
1432
|
+
|
|
1444
1433
|
</dd>
|
|
1445
1434
|
</dl>
|
|
1446
1435
|
|
|
1447
1436
|
<dl>
|
|
1448
1437
|
<dd>
|
|
1449
1438
|
|
|
1450
|
-
**requestOptions:** `
|
|
1451
|
-
|
|
1439
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1440
|
+
|
|
1452
1441
|
</dd>
|
|
1453
1442
|
</dl>
|
|
1454
1443
|
</dd>
|
|
1455
1444
|
</dl>
|
|
1456
1445
|
|
|
1446
|
+
|
|
1457
1447
|
</dd>
|
|
1458
1448
|
</dl>
|
|
1459
1449
|
</details>
|
|
@@ -1476,10 +1466,10 @@ await client.tools.dataFrame({
|
|
|
1476
1466
|
row_limit: 1,
|
|
1477
1467
|
index_column: 1,
|
|
1478
1468
|
sheet_name: "sheet_name",
|
|
1479
|
-
separator: "separator"
|
|
1469
|
+
separator: "separator"
|
|
1480
1470
|
});
|
|
1481
|
-
```
|
|
1482
1471
|
|
|
1472
|
+
```
|
|
1483
1473
|
</dd>
|
|
1484
1474
|
</dl>
|
|
1485
1475
|
</dd>
|
|
@@ -1493,21 +1483,22 @@ await client.tools.dataFrame({
|
|
|
1493
1483
|
<dl>
|
|
1494
1484
|
<dd>
|
|
1495
1485
|
|
|
1496
|
-
**request:** `AthenaIntelligence.ToolsDataFrameRequest`
|
|
1497
|
-
|
|
1486
|
+
**request:** `AthenaIntelligence.ToolsDataFrameRequest`
|
|
1487
|
+
|
|
1498
1488
|
</dd>
|
|
1499
1489
|
</dl>
|
|
1500
1490
|
|
|
1501
1491
|
<dl>
|
|
1502
1492
|
<dd>
|
|
1503
1493
|
|
|
1504
|
-
**requestOptions:** `
|
|
1505
|
-
|
|
1494
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1495
|
+
|
|
1506
1496
|
</dd>
|
|
1507
1497
|
</dl>
|
|
1508
1498
|
</dd>
|
|
1509
1499
|
</dl>
|
|
1510
1500
|
|
|
1501
|
+
|
|
1511
1502
|
</dd>
|
|
1512
1503
|
</dl>
|
|
1513
1504
|
</details>
|
|
@@ -1525,7 +1516,6 @@ await client.tools.dataFrame({
|
|
|
1525
1516
|
<dd>
|
|
1526
1517
|
|
|
1527
1518
|
Get the raw file data for given asset.
|
|
1528
|
-
|
|
1529
1519
|
</dd>
|
|
1530
1520
|
</dl>
|
|
1531
1521
|
</dd>
|
|
@@ -1541,10 +1531,10 @@ Get the raw file data for given asset.
|
|
|
1541
1531
|
|
|
1542
1532
|
```typescript
|
|
1543
1533
|
await client.tools.rawData({
|
|
1544
|
-
asset_id: "asset_id"
|
|
1534
|
+
asset_id: "asset_id"
|
|
1545
1535
|
});
|
|
1546
|
-
```
|
|
1547
1536
|
|
|
1537
|
+
```
|
|
1548
1538
|
</dd>
|
|
1549
1539
|
</dl>
|
|
1550
1540
|
</dd>
|
|
@@ -1558,21 +1548,22 @@ await client.tools.rawData({
|
|
|
1558
1548
|
<dl>
|
|
1559
1549
|
<dd>
|
|
1560
1550
|
|
|
1561
|
-
**request:** `AthenaIntelligence.ToolsRawDataRequest`
|
|
1562
|
-
|
|
1551
|
+
**request:** `AthenaIntelligence.ToolsRawDataRequest`
|
|
1552
|
+
|
|
1563
1553
|
</dd>
|
|
1564
1554
|
</dl>
|
|
1565
1555
|
|
|
1566
1556
|
<dl>
|
|
1567
1557
|
<dd>
|
|
1568
1558
|
|
|
1569
|
-
**requestOptions:** `
|
|
1570
|
-
|
|
1559
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1560
|
+
|
|
1571
1561
|
</dd>
|
|
1572
1562
|
</dl>
|
|
1573
1563
|
</dd>
|
|
1574
1564
|
</dl>
|
|
1575
1565
|
|
|
1566
|
+
|
|
1576
1567
|
</dd>
|
|
1577
1568
|
</dl>
|
|
1578
1569
|
</details>
|
|
@@ -1590,7 +1581,6 @@ await client.tools.rawData({
|
|
|
1590
1581
|
<dd>
|
|
1591
1582
|
|
|
1592
1583
|
Save a file as an asset in the user's workspace.
|
|
1593
|
-
|
|
1594
1584
|
</dd>
|
|
1595
1585
|
</dl>
|
|
1596
1586
|
</dd>
|
|
@@ -1607,10 +1597,10 @@ Save a file as an asset in the user's workspace.
|
|
|
1607
1597
|
```typescript
|
|
1608
1598
|
await client.tools.saveAsset({
|
|
1609
1599
|
file: fs.createReadStream("/path/to/your/file"),
|
|
1610
|
-
parent_folder_id: "parent_folder_id"
|
|
1600
|
+
parent_folder_id: "parent_folder_id"
|
|
1611
1601
|
});
|
|
1612
|
-
```
|
|
1613
1602
|
|
|
1603
|
+
```
|
|
1614
1604
|
</dd>
|
|
1615
1605
|
</dl>
|
|
1616
1606
|
</dd>
|
|
@@ -1624,27 +1614,27 @@ await client.tools.saveAsset({
|
|
|
1624
1614
|
<dl>
|
|
1625
1615
|
<dd>
|
|
1626
1616
|
|
|
1627
|
-
**request:** `AthenaIntelligence.BodySaveAssetApiV0ToolsFileSavePost`
|
|
1628
|
-
|
|
1617
|
+
**request:** `AthenaIntelligence.BodySaveAssetApiV0ToolsFileSavePost`
|
|
1618
|
+
|
|
1629
1619
|
</dd>
|
|
1630
1620
|
</dl>
|
|
1631
1621
|
|
|
1632
1622
|
<dl>
|
|
1633
1623
|
<dd>
|
|
1634
1624
|
|
|
1635
|
-
**requestOptions:** `
|
|
1636
|
-
|
|
1625
|
+
**requestOptions:** `ToolsClient.RequestOptions`
|
|
1626
|
+
|
|
1637
1627
|
</dd>
|
|
1638
1628
|
</dl>
|
|
1639
1629
|
</dd>
|
|
1640
1630
|
</dl>
|
|
1641
1631
|
|
|
1632
|
+
|
|
1642
1633
|
</dd>
|
|
1643
1634
|
</dl>
|
|
1644
1635
|
</details>
|
|
1645
1636
|
|
|
1646
1637
|
## Agents Drive
|
|
1647
|
-
|
|
1648
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>
|
|
1649
1639
|
<dl>
|
|
1650
1640
|
<dd>
|
|
@@ -1658,7 +1648,6 @@ await client.tools.saveAsset({
|
|
|
1658
1648
|
<dd>
|
|
1659
1649
|
|
|
1660
1650
|
Coming soon! Manage folders and search for files in the internal drive.
|
|
1661
|
-
|
|
1662
1651
|
</dd>
|
|
1663
1652
|
</dl>
|
|
1664
1653
|
</dd>
|
|
@@ -1675,16 +1664,14 @@ Coming soon! Manage folders and search for files in the internal drive.
|
|
|
1675
1664
|
```typescript
|
|
1676
1665
|
await client.agents.drive.invoke({
|
|
1677
1666
|
config: {
|
|
1678
|
-
key: "value"
|
|
1667
|
+
"key": "value"
|
|
1679
1668
|
},
|
|
1680
|
-
messages: [
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
},
|
|
1684
|
-
],
|
|
1669
|
+
messages: [{
|
|
1670
|
+
"key": "value"
|
|
1671
|
+
}]
|
|
1685
1672
|
});
|
|
1686
|
-
```
|
|
1687
1673
|
|
|
1674
|
+
```
|
|
1688
1675
|
</dd>
|
|
1689
1676
|
</dl>
|
|
1690
1677
|
</dd>
|
|
@@ -1698,27 +1685,27 @@ await client.agents.drive.invoke({
|
|
|
1698
1685
|
<dl>
|
|
1699
1686
|
<dd>
|
|
1700
1687
|
|
|
1701
|
-
**request:** `AthenaIntelligence.agents.DriveAgentRequest`
|
|
1702
|
-
|
|
1688
|
+
**request:** `AthenaIntelligence.agents.DriveAgentRequest`
|
|
1689
|
+
|
|
1703
1690
|
</dd>
|
|
1704
1691
|
</dl>
|
|
1705
1692
|
|
|
1706
1693
|
<dl>
|
|
1707
1694
|
<dd>
|
|
1708
1695
|
|
|
1709
|
-
**requestOptions:** `
|
|
1710
|
-
|
|
1696
|
+
**requestOptions:** `DriveClient.RequestOptions`
|
|
1697
|
+
|
|
1711
1698
|
</dd>
|
|
1712
1699
|
</dl>
|
|
1713
1700
|
</dd>
|
|
1714
1701
|
</dl>
|
|
1715
1702
|
|
|
1703
|
+
|
|
1716
1704
|
</dd>
|
|
1717
1705
|
</dl>
|
|
1718
1706
|
</details>
|
|
1719
1707
|
|
|
1720
1708
|
## Agents General
|
|
1721
|
-
|
|
1722
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>
|
|
1723
1710
|
<dl>
|
|
1724
1711
|
<dd>
|
|
@@ -1732,7 +1719,6 @@ await client.agents.drive.invoke({
|
|
|
1732
1719
|
<dd>
|
|
1733
1720
|
|
|
1734
1721
|
Coming soon! Call the general agent with batched requests and return the results.
|
|
1735
|
-
|
|
1736
1722
|
</dd>
|
|
1737
1723
|
</dl>
|
|
1738
1724
|
</dd>
|
|
@@ -1747,21 +1733,17 @@ Coming soon! Call the general agent with batched requests and return the results
|
|
|
1747
1733
|
<dd>
|
|
1748
1734
|
|
|
1749
1735
|
```typescript
|
|
1750
|
-
await client.agents.general.batch([
|
|
1751
|
-
{
|
|
1736
|
+
await client.agents.general.batch([{
|
|
1752
1737
|
config: {
|
|
1753
|
-
enabled_tools: ["search"]
|
|
1738
|
+
enabled_tools: ["search"]
|
|
1754
1739
|
},
|
|
1755
|
-
messages: [
|
|
1756
|
-
{
|
|
1740
|
+
messages: [{
|
|
1757
1741
|
content: "Please call the search tool for AAPL news.",
|
|
1758
|
-
role: "user"
|
|
1759
|
-
}
|
|
1760
|
-
|
|
1761
|
-
},
|
|
1762
|
-
]);
|
|
1763
|
-
```
|
|
1742
|
+
role: "user"
|
|
1743
|
+
}]
|
|
1744
|
+
}]);
|
|
1764
1745
|
|
|
1746
|
+
```
|
|
1765
1747
|
</dd>
|
|
1766
1748
|
</dl>
|
|
1767
1749
|
</dd>
|
|
@@ -1775,21 +1757,22 @@ await client.agents.general.batch([
|
|
|
1775
1757
|
<dl>
|
|
1776
1758
|
<dd>
|
|
1777
1759
|
|
|
1778
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest[]`
|
|
1779
|
-
|
|
1760
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest[]`
|
|
1761
|
+
|
|
1780
1762
|
</dd>
|
|
1781
1763
|
</dl>
|
|
1782
1764
|
|
|
1783
1765
|
<dl>
|
|
1784
1766
|
<dd>
|
|
1785
1767
|
|
|
1786
|
-
**requestOptions:** `
|
|
1787
|
-
|
|
1768
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1769
|
+
|
|
1788
1770
|
</dd>
|
|
1789
1771
|
</dl>
|
|
1790
1772
|
</dd>
|
|
1791
1773
|
</dl>
|
|
1792
1774
|
|
|
1775
|
+
|
|
1793
1776
|
</dd>
|
|
1794
1777
|
</dl>
|
|
1795
1778
|
</details>
|
|
@@ -1810,7 +1793,6 @@ Call the general Athena agent synchronously.
|
|
|
1810
1793
|
|
|
1811
1794
|
Call the agent with the messages list, wait for the agent to complete,
|
|
1812
1795
|
and return the result.
|
|
1813
|
-
|
|
1814
1796
|
</dd>
|
|
1815
1797
|
</dl>
|
|
1816
1798
|
</dd>
|
|
@@ -1827,17 +1809,15 @@ and return the result.
|
|
|
1827
1809
|
```typescript
|
|
1828
1810
|
await client.agents.general.invoke({
|
|
1829
1811
|
config: {
|
|
1830
|
-
enabled_tools: ["search"]
|
|
1812
|
+
enabled_tools: ["search"]
|
|
1831
1813
|
},
|
|
1832
|
-
messages: [
|
|
1833
|
-
{
|
|
1814
|
+
messages: [{
|
|
1834
1815
|
content: "Please call the search tool for AAPL news.",
|
|
1835
|
-
role: "user"
|
|
1836
|
-
}
|
|
1837
|
-
],
|
|
1816
|
+
role: "user"
|
|
1817
|
+
}]
|
|
1838
1818
|
});
|
|
1839
|
-
```
|
|
1840
1819
|
|
|
1820
|
+
```
|
|
1841
1821
|
</dd>
|
|
1842
1822
|
</dl>
|
|
1843
1823
|
</dd>
|
|
@@ -1851,21 +1831,22 @@ await client.agents.general.invoke({
|
|
|
1851
1831
|
<dl>
|
|
1852
1832
|
<dd>
|
|
1853
1833
|
|
|
1854
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1855
|
-
|
|
1834
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1835
|
+
|
|
1856
1836
|
</dd>
|
|
1857
1837
|
</dl>
|
|
1858
1838
|
|
|
1859
1839
|
<dl>
|
|
1860
1840
|
<dd>
|
|
1861
1841
|
|
|
1862
|
-
**requestOptions:** `
|
|
1863
|
-
|
|
1842
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1843
|
+
|
|
1864
1844
|
</dd>
|
|
1865
1845
|
</dl>
|
|
1866
1846
|
</dd>
|
|
1867
1847
|
</dl>
|
|
1868
1848
|
|
|
1849
|
+
|
|
1869
1850
|
</dd>
|
|
1870
1851
|
</dl>
|
|
1871
1852
|
</details>
|
|
@@ -1883,7 +1864,6 @@ await client.agents.general.invoke({
|
|
|
1883
1864
|
<dd>
|
|
1884
1865
|
|
|
1885
1866
|
Coming soon! Call the general agent and stream events for real-time chat applications.
|
|
1886
|
-
|
|
1887
1867
|
</dd>
|
|
1888
1868
|
</dl>
|
|
1889
1869
|
</dd>
|
|
@@ -1900,17 +1880,15 @@ Coming soon! Call the general agent and stream events for real-time chat applica
|
|
|
1900
1880
|
```typescript
|
|
1901
1881
|
await client.agents.general.streamEvents({
|
|
1902
1882
|
config: {
|
|
1903
|
-
enabled_tools: ["search"]
|
|
1883
|
+
enabled_tools: ["search"]
|
|
1904
1884
|
},
|
|
1905
|
-
messages: [
|
|
1906
|
-
{
|
|
1885
|
+
messages: [{
|
|
1907
1886
|
content: "Please call the search tool for AAPL news.",
|
|
1908
|
-
role: "user"
|
|
1909
|
-
}
|
|
1910
|
-
],
|
|
1887
|
+
role: "user"
|
|
1888
|
+
}]
|
|
1911
1889
|
});
|
|
1912
|
-
```
|
|
1913
1890
|
|
|
1891
|
+
```
|
|
1914
1892
|
</dd>
|
|
1915
1893
|
</dl>
|
|
1916
1894
|
</dd>
|
|
@@ -1924,27 +1902,27 @@ await client.agents.general.streamEvents({
|
|
|
1924
1902
|
<dl>
|
|
1925
1903
|
<dd>
|
|
1926
1904
|
|
|
1927
|
-
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1928
|
-
|
|
1905
|
+
**request:** `AthenaIntelligence.GeneralAgentRequest`
|
|
1906
|
+
|
|
1929
1907
|
</dd>
|
|
1930
1908
|
</dl>
|
|
1931
1909
|
|
|
1932
1910
|
<dl>
|
|
1933
1911
|
<dd>
|
|
1934
1912
|
|
|
1935
|
-
**requestOptions:** `
|
|
1936
|
-
|
|
1913
|
+
**requestOptions:** `GeneralClient.RequestOptions`
|
|
1914
|
+
|
|
1937
1915
|
</dd>
|
|
1938
1916
|
</dl>
|
|
1939
1917
|
</dd>
|
|
1940
1918
|
</dl>
|
|
1941
1919
|
|
|
1920
|
+
|
|
1942
1921
|
</dd>
|
|
1943
1922
|
</dl>
|
|
1944
1923
|
</details>
|
|
1945
1924
|
|
|
1946
1925
|
## Agents Research
|
|
1947
|
-
|
|
1948
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>
|
|
1949
1927
|
<dl>
|
|
1950
1928
|
<dd>
|
|
@@ -1958,7 +1936,6 @@ await client.agents.general.streamEvents({
|
|
|
1958
1936
|
<dd>
|
|
1959
1937
|
|
|
1960
1938
|
Coming soon! Conduct research using web and other sources.
|
|
1961
|
-
|
|
1962
1939
|
</dd>
|
|
1963
1940
|
</dl>
|
|
1964
1941
|
</dd>
|
|
@@ -1975,16 +1952,14 @@ Coming soon! Conduct research using web and other sources.
|
|
|
1975
1952
|
```typescript
|
|
1976
1953
|
await client.agents.research.invoke({
|
|
1977
1954
|
config: {
|
|
1978
|
-
key: "value"
|
|
1955
|
+
"key": "value"
|
|
1979
1956
|
},
|
|
1980
|
-
messages: [
|
|
1981
|
-
|
|
1982
|
-
|
|
1983
|
-
},
|
|
1984
|
-
],
|
|
1957
|
+
messages: [{
|
|
1958
|
+
"key": "value"
|
|
1959
|
+
}]
|
|
1985
1960
|
});
|
|
1986
|
-
```
|
|
1987
1961
|
|
|
1962
|
+
```
|
|
1988
1963
|
</dd>
|
|
1989
1964
|
</dl>
|
|
1990
1965
|
</dd>
|
|
@@ -1998,27 +1973,27 @@ await client.agents.research.invoke({
|
|
|
1998
1973
|
<dl>
|
|
1999
1974
|
<dd>
|
|
2000
1975
|
|
|
2001
|
-
**request:** `AthenaIntelligence.agents.ResearchAgentRequest`
|
|
2002
|
-
|
|
1976
|
+
**request:** `AthenaIntelligence.agents.ResearchAgentRequest`
|
|
1977
|
+
|
|
2003
1978
|
</dd>
|
|
2004
1979
|
</dl>
|
|
2005
1980
|
|
|
2006
1981
|
<dl>
|
|
2007
1982
|
<dd>
|
|
2008
1983
|
|
|
2009
|
-
**requestOptions:** `
|
|
2010
|
-
|
|
1984
|
+
**requestOptions:** `ResearchClient.RequestOptions`
|
|
1985
|
+
|
|
2011
1986
|
</dd>
|
|
2012
1987
|
</dl>
|
|
2013
1988
|
</dd>
|
|
2014
1989
|
</dl>
|
|
2015
1990
|
|
|
1991
|
+
|
|
2016
1992
|
</dd>
|
|
2017
1993
|
</dl>
|
|
2018
1994
|
</details>
|
|
2019
1995
|
|
|
2020
1996
|
## Agents Sql
|
|
2021
|
-
|
|
2022
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>
|
|
2023
1998
|
<dl>
|
|
2024
1999
|
<dd>
|
|
@@ -2032,7 +2007,6 @@ await client.agents.research.invoke({
|
|
|
2032
2007
|
<dd>
|
|
2033
2008
|
|
|
2034
2009
|
Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for the query object.
|
|
2035
|
-
|
|
2036
2010
|
</dd>
|
|
2037
2011
|
</dl>
|
|
2038
2012
|
</dd>
|
|
@@ -2049,16 +2023,14 @@ Coming soon! Generate, execute, and test SQL queries. Returns an asset ID for th
|
|
|
2049
2023
|
```typescript
|
|
2050
2024
|
await client.agents.sql.invoke({
|
|
2051
2025
|
config: {
|
|
2052
|
-
key: "value"
|
|
2026
|
+
"key": "value"
|
|
2053
2027
|
},
|
|
2054
|
-
messages: [
|
|
2055
|
-
|
|
2056
|
-
|
|
2057
|
-
},
|
|
2058
|
-
],
|
|
2028
|
+
messages: [{
|
|
2029
|
+
"key": "value"
|
|
2030
|
+
}]
|
|
2059
2031
|
});
|
|
2060
|
-
```
|
|
2061
2032
|
|
|
2033
|
+
```
|
|
2062
2034
|
</dd>
|
|
2063
2035
|
</dl>
|
|
2064
2036
|
</dd>
|
|
@@ -2072,27 +2044,27 @@ await client.agents.sql.invoke({
|
|
|
2072
2044
|
<dl>
|
|
2073
2045
|
<dd>
|
|
2074
2046
|
|
|
2075
|
-
**request:** `AthenaIntelligence.agents.SqlAgentRequest`
|
|
2076
|
-
|
|
2047
|
+
**request:** `AthenaIntelligence.agents.SqlAgentRequest`
|
|
2048
|
+
|
|
2077
2049
|
</dd>
|
|
2078
2050
|
</dl>
|
|
2079
2051
|
|
|
2080
2052
|
<dl>
|
|
2081
2053
|
<dd>
|
|
2082
2054
|
|
|
2083
|
-
**requestOptions:** `
|
|
2084
|
-
|
|
2055
|
+
**requestOptions:** `SqlClient.RequestOptions`
|
|
2056
|
+
|
|
2085
2057
|
</dd>
|
|
2086
2058
|
</dl>
|
|
2087
2059
|
</dd>
|
|
2088
2060
|
</dl>
|
|
2089
2061
|
|
|
2062
|
+
|
|
2090
2063
|
</dd>
|
|
2091
2064
|
</dl>
|
|
2092
2065
|
</details>
|
|
2093
2066
|
|
|
2094
2067
|
## Tools Calendar
|
|
2095
|
-
|
|
2096
2068
|
<details><summary><code>client.tools.calendar.<a href="/src/api/resources/tools/resources/calendar/client/Client.ts">listEvents</a>() -> unknown</code></summary>
|
|
2097
2069
|
<dl>
|
|
2098
2070
|
<dd>
|
|
@@ -2106,7 +2078,6 @@ await client.agents.sql.invoke({
|
|
|
2106
2078
|
<dd>
|
|
2107
2079
|
|
|
2108
2080
|
Coming soon! List calendar events with optional filtering.
|
|
2109
|
-
|
|
2110
2081
|
</dd>
|
|
2111
2082
|
</dl>
|
|
2112
2083
|
</dd>
|
|
@@ -2122,8 +2093,8 @@ Coming soon! List calendar events with optional filtering.
|
|
|
2122
2093
|
|
|
2123
2094
|
```typescript
|
|
2124
2095
|
await client.tools.calendar.listEvents();
|
|
2125
|
-
```
|
|
2126
2096
|
|
|
2097
|
+
```
|
|
2127
2098
|
</dd>
|
|
2128
2099
|
</dl>
|
|
2129
2100
|
</dd>
|
|
@@ -2137,13 +2108,14 @@ await client.tools.calendar.listEvents();
|
|
|
2137
2108
|
<dl>
|
|
2138
2109
|
<dd>
|
|
2139
2110
|
|
|
2140
|
-
**requestOptions:** `
|
|
2141
|
-
|
|
2111
|
+
**requestOptions:** `CalendarClient.RequestOptions`
|
|
2112
|
+
|
|
2142
2113
|
</dd>
|
|
2143
2114
|
</dl>
|
|
2144
2115
|
</dd>
|
|
2145
2116
|
</dl>
|
|
2146
2117
|
|
|
2118
|
+
|
|
2147
2119
|
</dd>
|
|
2148
2120
|
</dl>
|
|
2149
2121
|
</details>
|
|
@@ -2161,7 +2133,6 @@ await client.tools.calendar.listEvents();
|
|
|
2161
2133
|
<dd>
|
|
2162
2134
|
|
|
2163
2135
|
Coming soon! Create new calendar events.
|
|
2164
|
-
|
|
2165
2136
|
</dd>
|
|
2166
2137
|
</dl>
|
|
2167
2138
|
</dd>
|
|
@@ -2177,8 +2148,8 @@ Coming soon! Create new calendar events.
|
|
|
2177
2148
|
|
|
2178
2149
|
```typescript
|
|
2179
2150
|
await client.tools.calendar.createEvent();
|
|
2180
|
-
```
|
|
2181
2151
|
|
|
2152
|
+
```
|
|
2182
2153
|
</dd>
|
|
2183
2154
|
</dl>
|
|
2184
2155
|
</dd>
|
|
@@ -2192,19 +2163,19 @@ await client.tools.calendar.createEvent();
|
|
|
2192
2163
|
<dl>
|
|
2193
2164
|
<dd>
|
|
2194
2165
|
|
|
2195
|
-
**requestOptions:** `
|
|
2196
|
-
|
|
2166
|
+
**requestOptions:** `CalendarClient.RequestOptions`
|
|
2167
|
+
|
|
2197
2168
|
</dd>
|
|
2198
2169
|
</dl>
|
|
2199
2170
|
</dd>
|
|
2200
2171
|
</dl>
|
|
2201
2172
|
|
|
2173
|
+
|
|
2202
2174
|
</dd>
|
|
2203
2175
|
</dl>
|
|
2204
2176
|
</details>
|
|
2205
2177
|
|
|
2206
2178
|
## Tools Email
|
|
2207
|
-
|
|
2208
2179
|
<details><summary><code>client.tools.email.<a href="/src/api/resources/tools/resources/email/client/Client.ts">createDraft</a>() -> unknown</code></summary>
|
|
2209
2180
|
<dl>
|
|
2210
2181
|
<dd>
|
|
@@ -2218,7 +2189,6 @@ await client.tools.calendar.createEvent();
|
|
|
2218
2189
|
<dd>
|
|
2219
2190
|
|
|
2220
2191
|
Coming soon! Create email drafts with specified content and recipients.
|
|
2221
|
-
|
|
2222
2192
|
</dd>
|
|
2223
2193
|
</dl>
|
|
2224
2194
|
</dd>
|
|
@@ -2234,8 +2204,8 @@ Coming soon! Create email drafts with specified content and recipients.
|
|
|
2234
2204
|
|
|
2235
2205
|
```typescript
|
|
2236
2206
|
await client.tools.email.createDraft();
|
|
2237
|
-
```
|
|
2238
2207
|
|
|
2208
|
+
```
|
|
2239
2209
|
</dd>
|
|
2240
2210
|
</dl>
|
|
2241
2211
|
</dd>
|
|
@@ -2249,13 +2219,14 @@ await client.tools.email.createDraft();
|
|
|
2249
2219
|
<dl>
|
|
2250
2220
|
<dd>
|
|
2251
2221
|
|
|
2252
|
-
**requestOptions:** `
|
|
2253
|
-
|
|
2222
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2223
|
+
|
|
2254
2224
|
</dd>
|
|
2255
2225
|
</dl>
|
|
2256
2226
|
</dd>
|
|
2257
2227
|
</dl>
|
|
2258
2228
|
|
|
2229
|
+
|
|
2259
2230
|
</dd>
|
|
2260
2231
|
</dl>
|
|
2261
2232
|
</details>
|
|
@@ -2273,7 +2244,6 @@ await client.tools.email.createDraft();
|
|
|
2273
2244
|
<dd>
|
|
2274
2245
|
|
|
2275
2246
|
Coming soon! Search through emails with configurable filters.
|
|
2276
|
-
|
|
2277
2247
|
</dd>
|
|
2278
2248
|
</dl>
|
|
2279
2249
|
</dd>
|
|
@@ -2289,8 +2259,8 @@ Coming soon! Search through emails with configurable filters.
|
|
|
2289
2259
|
|
|
2290
2260
|
```typescript
|
|
2291
2261
|
await client.tools.email.search();
|
|
2292
|
-
```
|
|
2293
2262
|
|
|
2263
|
+
```
|
|
2294
2264
|
</dd>
|
|
2295
2265
|
</dl>
|
|
2296
2266
|
</dd>
|
|
@@ -2304,13 +2274,14 @@ await client.tools.email.search();
|
|
|
2304
2274
|
<dl>
|
|
2305
2275
|
<dd>
|
|
2306
2276
|
|
|
2307
|
-
**requestOptions:** `
|
|
2308
|
-
|
|
2277
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2278
|
+
|
|
2309
2279
|
</dd>
|
|
2310
2280
|
</dl>
|
|
2311
2281
|
</dd>
|
|
2312
2282
|
</dl>
|
|
2313
2283
|
|
|
2284
|
+
|
|
2314
2285
|
</dd>
|
|
2315
2286
|
</dl>
|
|
2316
2287
|
</details>
|
|
@@ -2328,7 +2299,6 @@ await client.tools.email.search();
|
|
|
2328
2299
|
<dd>
|
|
2329
2300
|
|
|
2330
2301
|
Coming soon! Send emails to specified recipients.
|
|
2331
|
-
|
|
2332
2302
|
</dd>
|
|
2333
2303
|
</dl>
|
|
2334
2304
|
</dd>
|
|
@@ -2344,8 +2314,8 @@ Coming soon! Send emails to specified recipients.
|
|
|
2344
2314
|
|
|
2345
2315
|
```typescript
|
|
2346
2316
|
await client.tools.email.send();
|
|
2347
|
-
```
|
|
2348
2317
|
|
|
2318
|
+
```
|
|
2349
2319
|
</dd>
|
|
2350
2320
|
</dl>
|
|
2351
2321
|
</dd>
|
|
@@ -2359,19 +2329,19 @@ await client.tools.email.send();
|
|
|
2359
2329
|
<dl>
|
|
2360
2330
|
<dd>
|
|
2361
2331
|
|
|
2362
|
-
**requestOptions:** `
|
|
2363
|
-
|
|
2332
|
+
**requestOptions:** `EmailClient.RequestOptions`
|
|
2333
|
+
|
|
2364
2334
|
</dd>
|
|
2365
2335
|
</dl>
|
|
2366
2336
|
</dd>
|
|
2367
2337
|
</dl>
|
|
2368
2338
|
|
|
2339
|
+
|
|
2369
2340
|
</dd>
|
|
2370
2341
|
</dl>
|
|
2371
2342
|
</details>
|
|
2372
2343
|
|
|
2373
2344
|
## Tools Sheets
|
|
2374
|
-
|
|
2375
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>
|
|
2376
2346
|
<dl>
|
|
2377
2347
|
<dd>
|
|
@@ -2385,7 +2355,6 @@ await client.tools.email.send();
|
|
|
2385
2355
|
<dd>
|
|
2386
2356
|
|
|
2387
2357
|
Update a single cell in an Athena spreadsheet.
|
|
2388
|
-
|
|
2389
2358
|
</dd>
|
|
2390
2359
|
</dl>
|
|
2391
2360
|
</dd>
|
|
@@ -2404,10 +2373,10 @@ await client.tools.sheets.updateCell({
|
|
|
2404
2373
|
asset_id: "asset_id",
|
|
2405
2374
|
column: 1,
|
|
2406
2375
|
row: 1,
|
|
2407
|
-
value: "value"
|
|
2376
|
+
value: "value"
|
|
2408
2377
|
});
|
|
2409
|
-
```
|
|
2410
2378
|
|
|
2379
|
+
```
|
|
2411
2380
|
</dd>
|
|
2412
2381
|
</dl>
|
|
2413
2382
|
</dd>
|
|
@@ -2421,21 +2390,22 @@ await client.tools.sheets.updateCell({
|
|
|
2421
2390
|
<dl>
|
|
2422
2391
|
<dd>
|
|
2423
2392
|
|
|
2424
|
-
**request:** `AthenaIntelligence.tools.UpdateSheetCellRequest`
|
|
2425
|
-
|
|
2393
|
+
**request:** `AthenaIntelligence.tools.UpdateSheetCellRequest`
|
|
2394
|
+
|
|
2426
2395
|
</dd>
|
|
2427
2396
|
</dl>
|
|
2428
2397
|
|
|
2429
2398
|
<dl>
|
|
2430
2399
|
<dd>
|
|
2431
2400
|
|
|
2432
|
-
**requestOptions:** `
|
|
2433
|
-
|
|
2401
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2402
|
+
|
|
2434
2403
|
</dd>
|
|
2435
2404
|
</dl>
|
|
2436
2405
|
</dd>
|
|
2437
2406
|
</dl>
|
|
2438
2407
|
|
|
2408
|
+
|
|
2439
2409
|
</dd>
|
|
2440
2410
|
</dl>
|
|
2441
2411
|
</details>
|
|
@@ -2453,7 +2423,6 @@ await client.tools.sheets.updateCell({
|
|
|
2453
2423
|
<dd>
|
|
2454
2424
|
|
|
2455
2425
|
Delete cells from an Athena spreadsheet.
|
|
2456
|
-
|
|
2457
2426
|
</dd>
|
|
2458
2427
|
</dl>
|
|
2459
2428
|
</dd>
|
|
@@ -2473,10 +2442,10 @@ await client.tools.sheets.deleteCells({
|
|
|
2473
2442
|
end_column_index: 1,
|
|
2474
2443
|
end_row_index: 1,
|
|
2475
2444
|
start_column_index: 1,
|
|
2476
|
-
start_row_index: 1
|
|
2445
|
+
start_row_index: 1
|
|
2477
2446
|
});
|
|
2478
|
-
```
|
|
2479
2447
|
|
|
2448
|
+
```
|
|
2480
2449
|
</dd>
|
|
2481
2450
|
</dl>
|
|
2482
2451
|
</dd>
|
|
@@ -2490,21 +2459,22 @@ await client.tools.sheets.deleteCells({
|
|
|
2490
2459
|
<dl>
|
|
2491
2460
|
<dd>
|
|
2492
2461
|
|
|
2493
|
-
**request:** `AthenaIntelligence.tools.DeleteCellsRequest`
|
|
2494
|
-
|
|
2462
|
+
**request:** `AthenaIntelligence.tools.DeleteCellsRequest`
|
|
2463
|
+
|
|
2495
2464
|
</dd>
|
|
2496
2465
|
</dl>
|
|
2497
2466
|
|
|
2498
2467
|
<dl>
|
|
2499
2468
|
<dd>
|
|
2500
2469
|
|
|
2501
|
-
**requestOptions:** `
|
|
2502
|
-
|
|
2470
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2471
|
+
|
|
2503
2472
|
</dd>
|
|
2504
2473
|
</dl>
|
|
2505
2474
|
</dd>
|
|
2506
2475
|
</dl>
|
|
2507
2476
|
|
|
2477
|
+
|
|
2508
2478
|
</dd>
|
|
2509
2479
|
</dl>
|
|
2510
2480
|
</details>
|
|
@@ -2522,7 +2492,6 @@ await client.tools.sheets.deleteCells({
|
|
|
2522
2492
|
<dd>
|
|
2523
2493
|
|
|
2524
2494
|
Delete columns from an Athena spreadsheet.
|
|
2525
|
-
|
|
2526
2495
|
</dd>
|
|
2527
2496
|
</dl>
|
|
2528
2497
|
</dd>
|
|
@@ -2539,10 +2508,10 @@ Delete columns from an Athena spreadsheet.
|
|
|
2539
2508
|
```typescript
|
|
2540
2509
|
await client.tools.sheets.deleteColumn({
|
|
2541
2510
|
asset_id: "asset_id",
|
|
2542
|
-
column_indexes: [1]
|
|
2511
|
+
column_indexes: [1]
|
|
2543
2512
|
});
|
|
2544
|
-
```
|
|
2545
2513
|
|
|
2514
|
+
```
|
|
2546
2515
|
</dd>
|
|
2547
2516
|
</dl>
|
|
2548
2517
|
</dd>
|
|
@@ -2556,21 +2525,22 @@ await client.tools.sheets.deleteColumn({
|
|
|
2556
2525
|
<dl>
|
|
2557
2526
|
<dd>
|
|
2558
2527
|
|
|
2559
|
-
**request:** `AthenaIntelligence.tools.DeleteColumnRequest`
|
|
2560
|
-
|
|
2528
|
+
**request:** `AthenaIntelligence.tools.DeleteColumnRequest`
|
|
2529
|
+
|
|
2561
2530
|
</dd>
|
|
2562
2531
|
</dl>
|
|
2563
2532
|
|
|
2564
2533
|
<dl>
|
|
2565
2534
|
<dd>
|
|
2566
2535
|
|
|
2567
|
-
**requestOptions:** `
|
|
2568
|
-
|
|
2536
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2537
|
+
|
|
2569
2538
|
</dd>
|
|
2570
2539
|
</dl>
|
|
2571
2540
|
</dd>
|
|
2572
2541
|
</dl>
|
|
2573
2542
|
|
|
2543
|
+
|
|
2574
2544
|
</dd>
|
|
2575
2545
|
</dl>
|
|
2576
2546
|
</details>
|
|
@@ -2588,7 +2558,6 @@ await client.tools.sheets.deleteColumn({
|
|
|
2588
2558
|
<dd>
|
|
2589
2559
|
|
|
2590
2560
|
Insert a column in an Athena spreadsheet.
|
|
2591
|
-
|
|
2592
2561
|
</dd>
|
|
2593
2562
|
</dl>
|
|
2594
2563
|
</dd>
|
|
@@ -2605,10 +2574,10 @@ Insert a column in an Athena spreadsheet.
|
|
|
2605
2574
|
```typescript
|
|
2606
2575
|
await client.tools.sheets.insertColumn({
|
|
2607
2576
|
asset_id: "asset_id",
|
|
2608
|
-
reference_column_index: 1
|
|
2577
|
+
reference_column_index: 1
|
|
2609
2578
|
});
|
|
2610
|
-
```
|
|
2611
2579
|
|
|
2580
|
+
```
|
|
2612
2581
|
</dd>
|
|
2613
2582
|
</dl>
|
|
2614
2583
|
</dd>
|
|
@@ -2622,21 +2591,22 @@ await client.tools.sheets.insertColumn({
|
|
|
2622
2591
|
<dl>
|
|
2623
2592
|
<dd>
|
|
2624
2593
|
|
|
2625
|
-
**request:** `AthenaIntelligence.tools.InsertColumnRequest`
|
|
2626
|
-
|
|
2594
|
+
**request:** `AthenaIntelligence.tools.InsertColumnRequest`
|
|
2595
|
+
|
|
2627
2596
|
</dd>
|
|
2628
2597
|
</dl>
|
|
2629
2598
|
|
|
2630
2599
|
<dl>
|
|
2631
2600
|
<dd>
|
|
2632
2601
|
|
|
2633
|
-
**requestOptions:** `
|
|
2634
|
-
|
|
2602
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2603
|
+
|
|
2635
2604
|
</dd>
|
|
2636
2605
|
</dl>
|
|
2637
2606
|
</dd>
|
|
2638
2607
|
</dl>
|
|
2639
2608
|
|
|
2609
|
+
|
|
2640
2610
|
</dd>
|
|
2641
2611
|
</dl>
|
|
2642
2612
|
</details>
|
|
@@ -2654,7 +2624,6 @@ await client.tools.sheets.insertColumn({
|
|
|
2654
2624
|
<dd>
|
|
2655
2625
|
|
|
2656
2626
|
Clear formatting from cells in an Athena spreadsheet.
|
|
2657
|
-
|
|
2658
2627
|
</dd>
|
|
2659
2628
|
</dl>
|
|
2660
2629
|
</dd>
|
|
@@ -2674,10 +2643,10 @@ await client.tools.sheets.clearFormatting({
|
|
|
2674
2643
|
end_column_index: 1,
|
|
2675
2644
|
end_row_index: 1,
|
|
2676
2645
|
start_column_index: 1,
|
|
2677
|
-
start_row_index: 1
|
|
2646
|
+
start_row_index: 1
|
|
2678
2647
|
});
|
|
2679
|
-
```
|
|
2680
2648
|
|
|
2649
|
+
```
|
|
2681
2650
|
</dd>
|
|
2682
2651
|
</dl>
|
|
2683
2652
|
</dd>
|
|
@@ -2691,21 +2660,22 @@ await client.tools.sheets.clearFormatting({
|
|
|
2691
2660
|
<dl>
|
|
2692
2661
|
<dd>
|
|
2693
2662
|
|
|
2694
|
-
**request:** `AthenaIntelligence.tools.ClearFormattingRequest`
|
|
2695
|
-
|
|
2663
|
+
**request:** `AthenaIntelligence.tools.ClearFormattingRequest`
|
|
2664
|
+
|
|
2696
2665
|
</dd>
|
|
2697
2666
|
</dl>
|
|
2698
2667
|
|
|
2699
2668
|
<dl>
|
|
2700
2669
|
<dd>
|
|
2701
2670
|
|
|
2702
|
-
**requestOptions:** `
|
|
2703
|
-
|
|
2671
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2672
|
+
|
|
2704
2673
|
</dd>
|
|
2705
2674
|
</dl>
|
|
2706
2675
|
</dd>
|
|
2707
2676
|
</dl>
|
|
2708
2677
|
|
|
2678
|
+
|
|
2709
2679
|
</dd>
|
|
2710
2680
|
</dl>
|
|
2711
2681
|
</details>
|
|
@@ -2723,7 +2693,6 @@ await client.tools.sheets.clearFormatting({
|
|
|
2723
2693
|
<dd>
|
|
2724
2694
|
|
|
2725
2695
|
Clear a range of cells in an Athena spreadsheet.
|
|
2726
|
-
|
|
2727
2696
|
</dd>
|
|
2728
2697
|
</dl>
|
|
2729
2698
|
</dd>
|
|
@@ -2743,10 +2712,10 @@ await client.tools.sheets.clearRange({
|
|
|
2743
2712
|
num_columns: 1,
|
|
2744
2713
|
num_rows: 1,
|
|
2745
2714
|
start_column: 1,
|
|
2746
|
-
start_row: 1
|
|
2715
|
+
start_row: 1
|
|
2747
2716
|
});
|
|
2748
|
-
```
|
|
2749
2717
|
|
|
2718
|
+
```
|
|
2750
2719
|
</dd>
|
|
2751
2720
|
</dl>
|
|
2752
2721
|
</dd>
|
|
@@ -2760,21 +2729,22 @@ await client.tools.sheets.clearRange({
|
|
|
2760
2729
|
<dl>
|
|
2761
2730
|
<dd>
|
|
2762
2731
|
|
|
2763
|
-
**request:** `AthenaIntelligence.tools.ClearSheetRangeRequest`
|
|
2764
|
-
|
|
2732
|
+
**request:** `AthenaIntelligence.tools.ClearSheetRangeRequest`
|
|
2733
|
+
|
|
2765
2734
|
</dd>
|
|
2766
2735
|
</dl>
|
|
2767
2736
|
|
|
2768
2737
|
<dl>
|
|
2769
2738
|
<dd>
|
|
2770
2739
|
|
|
2771
|
-
**requestOptions:** `
|
|
2772
|
-
|
|
2740
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2741
|
+
|
|
2773
2742
|
</dd>
|
|
2774
2743
|
</dl>
|
|
2775
2744
|
</dd>
|
|
2776
2745
|
</dl>
|
|
2777
2746
|
|
|
2747
|
+
|
|
2778
2748
|
</dd>
|
|
2779
2749
|
</dl>
|
|
2780
2750
|
</details>
|
|
@@ -2792,7 +2762,6 @@ await client.tools.sheets.clearRange({
|
|
|
2792
2762
|
<dd>
|
|
2793
2763
|
|
|
2794
2764
|
Apply formatting to a range of cells in an Athena spreadsheet.
|
|
2795
|
-
|
|
2796
2765
|
</dd>
|
|
2797
2766
|
</dl>
|
|
2798
2767
|
</dd>
|
|
@@ -2813,10 +2782,10 @@ await client.tools.sheets.formatRange({
|
|
|
2813
2782
|
end_row: 1,
|
|
2814
2783
|
formatting: {},
|
|
2815
2784
|
start_column: 1,
|
|
2816
|
-
start_row: 1
|
|
2785
|
+
start_row: 1
|
|
2817
2786
|
});
|
|
2818
|
-
```
|
|
2819
2787
|
|
|
2788
|
+
```
|
|
2820
2789
|
</dd>
|
|
2821
2790
|
</dl>
|
|
2822
2791
|
</dd>
|
|
@@ -2830,21 +2799,22 @@ await client.tools.sheets.formatRange({
|
|
|
2830
2799
|
<dl>
|
|
2831
2800
|
<dd>
|
|
2832
2801
|
|
|
2833
|
-
**request:** `AthenaIntelligence.tools.FormatSheetRangeRequest`
|
|
2834
|
-
|
|
2802
|
+
**request:** `AthenaIntelligence.tools.FormatSheetRangeRequest`
|
|
2803
|
+
|
|
2835
2804
|
</dd>
|
|
2836
2805
|
</dl>
|
|
2837
2806
|
|
|
2838
2807
|
<dl>
|
|
2839
2808
|
<dd>
|
|
2840
2809
|
|
|
2841
|
-
**requestOptions:** `
|
|
2842
|
-
|
|
2810
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2811
|
+
|
|
2843
2812
|
</dd>
|
|
2844
2813
|
</dl>
|
|
2845
2814
|
</dd>
|
|
2846
2815
|
</dl>
|
|
2847
2816
|
|
|
2817
|
+
|
|
2848
2818
|
</dd>
|
|
2849
2819
|
</dl>
|
|
2850
2820
|
</details>
|
|
@@ -2862,7 +2832,6 @@ await client.tools.sheets.formatRange({
|
|
|
2862
2832
|
<dd>
|
|
2863
2833
|
|
|
2864
2834
|
Update a range of cells in an Athena spreadsheet.
|
|
2865
|
-
|
|
2866
2835
|
</dd>
|
|
2867
2836
|
</dl>
|
|
2868
2837
|
</dd>
|
|
@@ -2881,10 +2850,10 @@ await client.tools.sheets.updateRange({
|
|
|
2881
2850
|
asset_id: "asset_id",
|
|
2882
2851
|
start_column: 1,
|
|
2883
2852
|
start_row: 1,
|
|
2884
|
-
values: [[]]
|
|
2853
|
+
values: [[]]
|
|
2885
2854
|
});
|
|
2886
|
-
```
|
|
2887
2855
|
|
|
2856
|
+
```
|
|
2888
2857
|
</dd>
|
|
2889
2858
|
</dl>
|
|
2890
2859
|
</dd>
|
|
@@ -2898,21 +2867,22 @@ await client.tools.sheets.updateRange({
|
|
|
2898
2867
|
<dl>
|
|
2899
2868
|
<dd>
|
|
2900
2869
|
|
|
2901
|
-
**request:** `AthenaIntelligence.tools.UpdateSheetRangeRequest`
|
|
2902
|
-
|
|
2870
|
+
**request:** `AthenaIntelligence.tools.UpdateSheetRangeRequest`
|
|
2871
|
+
|
|
2903
2872
|
</dd>
|
|
2904
2873
|
</dl>
|
|
2905
2874
|
|
|
2906
2875
|
<dl>
|
|
2907
2876
|
<dd>
|
|
2908
2877
|
|
|
2909
|
-
**requestOptions:** `
|
|
2910
|
-
|
|
2878
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2879
|
+
|
|
2911
2880
|
</dd>
|
|
2912
2881
|
</dl>
|
|
2913
2882
|
</dd>
|
|
2914
2883
|
</dl>
|
|
2915
2884
|
|
|
2885
|
+
|
|
2916
2886
|
</dd>
|
|
2917
2887
|
</dl>
|
|
2918
2888
|
</details>
|
|
@@ -2930,7 +2900,6 @@ await client.tools.sheets.updateRange({
|
|
|
2930
2900
|
<dd>
|
|
2931
2901
|
|
|
2932
2902
|
Insert a row in an Athena spreadsheet.
|
|
2933
|
-
|
|
2934
2903
|
</dd>
|
|
2935
2904
|
</dl>
|
|
2936
2905
|
</dd>
|
|
@@ -2947,10 +2916,10 @@ Insert a row in an Athena spreadsheet.
|
|
|
2947
2916
|
```typescript
|
|
2948
2917
|
await client.tools.sheets.insertRow({
|
|
2949
2918
|
asset_id: "asset_id",
|
|
2950
|
-
reference_row_index: 1
|
|
2919
|
+
reference_row_index: 1
|
|
2951
2920
|
});
|
|
2952
|
-
```
|
|
2953
2921
|
|
|
2922
|
+
```
|
|
2954
2923
|
</dd>
|
|
2955
2924
|
</dl>
|
|
2956
2925
|
</dd>
|
|
@@ -2964,21 +2933,22 @@ await client.tools.sheets.insertRow({
|
|
|
2964
2933
|
<dl>
|
|
2965
2934
|
<dd>
|
|
2966
2935
|
|
|
2967
|
-
**request:** `AthenaIntelligence.tools.InsertRowRequest`
|
|
2968
|
-
|
|
2936
|
+
**request:** `AthenaIntelligence.tools.InsertRowRequest`
|
|
2937
|
+
|
|
2969
2938
|
</dd>
|
|
2970
2939
|
</dl>
|
|
2971
2940
|
|
|
2972
2941
|
<dl>
|
|
2973
2942
|
<dd>
|
|
2974
2943
|
|
|
2975
|
-
**requestOptions:** `
|
|
2976
|
-
|
|
2944
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
2945
|
+
|
|
2977
2946
|
</dd>
|
|
2978
2947
|
</dl>
|
|
2979
2948
|
</dd>
|
|
2980
2949
|
</dl>
|
|
2981
2950
|
|
|
2951
|
+
|
|
2982
2952
|
</dd>
|
|
2983
2953
|
</dl>
|
|
2984
2954
|
</details>
|
|
@@ -2996,7 +2966,6 @@ await client.tools.sheets.insertRow({
|
|
|
2996
2966
|
<dd>
|
|
2997
2967
|
|
|
2998
2968
|
Duplicate an existing sheet in an Athena spreadsheet.
|
|
2999
|
-
|
|
3000
2969
|
</dd>
|
|
3001
2970
|
</dl>
|
|
3002
2971
|
</dd>
|
|
@@ -3012,10 +2981,10 @@ Duplicate an existing sheet in an Athena spreadsheet.
|
|
|
3012
2981
|
|
|
3013
2982
|
```typescript
|
|
3014
2983
|
await client.tools.sheets.duplicateSheet({
|
|
3015
|
-
asset_id: "asset_id"
|
|
2984
|
+
asset_id: "asset_id"
|
|
3016
2985
|
});
|
|
3017
|
-
```
|
|
3018
2986
|
|
|
2987
|
+
```
|
|
3019
2988
|
</dd>
|
|
3020
2989
|
</dl>
|
|
3021
2990
|
</dd>
|
|
@@ -3029,21 +2998,22 @@ await client.tools.sheets.duplicateSheet({
|
|
|
3029
2998
|
<dl>
|
|
3030
2999
|
<dd>
|
|
3031
3000
|
|
|
3032
|
-
**request:** `AthenaIntelligence.tools.DuplicateSheetRequest`
|
|
3033
|
-
|
|
3001
|
+
**request:** `AthenaIntelligence.tools.DuplicateSheetRequest`
|
|
3002
|
+
|
|
3034
3003
|
</dd>
|
|
3035
3004
|
</dl>
|
|
3036
3005
|
|
|
3037
3006
|
<dl>
|
|
3038
3007
|
<dd>
|
|
3039
3008
|
|
|
3040
|
-
**requestOptions:** `
|
|
3041
|
-
|
|
3009
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3010
|
+
|
|
3042
3011
|
</dd>
|
|
3043
3012
|
</dl>
|
|
3044
3013
|
</dd>
|
|
3045
3014
|
</dl>
|
|
3046
3015
|
|
|
3016
|
+
|
|
3047
3017
|
</dd>
|
|
3048
3018
|
</dl>
|
|
3049
3019
|
</details>
|
|
@@ -3061,7 +3031,6 @@ await client.tools.sheets.duplicateSheet({
|
|
|
3061
3031
|
<dd>
|
|
3062
3032
|
|
|
3063
3033
|
Create a new tab in an Athena spreadsheet.
|
|
3064
|
-
|
|
3065
3034
|
</dd>
|
|
3066
3035
|
</dl>
|
|
3067
3036
|
</dd>
|
|
@@ -3083,11 +3052,11 @@ await client.tools.sheets.createTab({
|
|
|
3083
3052
|
index: 1,
|
|
3084
3053
|
rowCount: 1,
|
|
3085
3054
|
sheetId: 1,
|
|
3086
|
-
title: "title"
|
|
3087
|
-
}
|
|
3055
|
+
title: "title"
|
|
3056
|
+
}
|
|
3088
3057
|
});
|
|
3089
|
-
```
|
|
3090
3058
|
|
|
3059
|
+
```
|
|
3091
3060
|
</dd>
|
|
3092
3061
|
</dl>
|
|
3093
3062
|
</dd>
|
|
@@ -3101,21 +3070,22 @@ await client.tools.sheets.createTab({
|
|
|
3101
3070
|
<dl>
|
|
3102
3071
|
<dd>
|
|
3103
3072
|
|
|
3104
|
-
**request:** `AthenaIntelligence.tools.CreateNewSheetTabRequest`
|
|
3105
|
-
|
|
3073
|
+
**request:** `AthenaIntelligence.tools.CreateNewSheetTabRequest`
|
|
3074
|
+
|
|
3106
3075
|
</dd>
|
|
3107
3076
|
</dl>
|
|
3108
3077
|
|
|
3109
3078
|
<dl>
|
|
3110
3079
|
<dd>
|
|
3111
3080
|
|
|
3112
|
-
**requestOptions:** `
|
|
3113
|
-
|
|
3081
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3082
|
+
|
|
3114
3083
|
</dd>
|
|
3115
3084
|
</dl>
|
|
3116
3085
|
</dd>
|
|
3117
3086
|
</dl>
|
|
3118
3087
|
|
|
3088
|
+
|
|
3119
3089
|
</dd>
|
|
3120
3090
|
</dl>
|
|
3121
3091
|
</details>
|
|
@@ -3133,7 +3103,6 @@ await client.tools.sheets.createTab({
|
|
|
3133
3103
|
<dd>
|
|
3134
3104
|
|
|
3135
3105
|
Delete a column from a table within an Athena spreadsheet.
|
|
3136
|
-
|
|
3137
3106
|
</dd>
|
|
3138
3107
|
</dl>
|
|
3139
3108
|
</dd>
|
|
@@ -3151,10 +3120,10 @@ Delete a column from a table within an Athena spreadsheet.
|
|
|
3151
3120
|
await client.tools.sheets.deleteTableColumn({
|
|
3152
3121
|
asset_id: "asset_id",
|
|
3153
3122
|
dimension_index: 1,
|
|
3154
|
-
table_id: "table_id"
|
|
3123
|
+
table_id: "table_id"
|
|
3155
3124
|
});
|
|
3156
|
-
```
|
|
3157
3125
|
|
|
3126
|
+
```
|
|
3158
3127
|
</dd>
|
|
3159
3128
|
</dl>
|
|
3160
3129
|
</dd>
|
|
@@ -3168,21 +3137,22 @@ await client.tools.sheets.deleteTableColumn({
|
|
|
3168
3137
|
<dl>
|
|
3169
3138
|
<dd>
|
|
3170
3139
|
|
|
3171
|
-
**request:** `AthenaIntelligence.tools.DeleteTableColumnRequest`
|
|
3172
|
-
|
|
3140
|
+
**request:** `AthenaIntelligence.tools.DeleteTableColumnRequest`
|
|
3141
|
+
|
|
3173
3142
|
</dd>
|
|
3174
3143
|
</dl>
|
|
3175
3144
|
|
|
3176
3145
|
<dl>
|
|
3177
3146
|
<dd>
|
|
3178
3147
|
|
|
3179
|
-
**requestOptions:** `
|
|
3180
|
-
|
|
3148
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3149
|
+
|
|
3181
3150
|
</dd>
|
|
3182
3151
|
</dl>
|
|
3183
3152
|
</dd>
|
|
3184
3153
|
</dl>
|
|
3185
3154
|
|
|
3155
|
+
|
|
3186
3156
|
</dd>
|
|
3187
3157
|
</dl>
|
|
3188
3158
|
</details>
|
|
@@ -3200,7 +3170,6 @@ await client.tools.sheets.deleteTableColumn({
|
|
|
3200
3170
|
<dd>
|
|
3201
3171
|
|
|
3202
3172
|
Insert a column in a table within an Athena spreadsheet.
|
|
3203
|
-
|
|
3204
3173
|
</dd>
|
|
3205
3174
|
</dl>
|
|
3206
3175
|
</dd>
|
|
@@ -3219,10 +3188,10 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3219
3188
|
asset_id: "asset_id",
|
|
3220
3189
|
dimension_index: 1,
|
|
3221
3190
|
direction: "direction",
|
|
3222
|
-
table_id: "table_id"
|
|
3191
|
+
table_id: "table_id"
|
|
3223
3192
|
});
|
|
3224
|
-
```
|
|
3225
3193
|
|
|
3194
|
+
```
|
|
3226
3195
|
</dd>
|
|
3227
3196
|
</dl>
|
|
3228
3197
|
</dd>
|
|
@@ -3236,21 +3205,22 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3236
3205
|
<dl>
|
|
3237
3206
|
<dd>
|
|
3238
3207
|
|
|
3239
|
-
**request:** `AthenaIntelligence.tools.InsertTableColumnRequest`
|
|
3240
|
-
|
|
3208
|
+
**request:** `AthenaIntelligence.tools.InsertTableColumnRequest`
|
|
3209
|
+
|
|
3241
3210
|
</dd>
|
|
3242
3211
|
</dl>
|
|
3243
3212
|
|
|
3244
3213
|
<dl>
|
|
3245
3214
|
<dd>
|
|
3246
3215
|
|
|
3247
|
-
**requestOptions:** `
|
|
3248
|
-
|
|
3216
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3217
|
+
|
|
3249
3218
|
</dd>
|
|
3250
3219
|
</dl>
|
|
3251
3220
|
</dd>
|
|
3252
3221
|
</dl>
|
|
3253
3222
|
|
|
3223
|
+
|
|
3254
3224
|
</dd>
|
|
3255
3225
|
</dl>
|
|
3256
3226
|
</details>
|
|
@@ -3268,7 +3238,6 @@ await client.tools.sheets.insertTableColumn({
|
|
|
3268
3238
|
<dd>
|
|
3269
3239
|
|
|
3270
3240
|
Create a table in an Athena spreadsheet.
|
|
3271
|
-
|
|
3272
3241
|
</dd>
|
|
3273
3242
|
</dl>
|
|
3274
3243
|
</dd>
|
|
@@ -3290,10 +3259,10 @@ await client.tools.sheets.createTable({
|
|
|
3290
3259
|
start_column_index: 1,
|
|
3291
3260
|
start_row_index: 1,
|
|
3292
3261
|
table_id: "table_id",
|
|
3293
|
-
table_name: "table_name"
|
|
3262
|
+
table_name: "table_name"
|
|
3294
3263
|
});
|
|
3295
|
-
```
|
|
3296
3264
|
|
|
3265
|
+
```
|
|
3297
3266
|
</dd>
|
|
3298
3267
|
</dl>
|
|
3299
3268
|
</dd>
|
|
@@ -3307,21 +3276,22 @@ await client.tools.sheets.createTable({
|
|
|
3307
3276
|
<dl>
|
|
3308
3277
|
<dd>
|
|
3309
3278
|
|
|
3310
|
-
**request:** `AthenaIntelligence.tools.CreateTableRequest`
|
|
3311
|
-
|
|
3279
|
+
**request:** `AthenaIntelligence.tools.CreateTableRequest`
|
|
3280
|
+
|
|
3312
3281
|
</dd>
|
|
3313
3282
|
</dl>
|
|
3314
3283
|
|
|
3315
3284
|
<dl>
|
|
3316
3285
|
<dd>
|
|
3317
3286
|
|
|
3318
|
-
**requestOptions:** `
|
|
3319
|
-
|
|
3287
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3288
|
+
|
|
3320
3289
|
</dd>
|
|
3321
3290
|
</dl>
|
|
3322
3291
|
</dd>
|
|
3323
3292
|
</dl>
|
|
3324
3293
|
|
|
3294
|
+
|
|
3325
3295
|
</dd>
|
|
3326
3296
|
</dl>
|
|
3327
3297
|
</details>
|
|
@@ -3339,7 +3309,6 @@ await client.tools.sheets.createTable({
|
|
|
3339
3309
|
<dd>
|
|
3340
3310
|
|
|
3341
3311
|
Retrieve table data from an Athena spreadsheet.
|
|
3342
|
-
|
|
3343
3312
|
</dd>
|
|
3344
3313
|
</dl>
|
|
3345
3314
|
</dd>
|
|
@@ -3356,10 +3325,10 @@ Retrieve table data from an Athena spreadsheet.
|
|
|
3356
3325
|
```typescript
|
|
3357
3326
|
await client.tools.sheets.getTable({
|
|
3358
3327
|
asset_id: "asset_id",
|
|
3359
|
-
table_name: "table_name"
|
|
3328
|
+
table_name: "table_name"
|
|
3360
3329
|
});
|
|
3361
|
-
```
|
|
3362
3330
|
|
|
3331
|
+
```
|
|
3363
3332
|
</dd>
|
|
3364
3333
|
</dl>
|
|
3365
3334
|
</dd>
|
|
@@ -3373,21 +3342,22 @@ await client.tools.sheets.getTable({
|
|
|
3373
3342
|
<dl>
|
|
3374
3343
|
<dd>
|
|
3375
3344
|
|
|
3376
|
-
**request:** `AthenaIntelligence.tools.GetTableRequest`
|
|
3377
|
-
|
|
3345
|
+
**request:** `AthenaIntelligence.tools.GetTableRequest`
|
|
3346
|
+
|
|
3378
3347
|
</dd>
|
|
3379
3348
|
</dl>
|
|
3380
3349
|
|
|
3381
3350
|
<dl>
|
|
3382
3351
|
<dd>
|
|
3383
3352
|
|
|
3384
|
-
**requestOptions:** `
|
|
3385
|
-
|
|
3353
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3354
|
+
|
|
3386
3355
|
</dd>
|
|
3387
3356
|
</dl>
|
|
3388
3357
|
</dd>
|
|
3389
3358
|
</dl>
|
|
3390
3359
|
|
|
3360
|
+
|
|
3391
3361
|
</dd>
|
|
3392
3362
|
</dl>
|
|
3393
3363
|
</details>
|
|
@@ -3405,7 +3375,6 @@ await client.tools.sheets.getTable({
|
|
|
3405
3375
|
<dd>
|
|
3406
3376
|
|
|
3407
3377
|
Insert rows into a table in an Athena spreadsheet.
|
|
3408
|
-
|
|
3409
3378
|
</dd>
|
|
3410
3379
|
</dl>
|
|
3411
3380
|
</dd>
|
|
@@ -3422,15 +3391,13 @@ Insert rows into a table in an Athena spreadsheet.
|
|
|
3422
3391
|
```typescript
|
|
3423
3392
|
await client.tools.sheets.insertTableRow({
|
|
3424
3393
|
asset_id: "asset_id",
|
|
3425
|
-
row_data: [
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
|
|
3429
|
-
],
|
|
3430
|
-
table_name: "table_name",
|
|
3394
|
+
row_data: [{
|
|
3395
|
+
"key": "value"
|
|
3396
|
+
}],
|
|
3397
|
+
table_name: "table_name"
|
|
3431
3398
|
});
|
|
3432
|
-
```
|
|
3433
3399
|
|
|
3400
|
+
```
|
|
3434
3401
|
</dd>
|
|
3435
3402
|
</dl>
|
|
3436
3403
|
</dd>
|
|
@@ -3444,21 +3411,22 @@ await client.tools.sheets.insertTableRow({
|
|
|
3444
3411
|
<dl>
|
|
3445
3412
|
<dd>
|
|
3446
3413
|
|
|
3447
|
-
**request:** `AthenaIntelligence.tools.InsertTableRowRequest`
|
|
3448
|
-
|
|
3414
|
+
**request:** `AthenaIntelligence.tools.InsertTableRowRequest`
|
|
3415
|
+
|
|
3449
3416
|
</dd>
|
|
3450
3417
|
</dl>
|
|
3451
3418
|
|
|
3452
3419
|
<dl>
|
|
3453
3420
|
<dd>
|
|
3454
3421
|
|
|
3455
|
-
**requestOptions:** `
|
|
3456
|
-
|
|
3422
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3423
|
+
|
|
3457
3424
|
</dd>
|
|
3458
3425
|
</dl>
|
|
3459
3426
|
</dd>
|
|
3460
3427
|
</dl>
|
|
3461
3428
|
|
|
3429
|
+
|
|
3462
3430
|
</dd>
|
|
3463
3431
|
</dl>
|
|
3464
3432
|
</details>
|
|
@@ -3476,7 +3444,6 @@ await client.tools.sheets.insertTableRow({
|
|
|
3476
3444
|
<dd>
|
|
3477
3445
|
|
|
3478
3446
|
Update an existing table in an Athena spreadsheet.
|
|
3479
|
-
|
|
3480
3447
|
</dd>
|
|
3481
3448
|
</dl>
|
|
3482
3449
|
</dd>
|
|
@@ -3498,10 +3465,10 @@ await client.tools.sheets.updateTable({
|
|
|
3498
3465
|
start_column_index: 1,
|
|
3499
3466
|
start_row_index: 1,
|
|
3500
3467
|
table_id: "table_id",
|
|
3501
|
-
table_name: "table_name"
|
|
3468
|
+
table_name: "table_name"
|
|
3502
3469
|
});
|
|
3503
|
-
```
|
|
3504
3470
|
|
|
3471
|
+
```
|
|
3505
3472
|
</dd>
|
|
3506
3473
|
</dl>
|
|
3507
3474
|
</dd>
|
|
@@ -3515,27 +3482,27 @@ await client.tools.sheets.updateTable({
|
|
|
3515
3482
|
<dl>
|
|
3516
3483
|
<dd>
|
|
3517
3484
|
|
|
3518
|
-
**request:** `AthenaIntelligence.tools.UpdateTableRequest`
|
|
3519
|
-
|
|
3485
|
+
**request:** `AthenaIntelligence.tools.UpdateTableRequest`
|
|
3486
|
+
|
|
3520
3487
|
</dd>
|
|
3521
3488
|
</dl>
|
|
3522
3489
|
|
|
3523
3490
|
<dl>
|
|
3524
3491
|
<dd>
|
|
3525
3492
|
|
|
3526
|
-
**requestOptions:** `
|
|
3527
|
-
|
|
3493
|
+
**requestOptions:** `SheetsClient.RequestOptions`
|
|
3494
|
+
|
|
3528
3495
|
</dd>
|
|
3529
3496
|
</dl>
|
|
3530
3497
|
</dd>
|
|
3531
3498
|
</dl>
|
|
3532
3499
|
|
|
3500
|
+
|
|
3533
3501
|
</dd>
|
|
3534
3502
|
</dl>
|
|
3535
3503
|
</details>
|
|
3536
3504
|
|
|
3537
3505
|
## Tools StructuredDataExtractor
|
|
3538
|
-
|
|
3539
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>
|
|
3540
3507
|
<dl>
|
|
3541
3508
|
<dd>
|
|
@@ -3551,7 +3518,6 @@ await client.tools.sheets.updateTable({
|
|
|
3551
3518
|
Extract structured data.
|
|
3552
3519
|
|
|
3553
3520
|
tl;dr:
|
|
3554
|
-
|
|
3555
3521
|
- pass a valid JSON schema in `json_schema`
|
|
3556
3522
|
- pass the page chunks as a list of `Chunk` objects, by default: `{"type": "text", "content": "..."}`
|
|
3557
3523
|
- leave all other fields as default
|
|
@@ -3566,11 +3532,10 @@ In some applications, you may not want to:
|
|
|
3566
3532
|
|
|
3567
3533
|
- map (if your input asset is small enough)
|
|
3568
3534
|
- reduce (if your output object is large enough that it will overflow the output length;
|
|
3569
|
-
|
|
3570
|
-
|
|
3535
|
+
if you're extracting a long list of entities; if youre )
|
|
3536
|
+
to extract all instances of the schema).
|
|
3571
3537
|
|
|
3572
3538
|
You can configure these behaviors with the `map` and `reduce` fields.
|
|
3573
|
-
|
|
3574
3539
|
</dd>
|
|
3575
3540
|
</dl>
|
|
3576
3541
|
</dd>
|
|
@@ -3586,46 +3551,41 @@ You can configure these behaviors with the `map` and `reduce` fields.
|
|
|
3586
3551
|
|
|
3587
3552
|
```typescript
|
|
3588
3553
|
await client.tools.structuredDataExtractor.invoke({
|
|
3589
|
-
chunks: [
|
|
3590
|
-
{
|
|
3554
|
+
chunks: [{
|
|
3591
3555
|
chunk_id: "1",
|
|
3592
|
-
content: [
|
|
3593
|
-
{
|
|
3556
|
+
content: [{
|
|
3594
3557
|
type: "text",
|
|
3595
|
-
text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
|
|
3596
|
-
}
|
|
3597
|
-
|
|
3598
|
-
},
|
|
3599
|
-
{
|
|
3558
|
+
text: "John Smith is a 35 year old developer. You can reach him at john.smith@example.com"
|
|
3559
|
+
}]
|
|
3560
|
+
}, {
|
|
3600
3561
|
chunk_id: "2",
|
|
3601
|
-
content: [
|
|
3602
|
-
{
|
|
3562
|
+
content: [{
|
|
3603
3563
|
type: "text",
|
|
3604
|
-
text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
|
|
3605
|
-
}
|
|
3606
|
-
|
|
3607
|
-
},
|
|
3608
|
-
],
|
|
3564
|
+
text: "Jane Doe is a 25 year old developer. You can reach her at jane@example.com"
|
|
3565
|
+
}]
|
|
3566
|
+
}],
|
|
3609
3567
|
json_schema: {
|
|
3610
|
-
description: "A person",
|
|
3611
|
-
properties: {
|
|
3612
|
-
age: {
|
|
3613
|
-
type: "integer"
|
|
3614
|
-
},
|
|
3615
|
-
email: {
|
|
3616
|
-
type: "string",
|
|
3568
|
+
"description": "A person",
|
|
3569
|
+
"properties": {
|
|
3570
|
+
"age": {
|
|
3571
|
+
"type": "integer"
|
|
3617
3572
|
},
|
|
3618
|
-
|
|
3619
|
-
type: "string"
|
|
3573
|
+
"email": {
|
|
3574
|
+
"type": "string"
|
|
3620
3575
|
},
|
|
3576
|
+
"name": {
|
|
3577
|
+
"type": "string"
|
|
3578
|
+
}
|
|
3621
3579
|
},
|
|
3622
|
-
required: [
|
|
3623
|
-
|
|
3624
|
-
|
|
3625
|
-
|
|
3580
|
+
"required": [
|
|
3581
|
+
"name"
|
|
3582
|
+
],
|
|
3583
|
+
"title": "Person",
|
|
3584
|
+
"type": "object"
|
|
3585
|
+
}
|
|
3626
3586
|
});
|
|
3627
|
-
```
|
|
3628
3587
|
|
|
3588
|
+
```
|
|
3629
3589
|
</dd>
|
|
3630
3590
|
</dl>
|
|
3631
3591
|
</dd>
|
|
@@ -3639,27 +3599,27 @@ await client.tools.structuredDataExtractor.invoke({
|
|
|
3639
3599
|
<dl>
|
|
3640
3600
|
<dd>
|
|
3641
3601
|
|
|
3642
|
-
**request:** `AthenaIntelligence.tools.StructuredDataExtractorRequest`
|
|
3643
|
-
|
|
3602
|
+
**request:** `AthenaIntelligence.tools.StructuredDataExtractorRequest`
|
|
3603
|
+
|
|
3644
3604
|
</dd>
|
|
3645
3605
|
</dl>
|
|
3646
3606
|
|
|
3647
3607
|
<dl>
|
|
3648
3608
|
<dd>
|
|
3649
3609
|
|
|
3650
|
-
**requestOptions:** `
|
|
3651
|
-
|
|
3610
|
+
**requestOptions:** `StructuredDataExtractorClient.RequestOptions`
|
|
3611
|
+
|
|
3652
3612
|
</dd>
|
|
3653
3613
|
</dl>
|
|
3654
3614
|
</dd>
|
|
3655
3615
|
</dl>
|
|
3656
3616
|
|
|
3617
|
+
|
|
3657
3618
|
</dd>
|
|
3658
3619
|
</dl>
|
|
3659
3620
|
</details>
|
|
3660
3621
|
|
|
3661
3622
|
## Tools Tasks
|
|
3662
|
-
|
|
3663
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>
|
|
3664
3624
|
<dl>
|
|
3665
3625
|
<dd>
|
|
@@ -3675,7 +3635,6 @@ await client.tools.structuredDataExtractor.invoke({
|
|
|
3675
3635
|
Run a [task](https://resources.athenaintel.com/docs/task-studio/home) and wait for the result.
|
|
3676
3636
|
|
|
3677
3637
|
Executes a Windmill script or flow synchronously. Server handles polling internally.
|
|
3678
|
-
|
|
3679
3638
|
</dd>
|
|
3680
3639
|
</dl>
|
|
3681
3640
|
</dd>
|
|
@@ -3691,10 +3650,10 @@ Executes a Windmill script or flow synchronously. Server handles polling interna
|
|
|
3691
3650
|
|
|
3692
3651
|
```typescript
|
|
3693
3652
|
await client.tools.tasks.runTask({
|
|
3694
|
-
task_id: "task_id"
|
|
3653
|
+
task_id: "task_id"
|
|
3695
3654
|
});
|
|
3696
|
-
```
|
|
3697
3655
|
|
|
3656
|
+
```
|
|
3698
3657
|
</dd>
|
|
3699
3658
|
</dl>
|
|
3700
3659
|
</dd>
|
|
@@ -3708,21 +3667,22 @@ await client.tools.tasks.runTask({
|
|
|
3708
3667
|
<dl>
|
|
3709
3668
|
<dd>
|
|
3710
3669
|
|
|
3711
|
-
**request:** `AthenaIntelligence.tools.RunTaskRequest`
|
|
3712
|
-
|
|
3670
|
+
**request:** `AthenaIntelligence.tools.RunTaskRequest`
|
|
3671
|
+
|
|
3713
3672
|
</dd>
|
|
3714
3673
|
</dl>
|
|
3715
3674
|
|
|
3716
3675
|
<dl>
|
|
3717
3676
|
<dd>
|
|
3718
3677
|
|
|
3719
|
-
**requestOptions:** `
|
|
3720
|
-
|
|
3678
|
+
**requestOptions:** `TasksClient.RequestOptions`
|
|
3679
|
+
|
|
3721
3680
|
</dd>
|
|
3722
3681
|
</dl>
|
|
3723
3682
|
</dd>
|
|
3724
3683
|
</dl>
|
|
3725
3684
|
|
|
3685
|
+
|
|
3726
3686
|
</dd>
|
|
3727
3687
|
</dl>
|
|
3728
3688
|
</details>
|