mavenagi 1.0.15 → 1.2.0
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/Client.d.ts +9 -4
- package/Client.js +69 -20
- package/README.md +21 -8
- package/api/resources/actions/client/Client.d.ts +42 -4
- package/api/resources/actions/client/Client.js +264 -40
- package/api/resources/actions/client/index.d.ts +1 -0
- package/api/resources/actions/client/index.js +15 -0
- package/api/resources/actions/client/requests/ActionGetRequest.d.ts +13 -0
- package/api/resources/actions/client/requests/index.d.ts +1 -0
- package/api/resources/actions/types/ActionField.d.ts +11 -0
- package/api/resources/actions/types/ActionField.js +13 -0
- package/api/resources/actions/types/ActionFilter.d.ts +14 -0
- package/api/resources/actions/types/ActionPatchRequest.d.ts +12 -0
- package/api/resources/actions/types/ActionsResponse.d.ts +8 -0
- package/api/resources/actions/types/ActionsSearchRequest.d.ts +8 -0
- package/api/resources/actions/types/index.d.ts +5 -0
- package/api/resources/actions/types/index.js +5 -0
- package/api/resources/agents/client/Client.d.ts +75 -4
- package/api/resources/agents/client/Client.js +363 -42
- package/api/resources/agents/types/Agent.d.ts +10 -0
- package/api/resources/agents/types/AgentPatchRequest.d.ts +12 -0
- package/api/resources/agents/types/CreateAgentRequest.d.ts +10 -0
- package/api/resources/agents/types/PiiCategory.d.ts +63 -0
- package/api/resources/agents/types/PiiCategory.js +65 -0
- package/api/resources/agents/types/index.d.ts +3 -0
- package/api/resources/agents/types/index.js +3 -0
- package/api/resources/analytics/client/Client.d.ts +9 -4
- package/api/resources/analytics/client/Client.js +76 -40
- package/api/resources/analytics/types/ConversationTableResponse.d.ts +3 -3
- package/api/resources/appSettings/client/Client.d.ts +9 -4
- package/api/resources/appSettings/client/Client.js +76 -44
- package/api/resources/appSettings/client/index.d.ts +1 -0
- package/api/resources/assets/client/Client.d.ts +76 -0
- package/api/resources/assets/client/Client.js +257 -0
- package/api/resources/assets/types/CommitAssetUploadRequest.d.ts +7 -0
- package/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +6 -0
- package/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +12 -0
- package/api/resources/assets/types/index.d.ts +3 -0
- package/api/resources/assets/types/index.js +19 -0
- package/api/resources/commons/errors/BadRequestError.d.ts +2 -1
- package/api/resources/commons/errors/BadRequestError.js +2 -1
- package/api/resources/commons/errors/NotFoundError.d.ts +2 -1
- package/api/resources/commons/errors/NotFoundError.js +2 -1
- package/api/resources/commons/errors/ServerError.d.ts +2 -1
- package/api/resources/commons/errors/ServerError.js +2 -1
- package/api/resources/commons/types/ActionResponse.d.ts +27 -1
- package/api/resources/commons/types/AppUserRequest.d.ts +2 -2
- package/api/resources/commons/types/AppUserResponse.d.ts +2 -2
- package/api/resources/commons/types/AttachmentRequest.d.ts +22 -0
- package/api/resources/commons/types/AttachmentResponse.d.ts +12 -0
- package/api/resources/commons/types/AttachmentStatus.d.ts +10 -0
- package/api/resources/commons/types/AttachmentStatus.js +12 -0
- package/api/resources/commons/types/BaseAttachment.d.ts +32 -0
- package/api/resources/commons/types/BaseConversationResponse.d.ts +11 -0
- package/api/resources/commons/types/BotLogic.d.ts +7 -0
- package/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +9 -0
- package/api/resources/commons/types/BotLogicActionItem.d.ts +8 -0
- package/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +8 -0
- package/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +6 -0
- package/api/resources/commons/types/BotLogicItem.d.ts +25 -0
- package/{dist/api/resources/commons/types/KnowledgeBaseInformation.d.ts → api/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +4 -2
- package/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +8 -0
- package/api/resources/{realtime/types/AudioPublishEvent.d.ts → commons/types/BotLogicSafetyItem.d.ts} +2 -2
- package/api/resources/commons/types/BotLogicSegmentsItem.d.ts +7 -0
- package/api/resources/{realtime/types/HangUpPublishEvent.d.ts → commons/types/BotLogicUserItem.d.ts} +2 -2
- package/api/resources/commons/types/BotMessage.d.ts +3 -1
- package/api/resources/commons/types/Capability.d.ts +2 -1
- package/api/resources/commons/types/Capability.js +1 -0
- package/api/resources/commons/types/ConversationResponse.d.ts +15 -2
- package/api/resources/commons/types/DocumentInformation.d.ts +2 -0
- package/api/resources/commons/types/EntityType.d.ts +2 -1
- package/api/resources/commons/types/EntityType.js +1 -0
- package/api/resources/commons/types/InboxItem.d.ts +1 -7
- package/api/resources/commons/types/InboxItemBase.d.ts +2 -0
- package/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/api/resources/commons/types/InboxItemFix.d.ts +1 -4
- package/api/resources/commons/types/InboxItemSeverity.d.ts +9 -0
- package/api/resources/commons/types/InboxItemSeverity.js +11 -0
- package/api/resources/commons/types/InboxItemType.d.ts +1 -9
- package/api/resources/commons/types/InboxItemType.js +0 -2
- package/api/resources/commons/types/LlmInclusionStatus.d.ts +9 -0
- package/api/resources/commons/types/LlmInclusionStatus.js +11 -0
- package/api/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +3 -3
- package/{dist/api/resources/commons/types/BotMessageStatus.js → api/resources/commons/types/MessageStatus.js} +2 -2
- package/api/resources/commons/types/ResponseConfig.d.ts +6 -8
- package/api/resources/commons/types/UserMessage.d.ts +21 -1
- package/api/resources/commons/types/UserMessageResponseState.d.ts +9 -0
- package/api/resources/commons/types/UserMessageResponseState.js +11 -0
- package/api/resources/commons/types/index.d.ts +19 -6
- package/api/resources/commons/types/index.js +19 -6
- package/api/resources/conversation/client/Client.d.ts +111 -51
- package/api/resources/conversation/client/Client.js +603 -222
- package/api/resources/conversation/client/index.d.ts +1 -0
- package/{dist/api/resources/conversation/types/GenerateObjectRequest.d.ts → api/resources/conversation/types/AskObjectRequest.d.ts} +1 -1
- package/api/resources/conversation/types/AskRequest.d.ts +5 -2
- package/api/resources/conversation/types/ConversationField.d.ts +5 -1
- package/api/resources/conversation/types/ConversationField.js +4 -0
- package/api/resources/conversation/types/ConversationFilter.d.ts +23 -1
- package/api/resources/conversation/types/ConversationMessageRequest.d.ts +2 -0
- package/api/resources/conversation/types/ConversationPatchRequest.d.ts +20 -0
- package/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +10 -0
- package/api/resources/conversation/types/DeliverMessageRequest.d.ts +13 -0
- package/api/resources/conversation/types/DeliverMessageResponse.d.ts +7 -0
- package/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +10 -0
- package/api/resources/conversation/types/DeliveryStatus.d.ts +9 -0
- package/api/resources/conversation/types/DeliveryStatus.js +11 -0
- package/api/resources/conversation/types/NumericConversationField.d.ts +2 -1
- package/api/resources/conversation/types/NumericConversationField.js +1 -0
- package/api/resources/conversation/types/ObjectStreamResponse.d.ts +16 -0
- package/api/resources/conversation/types/index.d.ts +8 -2
- package/api/resources/conversation/types/index.js +8 -2
- package/api/resources/events/client/Client.d.ts +5 -2
- package/api/resources/events/client/Client.js +26 -16
- package/api/resources/inbox/client/Client.d.ts +19 -11
- package/api/resources/inbox/client/Client.js +119 -68
- package/api/resources/inbox/client/index.d.ts +1 -0
- package/api/resources/inbox/types/AddDocumentFixRequest.d.ts +4 -1
- package/api/resources/inbox/types/ApplyFixesRequest.d.ts +12 -0
- package/api/resources/inbox/types/InboxFilter.d.ts +14 -0
- package/api/resources/inbox/types/InboxFilter.js +5 -0
- package/api/resources/inbox/types/InboxSearchRequest.d.ts +2 -9
- package/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/api/resources/inbox/types/index.d.ts +2 -2
- package/api/resources/inbox/types/index.js +2 -2
- package/api/resources/index.d.ts +9 -3
- package/api/resources/index.js +10 -4
- package/api/resources/knowledge/client/Client.d.ts +67 -8
- package/api/resources/knowledge/client/Client.js +459 -88
- package/api/resources/knowledge/client/index.d.ts +1 -0
- package/api/resources/knowledge/client/index.js +15 -0
- package/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.d.ts +13 -0
- package/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.js +5 -0
- package/api/resources/knowledge/client/requests/index.d.ts +1 -0
- package/api/resources/knowledge/client/requests/index.js +2 -0
- package/api/resources/knowledge/types/KnowledgeBaseField.d.ts +8 -0
- package/api/resources/knowledge/types/KnowledgeBaseField.js +10 -0
- package/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +26 -0
- package/api/resources/knowledge/types/KnowledgeBaseFilter.js +5 -0
- package/api/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +16 -0
- package/api/resources/knowledge/types/KnowledgeBasePatchRequest.js +5 -0
- package/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
- package/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
- package/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +12 -0
- package/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +15 -1
- package/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +8 -0
- package/api/resources/knowledge/types/KnowledgeBaseSearchRequest.js +5 -0
- package/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +8 -0
- package/api/resources/knowledge/types/KnowledgeBasesResponse.js +5 -0
- package/api/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
- package/api/resources/knowledge/types/KnowledgeDocumentField.js +12 -0
- package/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +26 -0
- package/api/resources/knowledge/types/KnowledgeDocumentFilter.js +5 -0
- package/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +8 -0
- package/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +5 -0
- package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +10 -0
- package/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +5 -0
- package/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +8 -0
- package/api/resources/knowledge/types/KnowledgeDocumentsResponse.js +5 -0
- package/api/resources/knowledge/types/index.d.ts +11 -0
- package/api/resources/knowledge/types/index.js +11 -0
- package/api/resources/organizations/client/Client.d.ts +7 -3
- package/api/resources/organizations/client/Client.js +51 -28
- package/api/resources/segments/client/Client.d.ts +120 -0
- package/api/resources/segments/client/Client.js +468 -0
- package/api/resources/segments/client/index.d.ts +2 -0
- package/{core/websocket → api/resources/segments/client}/index.js +1 -1
- package/api/resources/segments/client/requests/SegmentGetRequest.d.ts +13 -0
- package/api/resources/segments/client/requests/SegmentGetRequest.js +5 -0
- package/api/resources/segments/client/requests/index.d.ts +1 -0
- package/api/resources/segments/client/requests/index.js +2 -0
- package/api/resources/segments/types/SegmentBase.d.ts +10 -0
- package/api/resources/segments/types/SegmentBase.js +5 -0
- package/api/resources/segments/types/SegmentField.d.ts +8 -0
- package/api/resources/{realtime/types/AudioFormat.js → segments/types/SegmentField.js} +4 -4
- package/api/resources/segments/types/SegmentPatchRequest.d.ts +14 -0
- package/api/resources/segments/types/SegmentPatchRequest.js +5 -0
- package/api/resources/segments/types/SegmentRequest.d.ts +28 -0
- package/api/resources/segments/types/SegmentRequest.js +5 -0
- package/api/resources/segments/types/SegmentResponse.d.ts +39 -0
- package/api/resources/segments/types/SegmentResponse.js +5 -0
- package/api/resources/segments/types/SegmentStatus.d.ts +8 -0
- package/api/resources/segments/types/SegmentStatus.js +10 -0
- package/api/resources/segments/types/SegmentsSearchRequest.d.ts +8 -0
- package/api/resources/segments/types/SegmentsSearchRequest.js +5 -0
- package/api/resources/segments/types/SegmentsSearchResponse.d.ts +7 -0
- package/api/resources/segments/types/SegmentsSearchResponse.js +5 -0
- package/api/resources/segments/types/index.d.ts +8 -0
- package/api/resources/{realtime → segments}/types/index.js +8 -8
- package/api/resources/translations/client/Client.d.ts +5 -2
- package/api/resources/translations/client/Client.js +26 -16
- package/api/resources/triggers/client/Client.d.ts +13 -6
- package/api/resources/triggers/client/Client.js +118 -63
- package/api/resources/triggers/client/index.d.ts +1 -0
- package/api/resources/users/client/Client.d.ts +49 -10
- package/api/resources/users/client/Client.js +263 -47
- package/api/resources/users/client/index.d.ts +1 -0
- package/api/resources/users/client/requests/UserDeleteRequest.d.ts +1 -1
- package/api/resources/users/client/requests/UserGetRequest.d.ts +1 -1
- package/api/resources/users/index.d.ts +1 -0
- package/api/resources/users/index.js +1 -0
- package/api/resources/users/types/AgentUser.d.ts +24 -0
- package/api/resources/users/types/AgentUser.js +5 -0
- package/api/resources/users/types/AgentUserField.d.ts +8 -0
- package/api/resources/users/types/AgentUserField.js +10 -0
- package/api/resources/users/types/AgentUserFilter.d.ts +12 -0
- package/api/resources/users/types/AgentUserFilter.js +5 -0
- package/api/resources/users/types/AgentUserSearchRequest.d.ts +8 -0
- package/api/resources/users/types/AgentUserSearchRequest.js +5 -0
- package/api/resources/users/types/AgentUserSearchResponse.d.ts +8 -0
- package/api/resources/users/types/AgentUserSearchResponse.js +5 -0
- package/api/resources/users/types/AppUserSummary.d.ts +12 -0
- package/api/resources/users/types/AppUserSummary.js +5 -0
- package/api/resources/users/types/index.d.ts +6 -0
- package/api/resources/users/types/index.js +22 -0
- package/core/auth/BasicAuth.js +3 -3
- package/core/base64.d.ts +2 -0
- package/core/base64.js +26 -0
- package/core/fetcher/APIResponse.d.ts +10 -0
- package/core/fetcher/BinaryResponse.d.ts +20 -0
- package/core/fetcher/BinaryResponse.js +17 -0
- package/core/fetcher/Fetcher.d.ts +3 -2
- package/core/fetcher/Fetcher.js +32 -12
- package/core/fetcher/Headers.d.ts +2 -0
- package/core/fetcher/Headers.js +84 -0
- package/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/core/fetcher/HttpResponsePromise.js +103 -0
- package/core/fetcher/RawResponse.d.ts +29 -0
- package/core/fetcher/RawResponse.js +44 -0
- package/core/fetcher/ResponseWithBody.d.ts +4 -0
- package/core/fetcher/ResponseWithBody.js +6 -0
- package/core/fetcher/createRequestUrl.d.ts +1 -1
- package/core/fetcher/createRequestUrl.js +3 -7
- package/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/core/fetcher/getErrorResponseBody.js +44 -0
- package/core/fetcher/getFetchFn.d.ts +1 -4
- package/core/fetcher/getFetchFn.js +1 -52
- package/core/fetcher/getResponseBody.js +34 -33
- package/core/fetcher/index.d.ts +4 -0
- package/core/fetcher/index.js +7 -1
- package/core/headers.d.ts +3 -0
- package/core/headers.js +29 -0
- package/core/index.d.ts +3 -2
- package/core/index.js +4 -3
- package/core/runtime/runtime.js +0 -1
- package/core/{streaming-fetcher → stream}/Stream.d.ts +1 -2
- package/core/url/index.d.ts +2 -0
- package/core/url/index.js +7 -0
- package/core/url/join.d.ts +1 -0
- package/core/url/join.js +49 -0
- package/core/url/qs.d.ts +6 -0
- package/core/url/qs.js +64 -0
- package/dist/Client.d.ts +9 -4
- package/dist/Client.js +69 -20
- package/dist/api/resources/actions/client/Client.d.ts +42 -4
- package/dist/api/resources/actions/client/Client.js +264 -40
- package/dist/api/resources/actions/client/index.d.ts +1 -0
- package/dist/api/resources/actions/client/index.js +15 -0
- package/dist/api/resources/actions/client/requests/ActionGetRequest.d.ts +13 -0
- package/dist/api/resources/actions/client/requests/ActionGetRequest.js +5 -0
- package/dist/api/resources/actions/client/requests/index.d.ts +1 -0
- package/dist/api/resources/actions/client/requests/index.js +2 -0
- package/dist/api/resources/actions/types/ActionField.d.ts +11 -0
- package/dist/api/resources/actions/types/ActionField.js +13 -0
- package/dist/api/resources/actions/types/ActionFilter.d.ts +14 -0
- package/dist/api/resources/actions/types/ActionFilter.js +5 -0
- package/dist/api/resources/actions/types/ActionPatchRequest.d.ts +12 -0
- package/dist/api/resources/actions/types/ActionPatchRequest.js +5 -0
- package/dist/api/resources/actions/types/ActionsResponse.d.ts +8 -0
- package/dist/api/resources/actions/types/ActionsResponse.js +5 -0
- package/dist/api/resources/actions/types/ActionsSearchRequest.d.ts +8 -0
- package/dist/api/resources/actions/types/ActionsSearchRequest.js +5 -0
- package/dist/api/resources/actions/types/index.d.ts +5 -0
- package/dist/api/resources/actions/types/index.js +5 -0
- package/dist/api/resources/agents/client/Client.d.ts +75 -4
- package/dist/api/resources/agents/client/Client.js +363 -42
- package/dist/api/resources/agents/types/Agent.d.ts +10 -0
- package/dist/api/resources/agents/types/AgentPatchRequest.d.ts +12 -0
- package/dist/api/resources/agents/types/AgentPatchRequest.js +5 -0
- package/dist/api/resources/agents/types/CreateAgentRequest.d.ts +10 -0
- package/dist/api/resources/agents/types/CreateAgentRequest.js +5 -0
- package/dist/api/resources/agents/types/PiiCategory.d.ts +63 -0
- package/dist/api/resources/agents/types/PiiCategory.js +65 -0
- package/dist/api/resources/agents/types/index.d.ts +3 -0
- package/dist/api/resources/agents/types/index.js +3 -0
- package/dist/api/resources/analytics/client/Client.d.ts +9 -4
- package/dist/api/resources/analytics/client/Client.js +76 -40
- package/dist/api/resources/analytics/types/ConversationTableResponse.d.ts +3 -3
- package/dist/api/resources/appSettings/client/Client.d.ts +9 -4
- package/dist/api/resources/appSettings/client/Client.js +76 -44
- package/dist/api/resources/appSettings/client/index.d.ts +1 -0
- package/dist/api/resources/assets/client/Client.d.ts +76 -0
- package/dist/api/resources/assets/client/Client.js +257 -0
- package/dist/api/resources/assets/client/index.js +2 -0
- package/dist/api/resources/assets/index.d.ts +2 -0
- package/dist/api/resources/assets/index.js +18 -0
- package/dist/api/resources/assets/types/CommitAssetUploadRequest.d.ts +7 -0
- package/dist/api/resources/assets/types/CommitAssetUploadRequest.js +5 -0
- package/dist/api/resources/assets/types/InitiateAssetUploadRequest.d.ts +6 -0
- package/dist/api/resources/assets/types/InitiateAssetUploadRequest.js +5 -0
- package/dist/api/resources/assets/types/InitiateAssetUploadResponse.d.ts +12 -0
- package/dist/api/resources/assets/types/InitiateAssetUploadResponse.js +5 -0
- package/dist/api/resources/assets/types/index.d.ts +3 -0
- package/dist/api/resources/assets/types/index.js +19 -0
- package/dist/api/resources/commons/errors/BadRequestError.d.ts +2 -1
- package/dist/api/resources/commons/errors/BadRequestError.js +2 -1
- package/dist/api/resources/commons/errors/NotFoundError.d.ts +2 -1
- package/dist/api/resources/commons/errors/NotFoundError.js +2 -1
- package/dist/api/resources/commons/errors/ServerError.d.ts +2 -1
- package/dist/api/resources/commons/errors/ServerError.js +2 -1
- package/dist/api/resources/commons/types/ActionResponse.d.ts +27 -1
- package/dist/api/resources/commons/types/AppUserRequest.d.ts +2 -2
- package/dist/api/resources/commons/types/AppUserResponse.d.ts +2 -2
- package/dist/api/resources/commons/types/AttachmentRequest.d.ts +22 -0
- package/dist/api/resources/commons/types/AttachmentRequest.js +5 -0
- package/dist/api/resources/commons/types/AttachmentResponse.d.ts +12 -0
- package/dist/api/resources/commons/types/AttachmentResponse.js +5 -0
- package/dist/api/resources/commons/types/AttachmentStatus.d.ts +10 -0
- package/dist/api/resources/commons/types/AttachmentStatus.js +12 -0
- package/dist/api/resources/commons/types/BaseAttachment.d.ts +32 -0
- package/dist/api/resources/commons/types/BaseAttachment.js +5 -0
- package/dist/api/resources/commons/types/BaseConversationResponse.d.ts +11 -0
- package/dist/api/resources/commons/types/BotLogic.d.ts +7 -0
- package/dist/api/resources/commons/types/BotLogic.js +5 -0
- package/dist/api/resources/commons/types/BotLogicActionExecutedDetail.d.ts +9 -0
- package/dist/api/resources/commons/types/BotLogicActionExecutedDetail.js +5 -0
- package/dist/api/resources/commons/types/BotLogicActionItem.d.ts +8 -0
- package/dist/api/resources/commons/types/BotLogicActionItem.js +5 -0
- package/dist/api/resources/commons/types/BotLogicActionReviewedDetail.d.ts +8 -0
- package/dist/api/resources/commons/types/BotLogicActionReviewedDetail.js +5 -0
- package/dist/api/resources/commons/types/BotLogicFormSubmissionItem.d.ts +6 -0
- package/dist/api/resources/commons/types/BotLogicFormSubmissionItem.js +5 -0
- package/dist/api/resources/commons/types/BotLogicItem.d.ts +25 -0
- package/dist/api/resources/commons/types/BotLogicItem.js +5 -0
- package/{api/resources/commons/types/KnowledgeBaseInformation.d.ts → dist/api/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +4 -2
- package/dist/api/resources/commons/types/BotLogicKnowledgeDetail.js +5 -0
- package/dist/api/resources/commons/types/BotLogicKnowledgeItem.d.ts +8 -0
- package/dist/api/resources/commons/types/BotLogicKnowledgeItem.js +5 -0
- package/{api/resources/realtime/types/AudioSubscribeEvent.d.ts → dist/api/resources/commons/types/BotLogicSafetyItem.d.ts} +2 -2
- package/dist/api/resources/commons/types/BotLogicSafetyItem.js +5 -0
- package/dist/api/resources/commons/types/BotLogicSegmentsItem.d.ts +7 -0
- package/dist/api/resources/commons/types/BotLogicSegmentsItem.js +5 -0
- package/{api/resources/realtime/types/MessageBase.d.ts → dist/api/resources/commons/types/BotLogicUserItem.d.ts} +2 -2
- package/dist/api/resources/commons/types/BotLogicUserItem.js +5 -0
- package/dist/api/resources/commons/types/BotMessage.d.ts +3 -1
- package/dist/api/resources/commons/types/Capability.d.ts +2 -1
- package/dist/api/resources/commons/types/Capability.js +1 -0
- package/dist/api/resources/commons/types/ConversationResponse.d.ts +15 -2
- package/dist/api/resources/commons/types/DocumentInformation.d.ts +2 -0
- package/dist/api/resources/commons/types/EntityType.d.ts +2 -1
- package/dist/api/resources/commons/types/EntityType.js +1 -0
- package/dist/api/resources/commons/types/InboxItem.d.ts +1 -7
- package/dist/api/resources/commons/types/InboxItemBase.d.ts +2 -0
- package/dist/api/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/dist/api/resources/commons/types/InboxItemFix.d.ts +1 -4
- package/dist/api/resources/commons/types/InboxItemSeverity.d.ts +9 -0
- package/dist/api/resources/commons/types/InboxItemSeverity.js +11 -0
- package/dist/api/resources/commons/types/InboxItemType.d.ts +1 -9
- package/dist/api/resources/commons/types/InboxItemType.js +0 -2
- package/dist/api/resources/commons/types/LlmInclusionStatus.d.ts +9 -0
- package/dist/api/resources/commons/types/LlmInclusionStatus.js +11 -0
- package/dist/api/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +3 -3
- package/{api/resources/commons/types/BotMessageStatus.js → dist/api/resources/commons/types/MessageStatus.js} +2 -2
- package/dist/api/resources/commons/types/ResponseConfig.d.ts +6 -8
- package/dist/api/resources/commons/types/UserMessage.d.ts +21 -1
- package/dist/api/resources/commons/types/UserMessageResponseState.d.ts +9 -0
- package/dist/api/resources/commons/types/UserMessageResponseState.js +11 -0
- package/dist/api/resources/commons/types/index.d.ts +19 -6
- package/dist/api/resources/commons/types/index.js +19 -6
- package/dist/api/resources/conversation/client/Client.d.ts +111 -51
- package/dist/api/resources/conversation/client/Client.js +603 -222
- package/dist/api/resources/conversation/client/index.d.ts +1 -0
- package/{api/resources/conversation/types/GenerateObjectRequest.d.ts → dist/api/resources/conversation/types/AskObjectRequest.d.ts} +1 -1
- package/dist/api/resources/conversation/types/AskObjectRequest.js +5 -0
- package/dist/api/resources/conversation/types/AskRequest.d.ts +5 -2
- package/dist/api/resources/conversation/types/ConversationField.d.ts +5 -1
- package/dist/api/resources/conversation/types/ConversationField.js +4 -0
- package/dist/api/resources/conversation/types/ConversationFilter.d.ts +23 -1
- package/dist/api/resources/conversation/types/ConversationMessageRequest.d.ts +2 -0
- package/dist/api/resources/conversation/types/ConversationPatchRequest.d.ts +20 -0
- package/dist/api/resources/conversation/types/ConversationPatchRequest.js +5 -0
- package/dist/api/resources/conversation/types/DeliverConversationMessageRequest.d.ts +10 -0
- package/dist/api/resources/conversation/types/DeliverConversationMessageRequest.js +5 -0
- package/dist/api/resources/conversation/types/DeliverMessageRequest.d.ts +13 -0
- package/dist/api/resources/conversation/types/DeliverMessageRequest.js +5 -0
- package/dist/api/resources/conversation/types/DeliverMessageResponse.d.ts +7 -0
- package/dist/api/resources/conversation/types/DeliverMessageResponse.js +5 -0
- package/dist/api/resources/conversation/types/DeliverUserMessageRequest.d.ts +10 -0
- package/dist/api/resources/conversation/types/DeliverUserMessageRequest.js +5 -0
- package/dist/api/resources/conversation/types/DeliveryStatus.d.ts +9 -0
- package/dist/api/resources/conversation/types/DeliveryStatus.js +11 -0
- package/dist/api/resources/conversation/types/NumericConversationField.d.ts +2 -1
- package/dist/api/resources/conversation/types/NumericConversationField.js +1 -0
- package/dist/api/resources/conversation/types/ObjectStreamResponse.d.ts +16 -0
- package/dist/api/resources/conversation/types/ObjectStreamResponse.js +5 -0
- package/dist/api/resources/conversation/types/index.d.ts +8 -2
- package/dist/api/resources/conversation/types/index.js +8 -2
- package/dist/api/resources/events/client/Client.d.ts +5 -2
- package/dist/api/resources/events/client/Client.js +26 -16
- package/dist/api/resources/inbox/client/Client.d.ts +19 -11
- package/dist/api/resources/inbox/client/Client.js +119 -68
- package/dist/api/resources/inbox/client/index.d.ts +1 -0
- package/dist/api/resources/inbox/types/AddDocumentFixRequest.d.ts +4 -1
- package/dist/api/resources/inbox/types/ApplyFixesRequest.d.ts +12 -0
- package/dist/api/resources/inbox/types/ApplyFixesRequest.js +5 -0
- package/dist/api/resources/inbox/types/InboxFilter.d.ts +14 -0
- package/dist/api/resources/inbox/types/InboxFilter.js +5 -0
- package/dist/api/resources/inbox/types/InboxSearchRequest.d.ts +2 -9
- package/dist/api/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/dist/api/resources/inbox/types/index.d.ts +2 -2
- package/dist/api/resources/inbox/types/index.js +2 -2
- package/dist/api/resources/index.d.ts +9 -3
- package/dist/api/resources/index.js +10 -4
- package/dist/api/resources/knowledge/client/Client.d.ts +67 -8
- package/dist/api/resources/knowledge/client/Client.js +459 -88
- package/dist/api/resources/knowledge/client/index.d.ts +1 -0
- package/dist/api/resources/knowledge/client/index.js +15 -0
- package/dist/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.d.ts +13 -0
- package/dist/api/resources/knowledge/client/requests/KnowledgeBaseGetRequest.js +5 -0
- package/dist/api/resources/knowledge/client/requests/index.d.ts +1 -0
- package/dist/api/resources/knowledge/client/requests/index.js +2 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseField.d.ts +8 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseField.js +10 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.d.ts +26 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseFilter.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +16 -0
- package/dist/api/resources/knowledge/types/KnowledgeBasePatchRequest.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseProperties.d.ts +1 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +12 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseResponse.d.ts +15 -1
- package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +8 -0
- package/dist/api/resources/knowledge/types/KnowledgeBaseSearchRequest.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.d.ts +8 -0
- package/dist/api/resources/knowledge/types/KnowledgeBasesResponse.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentField.js +12 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +26 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentFilter.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +8 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +10 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +5 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +8 -0
- package/dist/api/resources/knowledge/types/KnowledgeDocumentsResponse.js +5 -0
- package/dist/api/resources/knowledge/types/index.d.ts +11 -0
- package/dist/api/resources/knowledge/types/index.js +11 -0
- package/dist/api/resources/organizations/client/Client.d.ts +7 -3
- package/dist/api/resources/organizations/client/Client.js +51 -28
- package/dist/api/resources/segments/client/Client.d.ts +120 -0
- package/dist/api/resources/segments/client/Client.js +468 -0
- package/dist/api/resources/segments/client/index.d.ts +2 -0
- package/dist/{core/websocket → api/resources/segments/client}/index.js +1 -1
- package/dist/api/resources/segments/client/requests/SegmentGetRequest.d.ts +13 -0
- package/dist/api/resources/segments/client/requests/SegmentGetRequest.js +5 -0
- package/dist/api/resources/segments/client/requests/index.d.ts +1 -0
- package/dist/api/resources/segments/client/requests/index.js +2 -0
- package/dist/api/resources/segments/index.d.ts +2 -0
- package/dist/api/resources/segments/index.js +18 -0
- package/dist/api/resources/segments/types/SegmentBase.d.ts +10 -0
- package/dist/api/resources/segments/types/SegmentBase.js +5 -0
- package/dist/api/resources/segments/types/SegmentField.d.ts +8 -0
- package/dist/api/resources/{realtime/types/AudioFormat.js → segments/types/SegmentField.js} +4 -4
- package/dist/api/resources/segments/types/SegmentPatchRequest.d.ts +14 -0
- package/dist/api/resources/segments/types/SegmentPatchRequest.js +5 -0
- package/dist/api/resources/segments/types/SegmentRequest.d.ts +28 -0
- package/dist/api/resources/segments/types/SegmentRequest.js +5 -0
- package/dist/api/resources/segments/types/SegmentResponse.d.ts +39 -0
- package/dist/api/resources/segments/types/SegmentResponse.js +5 -0
- package/dist/api/resources/segments/types/SegmentStatus.d.ts +8 -0
- package/dist/api/resources/segments/types/SegmentStatus.js +10 -0
- package/dist/api/resources/segments/types/SegmentsSearchRequest.d.ts +8 -0
- package/dist/api/resources/segments/types/SegmentsSearchRequest.js +5 -0
- package/dist/api/resources/segments/types/SegmentsSearchResponse.d.ts +7 -0
- package/dist/api/resources/segments/types/SegmentsSearchResponse.js +5 -0
- package/dist/api/resources/segments/types/index.d.ts +8 -0
- package/dist/api/resources/segments/types/index.js +24 -0
- package/dist/api/resources/translations/client/Client.d.ts +5 -2
- package/dist/api/resources/translations/client/Client.js +26 -16
- package/dist/api/resources/triggers/client/Client.d.ts +13 -6
- package/dist/api/resources/triggers/client/Client.js +118 -63
- package/dist/api/resources/triggers/client/index.d.ts +1 -0
- package/dist/api/resources/users/client/Client.d.ts +49 -10
- package/dist/api/resources/users/client/Client.js +263 -47
- package/dist/api/resources/users/client/index.d.ts +1 -0
- package/dist/api/resources/users/client/requests/UserDeleteRequest.d.ts +1 -1
- package/dist/api/resources/users/client/requests/UserGetRequest.d.ts +1 -1
- package/dist/api/resources/users/index.d.ts +1 -0
- package/dist/api/resources/users/index.js +1 -0
- package/dist/api/resources/users/types/AgentUser.d.ts +24 -0
- package/dist/api/resources/users/types/AgentUser.js +5 -0
- package/dist/api/resources/users/types/AgentUserField.d.ts +8 -0
- package/dist/api/resources/users/types/AgentUserField.js +10 -0
- package/dist/api/resources/users/types/AgentUserFilter.d.ts +12 -0
- package/dist/api/resources/users/types/AgentUserFilter.js +5 -0
- package/dist/api/resources/users/types/AgentUserSearchRequest.d.ts +8 -0
- package/dist/api/resources/users/types/AgentUserSearchRequest.js +5 -0
- package/dist/api/resources/users/types/AgentUserSearchResponse.d.ts +8 -0
- package/dist/api/resources/users/types/AgentUserSearchResponse.js +5 -0
- package/dist/api/resources/users/types/AppUserSummary.d.ts +12 -0
- package/dist/api/resources/users/types/AppUserSummary.js +5 -0
- package/dist/api/resources/users/types/index.d.ts +6 -0
- package/dist/api/resources/users/types/index.js +22 -0
- package/dist/core/auth/BasicAuth.js +3 -3
- package/dist/core/base64.d.ts +2 -0
- package/dist/core/base64.js +26 -0
- package/dist/core/fetcher/APIResponse.d.ts +10 -0
- package/dist/core/fetcher/BinaryResponse.d.ts +20 -0
- package/dist/core/fetcher/BinaryResponse.js +17 -0
- package/dist/core/fetcher/Fetcher.d.ts +3 -2
- package/dist/core/fetcher/Fetcher.js +32 -12
- package/dist/core/fetcher/Headers.d.ts +2 -0
- package/dist/core/fetcher/Headers.js +84 -0
- package/dist/core/fetcher/HttpResponsePromise.d.ts +58 -0
- package/dist/core/fetcher/HttpResponsePromise.js +103 -0
- package/dist/core/fetcher/RawResponse.d.ts +29 -0
- package/dist/core/fetcher/RawResponse.js +44 -0
- package/dist/core/fetcher/ResponseWithBody.d.ts +4 -0
- package/dist/core/fetcher/ResponseWithBody.js +6 -0
- package/dist/core/fetcher/createRequestUrl.d.ts +1 -1
- package/dist/core/fetcher/createRequestUrl.js +3 -7
- package/dist/core/fetcher/getErrorResponseBody.d.ts +1 -0
- package/dist/core/fetcher/getErrorResponseBody.js +44 -0
- package/dist/core/fetcher/getFetchFn.d.ts +1 -4
- package/dist/core/fetcher/getFetchFn.js +1 -52
- package/dist/core/fetcher/getResponseBody.js +34 -33
- package/dist/core/fetcher/index.d.ts +4 -0
- package/dist/core/fetcher/index.js +7 -1
- package/dist/core/headers.d.ts +3 -0
- package/dist/core/headers.js +29 -0
- package/dist/core/index.d.ts +3 -2
- package/dist/core/index.js +4 -3
- package/dist/core/runtime/runtime.js +0 -1
- package/dist/core/{streaming-fetcher → stream}/Stream.d.ts +1 -2
- package/dist/core/url/index.d.ts +2 -0
- package/dist/core/url/index.js +7 -0
- package/dist/core/url/join.d.ts +1 -0
- package/dist/core/url/join.js +49 -0
- package/dist/core/url/qs.d.ts +6 -0
- package/dist/core/url/qs.js +64 -0
- package/dist/errors/MavenAGIError.d.ts +4 -1
- package/dist/errors/MavenAGIError.js +4 -7
- package/dist/index.d.ts +2 -2
- package/dist/index.js +5 -5
- package/dist/serialization/resources/actions/types/ActionField.d.ts +10 -0
- package/dist/serialization/resources/actions/types/ActionField.js +41 -0
- package/dist/serialization/resources/actions/types/ActionFilter.d.ts +16 -0
- package/dist/serialization/resources/actions/types/ActionFilter.js +47 -0
- package/dist/serialization/resources/actions/types/ActionPatchRequest.d.ts +15 -0
- package/dist/serialization/resources/actions/types/ActionPatchRequest.js +46 -0
- package/dist/serialization/resources/actions/types/ActionsResponse.d.ts +14 -0
- package/dist/serialization/resources/{realtime/types/ControlEvent.js → actions/types/ActionsResponse.js} +6 -7
- package/dist/serialization/resources/actions/types/ActionsSearchRequest.d.ts +16 -0
- package/dist/serialization/resources/actions/types/ActionsSearchRequest.js +49 -0
- package/dist/serialization/resources/actions/types/index.d.ts +5 -0
- package/dist/serialization/resources/actions/types/index.js +5 -0
- package/dist/serialization/resources/agents/types/Agent.d.ts +2 -0
- package/dist/serialization/resources/agents/types/Agent.js +2 -0
- package/dist/serialization/resources/agents/types/AgentPatchRequest.d.ts +16 -0
- package/dist/serialization/resources/agents/types/AgentPatchRequest.js +47 -0
- package/dist/serialization/resources/agents/types/CreateAgentRequest.d.ts +14 -0
- package/dist/serialization/resources/agents/types/CreateAgentRequest.js +45 -0
- package/dist/serialization/resources/agents/types/PiiCategory.d.ts +10 -0
- package/dist/serialization/resources/agents/types/PiiCategory.js +99 -0
- package/dist/serialization/resources/agents/types/index.d.ts +3 -0
- package/dist/serialization/resources/agents/types/index.js +3 -0
- package/dist/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +12 -0
- package/dist/serialization/resources/assets/types/CommitAssetUploadRequest.js +43 -0
- package/dist/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +12 -0
- package/dist/serialization/resources/assets/types/InitiateAssetUploadRequest.js +42 -0
- package/dist/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +15 -0
- package/dist/serialization/resources/assets/types/InitiateAssetUploadResponse.js +46 -0
- package/dist/serialization/resources/assets/types/index.d.ts +3 -0
- package/dist/serialization/resources/assets/types/index.js +19 -0
- package/dist/serialization/resources/commons/types/ActionResponse.d.ts +6 -0
- package/dist/serialization/resources/commons/types/ActionResponse.js +6 -0
- package/dist/serialization/resources/commons/types/AttachmentRequest.d.ts +15 -0
- package/dist/serialization/resources/commons/types/AttachmentRequest.js +48 -0
- package/dist/serialization/resources/commons/types/AttachmentResponse.d.ts +16 -0
- package/dist/serialization/resources/commons/types/AttachmentResponse.js +49 -0
- package/dist/serialization/resources/commons/types/AttachmentStatus.d.ts +10 -0
- package/dist/serialization/resources/commons/types/AttachmentStatus.js +41 -0
- package/{serialization/resources/conversation/types/Attachment.d.ts → dist/serialization/resources/commons/types/BaseAttachment.d.ts} +3 -3
- package/dist/serialization/resources/{conversation/types/Attachment.js → commons/types/BaseAttachment.js} +3 -3
- package/dist/serialization/resources/commons/types/BaseConversationResponse.d.ts +2 -0
- package/dist/serialization/resources/commons/types/BaseConversationResponse.js +2 -0
- package/dist/serialization/resources/commons/types/BotLogic.d.ts +13 -0
- package/dist/serialization/resources/commons/types/BotLogic.js +44 -0
- package/dist/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +15 -0
- package/dist/serialization/resources/commons/types/BotLogicActionExecutedDetail.js +48 -0
- package/dist/serialization/resources/commons/types/BotLogicActionItem.d.ts +15 -0
- package/dist/serialization/resources/commons/types/BotLogicActionItem.js +46 -0
- package/dist/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +14 -0
- package/{serialization/resources/commons/types/KnowledgeBaseInformation.js → dist/serialization/resources/commons/types/BotLogicActionReviewedDetail.js} +4 -3
- package/dist/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +12 -0
- package/dist/serialization/resources/commons/types/BotLogicFormSubmissionItem.js +42 -0
- package/dist/serialization/resources/commons/types/BotLogicItem.d.ts +34 -0
- package/dist/serialization/resources/commons/types/BotLogicItem.js +59 -0
- package/{serialization/resources/commons/types/KnowledgeBaseInformation.d.ts → dist/serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +5 -2
- package/dist/serialization/resources/commons/types/BotLogicKnowledgeDetail.js +47 -0
- package/dist/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +14 -0
- package/dist/serialization/resources/commons/types/BotLogicKnowledgeItem.js +45 -0
- package/dist/serialization/resources/commons/types/{UserMessageAttachment.d.ts → BotLogicSafetyItem.d.ts} +3 -3
- package/dist/serialization/resources/{realtime/types/AudioPublishEvent.js → commons/types/BotLogicSafetyItem.js} +3 -3
- package/dist/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +13 -0
- package/dist/serialization/resources/{inbox/types/BaseInboxSearchRequest.js → commons/types/BotLogicSegmentsItem.js} +4 -4
- package/dist/serialization/resources/{realtime/types/AudioPublishEvent.d.ts → commons/types/BotLogicUserItem.d.ts} +3 -3
- package/dist/serialization/resources/commons/types/BotLogicUserItem.js +43 -0
- package/dist/serialization/resources/commons/types/BotMessage.d.ts +4 -2
- package/dist/serialization/resources/commons/types/BotMessage.js +4 -2
- package/dist/serialization/resources/commons/types/Capability.d.ts +1 -1
- package/dist/serialization/resources/commons/types/Capability.js +1 -1
- package/dist/serialization/resources/commons/types/ConversationResponse.d.ts +2 -0
- package/dist/serialization/resources/commons/types/ConversationResponse.js +2 -0
- package/dist/serialization/resources/commons/types/DocumentInformation.d.ts +1 -0
- package/dist/serialization/resources/commons/types/DocumentInformation.js +1 -0
- package/dist/serialization/resources/commons/types/EntityType.d.ts +1 -1
- package/dist/serialization/resources/commons/types/EntityType.js +1 -0
- package/dist/serialization/resources/commons/types/InboxItem.d.ts +1 -9
- package/dist/serialization/resources/commons/types/InboxItem.js +0 -4
- package/dist/serialization/resources/commons/types/InboxItemBase.d.ts +2 -0
- package/dist/serialization/resources/commons/types/InboxItemBase.js +2 -0
- package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/dist/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
- package/dist/serialization/resources/commons/types/InboxItemFix.d.ts +1 -5
- package/dist/serialization/resources/commons/types/InboxItemFix.js +0 -2
- package/dist/serialization/resources/commons/types/InboxItemSeverity.d.ts +10 -0
- package/dist/serialization/resources/{realtime/types/MessageBase.js → commons/types/InboxItemSeverity.js} +2 -4
- package/dist/serialization/resources/commons/types/InboxItemType.d.ts +1 -1
- package/dist/serialization/resources/commons/types/InboxItemType.js +1 -6
- package/dist/serialization/resources/commons/types/LlmInclusionStatus.d.ts +10 -0
- package/{serialization/resources/realtime/types/MessageBase.js → dist/serialization/resources/commons/types/LlmInclusionStatus.js} +2 -4
- package/dist/serialization/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +2 -2
- package/dist/serialization/resources/commons/types/{UserMessageAttachment.js → MessageStatus.js} +2 -4
- package/dist/serialization/resources/commons/types/UserMessage.d.ts +7 -2
- package/dist/serialization/resources/commons/types/UserMessage.js +7 -2
- package/dist/serialization/resources/commons/types/UserMessageResponseState.d.ts +10 -0
- package/dist/serialization/resources/commons/types/UserMessageResponseState.js +41 -0
- package/dist/serialization/resources/commons/types/index.d.ts +19 -6
- package/dist/serialization/resources/commons/types/index.js +19 -6
- package/{serialization/resources/conversation/types/GenerateObjectRequest.d.ts → dist/serialization/resources/conversation/types/AskObjectRequest.d.ts} +2 -2
- package/{serialization/resources/conversation/types/GenerateObjectRequest.js → dist/serialization/resources/conversation/types/AskObjectRequest.js} +2 -2
- package/dist/serialization/resources/conversation/types/AskRequest.d.ts +2 -2
- package/dist/serialization/resources/conversation/types/AskRequest.js +2 -2
- package/dist/serialization/resources/conversation/types/ConversationField.d.ts +1 -1
- package/dist/serialization/resources/conversation/types/ConversationField.js +4 -0
- package/dist/serialization/resources/conversation/types/ConversationFilter.d.ts +1 -0
- package/dist/serialization/resources/conversation/types/ConversationFilter.js +1 -0
- package/dist/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +2 -0
- package/dist/serialization/resources/conversation/types/ConversationMessageRequest.js +2 -0
- package/dist/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +16 -0
- package/dist/serialization/resources/conversation/types/ConversationPatchRequest.js +47 -0
- package/dist/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +15 -0
- package/dist/serialization/resources/conversation/types/DeliverConversationMessageRequest.js +46 -0
- package/dist/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +18 -0
- package/dist/serialization/resources/{realtime/types/PublishEvent.js → conversation/types/DeliverMessageRequest.js} +7 -7
- package/dist/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +13 -0
- package/dist/serialization/resources/conversation/types/DeliverMessageResponse.js +44 -0
- package/dist/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +15 -0
- package/dist/serialization/resources/conversation/types/DeliverUserMessageRequest.js +46 -0
- package/{serialization/resources/realtime/types/MessageBase.d.ts → dist/serialization/resources/conversation/types/DeliveryStatus.d.ts} +3 -5
- package/dist/serialization/resources/conversation/types/DeliveryStatus.js +41 -0
- package/dist/serialization/resources/conversation/types/NumericConversationField.d.ts +1 -1
- package/dist/serialization/resources/conversation/types/NumericConversationField.js +1 -0
- package/dist/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +22 -0
- package/dist/serialization/resources/{realtime/types/SubscribeEvent.js → conversation/types/ObjectStreamResponse.js} +9 -10
- package/dist/serialization/resources/conversation/types/index.d.ts +8 -2
- package/dist/serialization/resources/conversation/types/index.js +8 -2
- package/dist/serialization/resources/inbox/types/{ApplyInboxItemFixRequest.d.ts → ApplyFixesRequest.d.ts} +3 -2
- package/{serialization/resources/inbox/types/ApplyInboxItemFixRequest.js → dist/serialization/resources/inbox/types/ApplyFixesRequest.js} +3 -2
- package/dist/serialization/resources/inbox/types/InboxFilter.d.ts +17 -0
- package/dist/serialization/resources/inbox/types/InboxFilter.js +48 -0
- package/dist/serialization/resources/inbox/types/InboxSearchRequest.d.ts +4 -8
- package/dist/serialization/resources/inbox/types/InboxSearchRequest.js +4 -8
- package/dist/serialization/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/dist/serialization/resources/inbox/types/InboxSearchResponse.js +1 -1
- package/dist/serialization/resources/inbox/types/index.d.ts +2 -2
- package/dist/serialization/resources/inbox/types/index.js +2 -2
- package/dist/serialization/resources/index.d.ts +6 -2
- package/dist/serialization/resources/index.js +7 -3
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +10 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseField.js +41 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +15 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +46 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +18 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.js +49 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
- package/dist/serialization/resources/{commons/types/BotMessageStatus.js → knowledge/types/KnowledgeBaseRefreshFrequency.js} +2 -2
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +6 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +6 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +16 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +49 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +14 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +47 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentField.js +41 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +15 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentFilter.js +46 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +16 -0
- package/dist/serialization/resources/{commons/types/InboxItemKnowledgeBaseAlert.js → knowledge/types/KnowledgeDocumentSearchRequest.js} +8 -8
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +15 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +48 -0
- package/dist/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +14 -0
- package/dist/serialization/resources/{commons/types/InboxItemFixDeactivateKnowledgeBase.js → knowledge/types/KnowledgeDocumentsResponse.js} +6 -6
- package/dist/serialization/resources/knowledge/types/index.d.ts +11 -0
- package/dist/serialization/resources/knowledge/types/index.js +11 -0
- package/dist/serialization/resources/segments/types/SegmentBase.d.ts +13 -0
- package/dist/serialization/resources/segments/types/SegmentBase.js +45 -0
- package/{serialization/resources/realtime/types/AudioFormat.d.ts → dist/serialization/resources/segments/types/SegmentField.d.ts} +3 -3
- package/{serialization/resources/realtime/types/AudioFormat.js → dist/serialization/resources/segments/types/SegmentField.js} +2 -2
- package/dist/serialization/resources/segments/types/SegmentPatchRequest.d.ts +16 -0
- package/dist/serialization/resources/segments/types/SegmentPatchRequest.js +48 -0
- package/dist/serialization/resources/segments/types/SegmentRequest.d.ts +14 -0
- package/dist/serialization/resources/segments/types/SegmentRequest.js +47 -0
- package/dist/serialization/resources/segments/types/SegmentResponse.d.ts +16 -0
- package/dist/serialization/resources/segments/types/SegmentResponse.js +49 -0
- package/dist/serialization/resources/{realtime/types/MessageBase.d.ts → segments/types/SegmentStatus.d.ts} +3 -5
- package/dist/serialization/resources/segments/types/SegmentStatus.js +41 -0
- package/dist/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +14 -0
- package/dist/serialization/resources/segments/types/SegmentsSearchRequest.js +47 -0
- package/dist/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +14 -0
- package/{serialization/resources/realtime/types/ControlEvent.js → dist/serialization/resources/segments/types/SegmentsSearchResponse.js} +6 -7
- package/dist/serialization/resources/segments/types/index.d.ts +8 -0
- package/dist/serialization/resources/segments/types/index.js +24 -0
- package/dist/serialization/resources/users/index.d.ts +1 -0
- package/dist/serialization/resources/users/index.js +17 -0
- package/dist/serialization/resources/users/types/AgentUser.d.ts +19 -0
- package/dist/serialization/resources/users/types/AgentUser.js +50 -0
- package/dist/serialization/resources/users/types/AgentUserField.d.ts +10 -0
- package/dist/serialization/resources/users/types/AgentUserField.js +41 -0
- package/dist/serialization/resources/users/types/AgentUserFilter.d.ts +13 -0
- package/dist/serialization/resources/users/types/AgentUserFilter.js +44 -0
- package/dist/serialization/resources/users/types/AgentUserSearchRequest.d.ts +16 -0
- package/dist/serialization/resources/users/types/AgentUserSearchRequest.js +49 -0
- package/dist/serialization/resources/users/types/AgentUserSearchResponse.d.ts +14 -0
- package/dist/serialization/resources/users/types/AgentUserSearchResponse.js +47 -0
- package/dist/serialization/resources/users/types/AppUserSummary.d.ts +16 -0
- package/dist/serialization/resources/users/types/AppUserSummary.js +47 -0
- package/dist/serialization/resources/users/types/index.d.ts +6 -0
- package/dist/serialization/resources/users/types/index.js +22 -0
- package/dist/version.d.ts +1 -1
- package/dist/version.js +1 -1
- package/errors/MavenAGIError.d.ts +4 -1
- package/errors/MavenAGIError.js +4 -7
- package/index.d.ts +2 -2
- package/index.js +5 -5
- package/jest.config.mjs +6 -1
- package/package.json +13 -21
- package/reference.md +2051 -753
- package/scripts/rename-to-esm-files.js +10 -2
- package/serialization/resources/actions/types/ActionField.d.ts +10 -0
- package/serialization/resources/actions/types/ActionField.js +41 -0
- package/serialization/resources/actions/types/ActionFilter.d.ts +16 -0
- package/serialization/resources/actions/types/ActionFilter.js +47 -0
- package/serialization/resources/actions/types/ActionPatchRequest.d.ts +15 -0
- package/serialization/resources/actions/types/ActionPatchRequest.js +46 -0
- package/serialization/resources/actions/types/ActionsResponse.d.ts +14 -0
- package/serialization/resources/actions/types/ActionsResponse.js +47 -0
- package/serialization/resources/actions/types/ActionsSearchRequest.d.ts +16 -0
- package/serialization/resources/actions/types/ActionsSearchRequest.js +49 -0
- package/serialization/resources/actions/types/index.d.ts +5 -0
- package/serialization/resources/actions/types/index.js +5 -0
- package/serialization/resources/agents/types/Agent.d.ts +2 -0
- package/serialization/resources/agents/types/Agent.js +2 -0
- package/serialization/resources/agents/types/AgentPatchRequest.d.ts +16 -0
- package/serialization/resources/agents/types/AgentPatchRequest.js +47 -0
- package/serialization/resources/agents/types/CreateAgentRequest.d.ts +14 -0
- package/serialization/resources/agents/types/CreateAgentRequest.js +45 -0
- package/serialization/resources/agents/types/PiiCategory.d.ts +10 -0
- package/serialization/resources/agents/types/PiiCategory.js +99 -0
- package/serialization/resources/agents/types/index.d.ts +3 -0
- package/serialization/resources/agents/types/index.js +3 -0
- package/serialization/resources/assets/index.d.ts +1 -0
- package/serialization/resources/assets/index.js +17 -0
- package/serialization/resources/assets/types/CommitAssetUploadRequest.d.ts +12 -0
- package/serialization/resources/assets/types/CommitAssetUploadRequest.js +43 -0
- package/serialization/resources/assets/types/InitiateAssetUploadRequest.d.ts +12 -0
- package/serialization/resources/assets/types/InitiateAssetUploadRequest.js +42 -0
- package/serialization/resources/assets/types/InitiateAssetUploadResponse.d.ts +15 -0
- package/serialization/resources/assets/types/InitiateAssetUploadResponse.js +46 -0
- package/serialization/resources/assets/types/index.d.ts +3 -0
- package/serialization/resources/assets/types/index.js +19 -0
- package/serialization/resources/commons/types/ActionResponse.d.ts +6 -0
- package/serialization/resources/commons/types/ActionResponse.js +6 -0
- package/serialization/resources/commons/types/AttachmentRequest.d.ts +15 -0
- package/serialization/resources/commons/types/AttachmentRequest.js +48 -0
- package/serialization/resources/commons/types/AttachmentResponse.d.ts +16 -0
- package/serialization/resources/commons/types/AttachmentResponse.js +49 -0
- package/serialization/resources/commons/types/AttachmentStatus.d.ts +10 -0
- package/serialization/resources/commons/types/AttachmentStatus.js +41 -0
- package/{dist/serialization/resources/conversation/types/Attachment.d.ts → serialization/resources/commons/types/BaseAttachment.d.ts} +3 -3
- package/serialization/resources/{conversation/types/Attachment.js → commons/types/BaseAttachment.js} +3 -3
- package/serialization/resources/commons/types/BaseConversationResponse.d.ts +2 -0
- package/serialization/resources/commons/types/BaseConversationResponse.js +2 -0
- package/serialization/resources/commons/types/BotLogic.d.ts +13 -0
- package/serialization/resources/commons/types/BotLogic.js +44 -0
- package/serialization/resources/commons/types/BotLogicActionExecutedDetail.d.ts +15 -0
- package/serialization/resources/commons/types/BotLogicActionExecutedDetail.js +48 -0
- package/serialization/resources/commons/types/BotLogicActionItem.d.ts +15 -0
- package/serialization/resources/commons/types/BotLogicActionItem.js +46 -0
- package/serialization/resources/commons/types/BotLogicActionReviewedDetail.d.ts +14 -0
- package/{dist/serialization/resources/commons/types/KnowledgeBaseInformation.js → serialization/resources/commons/types/BotLogicActionReviewedDetail.js} +4 -3
- package/serialization/resources/commons/types/BotLogicFormSubmissionItem.d.ts +12 -0
- package/serialization/resources/commons/types/BotLogicFormSubmissionItem.js +42 -0
- package/serialization/resources/commons/types/BotLogicItem.d.ts +34 -0
- package/serialization/resources/commons/types/BotLogicItem.js +59 -0
- package/{dist/serialization/resources/commons/types/KnowledgeBaseInformation.d.ts → serialization/resources/commons/types/BotLogicKnowledgeDetail.d.ts} +5 -2
- package/serialization/resources/commons/types/BotLogicKnowledgeDetail.js +47 -0
- package/serialization/resources/commons/types/BotLogicKnowledgeItem.d.ts +14 -0
- package/serialization/resources/commons/types/BotLogicKnowledgeItem.js +45 -0
- package/serialization/resources/commons/types/BotLogicSafetyItem.d.ts +12 -0
- package/{dist/serialization/resources/realtime/types/AudioSubscribeEvent.js → serialization/resources/commons/types/BotLogicSafetyItem.js} +3 -3
- package/serialization/resources/commons/types/BotLogicSegmentsItem.d.ts +13 -0
- package/serialization/resources/commons/types/BotLogicSegmentsItem.js +44 -0
- package/{dist/serialization/resources/realtime/types/AudioSubscribeEvent.d.ts → serialization/resources/commons/types/BotLogicUserItem.d.ts} +3 -3
- package/serialization/resources/commons/types/BotLogicUserItem.js +43 -0
- package/serialization/resources/commons/types/BotMessage.d.ts +4 -2
- package/serialization/resources/commons/types/BotMessage.js +4 -2
- package/serialization/resources/commons/types/Capability.d.ts +1 -1
- package/serialization/resources/commons/types/Capability.js +1 -1
- package/serialization/resources/commons/types/ConversationResponse.d.ts +2 -0
- package/serialization/resources/commons/types/ConversationResponse.js +2 -0
- package/serialization/resources/commons/types/DocumentInformation.d.ts +1 -0
- package/serialization/resources/commons/types/DocumentInformation.js +1 -0
- package/serialization/resources/commons/types/EntityType.d.ts +1 -1
- package/serialization/resources/commons/types/EntityType.js +1 -0
- package/serialization/resources/commons/types/InboxItem.d.ts +1 -9
- package/serialization/resources/commons/types/InboxItem.js +0 -4
- package/serialization/resources/commons/types/InboxItemBase.d.ts +2 -0
- package/serialization/resources/commons/types/InboxItemBase.js +2 -0
- package/serialization/resources/commons/types/InboxItemDuplicateDocuments.d.ts +1 -1
- package/serialization/resources/commons/types/InboxItemDuplicateDocuments.js +1 -1
- package/serialization/resources/commons/types/InboxItemFix.d.ts +1 -5
- package/serialization/resources/commons/types/InboxItemFix.js +0 -2
- package/serialization/resources/commons/types/InboxItemSeverity.d.ts +10 -0
- package/serialization/resources/commons/types/InboxItemSeverity.js +41 -0
- package/serialization/resources/commons/types/InboxItemType.d.ts +1 -1
- package/serialization/resources/commons/types/InboxItemType.js +1 -6
- package/serialization/resources/commons/types/LlmInclusionStatus.d.ts +10 -0
- package/serialization/resources/commons/types/LlmInclusionStatus.js +41 -0
- package/serialization/resources/commons/types/{BotMessageStatus.d.ts → MessageStatus.d.ts} +2 -2
- package/serialization/resources/commons/types/MessageStatus.js +41 -0
- package/serialization/resources/commons/types/UserMessage.d.ts +7 -2
- package/serialization/resources/commons/types/UserMessage.js +7 -2
- package/serialization/resources/commons/types/UserMessageResponseState.d.ts +10 -0
- package/serialization/resources/commons/types/UserMessageResponseState.js +41 -0
- package/serialization/resources/commons/types/index.d.ts +19 -6
- package/serialization/resources/commons/types/index.js +19 -6
- package/{dist/serialization/resources/conversation/types/GenerateObjectRequest.d.ts → serialization/resources/conversation/types/AskObjectRequest.d.ts} +2 -2
- package/{dist/serialization/resources/conversation/types/GenerateObjectRequest.js → serialization/resources/conversation/types/AskObjectRequest.js} +2 -2
- package/serialization/resources/conversation/types/AskRequest.d.ts +2 -2
- package/serialization/resources/conversation/types/AskRequest.js +2 -2
- package/serialization/resources/conversation/types/ConversationField.d.ts +1 -1
- package/serialization/resources/conversation/types/ConversationField.js +4 -0
- package/serialization/resources/conversation/types/ConversationFilter.d.ts +1 -0
- package/serialization/resources/conversation/types/ConversationFilter.js +1 -0
- package/serialization/resources/conversation/types/ConversationMessageRequest.d.ts +2 -0
- package/serialization/resources/conversation/types/ConversationMessageRequest.js +2 -0
- package/serialization/resources/conversation/types/ConversationPatchRequest.d.ts +16 -0
- package/serialization/resources/conversation/types/ConversationPatchRequest.js +47 -0
- package/serialization/resources/conversation/types/DeliverConversationMessageRequest.d.ts +15 -0
- package/serialization/resources/conversation/types/DeliverConversationMessageRequest.js +46 -0
- package/serialization/resources/conversation/types/DeliverMessageRequest.d.ts +18 -0
- package/serialization/resources/{realtime/types/PublishEvent.js → conversation/types/DeliverMessageRequest.js} +7 -7
- package/serialization/resources/conversation/types/DeliverMessageResponse.d.ts +13 -0
- package/serialization/resources/conversation/types/DeliverMessageResponse.js +44 -0
- package/serialization/resources/conversation/types/DeliverUserMessageRequest.d.ts +15 -0
- package/serialization/resources/conversation/types/DeliverUserMessageRequest.js +46 -0
- package/serialization/resources/conversation/types/DeliveryStatus.d.ts +10 -0
- package/serialization/resources/conversation/types/DeliveryStatus.js +41 -0
- package/serialization/resources/conversation/types/NumericConversationField.d.ts +1 -1
- package/serialization/resources/conversation/types/NumericConversationField.js +1 -0
- package/serialization/resources/conversation/types/ObjectStreamResponse.d.ts +22 -0
- package/serialization/resources/{realtime/types/SubscribeEvent.js → conversation/types/ObjectStreamResponse.js} +9 -10
- package/serialization/resources/conversation/types/index.d.ts +8 -2
- package/serialization/resources/conversation/types/index.js +8 -2
- package/serialization/resources/inbox/types/{ApplyInboxItemFixRequest.d.ts → ApplyFixesRequest.d.ts} +3 -2
- package/{dist/serialization/resources/inbox/types/ApplyInboxItemFixRequest.js → serialization/resources/inbox/types/ApplyFixesRequest.js} +3 -2
- package/serialization/resources/inbox/types/InboxFilter.d.ts +17 -0
- package/serialization/resources/inbox/types/InboxFilter.js +48 -0
- package/serialization/resources/inbox/types/InboxSearchRequest.d.ts +4 -8
- package/serialization/resources/inbox/types/InboxSearchRequest.js +4 -8
- package/serialization/resources/inbox/types/InboxSearchResponse.d.ts +1 -1
- package/serialization/resources/inbox/types/InboxSearchResponse.js +1 -1
- package/serialization/resources/inbox/types/index.d.ts +2 -2
- package/serialization/resources/inbox/types/index.js +2 -2
- package/serialization/resources/index.d.ts +6 -2
- package/serialization/resources/index.js +7 -3
- package/serialization/resources/knowledge/types/KnowledgeBaseField.d.ts +10 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseField.js +41 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseFilter.d.ts +15 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseFilter.js +46 -0
- package/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.d.ts +18 -0
- package/serialization/resources/knowledge/types/KnowledgeBasePatchRequest.js +49 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.d.ts +10 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseRefreshFrequency.js +41 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseResponse.d.ts +6 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseResponse.js +6 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.d.ts +16 -0
- package/serialization/resources/knowledge/types/KnowledgeBaseSearchRequest.js +49 -0
- package/serialization/resources/knowledge/types/KnowledgeBasesResponse.d.ts +14 -0
- package/serialization/resources/knowledge/types/KnowledgeBasesResponse.js +47 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentField.d.ts +10 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentField.js +41 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentFilter.d.ts +15 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentFilter.js +46 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.d.ts +16 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchRequest.js +49 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.d.ts +15 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentSearchResponse.js +48 -0
- package/serialization/resources/knowledge/types/KnowledgeDocumentsResponse.d.ts +14 -0
- package/serialization/resources/{commons/types/InboxItemFixDeactivateKnowledgeBase.js → knowledge/types/KnowledgeDocumentsResponse.js} +6 -6
- package/serialization/resources/knowledge/types/index.d.ts +11 -0
- package/serialization/resources/knowledge/types/index.js +11 -0
- package/serialization/resources/segments/index.d.ts +1 -0
- package/serialization/resources/segments/index.js +17 -0
- package/serialization/resources/segments/types/SegmentBase.d.ts +13 -0
- package/serialization/resources/segments/types/SegmentBase.js +45 -0
- package/{dist/serialization/resources/realtime/types/AudioFormat.d.ts → serialization/resources/segments/types/SegmentField.d.ts} +3 -3
- package/{dist/serialization/resources/realtime/types/AudioFormat.js → serialization/resources/segments/types/SegmentField.js} +2 -2
- package/serialization/resources/segments/types/SegmentPatchRequest.d.ts +16 -0
- package/serialization/resources/segments/types/SegmentPatchRequest.js +48 -0
- package/serialization/resources/segments/types/SegmentRequest.d.ts +14 -0
- package/serialization/resources/segments/types/SegmentRequest.js +47 -0
- package/serialization/resources/segments/types/SegmentResponse.d.ts +16 -0
- package/serialization/resources/segments/types/SegmentResponse.js +49 -0
- package/serialization/resources/segments/types/SegmentStatus.d.ts +10 -0
- package/serialization/resources/segments/types/SegmentStatus.js +41 -0
- package/serialization/resources/segments/types/SegmentsSearchRequest.d.ts +14 -0
- package/serialization/resources/segments/types/SegmentsSearchRequest.js +47 -0
- package/serialization/resources/segments/types/SegmentsSearchResponse.d.ts +14 -0
- package/serialization/resources/segments/types/SegmentsSearchResponse.js +47 -0
- package/serialization/resources/segments/types/index.d.ts +8 -0
- package/serialization/resources/segments/types/index.js +24 -0
- package/serialization/resources/users/index.d.ts +1 -0
- package/serialization/resources/users/index.js +17 -0
- package/serialization/resources/users/types/AgentUser.d.ts +19 -0
- package/serialization/resources/users/types/AgentUser.js +50 -0
- package/serialization/resources/users/types/AgentUserField.d.ts +10 -0
- package/serialization/resources/users/types/AgentUserField.js +41 -0
- package/serialization/resources/users/types/AgentUserFilter.d.ts +13 -0
- package/serialization/resources/users/types/AgentUserFilter.js +44 -0
- package/serialization/resources/users/types/AgentUserSearchRequest.d.ts +16 -0
- package/serialization/resources/users/types/AgentUserSearchRequest.js +49 -0
- package/serialization/resources/users/types/AgentUserSearchResponse.d.ts +14 -0
- package/serialization/resources/users/types/AgentUserSearchResponse.js +47 -0
- package/serialization/resources/users/types/AppUserSummary.d.ts +16 -0
- package/serialization/resources/users/types/AppUserSummary.js +47 -0
- package/serialization/resources/users/types/index.d.ts +6 -0
- package/serialization/resources/users/types/index.js +22 -0
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -12
- package/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -8
- package/api/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -10
- package/api/resources/commons/types/UserMessageAttachment.d.ts +0 -7
- package/api/resources/conversation/types/Attachment.d.ts +0 -9
- package/api/resources/inbox/types/ApplyInboxItemFixRequest.d.ts +0 -9
- package/api/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -9
- package/api/resources/realtime/client/Client.d.ts +0 -36
- package/api/resources/realtime/client/Client.js +0 -90
- package/api/resources/realtime/client/Socket.d.ts +0 -41
- package/api/resources/realtime/client/Socket.js +0 -155
- package/api/resources/realtime/types/AudioFormat.d.ts +0 -8
- package/api/resources/realtime/types/ControlEvent.d.ts +0 -9
- package/api/resources/realtime/types/PublishEvent.d.ts +0 -16
- package/api/resources/realtime/types/SubscribeEvent.d.ts +0 -25
- package/api/resources/realtime/types/index.d.ts +0 -8
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
- package/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -247
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
- package/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -126
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
- package/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -229
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
- package/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -59
- package/core/websocket/events.d.ts +0 -36
- package/core/websocket/events.js +0 -27
- package/core/websocket/index.d.ts +0 -1
- package/core/websocket/ws.d.ts +0 -137
- package/core/websocket/ws.js +0 -452
- package/dist/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -12
- package/dist/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -8
- package/dist/api/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -10
- package/dist/api/resources/commons/types/UserMessageAttachment.d.ts +0 -7
- package/dist/api/resources/conversation/types/Attachment.d.ts +0 -9
- package/dist/api/resources/inbox/types/ApplyInboxItemFixRequest.d.ts +0 -9
- package/dist/api/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -9
- package/dist/api/resources/realtime/client/Client.d.ts +0 -36
- package/dist/api/resources/realtime/client/Client.js +0 -90
- package/dist/api/resources/realtime/client/Socket.d.ts +0 -41
- package/dist/api/resources/realtime/client/Socket.js +0 -155
- package/dist/api/resources/realtime/types/AudioFormat.d.ts +0 -8
- package/dist/api/resources/realtime/types/AudioPublishEvent.d.ts +0 -6
- package/dist/api/resources/realtime/types/AudioSubscribeEvent.d.ts +0 -6
- package/dist/api/resources/realtime/types/ControlEvent.d.ts +0 -9
- package/dist/api/resources/realtime/types/HangUpPublishEvent.d.ts +0 -6
- package/dist/api/resources/realtime/types/MessageBase.d.ts +0 -6
- package/dist/api/resources/realtime/types/PublishEvent.d.ts +0 -16
- package/dist/api/resources/realtime/types/SubscribeEvent.d.ts +0 -25
- package/dist/api/resources/realtime/types/index.d.ts +0 -8
- package/dist/api/resources/realtime/types/index.js +0 -24
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.d.ts +0 -30
- package/dist/core/fetcher/stream-wrappers/Node18UniversalStreamWrapper.js +0 -247
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.d.ts +0 -21
- package/dist/core/fetcher/stream-wrappers/NodePre18StreamWrapper.js +0 -126
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.d.ts +0 -31
- package/dist/core/fetcher/stream-wrappers/UndiciStreamWrapper.js +0 -229
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.d.ts +0 -18
- package/dist/core/fetcher/stream-wrappers/chooseStreamWrapper.js +0 -59
- package/dist/core/websocket/events.d.ts +0 -36
- package/dist/core/websocket/events.js +0 -27
- package/dist/core/websocket/index.d.ts +0 -1
- package/dist/core/websocket/ws.d.ts +0 -137
- package/dist/core/websocket/ws.js +0 -452
- package/dist/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -17
- package/dist/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.js +0 -50
- package/dist/serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -14
- package/dist/serialization/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -16
- package/dist/serialization/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -13
- package/dist/serialization/resources/realtime/types/ControlEvent.d.ts +0 -15
- package/dist/serialization/resources/realtime/types/HangUpPublishEvent.d.ts +0 -12
- package/dist/serialization/resources/realtime/types/HangUpPublishEvent.js +0 -43
- package/dist/serialization/resources/realtime/types/PublishEvent.d.ts +0 -18
- package/dist/serialization/resources/realtime/types/SubscribeEvent.d.ts +0 -27
- package/dist/serialization/resources/realtime/types/index.d.ts +0 -8
- package/dist/serialization/resources/realtime/types/index.js +0 -24
- package/serialization/resources/commons/types/BotMessageStatus.js +0 -41
- package/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.d.ts +0 -17
- package/serialization/resources/commons/types/InboxItemDuplicateKnowledgeBase.js +0 -50
- package/serialization/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.d.ts +0 -14
- package/serialization/resources/commons/types/InboxItemKnowledgeBaseAlert.d.ts +0 -16
- package/serialization/resources/commons/types/InboxItemKnowledgeBaseAlert.js +0 -49
- package/serialization/resources/commons/types/UserMessageAttachment.d.ts +0 -12
- package/serialization/resources/commons/types/UserMessageAttachment.js +0 -43
- package/serialization/resources/inbox/types/BaseInboxSearchRequest.d.ts +0 -13
- package/serialization/resources/inbox/types/BaseInboxSearchRequest.js +0 -44
- package/serialization/resources/realtime/types/AudioPublishEvent.d.ts +0 -12
- package/serialization/resources/realtime/types/AudioPublishEvent.js +0 -43
- package/serialization/resources/realtime/types/AudioSubscribeEvent.d.ts +0 -12
- package/serialization/resources/realtime/types/AudioSubscribeEvent.js +0 -43
- package/serialization/resources/realtime/types/ControlEvent.d.ts +0 -15
- package/serialization/resources/realtime/types/HangUpPublishEvent.d.ts +0 -12
- package/serialization/resources/realtime/types/HangUpPublishEvent.js +0 -43
- package/serialization/resources/realtime/types/PublishEvent.d.ts +0 -18
- package/serialization/resources/realtime/types/SubscribeEvent.d.ts +0 -27
- package/serialization/resources/realtime/types/index.d.ts +0 -8
- package/serialization/resources/realtime/types/index.js +0 -24
- /package/api/resources/{commons/types/InboxItemDuplicateKnowledgeBase.js → actions/client/requests/ActionGetRequest.js} +0 -0
- /package/api/resources/{realtime/client → actions/client/requests}/index.js +0 -0
- /package/api/resources/{commons/types/InboxItemFixDeactivateKnowledgeBase.js → actions/types/ActionFilter.js} +0 -0
- /package/api/resources/{commons/types/InboxItemKnowledgeBaseAlert.js → actions/types/ActionPatchRequest.js} +0 -0
- /package/api/resources/{commons/types/KnowledgeBaseInformation.js → actions/types/ActionsResponse.js} +0 -0
- /package/api/resources/{commons/types/UserMessageAttachment.js → actions/types/ActionsSearchRequest.js} +0 -0
- /package/api/resources/{conversation/types/Attachment.js → agents/types/AgentPatchRequest.js} +0 -0
- /package/api/resources/{conversation/types/GenerateObjectRequest.js → agents/types/CreateAgentRequest.js} +0 -0
- /package/api/resources/{realtime → assets}/client/index.d.ts +0 -0
- /package/{dist/api/resources/realtime → api/resources/assets}/client/index.js +0 -0
- /package/api/resources/{realtime → assets}/index.d.ts +0 -0
- /package/api/resources/{realtime → assets}/index.js +0 -0
- /package/api/resources/{inbox/types/ApplyInboxItemFixRequest.js → assets/types/CommitAssetUploadRequest.js} +0 -0
- /package/api/resources/{inbox/types/BaseInboxSearchRequest.js → assets/types/InitiateAssetUploadRequest.js} +0 -0
- /package/api/resources/{realtime/types/AudioPublishEvent.js → assets/types/InitiateAssetUploadResponse.js} +0 -0
- /package/api/resources/{realtime/types/AudioSubscribeEvent.js → commons/types/AttachmentRequest.js} +0 -0
- /package/api/resources/{realtime/types/ControlEvent.js → commons/types/AttachmentResponse.js} +0 -0
- /package/api/resources/{realtime/types/HangUpPublishEvent.js → commons/types/BaseAttachment.js} +0 -0
- /package/api/resources/{realtime/types/MessageBase.js → commons/types/BotLogic.js} +0 -0
- /package/api/resources/{realtime/types/PublishEvent.js → commons/types/BotLogicActionExecutedDetail.js} +0 -0
- /package/api/resources/{realtime/types/SubscribeEvent.js → commons/types/BotLogicActionItem.js} +0 -0
- /package/{dist/api/resources/commons/types/InboxItemDuplicateKnowledgeBase.js → api/resources/commons/types/BotLogicActionReviewedDetail.js} +0 -0
- /package/{dist/api/resources/commons/types/InboxItemFixDeactivateKnowledgeBase.js → api/resources/commons/types/BotLogicFormSubmissionItem.js} +0 -0
- /package/{dist/api/resources/commons/types/InboxItemKnowledgeBaseAlert.js → api/resources/commons/types/BotLogicItem.js} +0 -0
- /package/{dist/api/resources/commons/types/KnowledgeBaseInformation.js → api/resources/commons/types/BotLogicKnowledgeDetail.js} +0 -0
- /package/{dist/api/resources/commons/types/UserMessageAttachment.js → api/resources/commons/types/BotLogicKnowledgeItem.js} +0 -0
- /package/{dist/api/resources/conversation/types/Attachment.js → api/resources/commons/types/BotLogicSafetyItem.js} +0 -0
- /package/{dist/api/resources/conversation/types/GenerateObjectRequest.js → api/resources/commons/types/BotLogicSegmentsItem.js} +0 -0
- /package/{dist/api/resources/inbox/types/ApplyInboxItemFixRequest.js → api/resources/commons/types/BotLogicUserItem.js} +0 -0
- /package/{dist/api/resources/inbox/types/BaseInboxSearchRequest.js → api/resources/conversation/types/AskObjectRequest.js} +0 -0
- /package/{dist/api/resources/realtime/types/AudioPublishEvent.js → api/resources/conversation/types/ConversationPatchRequest.js} +0 -0
- /package/{dist/api/resources/realtime/types/AudioSubscribeEvent.js → api/resources/conversation/types/DeliverConversationMessageRequest.js} +0 -0
- /package/{dist/api/resources/realtime/types/ControlEvent.js → api/resources/conversation/types/DeliverMessageRequest.js} +0 -0
- /package/{dist/api/resources/realtime/types/HangUpPublishEvent.js → api/resources/conversation/types/DeliverMessageResponse.js} +0 -0
- /package/{dist/api/resources/realtime/types/MessageBase.js → api/resources/conversation/types/DeliverUserMessageRequest.js} +0 -0
- /package/{dist/api/resources/realtime/types/PublishEvent.js → api/resources/conversation/types/ObjectStreamResponse.js} +0 -0
- /package/{dist/api/resources/realtime/types/SubscribeEvent.js → api/resources/inbox/types/ApplyFixesRequest.js} +0 -0
- /package/{dist/api/resources/realtime → api/resources/segments}/index.d.ts +0 -0
- /package/{dist/api/resources/realtime → api/resources/segments}/index.js +0 -0
- /package/core/{streaming-fetcher → stream}/Stream.js +0 -0
- /package/core/{streaming-fetcher → stream}/index.d.ts +0 -0
- /package/core/{streaming-fetcher → stream}/index.js +0 -0
- /package/dist/api/resources/{realtime → assets}/client/index.d.ts +0 -0
- /package/dist/core/{streaming-fetcher → stream}/Stream.js +0 -0
- /package/dist/core/{streaming-fetcher → stream}/index.d.ts +0 -0
- /package/dist/core/{streaming-fetcher → stream}/index.js +0 -0
- /package/dist/serialization/resources/{realtime → assets}/index.d.ts +0 -0
- /package/dist/serialization/resources/{realtime → assets}/index.js +0 -0
- /package/{serialization/resources/realtime → dist/serialization/resources/segments}/index.d.ts +0 -0
- /package/{serialization/resources/realtime → dist/serialization/resources/segments}/index.js +0 -0
package/reference.md
CHANGED
|
@@ -2,6 +2,54 @@
|
|
|
2
2
|
|
|
3
3
|
## Actions
|
|
4
4
|
|
|
5
|
+
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ActionsResponse</code></summary>
|
|
6
|
+
<dl>
|
|
7
|
+
<dd>
|
|
8
|
+
|
|
9
|
+
#### 🔌 Usage
|
|
10
|
+
|
|
11
|
+
<dl>
|
|
12
|
+
<dd>
|
|
13
|
+
|
|
14
|
+
<dl>
|
|
15
|
+
<dd>
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
await client.actions.search({});
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
</dd>
|
|
22
|
+
</dl>
|
|
23
|
+
</dd>
|
|
24
|
+
</dl>
|
|
25
|
+
|
|
26
|
+
#### ⚙️ Parameters
|
|
27
|
+
|
|
28
|
+
<dl>
|
|
29
|
+
<dd>
|
|
30
|
+
|
|
31
|
+
<dl>
|
|
32
|
+
<dd>
|
|
33
|
+
|
|
34
|
+
**request:** `MavenAGI.ActionsSearchRequest`
|
|
35
|
+
|
|
36
|
+
</dd>
|
|
37
|
+
</dl>
|
|
38
|
+
|
|
39
|
+
<dl>
|
|
40
|
+
<dd>
|
|
41
|
+
|
|
42
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
43
|
+
|
|
44
|
+
</dd>
|
|
45
|
+
</dl>
|
|
46
|
+
</dd>
|
|
47
|
+
</dl>
|
|
48
|
+
|
|
49
|
+
</dd>
|
|
50
|
+
</dl>
|
|
51
|
+
</details>
|
|
52
|
+
|
|
5
53
|
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.ActionResponse</code></summary>
|
|
6
54
|
<dl>
|
|
7
55
|
<dd>
|
|
@@ -88,7 +136,7 @@ await client.actions.createOrUpdate({
|
|
|
88
136
|
</dl>
|
|
89
137
|
</details>
|
|
90
138
|
|
|
91
|
-
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">get</a>(actionReferenceId) -> MavenAGI.ActionResponse</code></summary>
|
|
139
|
+
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">get</a>(actionReferenceId, { ...params }) -> MavenAGI.ActionResponse</code></summary>
|
|
92
140
|
<dl>
|
|
93
141
|
<dd>
|
|
94
142
|
|
|
@@ -140,6 +188,14 @@ await client.actions.get("get-balance");
|
|
|
140
188
|
<dl>
|
|
141
189
|
<dd>
|
|
142
190
|
|
|
191
|
+
**request:** `MavenAGI.ActionGetRequest`
|
|
192
|
+
|
|
193
|
+
</dd>
|
|
194
|
+
</dl>
|
|
195
|
+
|
|
196
|
+
<dl>
|
|
197
|
+
<dd>
|
|
198
|
+
|
|
143
199
|
**requestOptions:** `Actions.RequestOptions`
|
|
144
200
|
|
|
145
201
|
</dd>
|
|
@@ -151,7 +207,7 @@ await client.actions.get("get-balance");
|
|
|
151
207
|
</dl>
|
|
152
208
|
</details>
|
|
153
209
|
|
|
154
|
-
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">
|
|
210
|
+
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">patch</a>(actionReferenceId, { ...params }) -> MavenAGI.ActionResponse</code></summary>
|
|
155
211
|
<dl>
|
|
156
212
|
<dd>
|
|
157
213
|
|
|
@@ -163,7 +219,10 @@ await client.actions.get("get-balance");
|
|
|
163
219
|
<dl>
|
|
164
220
|
<dd>
|
|
165
221
|
|
|
166
|
-
|
|
222
|
+
Update mutable action fields
|
|
223
|
+
|
|
224
|
+
The `appId` field can be provided to update an action owned by a different app.
|
|
225
|
+
All other fields will overwrite the existing value on the action only if provided.
|
|
167
226
|
|
|
168
227
|
</dd>
|
|
169
228
|
</dl>
|
|
@@ -179,7 +238,7 @@ Delete an action
|
|
|
179
238
|
<dd>
|
|
180
239
|
|
|
181
240
|
```typescript
|
|
182
|
-
await client.actions.
|
|
241
|
+
await client.actions.patch("actionReferenceId", {});
|
|
183
242
|
```
|
|
184
243
|
|
|
185
244
|
</dd>
|
|
@@ -195,7 +254,15 @@ await client.actions.delete("get-balance");
|
|
|
195
254
|
<dl>
|
|
196
255
|
<dd>
|
|
197
256
|
|
|
198
|
-
**actionReferenceId:** `string` — The reference ID of the action to
|
|
257
|
+
**actionReferenceId:** `string` — The reference ID of the action to patch.
|
|
258
|
+
|
|
259
|
+
</dd>
|
|
260
|
+
</dl>
|
|
261
|
+
|
|
262
|
+
<dl>
|
|
263
|
+
<dd>
|
|
264
|
+
|
|
265
|
+
**request:** `MavenAGI.ActionPatchRequest`
|
|
199
266
|
|
|
200
267
|
</dd>
|
|
201
268
|
</dl>
|
|
@@ -214,9 +281,7 @@ await client.actions.delete("get-balance");
|
|
|
214
281
|
</dl>
|
|
215
282
|
</details>
|
|
216
283
|
|
|
217
|
-
|
|
218
|
-
|
|
219
|
-
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
|
|
284
|
+
<details><summary><code>client.actions.<a href="/src/api/resources/actions/client/Client.ts">delete</a>(actionReferenceId) -> void</code></summary>
|
|
220
285
|
<dl>
|
|
221
286
|
<dd>
|
|
222
287
|
|
|
@@ -228,11 +293,8 @@ await client.actions.delete("get-balance");
|
|
|
228
293
|
<dl>
|
|
229
294
|
<dd>
|
|
230
295
|
|
|
231
|
-
|
|
296
|
+
Delete an action
|
|
232
297
|
|
|
233
|
-
<Tip>
|
|
234
|
-
This endpoint requires additional permissions. Contact support to request access.
|
|
235
|
-
</Tip>
|
|
236
298
|
</dd>
|
|
237
299
|
</dl>
|
|
238
300
|
</dd>
|
|
@@ -247,7 +309,7 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
247
309
|
<dd>
|
|
248
310
|
|
|
249
311
|
```typescript
|
|
250
|
-
await client.
|
|
312
|
+
await client.actions.delete("get-balance");
|
|
251
313
|
```
|
|
252
314
|
|
|
253
315
|
</dd>
|
|
@@ -263,7 +325,7 @@ await client.agents.search({});
|
|
|
263
325
|
<dl>
|
|
264
326
|
<dd>
|
|
265
327
|
|
|
266
|
-
**
|
|
328
|
+
**actionReferenceId:** `string` — The reference ID of the action to unregister. All other entity ID fields are inferred from the request.
|
|
267
329
|
|
|
268
330
|
</dd>
|
|
269
331
|
</dl>
|
|
@@ -271,7 +333,7 @@ await client.agents.search({});
|
|
|
271
333
|
<dl>
|
|
272
334
|
<dd>
|
|
273
335
|
|
|
274
|
-
**requestOptions:** `
|
|
336
|
+
**requestOptions:** `Actions.RequestOptions`
|
|
275
337
|
|
|
276
338
|
</dd>
|
|
277
339
|
</dl>
|
|
@@ -282,7 +344,9 @@ await client.agents.search({});
|
|
|
282
344
|
</dl>
|
|
283
345
|
</details>
|
|
284
346
|
|
|
285
|
-
|
|
347
|
+
## Agents
|
|
348
|
+
|
|
349
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentsSearchResponse</code></summary>
|
|
286
350
|
<dl>
|
|
287
351
|
<dd>
|
|
288
352
|
|
|
@@ -294,8 +358,11 @@ await client.agents.search({});
|
|
|
294
358
|
<dl>
|
|
295
359
|
<dd>
|
|
296
360
|
|
|
297
|
-
|
|
361
|
+
Search for agents across all organizations.
|
|
298
362
|
|
|
363
|
+
<Tip>
|
|
364
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
365
|
+
</Tip>
|
|
299
366
|
</dd>
|
|
300
367
|
</dl>
|
|
301
368
|
</dd>
|
|
@@ -310,7 +377,7 @@ Lists all agents for an organization
|
|
|
310
377
|
<dd>
|
|
311
378
|
|
|
312
379
|
```typescript
|
|
313
|
-
await client.agents.
|
|
380
|
+
await client.agents.search({});
|
|
314
381
|
```
|
|
315
382
|
|
|
316
383
|
</dd>
|
|
@@ -326,7 +393,7 @@ await client.agents.list("organizationReferenceId");
|
|
|
326
393
|
<dl>
|
|
327
394
|
<dd>
|
|
328
395
|
|
|
329
|
-
**
|
|
396
|
+
**request:** `MavenAGI.AgentsSearchRequest`
|
|
330
397
|
|
|
331
398
|
</dd>
|
|
332
399
|
</dl>
|
|
@@ -345,7 +412,7 @@ await client.agents.list("organizationReferenceId");
|
|
|
345
412
|
</dl>
|
|
346
413
|
</details>
|
|
347
414
|
|
|
348
|
-
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">
|
|
415
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">list</a>(organizationReferenceId) -> MavenAGI.Agent[]</code></summary>
|
|
349
416
|
<dl>
|
|
350
417
|
<dd>
|
|
351
418
|
|
|
@@ -357,7 +424,7 @@ await client.agents.list("organizationReferenceId");
|
|
|
357
424
|
<dl>
|
|
358
425
|
<dd>
|
|
359
426
|
|
|
360
|
-
|
|
427
|
+
Lists all agents for an organization
|
|
361
428
|
|
|
362
429
|
</dd>
|
|
363
430
|
</dl>
|
|
@@ -373,7 +440,7 @@ Get an agent
|
|
|
373
440
|
<dd>
|
|
374
441
|
|
|
375
442
|
```typescript
|
|
376
|
-
await client.agents.
|
|
443
|
+
await client.agents.list("organizationReferenceId");
|
|
377
444
|
```
|
|
378
445
|
|
|
379
446
|
</dd>
|
|
@@ -397,14 +464,6 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
397
464
|
<dl>
|
|
398
465
|
<dd>
|
|
399
466
|
|
|
400
|
-
**agentReferenceId:** `string` — The ID of the agent.
|
|
401
|
-
|
|
402
|
-
</dd>
|
|
403
|
-
</dl>
|
|
404
|
-
|
|
405
|
-
<dl>
|
|
406
|
-
<dd>
|
|
407
|
-
|
|
408
467
|
**requestOptions:** `Agents.RequestOptions`
|
|
409
468
|
|
|
410
469
|
</dd>
|
|
@@ -416,9 +475,7 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
416
475
|
</dl>
|
|
417
476
|
</details>
|
|
418
477
|
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
|
|
478
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">create</a>(organizationReferenceId, agentReferenceId, { ...params }) -> MavenAGI.Agent</code></summary>
|
|
422
479
|
<dl>
|
|
423
480
|
<dd>
|
|
424
481
|
|
|
@@ -430,8 +487,11 @@ await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
|
430
487
|
<dl>
|
|
431
488
|
<dd>
|
|
432
489
|
|
|
433
|
-
|
|
490
|
+
Create a new agent
|
|
434
491
|
|
|
492
|
+
<Tip>
|
|
493
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
494
|
+
</Tip>
|
|
435
495
|
</dd>
|
|
436
496
|
</dl>
|
|
437
497
|
</dd>
|
|
@@ -446,39 +506,9 @@ Retrieves structured conversation data formatted as a table, allowing users to g
|
|
|
446
506
|
<dd>
|
|
447
507
|
|
|
448
508
|
```typescript
|
|
449
|
-
await client.
|
|
450
|
-
|
|
451
|
-
|
|
452
|
-
},
|
|
453
|
-
timeGrouping: "DAY",
|
|
454
|
-
fieldGroupings: [
|
|
455
|
-
{
|
|
456
|
-
field: "Category",
|
|
457
|
-
},
|
|
458
|
-
],
|
|
459
|
-
columnDefinitions: [
|
|
460
|
-
{
|
|
461
|
-
header: "count",
|
|
462
|
-
metric: {
|
|
463
|
-
type: "count",
|
|
464
|
-
},
|
|
465
|
-
},
|
|
466
|
-
{
|
|
467
|
-
header: "avg_first_response_time",
|
|
468
|
-
metric: {
|
|
469
|
-
type: "average",
|
|
470
|
-
targetField: "FirstResponseTime",
|
|
471
|
-
},
|
|
472
|
-
},
|
|
473
|
-
{
|
|
474
|
-
header: "percentile_handle_time",
|
|
475
|
-
metric: {
|
|
476
|
-
type: "percentile",
|
|
477
|
-
targetField: "HandleTime",
|
|
478
|
-
percentile: 25,
|
|
479
|
-
},
|
|
480
|
-
},
|
|
481
|
-
],
|
|
509
|
+
await client.agents.create("organizationReferenceId", "agentReferenceId", {
|
|
510
|
+
name: "name",
|
|
511
|
+
environment: "DEMO",
|
|
482
512
|
});
|
|
483
513
|
```
|
|
484
514
|
|
|
@@ -495,7 +525,7 @@ await client.analytics.getConversationTable({
|
|
|
495
525
|
<dl>
|
|
496
526
|
<dd>
|
|
497
527
|
|
|
498
|
-
**
|
|
528
|
+
**organizationReferenceId:** `string` — The ID of the organization.
|
|
499
529
|
|
|
500
530
|
</dd>
|
|
501
531
|
</dl>
|
|
@@ -503,7 +533,23 @@ await client.analytics.getConversationTable({
|
|
|
503
533
|
<dl>
|
|
504
534
|
<dd>
|
|
505
535
|
|
|
506
|
-
**
|
|
536
|
+
**agentReferenceId:** `string` — The ID of the agent.
|
|
537
|
+
|
|
538
|
+
</dd>
|
|
539
|
+
</dl>
|
|
540
|
+
|
|
541
|
+
<dl>
|
|
542
|
+
<dd>
|
|
543
|
+
|
|
544
|
+
**request:** `MavenAGI.CreateAgentRequest`
|
|
545
|
+
|
|
546
|
+
</dd>
|
|
547
|
+
</dl>
|
|
548
|
+
|
|
549
|
+
<dl>
|
|
550
|
+
<dd>
|
|
551
|
+
|
|
552
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
507
553
|
|
|
508
554
|
</dd>
|
|
509
555
|
</dl>
|
|
@@ -514,7 +560,7 @@ await client.analytics.getConversationTable({
|
|
|
514
560
|
</dl>
|
|
515
561
|
</details>
|
|
516
562
|
|
|
517
|
-
<details><summary><code>client.
|
|
563
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">get</a>(organizationReferenceId, agentReferenceId) -> MavenAGI.Agent</code></summary>
|
|
518
564
|
<dl>
|
|
519
565
|
<dd>
|
|
520
566
|
|
|
@@ -526,7 +572,7 @@ await client.analytics.getConversationTable({
|
|
|
526
572
|
<dl>
|
|
527
573
|
<dd>
|
|
528
574
|
|
|
529
|
-
|
|
575
|
+
Get an agent
|
|
530
576
|
|
|
531
577
|
</dd>
|
|
532
578
|
</dl>
|
|
@@ -542,18 +588,7 @@ Fetches conversation data visualized in a chart format. Supported chart types in
|
|
|
542
588
|
<dd>
|
|
543
589
|
|
|
544
590
|
```typescript
|
|
545
|
-
await client.
|
|
546
|
-
type: "pieChart",
|
|
547
|
-
conversationFilter: {
|
|
548
|
-
languages: ["en", "es"],
|
|
549
|
-
},
|
|
550
|
-
groupBy: {
|
|
551
|
-
field: "Category",
|
|
552
|
-
},
|
|
553
|
-
metric: {
|
|
554
|
-
type: "count",
|
|
555
|
-
},
|
|
556
|
-
});
|
|
591
|
+
await client.agents.get("organizationReferenceId", "agentReferenceId");
|
|
557
592
|
```
|
|
558
593
|
|
|
559
594
|
</dd>
|
|
@@ -569,7 +604,7 @@ await client.analytics.getConversationChart({
|
|
|
569
604
|
<dl>
|
|
570
605
|
<dd>
|
|
571
606
|
|
|
572
|
-
**
|
|
607
|
+
**organizationReferenceId:** `string` — The ID of the organization.
|
|
573
608
|
|
|
574
609
|
</dd>
|
|
575
610
|
</dl>
|
|
@@ -577,7 +612,15 @@ await client.analytics.getConversationChart({
|
|
|
577
612
|
<dl>
|
|
578
613
|
<dd>
|
|
579
614
|
|
|
580
|
-
**
|
|
615
|
+
**agentReferenceId:** `string` — The ID of the agent.
|
|
616
|
+
|
|
617
|
+
</dd>
|
|
618
|
+
</dl>
|
|
619
|
+
|
|
620
|
+
<dl>
|
|
621
|
+
<dd>
|
|
622
|
+
|
|
623
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
581
624
|
|
|
582
625
|
</dd>
|
|
583
626
|
</dl>
|
|
@@ -588,7 +631,7 @@ await client.analytics.getConversationChart({
|
|
|
588
631
|
</dl>
|
|
589
632
|
</details>
|
|
590
633
|
|
|
591
|
-
<details><summary><code>client.
|
|
634
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">patch</a>(organizationReferenceId, agentReferenceId, { ...params }) -> MavenAGI.Agent</code></summary>
|
|
592
635
|
<dl>
|
|
593
636
|
<dd>
|
|
594
637
|
|
|
@@ -600,8 +643,12 @@ await client.analytics.getConversationChart({
|
|
|
600
643
|
<dl>
|
|
601
644
|
<dd>
|
|
602
645
|
|
|
603
|
-
|
|
646
|
+
Update mutable agent fields
|
|
647
|
+
All fields will overwrite the existing value on the agent only if provided.
|
|
604
648
|
|
|
649
|
+
<Tip>
|
|
650
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
651
|
+
</Tip>
|
|
605
652
|
</dd>
|
|
606
653
|
</dl>
|
|
607
654
|
</dd>
|
|
@@ -616,24 +663,7 @@ Retrieves structured feedback data formatted as a table, allowing users to group
|
|
|
616
663
|
<dd>
|
|
617
664
|
|
|
618
665
|
```typescript
|
|
619
|
-
await client.
|
|
620
|
-
feedbackFilter: {
|
|
621
|
-
types: ["THUMBS_UP", "INSERT"],
|
|
622
|
-
},
|
|
623
|
-
fieldGroupings: [
|
|
624
|
-
{
|
|
625
|
-
field: "CreatedBy",
|
|
626
|
-
},
|
|
627
|
-
],
|
|
628
|
-
columnDefinitions: [
|
|
629
|
-
{
|
|
630
|
-
header: "feedback_count",
|
|
631
|
-
metric: {
|
|
632
|
-
type: "count",
|
|
633
|
-
},
|
|
634
|
-
},
|
|
635
|
-
],
|
|
636
|
-
});
|
|
666
|
+
await client.agents.patch("organizationReferenceId", "agentReferenceId", {});
|
|
637
667
|
```
|
|
638
668
|
|
|
639
669
|
</dd>
|
|
@@ -649,7 +679,7 @@ await client.analytics.getFeedbackTable({
|
|
|
649
679
|
<dl>
|
|
650
680
|
<dd>
|
|
651
681
|
|
|
652
|
-
**
|
|
682
|
+
**organizationReferenceId:** `string` — The ID of the organization.
|
|
653
683
|
|
|
654
684
|
</dd>
|
|
655
685
|
</dl>
|
|
@@ -657,7 +687,23 @@ await client.analytics.getFeedbackTable({
|
|
|
657
687
|
<dl>
|
|
658
688
|
<dd>
|
|
659
689
|
|
|
660
|
-
**
|
|
690
|
+
**agentReferenceId:** `string` — The ID of the agent.
|
|
691
|
+
|
|
692
|
+
</dd>
|
|
693
|
+
</dl>
|
|
694
|
+
|
|
695
|
+
<dl>
|
|
696
|
+
<dd>
|
|
697
|
+
|
|
698
|
+
**request:** `MavenAGI.AgentPatchRequest`
|
|
699
|
+
|
|
700
|
+
</dd>
|
|
701
|
+
</dl>
|
|
702
|
+
|
|
703
|
+
<dl>
|
|
704
|
+
<dd>
|
|
705
|
+
|
|
706
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
661
707
|
|
|
662
708
|
</dd>
|
|
663
709
|
</dl>
|
|
@@ -668,9 +714,7 @@ await client.analytics.getFeedbackTable({
|
|
|
668
714
|
</dl>
|
|
669
715
|
</details>
|
|
670
716
|
|
|
671
|
-
|
|
672
|
-
|
|
673
|
-
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
|
|
717
|
+
<details><summary><code>client.agents.<a href="/src/api/resources/agents/client/Client.ts">delete</a>(organizationReferenceId, agentReferenceId) -> void</code></summary>
|
|
674
718
|
<dl>
|
|
675
719
|
<dd>
|
|
676
720
|
|
|
@@ -682,12 +726,11 @@ await client.analytics.getFeedbackTable({
|
|
|
682
726
|
<dl>
|
|
683
727
|
<dd>
|
|
684
728
|
|
|
685
|
-
|
|
686
|
-
|
|
687
|
-
You can set the `$index` key using the Update app settings API.
|
|
688
|
-
|
|
689
|
-
<Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
|
|
729
|
+
Delete an agent.
|
|
690
730
|
|
|
731
|
+
<Tip>
|
|
732
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
733
|
+
</Tip>
|
|
691
734
|
</dd>
|
|
692
735
|
</dl>
|
|
693
736
|
</dd>
|
|
@@ -702,9 +745,7 @@ You can set the `$index` key using the Update app settings API.
|
|
|
702
745
|
<dd>
|
|
703
746
|
|
|
704
747
|
```typescript
|
|
705
|
-
await client.
|
|
706
|
-
index: "index",
|
|
707
|
-
});
|
|
748
|
+
await client.agents.delete("organizationReferenceId", "agentReferenceId");
|
|
708
749
|
```
|
|
709
750
|
|
|
710
751
|
</dd>
|
|
@@ -720,7 +761,7 @@ await client.appSettings.search({
|
|
|
720
761
|
<dl>
|
|
721
762
|
<dd>
|
|
722
763
|
|
|
723
|
-
**
|
|
764
|
+
**organizationReferenceId:** `string` — The ID of the organization.
|
|
724
765
|
|
|
725
766
|
</dd>
|
|
726
767
|
</dl>
|
|
@@ -728,10 +769,18 @@ await client.appSettings.search({
|
|
|
728
769
|
<dl>
|
|
729
770
|
<dd>
|
|
730
771
|
|
|
731
|
-
**
|
|
772
|
+
**agentReferenceId:** `string` — The ID of the agent.
|
|
732
773
|
|
|
733
|
-
</dd>
|
|
734
|
-
</dl>
|
|
774
|
+
</dd>
|
|
775
|
+
</dl>
|
|
776
|
+
|
|
777
|
+
<dl>
|
|
778
|
+
<dd>
|
|
779
|
+
|
|
780
|
+
**requestOptions:** `Agents.RequestOptions`
|
|
781
|
+
|
|
782
|
+
</dd>
|
|
783
|
+
</dl>
|
|
735
784
|
</dd>
|
|
736
785
|
</dl>
|
|
737
786
|
|
|
@@ -739,7 +788,9 @@ await client.appSettings.search({
|
|
|
739
788
|
</dl>
|
|
740
789
|
</details>
|
|
741
790
|
|
|
742
|
-
|
|
791
|
+
## Analytics
|
|
792
|
+
|
|
793
|
+
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
|
|
743
794
|
<dl>
|
|
744
795
|
<dd>
|
|
745
796
|
|
|
@@ -751,7 +802,7 @@ await client.appSettings.search({
|
|
|
751
802
|
<dl>
|
|
752
803
|
<dd>
|
|
753
804
|
|
|
754
|
-
|
|
805
|
+
Retrieves structured conversation data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
755
806
|
|
|
756
807
|
</dd>
|
|
757
808
|
</dl>
|
|
@@ -767,7 +818,40 @@ Get app settings set during installation
|
|
|
767
818
|
<dd>
|
|
768
819
|
|
|
769
820
|
```typescript
|
|
770
|
-
await client.
|
|
821
|
+
await client.analytics.getConversationTable({
|
|
822
|
+
conversationFilter: {
|
|
823
|
+
languages: ["en", "es"],
|
|
824
|
+
},
|
|
825
|
+
timeGrouping: "DAY",
|
|
826
|
+
fieldGroupings: [
|
|
827
|
+
{
|
|
828
|
+
field: "Category",
|
|
829
|
+
},
|
|
830
|
+
],
|
|
831
|
+
columnDefinitions: [
|
|
832
|
+
{
|
|
833
|
+
header: "count",
|
|
834
|
+
metric: {
|
|
835
|
+
type: "count",
|
|
836
|
+
},
|
|
837
|
+
},
|
|
838
|
+
{
|
|
839
|
+
header: "avg_first_response_time",
|
|
840
|
+
metric: {
|
|
841
|
+
type: "average",
|
|
842
|
+
targetField: "FirstResponseTime",
|
|
843
|
+
},
|
|
844
|
+
},
|
|
845
|
+
{
|
|
846
|
+
header: "percentile_handle_time",
|
|
847
|
+
metric: {
|
|
848
|
+
type: "percentile",
|
|
849
|
+
targetField: "HandleTime",
|
|
850
|
+
percentile: 25,
|
|
851
|
+
},
|
|
852
|
+
},
|
|
853
|
+
],
|
|
854
|
+
});
|
|
771
855
|
```
|
|
772
856
|
|
|
773
857
|
</dd>
|
|
@@ -783,7 +867,15 @@ await client.appSettings.get();
|
|
|
783
867
|
<dl>
|
|
784
868
|
<dd>
|
|
785
869
|
|
|
786
|
-
**
|
|
870
|
+
**request:** `MavenAGI.ConversationTableRequest`
|
|
871
|
+
|
|
872
|
+
</dd>
|
|
873
|
+
</dl>
|
|
874
|
+
|
|
875
|
+
<dl>
|
|
876
|
+
<dd>
|
|
877
|
+
|
|
878
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
787
879
|
|
|
788
880
|
</dd>
|
|
789
881
|
</dl>
|
|
@@ -794,7 +886,7 @@ await client.appSettings.get();
|
|
|
794
886
|
</dl>
|
|
795
887
|
</details>
|
|
796
888
|
|
|
797
|
-
<details><summary><code>client.
|
|
889
|
+
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
|
|
798
890
|
<dl>
|
|
799
891
|
<dd>
|
|
800
892
|
|
|
@@ -806,13 +898,7 @@ await client.appSettings.get();
|
|
|
806
898
|
<dl>
|
|
807
899
|
<dd>
|
|
808
900
|
|
|
809
|
-
|
|
810
|
-
|
|
811
|
-
- If a new key is provided, it will be added to the app settings.
|
|
812
|
-
- If an existing key is provided, it will be updated.
|
|
813
|
-
- No keys will be removed.
|
|
814
|
-
|
|
815
|
-
Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
|
|
901
|
+
Fetches conversation data visualized in a chart format. Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
816
902
|
|
|
817
903
|
</dd>
|
|
818
904
|
</dl>
|
|
@@ -828,9 +914,16 @@ Note that if an array value is provided it will fully replace an existing value
|
|
|
828
914
|
<dd>
|
|
829
915
|
|
|
830
916
|
```typescript
|
|
831
|
-
await client.
|
|
832
|
-
|
|
833
|
-
|
|
917
|
+
await client.analytics.getConversationChart({
|
|
918
|
+
type: "pieChart",
|
|
919
|
+
conversationFilter: {
|
|
920
|
+
languages: ["en", "es"],
|
|
921
|
+
},
|
|
922
|
+
groupBy: {
|
|
923
|
+
field: "Category",
|
|
924
|
+
},
|
|
925
|
+
metric: {
|
|
926
|
+
type: "count",
|
|
834
927
|
},
|
|
835
928
|
});
|
|
836
929
|
```
|
|
@@ -848,7 +941,7 @@ await client.appSettings.update({
|
|
|
848
941
|
<dl>
|
|
849
942
|
<dd>
|
|
850
943
|
|
|
851
|
-
**request:** `
|
|
944
|
+
**request:** `MavenAGI.ConversationChartRequest`
|
|
852
945
|
|
|
853
946
|
</dd>
|
|
854
947
|
</dl>
|
|
@@ -856,7 +949,7 @@ await client.appSettings.update({
|
|
|
856
949
|
<dl>
|
|
857
950
|
<dd>
|
|
858
951
|
|
|
859
|
-
**requestOptions:** `
|
|
952
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
860
953
|
|
|
861
954
|
</dd>
|
|
862
955
|
</dl>
|
|
@@ -867,9 +960,7 @@ await client.appSettings.update({
|
|
|
867
960
|
</dl>
|
|
868
961
|
</details>
|
|
869
962
|
|
|
870
|
-
|
|
871
|
-
|
|
872
|
-
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
963
|
+
<details><summary><code>client.analytics.<a href="/src/api/resources/analytics/client/Client.ts">getFeedbackTable</a>({ ...params }) -> MavenAGI.FeedbackTableResponse</code></summary>
|
|
873
964
|
<dl>
|
|
874
965
|
<dd>
|
|
875
966
|
|
|
@@ -881,19 +972,12 @@ await client.appSettings.update({
|
|
|
881
972
|
<dl>
|
|
882
973
|
<dd>
|
|
883
974
|
|
|
884
|
-
|
|
885
|
-
Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
|
|
886
|
-
|
|
887
|
-
Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
|
|
888
|
-
|
|
889
|
-
After initialization,
|
|
975
|
+
Retrieves structured feedback data formatted as a table, allowing users to group, filter, and define specific metrics to display as columns.
|
|
890
976
|
|
|
891
|
-
|
|
892
|
-
|
|
893
|
-
|
|
894
|
-
|
|
895
|
-
</dd>
|
|
896
|
-
</dl>
|
|
977
|
+
</dd>
|
|
978
|
+
</dl>
|
|
979
|
+
</dd>
|
|
980
|
+
</dl>
|
|
897
981
|
|
|
898
982
|
#### 🔌 Usage
|
|
899
983
|
|
|
@@ -904,29 +988,20 @@ After initialization,
|
|
|
904
988
|
<dd>
|
|
905
989
|
|
|
906
990
|
```typescript
|
|
907
|
-
await client.
|
|
908
|
-
|
|
909
|
-
|
|
991
|
+
await client.analytics.getFeedbackTable({
|
|
992
|
+
feedbackFilter: {
|
|
993
|
+
types: ["THUMBS_UP", "INSERT"],
|
|
910
994
|
},
|
|
911
|
-
|
|
995
|
+
fieldGroupings: [
|
|
912
996
|
{
|
|
913
|
-
|
|
914
|
-
referenceId: "referenceId",
|
|
915
|
-
},
|
|
916
|
-
text: "text",
|
|
917
|
-
userMessageType: "USER",
|
|
918
|
-
conversationMessageId: {
|
|
919
|
-
referenceId: "referenceId",
|
|
920
|
-
},
|
|
997
|
+
field: "CreatedBy",
|
|
921
998
|
},
|
|
999
|
+
],
|
|
1000
|
+
columnDefinitions: [
|
|
922
1001
|
{
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
text: "text",
|
|
927
|
-
userMessageType: "USER",
|
|
928
|
-
conversationMessageId: {
|
|
929
|
-
referenceId: "referenceId",
|
|
1002
|
+
header: "feedback_count",
|
|
1003
|
+
metric: {
|
|
1004
|
+
type: "count",
|
|
930
1005
|
},
|
|
931
1006
|
},
|
|
932
1007
|
],
|
|
@@ -946,7 +1021,7 @@ await client.conversation.initialize({
|
|
|
946
1021
|
<dl>
|
|
947
1022
|
<dd>
|
|
948
1023
|
|
|
949
|
-
**request:** `MavenAGI.
|
|
1024
|
+
**request:** `MavenAGI.FeedbackTableRequest`
|
|
950
1025
|
|
|
951
1026
|
</dd>
|
|
952
1027
|
</dl>
|
|
@@ -954,7 +1029,7 @@ await client.conversation.initialize({
|
|
|
954
1029
|
<dl>
|
|
955
1030
|
<dd>
|
|
956
1031
|
|
|
957
|
-
**requestOptions:** `
|
|
1032
|
+
**requestOptions:** `Analytics.RequestOptions`
|
|
958
1033
|
|
|
959
1034
|
</dd>
|
|
960
1035
|
</dl>
|
|
@@ -965,7 +1040,9 @@ await client.conversation.initialize({
|
|
|
965
1040
|
</dl>
|
|
966
1041
|
</details>
|
|
967
1042
|
|
|
968
|
-
|
|
1043
|
+
## AppSettings
|
|
1044
|
+
|
|
1045
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SearchAppSettingsResponse</code></summary>
|
|
969
1046
|
<dl>
|
|
970
1047
|
<dd>
|
|
971
1048
|
|
|
@@ -977,7 +1054,11 @@ await client.conversation.initialize({
|
|
|
977
1054
|
<dl>
|
|
978
1055
|
<dd>
|
|
979
1056
|
|
|
980
|
-
|
|
1057
|
+
Search for app settings which have the `$index` key set to the provided value.
|
|
1058
|
+
|
|
1059
|
+
You can set the `$index` key using the Update app settings API.
|
|
1060
|
+
|
|
1061
|
+
<Warning>This API currently requires an organization ID and agent ID for any agent which is installed on the app. This requirement will be removed in a future update.</Warning>
|
|
981
1062
|
|
|
982
1063
|
</dd>
|
|
983
1064
|
</dl>
|
|
@@ -993,7 +1074,9 @@ Get a conversation
|
|
|
993
1074
|
<dd>
|
|
994
1075
|
|
|
995
1076
|
```typescript
|
|
996
|
-
await client.
|
|
1077
|
+
await client.appSettings.search({
|
|
1078
|
+
index: "index",
|
|
1079
|
+
});
|
|
997
1080
|
```
|
|
998
1081
|
|
|
999
1082
|
</dd>
|
|
@@ -1009,15 +1092,7 @@ await client.conversation.get("conversationId");
|
|
|
1009
1092
|
<dl>
|
|
1010
1093
|
<dd>
|
|
1011
1094
|
|
|
1012
|
-
**
|
|
1013
|
-
|
|
1014
|
-
</dd>
|
|
1015
|
-
</dl>
|
|
1016
|
-
|
|
1017
|
-
<dl>
|
|
1018
|
-
<dd>
|
|
1019
|
-
|
|
1020
|
-
**request:** `MavenAGI.ConversationGetRequest`
|
|
1095
|
+
**request:** `MavenAGI.SearchAppSettingsRequest`
|
|
1021
1096
|
|
|
1022
1097
|
</dd>
|
|
1023
1098
|
</dl>
|
|
@@ -1025,7 +1100,7 @@ await client.conversation.get("conversationId");
|
|
|
1025
1100
|
<dl>
|
|
1026
1101
|
<dd>
|
|
1027
1102
|
|
|
1028
|
-
**requestOptions:** `
|
|
1103
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1029
1104
|
|
|
1030
1105
|
</dd>
|
|
1031
1106
|
</dl>
|
|
@@ -1036,7 +1111,7 @@ await client.conversation.get("conversationId");
|
|
|
1036
1111
|
</dl>
|
|
1037
1112
|
</details>
|
|
1038
1113
|
|
|
1039
|
-
<details><summary><code>client.
|
|
1114
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">get</a>() -> Record<string, unknown></code></summary>
|
|
1040
1115
|
<dl>
|
|
1041
1116
|
<dd>
|
|
1042
1117
|
|
|
@@ -1048,13 +1123,7 @@ await client.conversation.get("conversationId");
|
|
|
1048
1123
|
<dl>
|
|
1049
1124
|
<dd>
|
|
1050
1125
|
|
|
1051
|
-
|
|
1052
|
-
The conversation ID will still exist and non-user specific data will still be retained.
|
|
1053
|
-
Attempts to modify or add messages to the conversation will throw an error.
|
|
1054
|
-
|
|
1055
|
-
<Warning>This is a destructive operation and cannot be undone. <br/><br/>
|
|
1056
|
-
The exact fields cleared include: the conversation subject, userRequest, agentResponse.
|
|
1057
|
-
As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
|
|
1126
|
+
Get app settings set during installation
|
|
1058
1127
|
|
|
1059
1128
|
</dd>
|
|
1060
1129
|
</dl>
|
|
@@ -1070,9 +1139,7 @@ As well as the text response, followup questions, and backend LLM prompt of all
|
|
|
1070
1139
|
<dd>
|
|
1071
1140
|
|
|
1072
1141
|
```typescript
|
|
1073
|
-
await client.
|
|
1074
|
-
reason: "GDPR deletion request 1234.",
|
|
1075
|
-
});
|
|
1142
|
+
await client.appSettings.get();
|
|
1076
1143
|
```
|
|
1077
1144
|
|
|
1078
1145
|
</dd>
|
|
@@ -1088,23 +1155,7 @@ await client.conversation.delete("conversation-0", {
|
|
|
1088
1155
|
<dl>
|
|
1089
1156
|
<dd>
|
|
1090
1157
|
|
|
1091
|
-
**
|
|
1092
|
-
|
|
1093
|
-
</dd>
|
|
1094
|
-
</dl>
|
|
1095
|
-
|
|
1096
|
-
<dl>
|
|
1097
|
-
<dd>
|
|
1098
|
-
|
|
1099
|
-
**request:** `MavenAGI.ConversationDeleteRequest`
|
|
1100
|
-
|
|
1101
|
-
</dd>
|
|
1102
|
-
</dl>
|
|
1103
|
-
|
|
1104
|
-
<dl>
|
|
1105
|
-
<dd>
|
|
1106
|
-
|
|
1107
|
-
**requestOptions:** `Conversation.RequestOptions`
|
|
1158
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1108
1159
|
|
|
1109
1160
|
</dd>
|
|
1110
1161
|
</dl>
|
|
@@ -1115,7 +1166,7 @@ await client.conversation.delete("conversation-0", {
|
|
|
1115
1166
|
</dl>
|
|
1116
1167
|
</details>
|
|
1117
1168
|
|
|
1118
|
-
<details><summary><code>client.
|
|
1169
|
+
<details><summary><code>client.appSettings.<a href="/src/api/resources/appSettings/client/Client.ts">update</a>({ ...params }) -> Record<string, unknown></code></summary>
|
|
1119
1170
|
<dl>
|
|
1120
1171
|
<dd>
|
|
1121
1172
|
|
|
@@ -1127,7 +1178,13 @@ await client.conversation.delete("conversation-0", {
|
|
|
1127
1178
|
<dl>
|
|
1128
1179
|
<dd>
|
|
1129
1180
|
|
|
1130
|
-
|
|
1181
|
+
Update app settings. Performs a merge of the provided settings with the existing app settings.
|
|
1182
|
+
|
|
1183
|
+
- If a new key is provided, it will be added to the app settings.
|
|
1184
|
+
- If an existing key is provided, it will be updated.
|
|
1185
|
+
- No keys will be removed.
|
|
1186
|
+
|
|
1187
|
+
Note that if an array value is provided it will fully replace an existing value as arrays cannot be merged.
|
|
1131
1188
|
|
|
1132
1189
|
</dd>
|
|
1133
1190
|
</dl>
|
|
@@ -1143,28 +1200,11 @@ Append messages to an existing conversation. The conversation must be initialize
|
|
|
1143
1200
|
<dd>
|
|
1144
1201
|
|
|
1145
1202
|
```typescript
|
|
1146
|
-
await client.
|
|
1147
|
-
{
|
|
1148
|
-
|
|
1149
|
-
referenceId: "referenceId",
|
|
1150
|
-
},
|
|
1151
|
-
text: "text",
|
|
1152
|
-
userMessageType: "USER",
|
|
1153
|
-
conversationMessageId: {
|
|
1154
|
-
referenceId: "referenceId",
|
|
1155
|
-
},
|
|
1156
|
-
},
|
|
1157
|
-
{
|
|
1158
|
-
userId: {
|
|
1159
|
-
referenceId: "referenceId",
|
|
1160
|
-
},
|
|
1161
|
-
text: "text",
|
|
1162
|
-
userMessageType: "USER",
|
|
1163
|
-
conversationMessageId: {
|
|
1164
|
-
referenceId: "referenceId",
|
|
1165
|
-
},
|
|
1203
|
+
await client.appSettings.update({
|
|
1204
|
+
string: {
|
|
1205
|
+
key: "value",
|
|
1166
1206
|
},
|
|
1167
|
-
|
|
1207
|
+
});
|
|
1168
1208
|
```
|
|
1169
1209
|
|
|
1170
1210
|
</dd>
|
|
@@ -1180,15 +1220,7 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1180
1220
|
<dl>
|
|
1181
1221
|
<dd>
|
|
1182
1222
|
|
|
1183
|
-
**
|
|
1184
|
-
|
|
1185
|
-
</dd>
|
|
1186
|
-
</dl>
|
|
1187
|
-
|
|
1188
|
-
<dl>
|
|
1189
|
-
<dd>
|
|
1190
|
-
|
|
1191
|
-
**request:** `MavenAGI.ConversationMessageRequest[]`
|
|
1223
|
+
**request:** `Record<string, unknown>`
|
|
1192
1224
|
|
|
1193
1225
|
</dd>
|
|
1194
1226
|
</dl>
|
|
@@ -1196,7 +1228,7 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1196
1228
|
<dl>
|
|
1197
1229
|
<dd>
|
|
1198
1230
|
|
|
1199
|
-
**requestOptions:** `
|
|
1231
|
+
**requestOptions:** `AppSettings.RequestOptions`
|
|
1200
1232
|
|
|
1201
1233
|
</dd>
|
|
1202
1234
|
</dl>
|
|
@@ -1207,7 +1239,9 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1207
1239
|
</dl>
|
|
1208
1240
|
</details>
|
|
1209
1241
|
|
|
1210
|
-
|
|
1242
|
+
## Assets
|
|
1243
|
+
|
|
1244
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">initiateUpload</a>({ ...params }) -> MavenAGI.InitiateAssetUploadResponse</code></summary>
|
|
1211
1245
|
<dl>
|
|
1212
1246
|
<dd>
|
|
1213
1247
|
|
|
@@ -1219,21 +1253,1168 @@ await client.conversation.appendNewMessages("conversationId", [
|
|
|
1219
1253
|
<dl>
|
|
1220
1254
|
<dd>
|
|
1221
1255
|
|
|
1222
|
-
|
|
1223
|
-
|
|
1256
|
+
Initiate an upload.
|
|
1257
|
+
Returns a pre-signed URL for direct file upload and an asset ID for subsequent operations.
|
|
1224
1258
|
|
|
1225
|
-
|
|
1259
|
+
</dd>
|
|
1260
|
+
</dl>
|
|
1261
|
+
</dd>
|
|
1262
|
+
</dl>
|
|
1263
|
+
|
|
1264
|
+
#### 🔌 Usage
|
|
1265
|
+
|
|
1266
|
+
<dl>
|
|
1267
|
+
<dd>
|
|
1268
|
+
|
|
1269
|
+
<dl>
|
|
1270
|
+
<dd>
|
|
1271
|
+
|
|
1272
|
+
```typescript
|
|
1273
|
+
await client.assets.initiateUpload({
|
|
1274
|
+
type: "type",
|
|
1275
|
+
});
|
|
1276
|
+
```
|
|
1277
|
+
|
|
1278
|
+
</dd>
|
|
1279
|
+
</dl>
|
|
1280
|
+
</dd>
|
|
1281
|
+
</dl>
|
|
1282
|
+
|
|
1283
|
+
#### ⚙️ Parameters
|
|
1284
|
+
|
|
1285
|
+
<dl>
|
|
1286
|
+
<dd>
|
|
1287
|
+
|
|
1288
|
+
<dl>
|
|
1289
|
+
<dd>
|
|
1290
|
+
|
|
1291
|
+
**request:** `MavenAGI.InitiateAssetUploadRequest`
|
|
1292
|
+
|
|
1293
|
+
</dd>
|
|
1294
|
+
</dl>
|
|
1295
|
+
|
|
1296
|
+
<dl>
|
|
1297
|
+
<dd>
|
|
1298
|
+
|
|
1299
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
1300
|
+
|
|
1301
|
+
</dd>
|
|
1302
|
+
</dl>
|
|
1303
|
+
</dd>
|
|
1304
|
+
</dl>
|
|
1305
|
+
|
|
1306
|
+
</dd>
|
|
1307
|
+
</dl>
|
|
1308
|
+
</details>
|
|
1309
|
+
|
|
1310
|
+
<details><summary><code>client.assets.<a href="/src/api/resources/assets/client/Client.ts">commitUpload</a>(assetReferenceId, { ...params }) -> void</code></summary>
|
|
1311
|
+
<dl>
|
|
1312
|
+
<dd>
|
|
1313
|
+
|
|
1314
|
+
#### 📝 Description
|
|
1315
|
+
|
|
1316
|
+
<dl>
|
|
1317
|
+
<dd>
|
|
1318
|
+
|
|
1319
|
+
<dl>
|
|
1320
|
+
<dd>
|
|
1321
|
+
|
|
1322
|
+
Commit an upload after successful file transfer.
|
|
1323
|
+
Updates the asset status and makes it available for use.
|
|
1324
|
+
|
|
1325
|
+
</dd>
|
|
1326
|
+
</dl>
|
|
1327
|
+
</dd>
|
|
1328
|
+
</dl>
|
|
1329
|
+
|
|
1330
|
+
#### 🔌 Usage
|
|
1331
|
+
|
|
1332
|
+
<dl>
|
|
1333
|
+
<dd>
|
|
1334
|
+
|
|
1335
|
+
<dl>
|
|
1336
|
+
<dd>
|
|
1337
|
+
|
|
1338
|
+
```typescript
|
|
1339
|
+
await client.assets.commitUpload("assetReferenceId", {});
|
|
1340
|
+
```
|
|
1341
|
+
|
|
1342
|
+
</dd>
|
|
1343
|
+
</dl>
|
|
1344
|
+
</dd>
|
|
1345
|
+
</dl>
|
|
1346
|
+
|
|
1347
|
+
#### ⚙️ Parameters
|
|
1348
|
+
|
|
1349
|
+
<dl>
|
|
1350
|
+
<dd>
|
|
1351
|
+
|
|
1352
|
+
<dl>
|
|
1353
|
+
<dd>
|
|
1354
|
+
|
|
1355
|
+
**assetReferenceId:** `string` — The reference ID of the asset to commit (provided by the initiate call). All other entity ID fields are inferred from the API request.
|
|
1356
|
+
|
|
1357
|
+
</dd>
|
|
1358
|
+
</dl>
|
|
1359
|
+
|
|
1360
|
+
<dl>
|
|
1361
|
+
<dd>
|
|
1362
|
+
|
|
1363
|
+
**request:** `MavenAGI.CommitAssetUploadRequest`
|
|
1364
|
+
|
|
1365
|
+
</dd>
|
|
1366
|
+
</dl>
|
|
1367
|
+
|
|
1368
|
+
<dl>
|
|
1369
|
+
<dd>
|
|
1370
|
+
|
|
1371
|
+
**requestOptions:** `Assets.RequestOptions`
|
|
1372
|
+
|
|
1373
|
+
</dd>
|
|
1374
|
+
</dl>
|
|
1375
|
+
</dd>
|
|
1376
|
+
</dl>
|
|
1377
|
+
|
|
1378
|
+
</dd>
|
|
1379
|
+
</dl>
|
|
1380
|
+
</details>
|
|
1381
|
+
|
|
1382
|
+
## Conversation
|
|
1383
|
+
|
|
1384
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">initialize</a>({ ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1385
|
+
<dl>
|
|
1386
|
+
<dd>
|
|
1387
|
+
|
|
1388
|
+
#### 📝 Description
|
|
1389
|
+
|
|
1390
|
+
<dl>
|
|
1391
|
+
<dd>
|
|
1392
|
+
|
|
1393
|
+
<dl>
|
|
1394
|
+
<dd>
|
|
1395
|
+
|
|
1396
|
+
Initialize a new conversation.
|
|
1397
|
+
Only required if the ask request wishes to supply conversation level data or when syncing to external systems.
|
|
1398
|
+
|
|
1399
|
+
Conversations can not be modified using this API. If the conversation already exists then the existing conversation will be returned.
|
|
1400
|
+
|
|
1401
|
+
After initialization,
|
|
1402
|
+
|
|
1403
|
+
- metadata can be changed using the `updateConversationMetadata` API.
|
|
1404
|
+
- messages can be added to the conversation with the `appendNewMessages` or `ask` APIs.
|
|
1405
|
+
</dd>
|
|
1406
|
+
</dl>
|
|
1407
|
+
</dd>
|
|
1408
|
+
</dl>
|
|
1409
|
+
|
|
1410
|
+
#### 🔌 Usage
|
|
1411
|
+
|
|
1412
|
+
<dl>
|
|
1413
|
+
<dd>
|
|
1414
|
+
|
|
1415
|
+
<dl>
|
|
1416
|
+
<dd>
|
|
1417
|
+
|
|
1418
|
+
```typescript
|
|
1419
|
+
await client.conversation.initialize({
|
|
1420
|
+
conversationId: {
|
|
1421
|
+
referenceId: "referenceId",
|
|
1422
|
+
},
|
|
1423
|
+
messages: [
|
|
1424
|
+
{
|
|
1425
|
+
conversationMessageId: {
|
|
1426
|
+
referenceId: "referenceId",
|
|
1427
|
+
},
|
|
1428
|
+
userId: {
|
|
1429
|
+
referenceId: "referenceId",
|
|
1430
|
+
},
|
|
1431
|
+
text: "text",
|
|
1432
|
+
userMessageType: "USER",
|
|
1433
|
+
},
|
|
1434
|
+
{
|
|
1435
|
+
conversationMessageId: {
|
|
1436
|
+
referenceId: "referenceId",
|
|
1437
|
+
},
|
|
1438
|
+
userId: {
|
|
1439
|
+
referenceId: "referenceId",
|
|
1440
|
+
},
|
|
1441
|
+
text: "text",
|
|
1442
|
+
userMessageType: "USER",
|
|
1443
|
+
},
|
|
1444
|
+
],
|
|
1445
|
+
});
|
|
1446
|
+
```
|
|
1447
|
+
|
|
1448
|
+
</dd>
|
|
1449
|
+
</dl>
|
|
1450
|
+
</dd>
|
|
1451
|
+
</dl>
|
|
1452
|
+
|
|
1453
|
+
#### ⚙️ Parameters
|
|
1454
|
+
|
|
1455
|
+
<dl>
|
|
1456
|
+
<dd>
|
|
1457
|
+
|
|
1458
|
+
<dl>
|
|
1459
|
+
<dd>
|
|
1460
|
+
|
|
1461
|
+
**request:** `MavenAGI.ConversationRequest`
|
|
1462
|
+
|
|
1463
|
+
</dd>
|
|
1464
|
+
</dl>
|
|
1465
|
+
|
|
1466
|
+
<dl>
|
|
1467
|
+
<dd>
|
|
1468
|
+
|
|
1469
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1470
|
+
|
|
1471
|
+
</dd>
|
|
1472
|
+
</dl>
|
|
1473
|
+
</dd>
|
|
1474
|
+
</dl>
|
|
1475
|
+
|
|
1476
|
+
</dd>
|
|
1477
|
+
</dl>
|
|
1478
|
+
</details>
|
|
1479
|
+
|
|
1480
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">patch</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1481
|
+
<dl>
|
|
1482
|
+
<dd>
|
|
1483
|
+
|
|
1484
|
+
#### 📝 Description
|
|
1485
|
+
|
|
1486
|
+
<dl>
|
|
1487
|
+
<dd>
|
|
1488
|
+
|
|
1489
|
+
<dl>
|
|
1490
|
+
<dd>
|
|
1491
|
+
|
|
1492
|
+
Update mutable conversation fields.
|
|
1493
|
+
|
|
1494
|
+
The `appId` field can be provided to update a conversation owned by a different app.
|
|
1495
|
+
All other fields will overwrite the existing value on the conversation only if provided.
|
|
1496
|
+
|
|
1497
|
+
</dd>
|
|
1498
|
+
</dl>
|
|
1499
|
+
</dd>
|
|
1500
|
+
</dl>
|
|
1501
|
+
|
|
1502
|
+
#### 🔌 Usage
|
|
1503
|
+
|
|
1504
|
+
<dl>
|
|
1505
|
+
<dd>
|
|
1506
|
+
|
|
1507
|
+
<dl>
|
|
1508
|
+
<dd>
|
|
1509
|
+
|
|
1510
|
+
```typescript
|
|
1511
|
+
await client.conversation.patch("conversation-0", {
|
|
1512
|
+
llmEnabled: true,
|
|
1513
|
+
});
|
|
1514
|
+
```
|
|
1515
|
+
|
|
1516
|
+
</dd>
|
|
1517
|
+
</dl>
|
|
1518
|
+
</dd>
|
|
1519
|
+
</dl>
|
|
1520
|
+
|
|
1521
|
+
#### ⚙️ Parameters
|
|
1522
|
+
|
|
1523
|
+
<dl>
|
|
1524
|
+
<dd>
|
|
1525
|
+
|
|
1526
|
+
<dl>
|
|
1527
|
+
<dd>
|
|
1528
|
+
|
|
1529
|
+
**conversationId:** `string` — The ID of the conversation to patch
|
|
1530
|
+
|
|
1531
|
+
</dd>
|
|
1532
|
+
</dl>
|
|
1533
|
+
|
|
1534
|
+
<dl>
|
|
1535
|
+
<dd>
|
|
1536
|
+
|
|
1537
|
+
**request:** `MavenAGI.ConversationPatchRequest`
|
|
1538
|
+
|
|
1539
|
+
</dd>
|
|
1540
|
+
</dl>
|
|
1541
|
+
|
|
1542
|
+
<dl>
|
|
1543
|
+
<dd>
|
|
1544
|
+
|
|
1545
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1546
|
+
|
|
1547
|
+
</dd>
|
|
1548
|
+
</dl>
|
|
1549
|
+
</dd>
|
|
1550
|
+
</dl>
|
|
1551
|
+
|
|
1552
|
+
</dd>
|
|
1553
|
+
</dl>
|
|
1554
|
+
</details>
|
|
1555
|
+
|
|
1556
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">get</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1557
|
+
<dl>
|
|
1558
|
+
<dd>
|
|
1559
|
+
|
|
1560
|
+
#### 📝 Description
|
|
1561
|
+
|
|
1562
|
+
<dl>
|
|
1563
|
+
<dd>
|
|
1564
|
+
|
|
1565
|
+
<dl>
|
|
1566
|
+
<dd>
|
|
1567
|
+
|
|
1568
|
+
Get a conversation
|
|
1569
|
+
|
|
1570
|
+
</dd>
|
|
1571
|
+
</dl>
|
|
1572
|
+
</dd>
|
|
1573
|
+
</dl>
|
|
1574
|
+
|
|
1575
|
+
#### 🔌 Usage
|
|
1576
|
+
|
|
1577
|
+
<dl>
|
|
1578
|
+
<dd>
|
|
1579
|
+
|
|
1580
|
+
<dl>
|
|
1581
|
+
<dd>
|
|
1582
|
+
|
|
1583
|
+
```typescript
|
|
1584
|
+
await client.conversation.get("conversationId");
|
|
1585
|
+
```
|
|
1586
|
+
|
|
1587
|
+
</dd>
|
|
1588
|
+
</dl>
|
|
1589
|
+
</dd>
|
|
1590
|
+
</dl>
|
|
1591
|
+
|
|
1592
|
+
#### ⚙️ Parameters
|
|
1593
|
+
|
|
1594
|
+
<dl>
|
|
1595
|
+
<dd>
|
|
1596
|
+
|
|
1597
|
+
<dl>
|
|
1598
|
+
<dd>
|
|
1599
|
+
|
|
1600
|
+
**conversationId:** `string` — The ID of the conversation to get
|
|
1601
|
+
|
|
1602
|
+
</dd>
|
|
1603
|
+
</dl>
|
|
1604
|
+
|
|
1605
|
+
<dl>
|
|
1606
|
+
<dd>
|
|
1607
|
+
|
|
1608
|
+
**request:** `MavenAGI.ConversationGetRequest`
|
|
1609
|
+
|
|
1610
|
+
</dd>
|
|
1611
|
+
</dl>
|
|
1612
|
+
|
|
1613
|
+
<dl>
|
|
1614
|
+
<dd>
|
|
1615
|
+
|
|
1616
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1617
|
+
|
|
1618
|
+
</dd>
|
|
1619
|
+
</dl>
|
|
1620
|
+
</dd>
|
|
1621
|
+
</dl>
|
|
1622
|
+
|
|
1623
|
+
</dd>
|
|
1624
|
+
</dl>
|
|
1625
|
+
</details>
|
|
1626
|
+
|
|
1627
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">delete</a>(conversationId, { ...params }) -> void</code></summary>
|
|
1628
|
+
<dl>
|
|
1629
|
+
<dd>
|
|
1630
|
+
|
|
1631
|
+
#### 📝 Description
|
|
1632
|
+
|
|
1633
|
+
<dl>
|
|
1634
|
+
<dd>
|
|
1635
|
+
|
|
1636
|
+
<dl>
|
|
1637
|
+
<dd>
|
|
1638
|
+
|
|
1639
|
+
Wipes a conversation of all user data.
|
|
1640
|
+
The conversation ID will still exist and non-user specific data will still be retained.
|
|
1641
|
+
Attempts to modify or add messages to the conversation will throw an error.
|
|
1642
|
+
|
|
1643
|
+
<Warning>This is a destructive operation and cannot be undone. <br/><br/>
|
|
1644
|
+
The exact fields cleared include: the conversation subject, userRequest, agentResponse.
|
|
1645
|
+
As well as the text response, followup questions, and backend LLM prompt of all messages.</Warning>
|
|
1646
|
+
|
|
1647
|
+
</dd>
|
|
1648
|
+
</dl>
|
|
1649
|
+
</dd>
|
|
1650
|
+
</dl>
|
|
1651
|
+
|
|
1652
|
+
#### 🔌 Usage
|
|
1653
|
+
|
|
1654
|
+
<dl>
|
|
1655
|
+
<dd>
|
|
1656
|
+
|
|
1657
|
+
<dl>
|
|
1658
|
+
<dd>
|
|
1659
|
+
|
|
1660
|
+
```typescript
|
|
1661
|
+
await client.conversation.delete("conversation-0", {
|
|
1662
|
+
reason: "GDPR deletion request 1234.",
|
|
1663
|
+
});
|
|
1664
|
+
```
|
|
1665
|
+
|
|
1666
|
+
</dd>
|
|
1667
|
+
</dl>
|
|
1668
|
+
</dd>
|
|
1669
|
+
</dl>
|
|
1670
|
+
|
|
1671
|
+
#### ⚙️ Parameters
|
|
1672
|
+
|
|
1673
|
+
<dl>
|
|
1674
|
+
<dd>
|
|
1675
|
+
|
|
1676
|
+
<dl>
|
|
1677
|
+
<dd>
|
|
1678
|
+
|
|
1679
|
+
**conversationId:** `string` — The ID of the conversation to delete
|
|
1680
|
+
|
|
1681
|
+
</dd>
|
|
1682
|
+
</dl>
|
|
1683
|
+
|
|
1684
|
+
<dl>
|
|
1685
|
+
<dd>
|
|
1686
|
+
|
|
1687
|
+
**request:** `MavenAGI.ConversationDeleteRequest`
|
|
1688
|
+
|
|
1689
|
+
</dd>
|
|
1690
|
+
</dl>
|
|
1691
|
+
|
|
1692
|
+
<dl>
|
|
1693
|
+
<dd>
|
|
1694
|
+
|
|
1695
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1696
|
+
|
|
1697
|
+
</dd>
|
|
1698
|
+
</dl>
|
|
1699
|
+
</dd>
|
|
1700
|
+
</dl>
|
|
1701
|
+
|
|
1702
|
+
</dd>
|
|
1703
|
+
</dl>
|
|
1704
|
+
</details>
|
|
1705
|
+
|
|
1706
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">appendNewMessages</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1707
|
+
<dl>
|
|
1708
|
+
<dd>
|
|
1709
|
+
|
|
1710
|
+
#### 📝 Description
|
|
1711
|
+
|
|
1712
|
+
<dl>
|
|
1713
|
+
<dd>
|
|
1714
|
+
|
|
1715
|
+
<dl>
|
|
1716
|
+
<dd>
|
|
1717
|
+
|
|
1718
|
+
Append messages to an existing conversation. The conversation must be initialized first. If a message with the same ID already exists, it will be ignored. Messages do not allow modification.
|
|
1719
|
+
|
|
1720
|
+
</dd>
|
|
1721
|
+
</dl>
|
|
1722
|
+
</dd>
|
|
1723
|
+
</dl>
|
|
1724
|
+
|
|
1725
|
+
#### 🔌 Usage
|
|
1726
|
+
|
|
1727
|
+
<dl>
|
|
1728
|
+
<dd>
|
|
1729
|
+
|
|
1730
|
+
<dl>
|
|
1731
|
+
<dd>
|
|
1732
|
+
|
|
1733
|
+
```typescript
|
|
1734
|
+
await client.conversation.appendNewMessages("conversationId", [
|
|
1735
|
+
{
|
|
1736
|
+
conversationMessageId: {
|
|
1737
|
+
referenceId: "referenceId",
|
|
1738
|
+
},
|
|
1739
|
+
userId: {
|
|
1740
|
+
referenceId: "referenceId",
|
|
1741
|
+
},
|
|
1742
|
+
text: "text",
|
|
1743
|
+
userMessageType: "USER",
|
|
1744
|
+
},
|
|
1745
|
+
{
|
|
1746
|
+
conversationMessageId: {
|
|
1747
|
+
referenceId: "referenceId",
|
|
1748
|
+
},
|
|
1749
|
+
userId: {
|
|
1750
|
+
referenceId: "referenceId",
|
|
1751
|
+
},
|
|
1752
|
+
text: "text",
|
|
1753
|
+
userMessageType: "USER",
|
|
1754
|
+
},
|
|
1755
|
+
]);
|
|
1756
|
+
```
|
|
1757
|
+
|
|
1758
|
+
</dd>
|
|
1759
|
+
</dl>
|
|
1760
|
+
</dd>
|
|
1761
|
+
</dl>
|
|
1762
|
+
|
|
1763
|
+
#### ⚙️ Parameters
|
|
1764
|
+
|
|
1765
|
+
<dl>
|
|
1766
|
+
<dd>
|
|
1767
|
+
|
|
1768
|
+
<dl>
|
|
1769
|
+
<dd>
|
|
1770
|
+
|
|
1771
|
+
**conversationId:** `string` — The ID of the conversation to append messages to
|
|
1772
|
+
|
|
1773
|
+
</dd>
|
|
1774
|
+
</dl>
|
|
1775
|
+
|
|
1776
|
+
<dl>
|
|
1777
|
+
<dd>
|
|
1778
|
+
|
|
1779
|
+
**request:** `MavenAGI.ConversationMessageRequest[]`
|
|
1780
|
+
|
|
1781
|
+
</dd>
|
|
1782
|
+
</dl>
|
|
1783
|
+
|
|
1784
|
+
<dl>
|
|
1785
|
+
<dd>
|
|
1786
|
+
|
|
1787
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1788
|
+
|
|
1789
|
+
</dd>
|
|
1790
|
+
</dl>
|
|
1791
|
+
</dd>
|
|
1792
|
+
</dl>
|
|
1793
|
+
|
|
1794
|
+
</dd>
|
|
1795
|
+
</dl>
|
|
1796
|
+
</details>
|
|
1797
|
+
|
|
1798
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">ask</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
1799
|
+
<dl>
|
|
1800
|
+
<dd>
|
|
1801
|
+
|
|
1802
|
+
#### 📝 Description
|
|
1803
|
+
|
|
1804
|
+
<dl>
|
|
1805
|
+
<dd>
|
|
1806
|
+
|
|
1807
|
+
<dl>
|
|
1808
|
+
<dd>
|
|
1809
|
+
|
|
1810
|
+
Get an answer from Maven for a given user question. If the user question or its answer already exists,
|
|
1811
|
+
they will be reused and will not be updated. Messages do not allow modification once generated.
|
|
1812
|
+
|
|
1813
|
+
Concurrency Behavior:
|
|
1814
|
+
|
|
1815
|
+
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
1816
|
+
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
1817
|
+
|
|
1818
|
+
Known Limitation:
|
|
1819
|
+
|
|
1820
|
+
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
1821
|
+
</dd>
|
|
1822
|
+
</dl>
|
|
1823
|
+
</dd>
|
|
1824
|
+
</dl>
|
|
1825
|
+
|
|
1826
|
+
#### 🔌 Usage
|
|
1827
|
+
|
|
1828
|
+
<dl>
|
|
1829
|
+
<dd>
|
|
1830
|
+
|
|
1831
|
+
<dl>
|
|
1832
|
+
<dd>
|
|
1833
|
+
|
|
1834
|
+
```typescript
|
|
1835
|
+
await client.conversation.ask("conversation-0", {
|
|
1836
|
+
conversationMessageId: {
|
|
1837
|
+
referenceId: "message-0",
|
|
1838
|
+
},
|
|
1839
|
+
userId: {
|
|
1840
|
+
referenceId: "user-0",
|
|
1841
|
+
},
|
|
1842
|
+
text: "How do I reset my password?",
|
|
1843
|
+
attachments: [
|
|
1844
|
+
{
|
|
1845
|
+
type: "image/png",
|
|
1846
|
+
content: "iVBORw0KGgo...",
|
|
1847
|
+
},
|
|
1848
|
+
],
|
|
1849
|
+
transientData: {
|
|
1850
|
+
userToken: "abcdef123",
|
|
1851
|
+
queryApiKey: "foobar456",
|
|
1852
|
+
},
|
|
1853
|
+
timezone: "America/New_York",
|
|
1854
|
+
});
|
|
1855
|
+
```
|
|
1856
|
+
|
|
1857
|
+
</dd>
|
|
1858
|
+
</dl>
|
|
1859
|
+
</dd>
|
|
1860
|
+
</dl>
|
|
1861
|
+
|
|
1862
|
+
#### ⚙️ Parameters
|
|
1863
|
+
|
|
1864
|
+
<dl>
|
|
1865
|
+
<dd>
|
|
1866
|
+
|
|
1867
|
+
<dl>
|
|
1868
|
+
<dd>
|
|
1869
|
+
|
|
1870
|
+
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
|
|
1871
|
+
|
|
1872
|
+
</dd>
|
|
1873
|
+
</dl>
|
|
1874
|
+
|
|
1875
|
+
<dl>
|
|
1876
|
+
<dd>
|
|
1877
|
+
|
|
1878
|
+
**request:** `MavenAGI.AskRequest`
|
|
1879
|
+
|
|
1880
|
+
</dd>
|
|
1881
|
+
</dl>
|
|
1882
|
+
|
|
1883
|
+
<dl>
|
|
1884
|
+
<dd>
|
|
1885
|
+
|
|
1886
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1887
|
+
|
|
1888
|
+
</dd>
|
|
1889
|
+
</dl>
|
|
1890
|
+
</dd>
|
|
1891
|
+
</dl>
|
|
1892
|
+
|
|
1893
|
+
</dd>
|
|
1894
|
+
</dl>
|
|
1895
|
+
</details>
|
|
1896
|
+
|
|
1897
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.StreamResponse></code></summary>
|
|
1898
|
+
<dl>
|
|
1899
|
+
<dd>
|
|
1900
|
+
|
|
1901
|
+
#### 📝 Description
|
|
1902
|
+
|
|
1903
|
+
<dl>
|
|
1904
|
+
<dd>
|
|
1905
|
+
|
|
1906
|
+
<dl>
|
|
1907
|
+
<dd>
|
|
1908
|
+
|
|
1909
|
+
Get an answer from Maven for a given user question with a streaming response. The response will be sent as a stream of events.
|
|
1910
|
+
The text portions of stream responses should be concatenated to form the full response text.
|
|
1911
|
+
Action and metadata events should overwrite past data and do not need concatenation.
|
|
1912
|
+
|
|
1913
|
+
If the user question or its answer already exists, they will be reused and will not be updated.
|
|
1914
|
+
Messages do not allow modification once generated.
|
|
1915
|
+
|
|
1916
|
+
Concurrency Behavior:
|
|
1917
|
+
|
|
1918
|
+
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
1919
|
+
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
1920
|
+
|
|
1921
|
+
Known Limitation:
|
|
1922
|
+
|
|
1923
|
+
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
1924
|
+
</dd>
|
|
1925
|
+
</dl>
|
|
1926
|
+
</dd>
|
|
1927
|
+
</dl>
|
|
1928
|
+
|
|
1929
|
+
#### 🔌 Usage
|
|
1930
|
+
|
|
1931
|
+
<dl>
|
|
1932
|
+
<dd>
|
|
1933
|
+
|
|
1934
|
+
<dl>
|
|
1935
|
+
<dd>
|
|
1936
|
+
|
|
1937
|
+
```typescript
|
|
1938
|
+
const response = await client.conversation.askStream("conversation-0", {
|
|
1939
|
+
conversationMessageId: {
|
|
1940
|
+
referenceId: "message-0",
|
|
1941
|
+
},
|
|
1942
|
+
userId: {
|
|
1943
|
+
referenceId: "user-0",
|
|
1944
|
+
},
|
|
1945
|
+
text: "How do I reset my password?",
|
|
1946
|
+
attachments: [
|
|
1947
|
+
{
|
|
1948
|
+
type: "image/png",
|
|
1949
|
+
content: "iVBORw0KGgo...",
|
|
1950
|
+
},
|
|
1951
|
+
],
|
|
1952
|
+
transientData: {
|
|
1953
|
+
userToken: "abcdef123",
|
|
1954
|
+
queryApiKey: "foobar456",
|
|
1955
|
+
},
|
|
1956
|
+
timezone: "America/New_York",
|
|
1957
|
+
});
|
|
1958
|
+
for await (const item of response) {
|
|
1959
|
+
console.log(item);
|
|
1960
|
+
}
|
|
1961
|
+
```
|
|
1962
|
+
|
|
1963
|
+
</dd>
|
|
1964
|
+
</dl>
|
|
1965
|
+
</dd>
|
|
1966
|
+
</dl>
|
|
1967
|
+
|
|
1968
|
+
#### ⚙️ Parameters
|
|
1969
|
+
|
|
1970
|
+
<dl>
|
|
1971
|
+
<dd>
|
|
1972
|
+
|
|
1973
|
+
<dl>
|
|
1974
|
+
<dd>
|
|
1975
|
+
|
|
1976
|
+
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the question
|
|
1977
|
+
|
|
1978
|
+
</dd>
|
|
1979
|
+
</dl>
|
|
1980
|
+
|
|
1981
|
+
<dl>
|
|
1982
|
+
<dd>
|
|
1983
|
+
|
|
1984
|
+
**request:** `MavenAGI.AskRequest`
|
|
1985
|
+
|
|
1986
|
+
</dd>
|
|
1987
|
+
</dl>
|
|
1988
|
+
|
|
1989
|
+
<dl>
|
|
1990
|
+
<dd>
|
|
1991
|
+
|
|
1992
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
1993
|
+
|
|
1994
|
+
</dd>
|
|
1995
|
+
</dl>
|
|
1996
|
+
</dd>
|
|
1997
|
+
</dl>
|
|
1998
|
+
|
|
1999
|
+
</dd>
|
|
2000
|
+
</dl>
|
|
2001
|
+
</details>
|
|
2002
|
+
|
|
2003
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">generateMavenSuggestions</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
2004
|
+
<dl>
|
|
2005
|
+
<dd>
|
|
2006
|
+
|
|
2007
|
+
#### 📝 Description
|
|
2008
|
+
|
|
2009
|
+
<dl>
|
|
2010
|
+
<dd>
|
|
2011
|
+
|
|
2012
|
+
<dl>
|
|
2013
|
+
<dd>
|
|
2014
|
+
|
|
2015
|
+
This method is deprecated and will be removed in a future release. Use either `ask` or `askStream` instead.
|
|
2016
|
+
|
|
2017
|
+
</dd>
|
|
2018
|
+
</dl>
|
|
2019
|
+
</dd>
|
|
2020
|
+
</dl>
|
|
2021
|
+
|
|
2022
|
+
#### 🔌 Usage
|
|
2023
|
+
|
|
2024
|
+
<dl>
|
|
2025
|
+
<dd>
|
|
2026
|
+
|
|
2027
|
+
<dl>
|
|
2028
|
+
<dd>
|
|
2029
|
+
|
|
2030
|
+
```typescript
|
|
2031
|
+
await client.conversation.generateMavenSuggestions("conversationId", {
|
|
2032
|
+
conversationMessageIds: [
|
|
2033
|
+
{
|
|
2034
|
+
referenceId: "referenceId",
|
|
2035
|
+
},
|
|
2036
|
+
{
|
|
2037
|
+
referenceId: "referenceId",
|
|
2038
|
+
},
|
|
2039
|
+
],
|
|
2040
|
+
});
|
|
2041
|
+
```
|
|
2042
|
+
|
|
2043
|
+
</dd>
|
|
2044
|
+
</dl>
|
|
2045
|
+
</dd>
|
|
2046
|
+
</dl>
|
|
2047
|
+
|
|
2048
|
+
#### ⚙️ Parameters
|
|
2049
|
+
|
|
2050
|
+
<dl>
|
|
2051
|
+
<dd>
|
|
2052
|
+
|
|
2053
|
+
<dl>
|
|
2054
|
+
<dd>
|
|
2055
|
+
|
|
2056
|
+
**conversationId:** `string` — The ID of a conversation the messages belong to
|
|
2057
|
+
|
|
2058
|
+
</dd>
|
|
2059
|
+
</dl>
|
|
2060
|
+
|
|
2061
|
+
<dl>
|
|
2062
|
+
<dd>
|
|
2063
|
+
|
|
2064
|
+
**request:** `MavenAGI.GenerateMavenSuggestionsRequest`
|
|
2065
|
+
|
|
2066
|
+
</dd>
|
|
2067
|
+
</dl>
|
|
2068
|
+
|
|
2069
|
+
<dl>
|
|
2070
|
+
<dd>
|
|
2071
|
+
|
|
2072
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2073
|
+
|
|
2074
|
+
</dd>
|
|
2075
|
+
</dl>
|
|
2076
|
+
</dd>
|
|
2077
|
+
</dl>
|
|
2078
|
+
|
|
2079
|
+
</dd>
|
|
2080
|
+
</dl>
|
|
2081
|
+
</details>
|
|
2082
|
+
|
|
2083
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">askObjectStream</a>(conversationId, { ...params }) -> core.Stream<MavenAGI.ObjectStreamResponse></code></summary>
|
|
2084
|
+
<dl>
|
|
2085
|
+
<dd>
|
|
2086
|
+
|
|
2087
|
+
#### 📝 Description
|
|
2088
|
+
|
|
2089
|
+
<dl>
|
|
2090
|
+
<dd>
|
|
2091
|
+
|
|
2092
|
+
<dl>
|
|
2093
|
+
<dd>
|
|
2094
|
+
|
|
2095
|
+
Generate a structured object response based on a provided schema and user prompt with a streaming response.
|
|
2096
|
+
The response will be sent as a stream of events containing text, start, and end events.
|
|
2097
|
+
The text portions of stream responses should be concatenated to form the full response text.
|
|
2098
|
+
|
|
2099
|
+
If the user question and object response already exist, they will be reused and not updated.
|
|
2100
|
+
|
|
2101
|
+
Concurrency Behavior:
|
|
1226
2102
|
|
|
1227
2103
|
- If another API call is made for the same user question while a response is mid-stream, partial answers may be returned.
|
|
1228
2104
|
- The second caller will receive a truncated or partial response depending on where the first stream is in its processing. The first caller's stream will remain unaffected and continue delivering the full response.
|
|
1229
2105
|
|
|
1230
|
-
Known
|
|
2106
|
+
Known Limitations:
|
|
2107
|
+
|
|
2108
|
+
- Schema enforcement is best-effort and may not guarantee exact conformity.
|
|
2109
|
+
- The API does not currently expose metadata indicating whether a response or message is incomplete. This will be addressed in a future update.
|
|
2110
|
+
</dd>
|
|
2111
|
+
</dl>
|
|
2112
|
+
</dd>
|
|
2113
|
+
</dl>
|
|
2114
|
+
|
|
2115
|
+
#### 🔌 Usage
|
|
2116
|
+
|
|
2117
|
+
<dl>
|
|
2118
|
+
<dd>
|
|
2119
|
+
|
|
2120
|
+
<dl>
|
|
2121
|
+
<dd>
|
|
2122
|
+
|
|
2123
|
+
```typescript
|
|
2124
|
+
const response = await client.conversation.askObjectStream("conversationId", {
|
|
2125
|
+
schema: "schema",
|
|
2126
|
+
conversationMessageId: {
|
|
2127
|
+
referenceId: "referenceId",
|
|
2128
|
+
},
|
|
2129
|
+
userId: {
|
|
2130
|
+
referenceId: "referenceId",
|
|
2131
|
+
},
|
|
2132
|
+
text: "text",
|
|
2133
|
+
});
|
|
2134
|
+
for await (const item of response) {
|
|
2135
|
+
console.log(item);
|
|
2136
|
+
}
|
|
2137
|
+
```
|
|
2138
|
+
|
|
2139
|
+
</dd>
|
|
2140
|
+
</dl>
|
|
2141
|
+
</dd>
|
|
2142
|
+
</dl>
|
|
2143
|
+
|
|
2144
|
+
#### ⚙️ Parameters
|
|
2145
|
+
|
|
2146
|
+
<dl>
|
|
2147
|
+
<dd>
|
|
2148
|
+
|
|
2149
|
+
<dl>
|
|
2150
|
+
<dd>
|
|
2151
|
+
|
|
2152
|
+
**conversationId:** `string` — The ID of a new or existing conversation to use as context for the object generation request
|
|
2153
|
+
|
|
2154
|
+
</dd>
|
|
2155
|
+
</dl>
|
|
2156
|
+
|
|
2157
|
+
<dl>
|
|
2158
|
+
<dd>
|
|
2159
|
+
|
|
2160
|
+
**request:** `MavenAGI.AskObjectRequest`
|
|
2161
|
+
|
|
2162
|
+
</dd>
|
|
2163
|
+
</dl>
|
|
2164
|
+
|
|
2165
|
+
<dl>
|
|
2166
|
+
<dd>
|
|
2167
|
+
|
|
2168
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2169
|
+
|
|
2170
|
+
</dd>
|
|
2171
|
+
</dl>
|
|
2172
|
+
</dd>
|
|
2173
|
+
</dl>
|
|
2174
|
+
|
|
2175
|
+
</dd>
|
|
2176
|
+
</dl>
|
|
2177
|
+
</details>
|
|
2178
|
+
|
|
2179
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">categorize</a>(conversationId) -> MavenAGI.CategorizationResponse</code></summary>
|
|
2180
|
+
<dl>
|
|
2181
|
+
<dd>
|
|
2182
|
+
|
|
2183
|
+
#### 📝 Description
|
|
2184
|
+
|
|
2185
|
+
<dl>
|
|
2186
|
+
<dd>
|
|
2187
|
+
|
|
2188
|
+
<dl>
|
|
2189
|
+
<dd>
|
|
2190
|
+
|
|
2191
|
+
Uses an LLM flow to categorize the conversation. Experimental.
|
|
2192
|
+
|
|
2193
|
+
</dd>
|
|
2194
|
+
</dl>
|
|
2195
|
+
</dd>
|
|
2196
|
+
</dl>
|
|
2197
|
+
|
|
2198
|
+
#### 🔌 Usage
|
|
2199
|
+
|
|
2200
|
+
<dl>
|
|
2201
|
+
<dd>
|
|
2202
|
+
|
|
2203
|
+
<dl>
|
|
2204
|
+
<dd>
|
|
2205
|
+
|
|
2206
|
+
```typescript
|
|
2207
|
+
await client.conversation.categorize("conversationId");
|
|
2208
|
+
```
|
|
2209
|
+
|
|
2210
|
+
</dd>
|
|
2211
|
+
</dl>
|
|
2212
|
+
</dd>
|
|
2213
|
+
</dl>
|
|
2214
|
+
|
|
2215
|
+
#### ⚙️ Parameters
|
|
2216
|
+
|
|
2217
|
+
<dl>
|
|
2218
|
+
<dd>
|
|
2219
|
+
|
|
2220
|
+
<dl>
|
|
2221
|
+
<dd>
|
|
2222
|
+
|
|
2223
|
+
**conversationId:** `string` — The ID of the conversation to categorize
|
|
2224
|
+
|
|
2225
|
+
</dd>
|
|
2226
|
+
</dl>
|
|
2227
|
+
|
|
2228
|
+
<dl>
|
|
2229
|
+
<dd>
|
|
2230
|
+
|
|
2231
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2232
|
+
|
|
2233
|
+
</dd>
|
|
2234
|
+
</dl>
|
|
2235
|
+
</dd>
|
|
2236
|
+
</dl>
|
|
2237
|
+
|
|
2238
|
+
</dd>
|
|
2239
|
+
</dl>
|
|
2240
|
+
</details>
|
|
2241
|
+
|
|
2242
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">createFeedback</a>({ ...params }) -> MavenAGI.Feedback</code></summary>
|
|
2243
|
+
<dl>
|
|
2244
|
+
<dd>
|
|
2245
|
+
|
|
2246
|
+
#### 📝 Description
|
|
2247
|
+
|
|
2248
|
+
<dl>
|
|
2249
|
+
<dd>
|
|
2250
|
+
|
|
2251
|
+
<dl>
|
|
2252
|
+
<dd>
|
|
2253
|
+
|
|
2254
|
+
Update feedback or create it if it doesn't exist
|
|
2255
|
+
|
|
2256
|
+
</dd>
|
|
2257
|
+
</dl>
|
|
2258
|
+
</dd>
|
|
2259
|
+
</dl>
|
|
2260
|
+
|
|
2261
|
+
#### 🔌 Usage
|
|
2262
|
+
|
|
2263
|
+
<dl>
|
|
2264
|
+
<dd>
|
|
2265
|
+
|
|
2266
|
+
<dl>
|
|
2267
|
+
<dd>
|
|
2268
|
+
|
|
2269
|
+
```typescript
|
|
2270
|
+
await client.conversation.createFeedback({
|
|
2271
|
+
feedbackId: {
|
|
2272
|
+
referenceId: "feedback-0",
|
|
2273
|
+
},
|
|
2274
|
+
userId: {
|
|
2275
|
+
referenceId: "user-0",
|
|
2276
|
+
},
|
|
2277
|
+
conversationId: {
|
|
2278
|
+
referenceId: "conversation-0",
|
|
2279
|
+
},
|
|
2280
|
+
conversationMessageId: {
|
|
2281
|
+
referenceId: "message-1",
|
|
2282
|
+
},
|
|
2283
|
+
type: "THUMBS_UP",
|
|
2284
|
+
text: "Great answer!",
|
|
2285
|
+
});
|
|
2286
|
+
```
|
|
2287
|
+
|
|
2288
|
+
</dd>
|
|
2289
|
+
</dl>
|
|
2290
|
+
</dd>
|
|
2291
|
+
</dl>
|
|
2292
|
+
|
|
2293
|
+
#### ⚙️ Parameters
|
|
2294
|
+
|
|
2295
|
+
<dl>
|
|
2296
|
+
<dd>
|
|
2297
|
+
|
|
2298
|
+
<dl>
|
|
2299
|
+
<dd>
|
|
2300
|
+
|
|
2301
|
+
**request:** `MavenAGI.FeedbackRequest`
|
|
2302
|
+
|
|
2303
|
+
</dd>
|
|
2304
|
+
</dl>
|
|
2305
|
+
|
|
2306
|
+
<dl>
|
|
2307
|
+
<dd>
|
|
2308
|
+
|
|
2309
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2310
|
+
|
|
2311
|
+
</dd>
|
|
2312
|
+
</dl>
|
|
2313
|
+
</dd>
|
|
2314
|
+
</dl>
|
|
2315
|
+
|
|
2316
|
+
</dd>
|
|
2317
|
+
</dl>
|
|
2318
|
+
</details>
|
|
2319
|
+
|
|
2320
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">submitActionForm</a>(conversationId, { ...params }) -> MavenAGI.ConversationResponse</code></summary>
|
|
2321
|
+
<dl>
|
|
2322
|
+
<dd>
|
|
2323
|
+
|
|
2324
|
+
#### 📝 Description
|
|
2325
|
+
|
|
2326
|
+
<dl>
|
|
2327
|
+
<dd>
|
|
2328
|
+
|
|
2329
|
+
<dl>
|
|
2330
|
+
<dd>
|
|
2331
|
+
|
|
2332
|
+
Submit a filled out action form
|
|
2333
|
+
|
|
2334
|
+
</dd>
|
|
2335
|
+
</dl>
|
|
2336
|
+
</dd>
|
|
2337
|
+
</dl>
|
|
2338
|
+
|
|
2339
|
+
#### 🔌 Usage
|
|
2340
|
+
|
|
2341
|
+
<dl>
|
|
2342
|
+
<dd>
|
|
2343
|
+
|
|
2344
|
+
<dl>
|
|
2345
|
+
<dd>
|
|
2346
|
+
|
|
2347
|
+
```typescript
|
|
2348
|
+
await client.conversation.submitActionForm("conversationId", {
|
|
2349
|
+
actionFormId: "actionFormId",
|
|
2350
|
+
parameters: {
|
|
2351
|
+
parameters: {
|
|
2352
|
+
key: "value",
|
|
2353
|
+
},
|
|
2354
|
+
},
|
|
2355
|
+
});
|
|
2356
|
+
```
|
|
2357
|
+
|
|
2358
|
+
</dd>
|
|
2359
|
+
</dl>
|
|
2360
|
+
</dd>
|
|
2361
|
+
</dl>
|
|
2362
|
+
|
|
2363
|
+
#### ⚙️ Parameters
|
|
2364
|
+
|
|
2365
|
+
<dl>
|
|
2366
|
+
<dd>
|
|
2367
|
+
|
|
2368
|
+
<dl>
|
|
2369
|
+
<dd>
|
|
2370
|
+
|
|
2371
|
+
**conversationId:** `string` — The ID of a conversation the form being submitted belongs to
|
|
2372
|
+
|
|
2373
|
+
</dd>
|
|
2374
|
+
</dl>
|
|
2375
|
+
|
|
2376
|
+
<dl>
|
|
2377
|
+
<dd>
|
|
2378
|
+
|
|
2379
|
+
**request:** `MavenAGI.SubmitActionFormRequest`
|
|
2380
|
+
|
|
2381
|
+
</dd>
|
|
2382
|
+
</dl>
|
|
2383
|
+
|
|
2384
|
+
<dl>
|
|
2385
|
+
<dd>
|
|
2386
|
+
|
|
2387
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2388
|
+
|
|
2389
|
+
</dd>
|
|
2390
|
+
</dl>
|
|
2391
|
+
</dd>
|
|
2392
|
+
</dl>
|
|
2393
|
+
|
|
2394
|
+
</dd>
|
|
2395
|
+
</dl>
|
|
2396
|
+
</details>
|
|
2397
|
+
|
|
2398
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">addConversationMetadata</a>(conversationId, { ...params }) -> Record<string, string></code></summary>
|
|
2399
|
+
<dl>
|
|
2400
|
+
<dd>
|
|
2401
|
+
|
|
2402
|
+
#### 📝 Description
|
|
2403
|
+
|
|
2404
|
+
<dl>
|
|
2405
|
+
<dd>
|
|
2406
|
+
|
|
2407
|
+
<dl>
|
|
2408
|
+
<dd>
|
|
2409
|
+
|
|
2410
|
+
Replaced by `updateConversationMetadata`.
|
|
2411
|
+
|
|
2412
|
+
Adds metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
|
|
1231
2413
|
|
|
1232
|
-
|
|
1233
|
-
|
|
1234
|
-
|
|
1235
|
-
|
|
1236
|
-
</dl>
|
|
2414
|
+
</dd>
|
|
2415
|
+
</dl>
|
|
2416
|
+
</dd>
|
|
2417
|
+
</dl>
|
|
1237
2418
|
|
|
1238
2419
|
#### 🔌 Usage
|
|
1239
2420
|
|
|
@@ -1244,25 +2425,90 @@ Known Limitation:
|
|
|
1244
2425
|
<dd>
|
|
1245
2426
|
|
|
1246
2427
|
```typescript
|
|
1247
|
-
await client.conversation.
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1255
|
-
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
|
|
2428
|
+
await client.conversation.addConversationMetadata("conversationId", {
|
|
2429
|
+
string: "string",
|
|
2430
|
+
});
|
|
2431
|
+
```
|
|
2432
|
+
|
|
2433
|
+
</dd>
|
|
2434
|
+
</dl>
|
|
2435
|
+
</dd>
|
|
2436
|
+
</dl>
|
|
2437
|
+
|
|
2438
|
+
#### ⚙️ Parameters
|
|
2439
|
+
|
|
2440
|
+
<dl>
|
|
2441
|
+
<dd>
|
|
2442
|
+
|
|
2443
|
+
<dl>
|
|
2444
|
+
<dd>
|
|
2445
|
+
|
|
2446
|
+
**conversationId:** `string` — The ID of a conversation the metadata being added belongs to
|
|
2447
|
+
|
|
2448
|
+
</dd>
|
|
2449
|
+
</dl>
|
|
2450
|
+
|
|
2451
|
+
<dl>
|
|
2452
|
+
<dd>
|
|
2453
|
+
|
|
2454
|
+
**request:** `Record<string, string>`
|
|
2455
|
+
|
|
2456
|
+
</dd>
|
|
2457
|
+
</dl>
|
|
2458
|
+
|
|
2459
|
+
<dl>
|
|
2460
|
+
<dd>
|
|
2461
|
+
|
|
2462
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2463
|
+
|
|
2464
|
+
</dd>
|
|
2465
|
+
</dl>
|
|
2466
|
+
</dd>
|
|
2467
|
+
</dl>
|
|
2468
|
+
|
|
2469
|
+
</dd>
|
|
2470
|
+
</dl>
|
|
2471
|
+
</details>
|
|
2472
|
+
|
|
2473
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">updateConversationMetadata</a>(conversationId, { ...params }) -> MavenAGI.ConversationMetadata</code></summary>
|
|
2474
|
+
<dl>
|
|
2475
|
+
<dd>
|
|
2476
|
+
|
|
2477
|
+
#### 📝 Description
|
|
2478
|
+
|
|
2479
|
+
<dl>
|
|
2480
|
+
<dd>
|
|
2481
|
+
|
|
2482
|
+
<dl>
|
|
2483
|
+
<dd>
|
|
2484
|
+
|
|
2485
|
+
Update metadata supplied by the calling application for an existing conversation.
|
|
2486
|
+
Does not modify metadata saved by other apps.
|
|
2487
|
+
|
|
2488
|
+
If a metadata field already exists for the calling app, it will be overwritten.
|
|
2489
|
+
If it does not exist, it will be added. Will not remove metadata fields.
|
|
2490
|
+
|
|
2491
|
+
Returns all metadata saved by any app on the conversation.
|
|
2492
|
+
|
|
2493
|
+
</dd>
|
|
2494
|
+
</dl>
|
|
2495
|
+
</dd>
|
|
2496
|
+
</dl>
|
|
2497
|
+
|
|
2498
|
+
#### 🔌 Usage
|
|
2499
|
+
|
|
2500
|
+
<dl>
|
|
2501
|
+
<dd>
|
|
2502
|
+
|
|
2503
|
+
<dl>
|
|
2504
|
+
<dd>
|
|
2505
|
+
|
|
2506
|
+
```typescript
|
|
2507
|
+
await client.conversation.updateConversationMetadata("conversation-0", {
|
|
2508
|
+
appId: "conversation-owning-app",
|
|
2509
|
+
values: {
|
|
2510
|
+
key: "newValue",
|
|
1264
2511
|
},
|
|
1265
|
-
timezone: "America/New_York",
|
|
1266
2512
|
});
|
|
1267
2513
|
```
|
|
1268
2514
|
|
|
@@ -1279,7 +2525,7 @@ await client.conversation.ask("conversation-0", {
|
|
|
1279
2525
|
<dl>
|
|
1280
2526
|
<dd>
|
|
1281
2527
|
|
|
1282
|
-
**conversationId:** `string` — The ID of
|
|
2528
|
+
**conversationId:** `string` — The ID of the conversation to modify metadata for
|
|
1283
2529
|
|
|
1284
2530
|
</dd>
|
|
1285
2531
|
</dl>
|
|
@@ -1287,7 +2533,7 @@ await client.conversation.ask("conversation-0", {
|
|
|
1287
2533
|
<dl>
|
|
1288
2534
|
<dd>
|
|
1289
2535
|
|
|
1290
|
-
**request:** `MavenAGI.
|
|
2536
|
+
**request:** `MavenAGI.UpdateMetadataRequest`
|
|
1291
2537
|
|
|
1292
2538
|
</dd>
|
|
1293
2539
|
</dl>
|
|
@@ -1306,7 +2552,7 @@ await client.conversation.ask("conversation-0", {
|
|
|
1306
2552
|
</dl>
|
|
1307
2553
|
</details>
|
|
1308
2554
|
|
|
1309
|
-
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">
|
|
2555
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">search</a>({ ...params }) -> MavenAGI.ConversationsResponse</code></summary>
|
|
1310
2556
|
<dl>
|
|
1311
2557
|
<dd>
|
|
1312
2558
|
|
|
@@ -1318,25 +2564,79 @@ await client.conversation.ask("conversation-0", {
|
|
|
1318
2564
|
<dl>
|
|
1319
2565
|
<dd>
|
|
1320
2566
|
|
|
1321
|
-
|
|
1322
|
-
The text portions of stream responses should be concatenated to form the full response text.
|
|
1323
|
-
Action and metadata events should overwrite past data and do not need concatenation.
|
|
2567
|
+
Search conversations
|
|
1324
2568
|
|
|
1325
|
-
|
|
1326
|
-
|
|
2569
|
+
</dd>
|
|
2570
|
+
</dl>
|
|
2571
|
+
</dd>
|
|
2572
|
+
</dl>
|
|
1327
2573
|
|
|
1328
|
-
|
|
2574
|
+
#### 🔌 Usage
|
|
1329
2575
|
|
|
1330
|
-
|
|
1331
|
-
|
|
2576
|
+
<dl>
|
|
2577
|
+
<dd>
|
|
1332
2578
|
|
|
1333
|
-
|
|
2579
|
+
<dl>
|
|
2580
|
+
<dd>
|
|
1334
2581
|
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
2582
|
+
```typescript
|
|
2583
|
+
await client.conversation.search({});
|
|
2584
|
+
```
|
|
2585
|
+
|
|
2586
|
+
</dd>
|
|
2587
|
+
</dl>
|
|
2588
|
+
</dd>
|
|
2589
|
+
</dl>
|
|
2590
|
+
|
|
2591
|
+
#### ⚙️ Parameters
|
|
2592
|
+
|
|
2593
|
+
<dl>
|
|
2594
|
+
<dd>
|
|
2595
|
+
|
|
2596
|
+
<dl>
|
|
2597
|
+
<dd>
|
|
2598
|
+
|
|
2599
|
+
**request:** `MavenAGI.ConversationsSearchRequest`
|
|
2600
|
+
|
|
2601
|
+
</dd>
|
|
2602
|
+
</dl>
|
|
2603
|
+
|
|
2604
|
+
<dl>
|
|
2605
|
+
<dd>
|
|
2606
|
+
|
|
2607
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2608
|
+
|
|
2609
|
+
</dd>
|
|
2610
|
+
</dl>
|
|
2611
|
+
</dd>
|
|
2612
|
+
</dl>
|
|
2613
|
+
|
|
2614
|
+
</dd>
|
|
2615
|
+
</dl>
|
|
2616
|
+
</details>
|
|
2617
|
+
|
|
2618
|
+
<details><summary><code>client.conversation.<a href="/src/api/resources/conversation/client/Client.ts">deliverMessage</a>({ ...params }) -> MavenAGI.DeliverMessageResponse</code></summary>
|
|
2619
|
+
<dl>
|
|
2620
|
+
<dd>
|
|
2621
|
+
|
|
2622
|
+
#### 📝 Description
|
|
2623
|
+
|
|
2624
|
+
<dl>
|
|
2625
|
+
<dd>
|
|
2626
|
+
|
|
2627
|
+
<dl>
|
|
2628
|
+
<dd>
|
|
2629
|
+
|
|
2630
|
+
Deliver a message to a user or conversation.
|
|
2631
|
+
|
|
2632
|
+
<Warning>
|
|
2633
|
+
Currently, messages can only be successfully delivered to conversations with the `ASYNC` capability that are `open`.
|
|
2634
|
+
User message delivery is not yet supported.
|
|
2635
|
+
</Warning>
|
|
2636
|
+
</dd>
|
|
2637
|
+
</dl>
|
|
2638
|
+
</dd>
|
|
2639
|
+
</dl>
|
|
1340
2640
|
|
|
1341
2641
|
#### 🔌 Usage
|
|
1342
2642
|
|
|
@@ -1347,29 +2647,24 @@ Known Limitation:
|
|
|
1347
2647
|
<dd>
|
|
1348
2648
|
|
|
1349
2649
|
```typescript
|
|
1350
|
-
|
|
1351
|
-
|
|
1352
|
-
referenceId: "message-0",
|
|
1353
|
-
},
|
|
2650
|
+
await client.conversation.deliverMessage({
|
|
2651
|
+
type: "user",
|
|
1354
2652
|
userId: {
|
|
1355
|
-
|
|
2653
|
+
type: "AGENT",
|
|
2654
|
+
appId: "appId",
|
|
2655
|
+
referenceId: "referenceId",
|
|
1356
2656
|
},
|
|
1357
|
-
|
|
1358
|
-
|
|
1359
|
-
|
|
1360
|
-
type: "image/png",
|
|
1361
|
-
content: "iVBORw0KGgo...",
|
|
2657
|
+
message: {
|
|
2658
|
+
conversationMessageId: {
|
|
2659
|
+
referenceId: "referenceId",
|
|
1362
2660
|
},
|
|
1363
|
-
|
|
1364
|
-
|
|
1365
|
-
|
|
1366
|
-
|
|
2661
|
+
userId: {
|
|
2662
|
+
referenceId: "referenceId",
|
|
2663
|
+
},
|
|
2664
|
+
text: "text",
|
|
2665
|
+
userMessageType: "USER",
|
|
1367
2666
|
},
|
|
1368
|
-
timezone: "America/New_York",
|
|
1369
2667
|
});
|
|
1370
|
-
for await (const item of response) {
|
|
1371
|
-
console.log(item);
|
|
1372
|
-
}
|
|
1373
2668
|
```
|
|
1374
2669
|
|
|
1375
2670
|
</dd>
|
|
@@ -1377,7 +2672,55 @@ for await (const item of response) {
|
|
|
1377
2672
|
</dd>
|
|
1378
2673
|
</dl>
|
|
1379
2674
|
|
|
1380
|
-
#### ⚙️ Parameters
|
|
2675
|
+
#### ⚙️ Parameters
|
|
2676
|
+
|
|
2677
|
+
<dl>
|
|
2678
|
+
<dd>
|
|
2679
|
+
|
|
2680
|
+
<dl>
|
|
2681
|
+
<dd>
|
|
2682
|
+
|
|
2683
|
+
**request:** `MavenAGI.DeliverMessageRequest`
|
|
2684
|
+
|
|
2685
|
+
</dd>
|
|
2686
|
+
</dl>
|
|
2687
|
+
|
|
2688
|
+
<dl>
|
|
2689
|
+
<dd>
|
|
2690
|
+
|
|
2691
|
+
**requestOptions:** `Conversation.RequestOptions`
|
|
2692
|
+
|
|
2693
|
+
</dd>
|
|
2694
|
+
</dl>
|
|
2695
|
+
</dd>
|
|
2696
|
+
</dl>
|
|
2697
|
+
|
|
2698
|
+
</dd>
|
|
2699
|
+
</dl>
|
|
2700
|
+
</details>
|
|
2701
|
+
|
|
2702
|
+
## Events
|
|
2703
|
+
|
|
2704
|
+
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
|
|
2705
|
+
<dl>
|
|
2706
|
+
<dd>
|
|
2707
|
+
|
|
2708
|
+
#### 📝 Description
|
|
2709
|
+
|
|
2710
|
+
<dl>
|
|
2711
|
+
<dd>
|
|
2712
|
+
|
|
2713
|
+
<dl>
|
|
2714
|
+
<dd>
|
|
2715
|
+
|
|
2716
|
+
Search events
|
|
2717
|
+
|
|
2718
|
+
</dd>
|
|
2719
|
+
</dl>
|
|
2720
|
+
</dd>
|
|
2721
|
+
</dl>
|
|
2722
|
+
|
|
2723
|
+
#### 🔌 Usage
|
|
1381
2724
|
|
|
1382
2725
|
<dl>
|
|
1383
2726
|
<dd>
|
|
@@ -1385,15 +2728,24 @@ for await (const item of response) {
|
|
|
1385
2728
|
<dl>
|
|
1386
2729
|
<dd>
|
|
1387
2730
|
|
|
1388
|
-
|
|
2731
|
+
```typescript
|
|
2732
|
+
await client.events.search({});
|
|
2733
|
+
```
|
|
1389
2734
|
|
|
1390
2735
|
</dd>
|
|
1391
2736
|
</dl>
|
|
2737
|
+
</dd>
|
|
2738
|
+
</dl>
|
|
2739
|
+
|
|
2740
|
+
#### ⚙️ Parameters
|
|
1392
2741
|
|
|
1393
2742
|
<dl>
|
|
1394
2743
|
<dd>
|
|
1395
2744
|
|
|
1396
|
-
|
|
2745
|
+
<dl>
|
|
2746
|
+
<dd>
|
|
2747
|
+
|
|
2748
|
+
**request:** `MavenAGI.EventsSearchRequest`
|
|
1397
2749
|
|
|
1398
2750
|
</dd>
|
|
1399
2751
|
</dl>
|
|
@@ -1401,7 +2753,7 @@ for await (const item of response) {
|
|
|
1401
2753
|
<dl>
|
|
1402
2754
|
<dd>
|
|
1403
2755
|
|
|
1404
|
-
**requestOptions:** `
|
|
2756
|
+
**requestOptions:** `Events.RequestOptions`
|
|
1405
2757
|
|
|
1406
2758
|
</dd>
|
|
1407
2759
|
</dl>
|
|
@@ -1412,7 +2764,9 @@ for await (const item of response) {
|
|
|
1412
2764
|
</dl>
|
|
1413
2765
|
</details>
|
|
1414
2766
|
|
|
1415
|
-
|
|
2767
|
+
## Inbox
|
|
2768
|
+
|
|
2769
|
+
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
|
|
1416
2770
|
<dl>
|
|
1417
2771
|
<dd>
|
|
1418
2772
|
|
|
@@ -1424,7 +2778,7 @@ for await (const item of response) {
|
|
|
1424
2778
|
<dl>
|
|
1425
2779
|
<dd>
|
|
1426
2780
|
|
|
1427
|
-
|
|
2781
|
+
Retrieve a paginated list of inbox items for an agent.
|
|
1428
2782
|
|
|
1429
2783
|
</dd>
|
|
1430
2784
|
</dl>
|
|
@@ -1440,16 +2794,7 @@ This method is deprecated and will be removed in a future release. Use either `a
|
|
|
1440
2794
|
<dd>
|
|
1441
2795
|
|
|
1442
2796
|
```typescript
|
|
1443
|
-
await client.
|
|
1444
|
-
conversationMessageIds: [
|
|
1445
|
-
{
|
|
1446
|
-
referenceId: "referenceId",
|
|
1447
|
-
},
|
|
1448
|
-
{
|
|
1449
|
-
referenceId: "referenceId",
|
|
1450
|
-
},
|
|
1451
|
-
],
|
|
1452
|
-
});
|
|
2797
|
+
await client.inbox.search({});
|
|
1453
2798
|
```
|
|
1454
2799
|
|
|
1455
2800
|
</dd>
|
|
@@ -1465,15 +2810,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
|
|
|
1465
2810
|
<dl>
|
|
1466
2811
|
<dd>
|
|
1467
2812
|
|
|
1468
|
-
**
|
|
1469
|
-
|
|
1470
|
-
</dd>
|
|
1471
|
-
</dl>
|
|
1472
|
-
|
|
1473
|
-
<dl>
|
|
1474
|
-
<dd>
|
|
1475
|
-
|
|
1476
|
-
**request:** `MavenAGI.GenerateMavenSuggestionsRequest`
|
|
2813
|
+
**request:** `MavenAGI.InboxSearchRequest`
|
|
1477
2814
|
|
|
1478
2815
|
</dd>
|
|
1479
2816
|
</dl>
|
|
@@ -1481,7 +2818,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
|
|
|
1481
2818
|
<dl>
|
|
1482
2819
|
<dd>
|
|
1483
2820
|
|
|
1484
|
-
**requestOptions:** `
|
|
2821
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
1485
2822
|
|
|
1486
2823
|
</dd>
|
|
1487
2824
|
</dl>
|
|
@@ -1492,7 +2829,7 @@ await client.conversation.generateMavenSuggestions("conversationId", {
|
|
|
1492
2829
|
</dl>
|
|
1493
2830
|
</details>
|
|
1494
2831
|
|
|
1495
|
-
<details><summary><code>client.
|
|
2832
|
+
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">get</a>(inboxItemId, { ...params }) -> MavenAGI.InboxItem</code></summary>
|
|
1496
2833
|
<dl>
|
|
1497
2834
|
<dd>
|
|
1498
2835
|
|
|
@@ -1504,18 +2841,12 @@ await client.conversation.generateMavenSuggestions("conversationId", {
|
|
|
1504
2841
|
<dl>
|
|
1505
2842
|
<dd>
|
|
1506
2843
|
|
|
1507
|
-
|
|
1508
|
-
|
|
1509
|
-
If the user question and object response already exist, they will be reused and not updated.
|
|
1510
|
-
|
|
1511
|
-
Known Limitations:
|
|
2844
|
+
Retrieve details of a specific inbox item by its ID.
|
|
1512
2845
|
|
|
1513
|
-
|
|
1514
|
-
|
|
1515
|
-
|
|
1516
|
-
|
|
1517
|
-
</dd>
|
|
1518
|
-
</dl>
|
|
2846
|
+
</dd>
|
|
2847
|
+
</dl>
|
|
2848
|
+
</dd>
|
|
2849
|
+
</dl>
|
|
1519
2850
|
|
|
1520
2851
|
#### 🔌 Usage
|
|
1521
2852
|
|
|
@@ -1526,15 +2857,8 @@ Known Limitations:
|
|
|
1526
2857
|
<dd>
|
|
1527
2858
|
|
|
1528
2859
|
```typescript
|
|
1529
|
-
await client.
|
|
1530
|
-
|
|
1531
|
-
referenceId: "referenceId",
|
|
1532
|
-
},
|
|
1533
|
-
userId: {
|
|
1534
|
-
referenceId: "referenceId",
|
|
1535
|
-
},
|
|
1536
|
-
text: "text",
|
|
1537
|
-
schema: "schema",
|
|
2860
|
+
await client.inbox.get("inboxItemId", {
|
|
2861
|
+
appId: "appId",
|
|
1538
2862
|
});
|
|
1539
2863
|
```
|
|
1540
2864
|
|
|
@@ -1551,7 +2875,7 @@ await client.conversation.generateObject("conversationId", {
|
|
|
1551
2875
|
<dl>
|
|
1552
2876
|
<dd>
|
|
1553
2877
|
|
|
1554
|
-
**
|
|
2878
|
+
**inboxItemId:** `string` — The ID of the inbox item to get. All other entity ID fields are inferred from the request.
|
|
1555
2879
|
|
|
1556
2880
|
</dd>
|
|
1557
2881
|
</dl>
|
|
@@ -1559,7 +2883,7 @@ await client.conversation.generateObject("conversationId", {
|
|
|
1559
2883
|
<dl>
|
|
1560
2884
|
<dd>
|
|
1561
2885
|
|
|
1562
|
-
**request:** `MavenAGI.
|
|
2886
|
+
**request:** `MavenAGI.InboxItemRequest`
|
|
1563
2887
|
|
|
1564
2888
|
</dd>
|
|
1565
2889
|
</dl>
|
|
@@ -1567,7 +2891,7 @@ await client.conversation.generateObject("conversationId", {
|
|
|
1567
2891
|
<dl>
|
|
1568
2892
|
<dd>
|
|
1569
2893
|
|
|
1570
|
-
**requestOptions:** `
|
|
2894
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
1571
2895
|
|
|
1572
2896
|
</dd>
|
|
1573
2897
|
</dl>
|
|
@@ -1578,7 +2902,7 @@ await client.conversation.generateObject("conversationId", {
|
|
|
1578
2902
|
</dl>
|
|
1579
2903
|
</details>
|
|
1580
2904
|
|
|
1581
|
-
<details><summary><code>client.
|
|
2905
|
+
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">getFix</a>(inboxItemFixId, { ...params }) -> MavenAGI.InboxItemFix</code></summary>
|
|
1582
2906
|
<dl>
|
|
1583
2907
|
<dd>
|
|
1584
2908
|
|
|
@@ -1590,7 +2914,7 @@ await client.conversation.generateObject("conversationId", {
|
|
|
1590
2914
|
<dl>
|
|
1591
2915
|
<dd>
|
|
1592
2916
|
|
|
1593
|
-
|
|
2917
|
+
Retrieve a suggested fix. Includes document information if the fix is a Missing Knowledge suggestion.
|
|
1594
2918
|
|
|
1595
2919
|
</dd>
|
|
1596
2920
|
</dl>
|
|
@@ -1606,7 +2930,9 @@ Uses an LLM flow to categorize the conversation. Experimental.
|
|
|
1606
2930
|
<dd>
|
|
1607
2931
|
|
|
1608
2932
|
```typescript
|
|
1609
|
-
await client.
|
|
2933
|
+
await client.inbox.getFix("inboxItemFixId", {
|
|
2934
|
+
appId: "appId",
|
|
2935
|
+
});
|
|
1610
2936
|
```
|
|
1611
2937
|
|
|
1612
2938
|
</dd>
|
|
@@ -1622,7 +2948,7 @@ await client.conversation.categorize("conversationId");
|
|
|
1622
2948
|
<dl>
|
|
1623
2949
|
<dd>
|
|
1624
2950
|
|
|
1625
|
-
**
|
|
2951
|
+
**inboxItemFixId:** `string` — Unique identifier for the inbox fix.
|
|
1626
2952
|
|
|
1627
2953
|
</dd>
|
|
1628
2954
|
</dl>
|
|
@@ -1630,7 +2956,15 @@ await client.conversation.categorize("conversationId");
|
|
|
1630
2956
|
<dl>
|
|
1631
2957
|
<dd>
|
|
1632
2958
|
|
|
1633
|
-
**
|
|
2959
|
+
**request:** `MavenAGI.InboxItemFixRequest`
|
|
2960
|
+
|
|
2961
|
+
</dd>
|
|
2962
|
+
</dl>
|
|
2963
|
+
|
|
2964
|
+
<dl>
|
|
2965
|
+
<dd>
|
|
2966
|
+
|
|
2967
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
1634
2968
|
|
|
1635
2969
|
</dd>
|
|
1636
2970
|
</dl>
|
|
@@ -1641,7 +2975,7 @@ await client.conversation.categorize("conversationId");
|
|
|
1641
2975
|
</dl>
|
|
1642
2976
|
</details>
|
|
1643
2977
|
|
|
1644
|
-
<details><summary><code>client.
|
|
2978
|
+
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">applyFixes</a>(inboxItemId, { ...params }) -> void</code></summary>
|
|
1645
2979
|
<dl>
|
|
1646
2980
|
<dd>
|
|
1647
2981
|
|
|
@@ -1653,7 +2987,7 @@ await client.conversation.categorize("conversationId");
|
|
|
1653
2987
|
<dl>
|
|
1654
2988
|
<dd>
|
|
1655
2989
|
|
|
1656
|
-
|
|
2990
|
+
Apply a list of fixes belonging to an inbox item.
|
|
1657
2991
|
|
|
1658
2992
|
</dd>
|
|
1659
2993
|
</dl>
|
|
@@ -1669,21 +3003,9 @@ Update feedback or create it if it doesn't exist
|
|
|
1669
3003
|
<dd>
|
|
1670
3004
|
|
|
1671
3005
|
```typescript
|
|
1672
|
-
await client.
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
},
|
|
1676
|
-
userId: {
|
|
1677
|
-
referenceId: "user-0",
|
|
1678
|
-
},
|
|
1679
|
-
conversationId: {
|
|
1680
|
-
referenceId: "conversation-0",
|
|
1681
|
-
},
|
|
1682
|
-
conversationMessageId: {
|
|
1683
|
-
referenceId: "message-1",
|
|
1684
|
-
},
|
|
1685
|
-
type: "THUMBS_UP",
|
|
1686
|
-
text: "Great answer!",
|
|
3006
|
+
await client.inbox.applyFixes("inboxItemId", {
|
|
3007
|
+
appId: "appId",
|
|
3008
|
+
fixReferenceIds: ["fixReferenceIds", "fixReferenceIds"],
|
|
1687
3009
|
});
|
|
1688
3010
|
```
|
|
1689
3011
|
|
|
@@ -1700,7 +3022,7 @@ await client.conversation.createFeedback({
|
|
|
1700
3022
|
<dl>
|
|
1701
3023
|
<dd>
|
|
1702
3024
|
|
|
1703
|
-
**
|
|
3025
|
+
**inboxItemId:** `string` — Unique identifier for the inbox item.
|
|
1704
3026
|
|
|
1705
3027
|
</dd>
|
|
1706
3028
|
</dl>
|
|
@@ -1708,7 +3030,15 @@ await client.conversation.createFeedback({
|
|
|
1708
3030
|
<dl>
|
|
1709
3031
|
<dd>
|
|
1710
3032
|
|
|
1711
|
-
**
|
|
3033
|
+
**request:** `MavenAGI.ApplyFixesRequest`
|
|
3034
|
+
|
|
3035
|
+
</dd>
|
|
3036
|
+
</dl>
|
|
3037
|
+
|
|
3038
|
+
<dl>
|
|
3039
|
+
<dd>
|
|
3040
|
+
|
|
3041
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
1712
3042
|
|
|
1713
3043
|
</dd>
|
|
1714
3044
|
</dl>
|
|
@@ -1719,7 +3049,7 @@ await client.conversation.createFeedback({
|
|
|
1719
3049
|
</dl>
|
|
1720
3050
|
</details>
|
|
1721
3051
|
|
|
1722
|
-
<details><summary><code>client.
|
|
3052
|
+
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">ignore</a>(inboxItemId, { ...params }) -> void</code></summary>
|
|
1723
3053
|
<dl>
|
|
1724
3054
|
<dd>
|
|
1725
3055
|
|
|
@@ -1731,7 +3061,7 @@ await client.conversation.createFeedback({
|
|
|
1731
3061
|
<dl>
|
|
1732
3062
|
<dd>
|
|
1733
3063
|
|
|
1734
|
-
|
|
3064
|
+
Ignore a specific inbox item by its ID.
|
|
1735
3065
|
|
|
1736
3066
|
</dd>
|
|
1737
3067
|
</dl>
|
|
@@ -1747,13 +3077,8 @@ Submit a filled out action form
|
|
|
1747
3077
|
<dd>
|
|
1748
3078
|
|
|
1749
3079
|
```typescript
|
|
1750
|
-
await client.
|
|
1751
|
-
|
|
1752
|
-
parameters: {
|
|
1753
|
-
parameters: {
|
|
1754
|
-
key: "value",
|
|
1755
|
-
},
|
|
1756
|
-
},
|
|
3080
|
+
await client.inbox.ignore("inboxItemId", {
|
|
3081
|
+
appId: "appId",
|
|
1757
3082
|
});
|
|
1758
3083
|
```
|
|
1759
3084
|
|
|
@@ -1770,7 +3095,7 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
1770
3095
|
<dl>
|
|
1771
3096
|
<dd>
|
|
1772
3097
|
|
|
1773
|
-
**
|
|
3098
|
+
**inboxItemId:** `string` — Unique identifier for the inbox item.
|
|
1774
3099
|
|
|
1775
3100
|
</dd>
|
|
1776
3101
|
</dl>
|
|
@@ -1778,7 +3103,7 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
1778
3103
|
<dl>
|
|
1779
3104
|
<dd>
|
|
1780
3105
|
|
|
1781
|
-
**request:** `MavenAGI.
|
|
3106
|
+
**request:** `MavenAGI.InboxItemIgnoreRequest`
|
|
1782
3107
|
|
|
1783
3108
|
</dd>
|
|
1784
3109
|
</dl>
|
|
@@ -1786,7 +3111,7 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
1786
3111
|
<dl>
|
|
1787
3112
|
<dd>
|
|
1788
3113
|
|
|
1789
|
-
**requestOptions:** `
|
|
3114
|
+
**requestOptions:** `Inbox.RequestOptions`
|
|
1790
3115
|
|
|
1791
3116
|
</dd>
|
|
1792
3117
|
</dl>
|
|
@@ -1797,7 +3122,9 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
1797
3122
|
</dl>
|
|
1798
3123
|
</details>
|
|
1799
3124
|
|
|
1800
|
-
|
|
3125
|
+
## Knowledge
|
|
3126
|
+
|
|
3127
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeBases</a>({ ...params }) -> MavenAGI.KnowledgeBasesResponse</code></summary>
|
|
1801
3128
|
<dl>
|
|
1802
3129
|
<dd>
|
|
1803
3130
|
|
|
@@ -1809,9 +3136,7 @@ await client.conversation.submitActionForm("conversationId", {
|
|
|
1809
3136
|
<dl>
|
|
1810
3137
|
<dd>
|
|
1811
3138
|
|
|
1812
|
-
|
|
1813
|
-
|
|
1814
|
-
Adds metadata to an existing conversation. If a metadata field already exists, it will be overwritten.
|
|
3139
|
+
Search knowledge bases
|
|
1815
3140
|
|
|
1816
3141
|
</dd>
|
|
1817
3142
|
</dl>
|
|
@@ -1827,9 +3152,7 @@ Adds metadata to an existing conversation. If a metadata field already exists, i
|
|
|
1827
3152
|
<dd>
|
|
1828
3153
|
|
|
1829
3154
|
```typescript
|
|
1830
|
-
await client.
|
|
1831
|
-
string: "string",
|
|
1832
|
-
});
|
|
3155
|
+
await client.knowledge.searchKnowledgeBases({});
|
|
1833
3156
|
```
|
|
1834
3157
|
|
|
1835
3158
|
</dd>
|
|
@@ -1845,15 +3168,7 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
1845
3168
|
<dl>
|
|
1846
3169
|
<dd>
|
|
1847
3170
|
|
|
1848
|
-
**
|
|
1849
|
-
|
|
1850
|
-
</dd>
|
|
1851
|
-
</dl>
|
|
1852
|
-
|
|
1853
|
-
<dl>
|
|
1854
|
-
<dd>
|
|
1855
|
-
|
|
1856
|
-
**request:** `Record<string, string>`
|
|
3171
|
+
**request:** `MavenAGI.KnowledgeBaseSearchRequest`
|
|
1857
3172
|
|
|
1858
3173
|
</dd>
|
|
1859
3174
|
</dl>
|
|
@@ -1861,7 +3176,7 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
1861
3176
|
<dl>
|
|
1862
3177
|
<dd>
|
|
1863
3178
|
|
|
1864
|
-
**requestOptions:** `
|
|
3179
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
1865
3180
|
|
|
1866
3181
|
</dd>
|
|
1867
3182
|
</dl>
|
|
@@ -1872,7 +3187,7 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
1872
3187
|
</dl>
|
|
1873
3188
|
</details>
|
|
1874
3189
|
|
|
1875
|
-
<details><summary><code>client.
|
|
3190
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createOrUpdateKnowledgeBase</a>({ ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
|
|
1876
3191
|
<dl>
|
|
1877
3192
|
<dd>
|
|
1878
3193
|
|
|
@@ -1884,13 +3199,7 @@ await client.conversation.addConversationMetadata("conversationId", {
|
|
|
1884
3199
|
<dl>
|
|
1885
3200
|
<dd>
|
|
1886
3201
|
|
|
1887
|
-
Update
|
|
1888
|
-
Does not modify metadata saved by other apps.
|
|
1889
|
-
|
|
1890
|
-
If a metadata field already exists for the calling app, it will be overwritten.
|
|
1891
|
-
If it does not exist, it will be added. Will not remove metadata fields.
|
|
1892
|
-
|
|
1893
|
-
Returns all metadata saved by any app on the conversation.
|
|
3202
|
+
Update a knowledge base or create it if it doesn't exist.
|
|
1894
3203
|
|
|
1895
3204
|
</dd>
|
|
1896
3205
|
</dl>
|
|
@@ -1906,11 +3215,11 @@ Returns all metadata saved by any app on the conversation.
|
|
|
1906
3215
|
<dd>
|
|
1907
3216
|
|
|
1908
3217
|
```typescript
|
|
1909
|
-
await client.
|
|
1910
|
-
|
|
1911
|
-
|
|
1912
|
-
key: "newValue",
|
|
3218
|
+
await client.knowledge.createOrUpdateKnowledgeBase({
|
|
3219
|
+
knowledgeBaseId: {
|
|
3220
|
+
referenceId: "help-center",
|
|
1913
3221
|
},
|
|
3222
|
+
name: "Help center",
|
|
1914
3223
|
});
|
|
1915
3224
|
```
|
|
1916
3225
|
|
|
@@ -1927,15 +3236,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
1927
3236
|
<dl>
|
|
1928
3237
|
<dd>
|
|
1929
3238
|
|
|
1930
|
-
**
|
|
1931
|
-
|
|
1932
|
-
</dd>
|
|
1933
|
-
</dl>
|
|
1934
|
-
|
|
1935
|
-
<dl>
|
|
1936
|
-
<dd>
|
|
1937
|
-
|
|
1938
|
-
**request:** `MavenAGI.UpdateMetadataRequest`
|
|
3239
|
+
**request:** `MavenAGI.KnowledgeBaseRequest`
|
|
1939
3240
|
|
|
1940
3241
|
</dd>
|
|
1941
3242
|
</dl>
|
|
@@ -1943,7 +3244,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
1943
3244
|
<dl>
|
|
1944
3245
|
<dd>
|
|
1945
3246
|
|
|
1946
|
-
**requestOptions:** `
|
|
3247
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
1947
3248
|
|
|
1948
3249
|
</dd>
|
|
1949
3250
|
</dl>
|
|
@@ -1954,7 +3255,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
1954
3255
|
</dl>
|
|
1955
3256
|
</details>
|
|
1956
3257
|
|
|
1957
|
-
<details><summary><code>client.
|
|
3258
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">getKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
|
|
1958
3259
|
<dl>
|
|
1959
3260
|
<dd>
|
|
1960
3261
|
|
|
@@ -1966,7 +3267,7 @@ await client.conversation.updateConversationMetadata("conversation-0", {
|
|
|
1966
3267
|
<dl>
|
|
1967
3268
|
<dd>
|
|
1968
3269
|
|
|
1969
|
-
|
|
3270
|
+
Get an existing knowledge base by its supplied ID
|
|
1970
3271
|
|
|
1971
3272
|
</dd>
|
|
1972
3273
|
</dl>
|
|
@@ -1982,7 +3283,7 @@ Search conversations
|
|
|
1982
3283
|
<dd>
|
|
1983
3284
|
|
|
1984
3285
|
```typescript
|
|
1985
|
-
await client.
|
|
3286
|
+
await client.knowledge.getKnowledgeBase("help-center");
|
|
1986
3287
|
```
|
|
1987
3288
|
|
|
1988
3289
|
</dd>
|
|
@@ -1998,7 +3299,7 @@ await client.conversation.search({});
|
|
|
1998
3299
|
<dl>
|
|
1999
3300
|
<dd>
|
|
2000
3301
|
|
|
2001
|
-
**
|
|
3302
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to get. All other entity ID fields are inferred from the request.
|
|
2002
3303
|
|
|
2003
3304
|
</dd>
|
|
2004
3305
|
</dl>
|
|
@@ -2006,7 +3307,15 @@ await client.conversation.search({});
|
|
|
2006
3307
|
<dl>
|
|
2007
3308
|
<dd>
|
|
2008
3309
|
|
|
2009
|
-
**
|
|
3310
|
+
**request:** `MavenAGI.KnowledgeBaseGetRequest`
|
|
3311
|
+
|
|
3312
|
+
</dd>
|
|
3313
|
+
</dl>
|
|
3314
|
+
|
|
3315
|
+
<dl>
|
|
3316
|
+
<dd>
|
|
3317
|
+
|
|
3318
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2010
3319
|
|
|
2011
3320
|
</dd>
|
|
2012
3321
|
</dl>
|
|
@@ -2017,9 +3326,7 @@ await client.conversation.search({});
|
|
|
2017
3326
|
</dl>
|
|
2018
3327
|
</details>
|
|
2019
3328
|
|
|
2020
|
-
|
|
2021
|
-
|
|
2022
|
-
<details><summary><code>client.events.<a href="/src/api/resources/events/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventsSearchResponse</code></summary>
|
|
3329
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">patchKnowledgeBase</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
|
|
2023
3330
|
<dl>
|
|
2024
3331
|
<dd>
|
|
2025
3332
|
|
|
@@ -2031,7 +3338,10 @@ await client.conversation.search({});
|
|
|
2031
3338
|
<dl>
|
|
2032
3339
|
<dd>
|
|
2033
3340
|
|
|
2034
|
-
|
|
3341
|
+
Update mutable knowledge base fields
|
|
3342
|
+
|
|
3343
|
+
The `appId` field can be provided to update a knowledge base owned by a different app.
|
|
3344
|
+
All other fields will overwrite the existing value on the knowledge base only if provided.
|
|
2035
3345
|
|
|
2036
3346
|
</dd>
|
|
2037
3347
|
</dl>
|
|
@@ -2047,7 +3357,7 @@ Search events
|
|
|
2047
3357
|
<dd>
|
|
2048
3358
|
|
|
2049
3359
|
```typescript
|
|
2050
|
-
await client.
|
|
3360
|
+
await client.knowledge.patchKnowledgeBase("knowledgeBaseReferenceId", {});
|
|
2051
3361
|
```
|
|
2052
3362
|
|
|
2053
3363
|
</dd>
|
|
@@ -2063,7 +3373,7 @@ await client.events.search({});
|
|
|
2063
3373
|
<dl>
|
|
2064
3374
|
<dd>
|
|
2065
3375
|
|
|
2066
|
-
**
|
|
3376
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to patch.
|
|
2067
3377
|
|
|
2068
3378
|
</dd>
|
|
2069
3379
|
</dl>
|
|
@@ -2071,7 +3381,15 @@ await client.events.search({});
|
|
|
2071
3381
|
<dl>
|
|
2072
3382
|
<dd>
|
|
2073
3383
|
|
|
2074
|
-
**
|
|
3384
|
+
**request:** `MavenAGI.KnowledgeBasePatchRequest`
|
|
3385
|
+
|
|
3386
|
+
</dd>
|
|
3387
|
+
</dl>
|
|
3388
|
+
|
|
3389
|
+
<dl>
|
|
3390
|
+
<dd>
|
|
3391
|
+
|
|
3392
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2075
3393
|
|
|
2076
3394
|
</dd>
|
|
2077
3395
|
</dl>
|
|
@@ -2082,9 +3400,7 @@ await client.events.search({});
|
|
|
2082
3400
|
</dl>
|
|
2083
3401
|
</details>
|
|
2084
3402
|
|
|
2085
|
-
|
|
2086
|
-
|
|
2087
|
-
<details><summary><code>client.inbox.<a href="/src/api/resources/inbox/client/Client.ts">search</a>({ ...params }) -> MavenAGI.InboxSearchResponse</code></summary>
|
|
3403
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
|
|
2088
3404
|
<dl>
|
|
2089
3405
|
<dd>
|
|
2090
3406
|
|
|
@@ -2096,7 +3412,9 @@ await client.events.search({});
|
|
|
2096
3412
|
<dl>
|
|
2097
3413
|
<dd>
|
|
2098
3414
|
|
|
2099
|
-
|
|
3415
|
+
Create a new knowledge base version.
|
|
3416
|
+
|
|
3417
|
+
If an existing version is in progress, then that version will be finalized in an error state.
|
|
2100
3418
|
|
|
2101
3419
|
</dd>
|
|
2102
3420
|
</dl>
|
|
@@ -2112,7 +3430,17 @@ Retrieve a paginated list of inbox items for an agent.
|
|
|
2112
3430
|
<dd>
|
|
2113
3431
|
|
|
2114
3432
|
```typescript
|
|
2115
|
-
await client.
|
|
3433
|
+
await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
3434
|
+
versionId: {
|
|
3435
|
+
type: "KNOWLEDGE_BASE_VERSION",
|
|
3436
|
+
referenceId: "versionId",
|
|
3437
|
+
appId: "maven",
|
|
3438
|
+
organizationId: "acme",
|
|
3439
|
+
agentId: "support",
|
|
3440
|
+
},
|
|
3441
|
+
type: "FULL",
|
|
3442
|
+
status: "IN_PROGRESS",
|
|
3443
|
+
});
|
|
2116
3444
|
```
|
|
2117
3445
|
|
|
2118
3446
|
</dd>
|
|
@@ -2128,7 +3456,7 @@ await client.inbox.search({});
|
|
|
2128
3456
|
<dl>
|
|
2129
3457
|
<dd>
|
|
2130
3458
|
|
|
2131
|
-
**
|
|
3459
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a version for. All other entity ID fields are inferred from the request.
|
|
2132
3460
|
|
|
2133
3461
|
</dd>
|
|
2134
3462
|
</dl>
|
|
@@ -2136,7 +3464,15 @@ await client.inbox.search({});
|
|
|
2136
3464
|
<dl>
|
|
2137
3465
|
<dd>
|
|
2138
3466
|
|
|
2139
|
-
**
|
|
3467
|
+
**request:** `MavenAGI.KnowledgeBaseVersion`
|
|
3468
|
+
|
|
3469
|
+
</dd>
|
|
3470
|
+
</dl>
|
|
3471
|
+
|
|
3472
|
+
<dl>
|
|
3473
|
+
<dd>
|
|
3474
|
+
|
|
3475
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2140
3476
|
|
|
2141
3477
|
</dd>
|
|
2142
3478
|
</dl>
|
|
@@ -2147,7 +3483,7 @@ await client.inbox.search({});
|
|
|
2147
3483
|
</dl>
|
|
2148
3484
|
</details>
|
|
2149
3485
|
|
|
2150
|
-
<details><summary><code>client.
|
|
3486
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">finalizeKnowledgeBaseVersion</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeBaseVersion</code></summary>
|
|
2151
3487
|
<dl>
|
|
2152
3488
|
<dd>
|
|
2153
3489
|
|
|
@@ -2159,7 +3495,7 @@ await client.inbox.search({});
|
|
|
2159
3495
|
<dl>
|
|
2160
3496
|
<dd>
|
|
2161
3497
|
|
|
2162
|
-
|
|
3498
|
+
Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
|
|
2163
3499
|
|
|
2164
3500
|
</dd>
|
|
2165
3501
|
</dl>
|
|
@@ -2175,8 +3511,13 @@ Retrieve details of a specific inbox item by its ID.
|
|
|
2175
3511
|
<dd>
|
|
2176
3512
|
|
|
2177
3513
|
```typescript
|
|
2178
|
-
await client.
|
|
2179
|
-
|
|
3514
|
+
await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
3515
|
+
versionId: {
|
|
3516
|
+
type: "KNOWLEDGE_BASE_VERSION",
|
|
3517
|
+
referenceId: "versionId",
|
|
3518
|
+
appId: "maven",
|
|
3519
|
+
},
|
|
3520
|
+
status: "SUCCEEDED",
|
|
2180
3521
|
});
|
|
2181
3522
|
```
|
|
2182
3523
|
|
|
@@ -2193,7 +3534,7 @@ await client.inbox.get("inboxItemId", {
|
|
|
2193
3534
|
<dl>
|
|
2194
3535
|
<dd>
|
|
2195
3536
|
|
|
2196
|
-
**
|
|
3537
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to finalize a version for. All other entity ID fields are inferred from the request.
|
|
2197
3538
|
|
|
2198
3539
|
</dd>
|
|
2199
3540
|
</dl>
|
|
@@ -2201,7 +3542,7 @@ await client.inbox.get("inboxItemId", {
|
|
|
2201
3542
|
<dl>
|
|
2202
3543
|
<dd>
|
|
2203
3544
|
|
|
2204
|
-
**request:** `MavenAGI.
|
|
3545
|
+
**request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
|
|
2205
3546
|
|
|
2206
3547
|
</dd>
|
|
2207
3548
|
</dl>
|
|
@@ -2209,7 +3550,7 @@ await client.inbox.get("inboxItemId", {
|
|
|
2209
3550
|
<dl>
|
|
2210
3551
|
<dd>
|
|
2211
3552
|
|
|
2212
|
-
**requestOptions:** `
|
|
3553
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2213
3554
|
|
|
2214
3555
|
</dd>
|
|
2215
3556
|
</dl>
|
|
@@ -2220,7 +3561,7 @@ await client.inbox.get("inboxItemId", {
|
|
|
2220
3561
|
</dl>
|
|
2221
3562
|
</details>
|
|
2222
3563
|
|
|
2223
|
-
<details><summary><code>client.
|
|
3564
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">searchKnowledgeDocuments</a>({ ...params }) -> MavenAGI.KnowledgeDocumentsResponse</code></summary>
|
|
2224
3565
|
<dl>
|
|
2225
3566
|
<dd>
|
|
2226
3567
|
|
|
@@ -2232,7 +3573,7 @@ await client.inbox.get("inboxItemId", {
|
|
|
2232
3573
|
<dl>
|
|
2233
3574
|
<dd>
|
|
2234
3575
|
|
|
2235
|
-
|
|
3576
|
+
Search knowledge documents
|
|
2236
3577
|
|
|
2237
3578
|
</dd>
|
|
2238
3579
|
</dl>
|
|
@@ -2248,9 +3589,7 @@ Retrieve a suggested fix. Includes document information if the fix is a Missing
|
|
|
2248
3589
|
<dd>
|
|
2249
3590
|
|
|
2250
3591
|
```typescript
|
|
2251
|
-
await client.
|
|
2252
|
-
appId: "appId",
|
|
2253
|
-
});
|
|
3592
|
+
await client.knowledge.searchKnowledgeDocuments({});
|
|
2254
3593
|
```
|
|
2255
3594
|
|
|
2256
3595
|
</dd>
|
|
@@ -2266,15 +3605,7 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
2266
3605
|
<dl>
|
|
2267
3606
|
<dd>
|
|
2268
3607
|
|
|
2269
|
-
**
|
|
2270
|
-
|
|
2271
|
-
</dd>
|
|
2272
|
-
</dl>
|
|
2273
|
-
|
|
2274
|
-
<dl>
|
|
2275
|
-
<dd>
|
|
2276
|
-
|
|
2277
|
-
**request:** `MavenAGI.InboxItemFixRequest`
|
|
3608
|
+
**request:** `MavenAGI.KnowledgeDocumentSearchRequest`
|
|
2278
3609
|
|
|
2279
3610
|
</dd>
|
|
2280
3611
|
</dl>
|
|
@@ -2282,7 +3613,7 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
2282
3613
|
<dl>
|
|
2283
3614
|
<dd>
|
|
2284
3615
|
|
|
2285
|
-
**requestOptions:** `
|
|
3616
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2286
3617
|
|
|
2287
3618
|
</dd>
|
|
2288
3619
|
</dl>
|
|
@@ -2293,7 +3624,7 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
2293
3624
|
</dl>
|
|
2294
3625
|
</details>
|
|
2295
3626
|
|
|
2296
|
-
<details><summary><code>client.
|
|
3627
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
|
|
2297
3628
|
<dl>
|
|
2298
3629
|
<dd>
|
|
2299
3630
|
|
|
@@ -2305,8 +3636,12 @@ await client.inbox.getFix("inboxItemFixId", {
|
|
|
2305
3636
|
<dl>
|
|
2306
3637
|
<dd>
|
|
2307
3638
|
|
|
2308
|
-
|
|
3639
|
+
Create knowledge document. Requires an existing knowledge base with an in progress version. Will throw an exception if the latest version is not in progress.
|
|
2309
3640
|
|
|
3641
|
+
<Tip>
|
|
3642
|
+
This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
|
|
3643
|
+
have changed, a new document version will not be created. The existing version will be reused.
|
|
3644
|
+
</Tip>
|
|
2310
3645
|
</dd>
|
|
2311
3646
|
</dl>
|
|
2312
3647
|
</dd>
|
|
@@ -2321,8 +3656,21 @@ Apply a fix to an inbox item with a specific document.
|
|
|
2321
3656
|
<dd>
|
|
2322
3657
|
|
|
2323
3658
|
```typescript
|
|
2324
|
-
await client.
|
|
2325
|
-
|
|
3659
|
+
await client.knowledge.createKnowledgeDocument("help-center", {
|
|
3660
|
+
knowledgeDocumentId: {
|
|
3661
|
+
referenceId: "getting-started",
|
|
3662
|
+
},
|
|
3663
|
+
versionId: {
|
|
3664
|
+
type: "KNOWLEDGE_BASE_VERSION",
|
|
3665
|
+
referenceId: "versionId",
|
|
3666
|
+
appId: "maven",
|
|
3667
|
+
},
|
|
3668
|
+
contentType: "MARKDOWN",
|
|
3669
|
+
content: "## Getting started\\nThis is a getting started guide for the help center.",
|
|
3670
|
+
title: "Getting started",
|
|
3671
|
+
metadata: {
|
|
3672
|
+
category: "getting-started",
|
|
3673
|
+
},
|
|
2326
3674
|
});
|
|
2327
3675
|
```
|
|
2328
3676
|
|
|
@@ -2339,7 +3687,7 @@ await client.inbox.applyFix("inboxItemFixId", {
|
|
|
2339
3687
|
<dl>
|
|
2340
3688
|
<dd>
|
|
2341
3689
|
|
|
2342
|
-
**
|
|
3690
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base to create a document for. All other entity ID fields are inferred from the request.
|
|
2343
3691
|
|
|
2344
3692
|
</dd>
|
|
2345
3693
|
</dl>
|
|
@@ -2347,7 +3695,7 @@ await client.inbox.applyFix("inboxItemFixId", {
|
|
|
2347
3695
|
<dl>
|
|
2348
3696
|
<dd>
|
|
2349
3697
|
|
|
2350
|
-
**request:** `MavenAGI.
|
|
3698
|
+
**request:** `MavenAGI.KnowledgeDocumentRequest`
|
|
2351
3699
|
|
|
2352
3700
|
</dd>
|
|
2353
3701
|
</dl>
|
|
@@ -2355,7 +3703,7 @@ await client.inbox.applyFix("inboxItemFixId", {
|
|
|
2355
3703
|
<dl>
|
|
2356
3704
|
<dd>
|
|
2357
3705
|
|
|
2358
|
-
**requestOptions:** `
|
|
3706
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2359
3707
|
|
|
2360
3708
|
</dd>
|
|
2361
3709
|
</dl>
|
|
@@ -2366,7 +3714,7 @@ await client.inbox.applyFix("inboxItemFixId", {
|
|
|
2366
3714
|
</dl>
|
|
2367
3715
|
</details>
|
|
2368
3716
|
|
|
2369
|
-
<details><summary><code>client.
|
|
3717
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">updateKnowledgeDocument</a>(knowledgeBaseReferenceId, { ...params }) -> MavenAGI.KnowledgeDocumentResponse</code></summary>
|
|
2370
3718
|
<dl>
|
|
2371
3719
|
<dd>
|
|
2372
3720
|
|
|
@@ -2378,7 +3726,7 @@ await client.inbox.applyFix("inboxItemFixId", {
|
|
|
2378
3726
|
<dl>
|
|
2379
3727
|
<dd>
|
|
2380
3728
|
|
|
2381
|
-
|
|
3729
|
+
Not yet implemented. Update knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
|
|
2382
3730
|
|
|
2383
3731
|
</dd>
|
|
2384
3732
|
</dl>
|
|
@@ -2394,8 +3742,21 @@ Ignore a specific inbox item by its ID.
|
|
|
2394
3742
|
<dd>
|
|
2395
3743
|
|
|
2396
3744
|
```typescript
|
|
2397
|
-
await client.
|
|
2398
|
-
|
|
3745
|
+
await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
3746
|
+
knowledgeDocumentId: {
|
|
3747
|
+
referenceId: "getting-started",
|
|
3748
|
+
},
|
|
3749
|
+
versionId: {
|
|
3750
|
+
type: "KNOWLEDGE_BASE_VERSION",
|
|
3751
|
+
referenceId: "versionId",
|
|
3752
|
+
appId: "maven",
|
|
3753
|
+
},
|
|
3754
|
+
contentType: "MARKDOWN",
|
|
3755
|
+
content: "## Getting started\\nThis is a getting started guide for the help center.",
|
|
3756
|
+
title: "Getting started",
|
|
3757
|
+
metadata: {
|
|
3758
|
+
category: "getting-started",
|
|
3759
|
+
},
|
|
2399
3760
|
});
|
|
2400
3761
|
```
|
|
2401
3762
|
|
|
@@ -2412,7 +3773,7 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
2412
3773
|
<dl>
|
|
2413
3774
|
<dd>
|
|
2414
3775
|
|
|
2415
|
-
**
|
|
3776
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to update. All other entity ID fields are inferred from the request.
|
|
2416
3777
|
|
|
2417
3778
|
</dd>
|
|
2418
3779
|
</dl>
|
|
@@ -2420,7 +3781,7 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
2420
3781
|
<dl>
|
|
2421
3782
|
<dd>
|
|
2422
3783
|
|
|
2423
|
-
**request:** `MavenAGI.
|
|
3784
|
+
**request:** `MavenAGI.KnowledgeDocumentRequest`
|
|
2424
3785
|
|
|
2425
3786
|
</dd>
|
|
2426
3787
|
</dl>
|
|
@@ -2428,7 +3789,7 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
2428
3789
|
<dl>
|
|
2429
3790
|
<dd>
|
|
2430
3791
|
|
|
2431
|
-
**requestOptions:** `
|
|
3792
|
+
**requestOptions:** `Knowledge.RequestOptions`
|
|
2432
3793
|
|
|
2433
3794
|
</dd>
|
|
2434
3795
|
</dl>
|
|
@@ -2439,9 +3800,7 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
2439
3800
|
</dl>
|
|
2440
3801
|
</details>
|
|
2441
3802
|
|
|
2442
|
-
|
|
2443
|
-
|
|
2444
|
-
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">createOrUpdateKnowledgeBase</a>({ ...params }) -> MavenAGI.KnowledgeBaseResponse</code></summary>
|
|
3803
|
+
<details><summary><code>client.knowledge.<a href="/src/api/resources/knowledge/client/Client.ts">deleteKnowledgeDocument</a>(knowledgeBaseReferenceId, knowledgeDocumentReferenceId) -> void</code></summary>
|
|
2445
3804
|
<dl>
|
|
2446
3805
|
<dd>
|
|
2447
3806
|
|
|
@@ -2453,7 +3812,7 @@ await client.inbox.ignore("inboxItemId", {
|
|
|
2453
3812
|
<dl>
|
|
2454
3813
|
<dd>
|
|
2455
3814
|
|
|
2456
|
-
|
|
3815
|
+
Not yet implemented. Delete knowledge document. Requires an existing knowledge base with an in progress version of type PARTIAL. Will throw an exception if the latest version is not in progress.
|
|
2457
3816
|
|
|
2458
3817
|
</dd>
|
|
2459
3818
|
</dl>
|
|
@@ -2469,12 +3828,7 @@ Update a knowledge base or create it if it doesn't exist.
|
|
|
2469
3828
|
<dd>
|
|
2470
3829
|
|
|
2471
3830
|
```typescript
|
|
2472
|
-
await client.knowledge.
|
|
2473
|
-
knowledgeBaseId: {
|
|
2474
|
-
referenceId: "help-center",
|
|
2475
|
-
},
|
|
2476
|
-
name: "Help center",
|
|
2477
|
-
});
|
|
3831
|
+
await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started");
|
|
2478
3832
|
```
|
|
2479
3833
|
|
|
2480
3834
|
</dd>
|
|
@@ -2490,7 +3844,15 @@ await client.knowledge.createOrUpdateKnowledgeBase({
|
|
|
2490
3844
|
<dl>
|
|
2491
3845
|
<dd>
|
|
2492
3846
|
|
|
2493
|
-
**
|
|
3847
|
+
**knowledgeBaseReferenceId:** `string` — The reference ID of the knowledge base that contains the document to delete. All other entity ID fields are inferred from the request
|
|
3848
|
+
|
|
3849
|
+
</dd>
|
|
3850
|
+
</dl>
|
|
3851
|
+
|
|
3852
|
+
<dl>
|
|
3853
|
+
<dd>
|
|
3854
|
+
|
|
3855
|
+
**knowledgeDocumentReferenceId:** `string` — The reference ID of the knowledge document to delete. All other entity ID fields are inferred from the request.
|
|
2494
3856
|
|
|
2495
3857
|
</dd>
|
|
2496
3858
|
</dl>
|
|
@@ -2509,7 +3871,9 @@ await client.knowledge.createOrUpdateKnowledgeBase({
|
|
|
2509
3871
|
</dl>
|
|
2510
3872
|
</details>
|
|
2511
3873
|
|
|
2512
|
-
|
|
3874
|
+
## Organizations
|
|
3875
|
+
|
|
3876
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationTable</a>({ ...params }) -> MavenAGI.ConversationTableResponse</code></summary>
|
|
2513
3877
|
<dl>
|
|
2514
3878
|
<dd>
|
|
2515
3879
|
|
|
@@ -2521,8 +3885,12 @@ await client.knowledge.createOrUpdateKnowledgeBase({
|
|
|
2521
3885
|
<dl>
|
|
2522
3886
|
<dd>
|
|
2523
3887
|
|
|
2524
|
-
|
|
3888
|
+
Retrieves structured conversation data across all organizations, formatted as a table,
|
|
3889
|
+
allowing users to group, filter, and define specific metrics to display as columns.
|
|
2525
3890
|
|
|
3891
|
+
<Tip>
|
|
3892
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
3893
|
+
</Tip>
|
|
2526
3894
|
</dd>
|
|
2527
3895
|
</dl>
|
|
2528
3896
|
</dd>
|
|
@@ -2537,7 +3905,40 @@ Get an existing knowledge base by its supplied ID
|
|
|
2537
3905
|
<dd>
|
|
2538
3906
|
|
|
2539
3907
|
```typescript
|
|
2540
|
-
await client.
|
|
3908
|
+
await client.organizations.getConversationTable({
|
|
3909
|
+
conversationFilter: {
|
|
3910
|
+
languages: ["en", "es"],
|
|
3911
|
+
},
|
|
3912
|
+
timeGrouping: "DAY",
|
|
3913
|
+
fieldGroupings: [
|
|
3914
|
+
{
|
|
3915
|
+
field: "Category",
|
|
3916
|
+
},
|
|
3917
|
+
],
|
|
3918
|
+
columnDefinitions: [
|
|
3919
|
+
{
|
|
3920
|
+
header: "count",
|
|
3921
|
+
metric: {
|
|
3922
|
+
type: "count",
|
|
3923
|
+
},
|
|
3924
|
+
},
|
|
3925
|
+
{
|
|
3926
|
+
header: "avg_first_response_time",
|
|
3927
|
+
metric: {
|
|
3928
|
+
type: "average",
|
|
3929
|
+
targetField: "FirstResponseTime",
|
|
3930
|
+
},
|
|
3931
|
+
},
|
|
3932
|
+
{
|
|
3933
|
+
header: "percentile_handle_time",
|
|
3934
|
+
metric: {
|
|
3935
|
+
type: "percentile",
|
|
3936
|
+
targetField: "HandleTime",
|
|
3937
|
+
percentile: 25,
|
|
3938
|
+
},
|
|
3939
|
+
},
|
|
3940
|
+
],
|
|
3941
|
+
});
|
|
2541
3942
|
```
|
|
2542
3943
|
|
|
2543
3944
|
</dd>
|
|
@@ -2553,7 +3954,7 @@ await client.knowledge.getKnowledgeBase("help-center");
|
|
|
2553
3954
|
<dl>
|
|
2554
3955
|
<dd>
|
|
2555
3956
|
|
|
2556
|
-
**
|
|
3957
|
+
**request:** `MavenAGI.ConversationTableRequest`
|
|
2557
3958
|
|
|
2558
3959
|
</dd>
|
|
2559
3960
|
</dl>
|
|
@@ -2561,7 +3962,7 @@ await client.knowledge.getKnowledgeBase("help-center");
|
|
|
2561
3962
|
<dl>
|
|
2562
3963
|
<dd>
|
|
2563
3964
|
|
|
2564
|
-
**requestOptions:** `
|
|
3965
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
2565
3966
|
|
|
2566
3967
|
</dd>
|
|
2567
3968
|
</dl>
|
|
@@ -2572,7 +3973,7 @@ await client.knowledge.getKnowledgeBase("help-center");
|
|
|
2572
3973
|
</dl>
|
|
2573
3974
|
</details>
|
|
2574
3975
|
|
|
2575
|
-
<details><summary><code>client.
|
|
3976
|
+
<details><summary><code>client.organizations.<a href="/src/api/resources/organizations/client/Client.ts">getConversationChart</a>({ ...params }) -> MavenAGI.ChartResponse</code></summary>
|
|
2576
3977
|
<dl>
|
|
2577
3978
|
<dd>
|
|
2578
3979
|
|
|
@@ -2584,10 +3985,12 @@ await client.knowledge.getKnowledgeBase("help-center");
|
|
|
2584
3985
|
<dl>
|
|
2585
3986
|
<dd>
|
|
2586
3987
|
|
|
2587
|
-
|
|
2588
|
-
|
|
2589
|
-
If an existing version is in progress, then that version will be finalized in an error state.
|
|
3988
|
+
Fetches conversation data across all organizations, visualized in a chart format.
|
|
3989
|
+
Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
2590
3990
|
|
|
3991
|
+
<Tip>
|
|
3992
|
+
This endpoint requires additional permissions. Contact support to request access.
|
|
3993
|
+
</Tip>
|
|
2591
3994
|
</dd>
|
|
2592
3995
|
</dl>
|
|
2593
3996
|
</dd>
|
|
@@ -2602,16 +4005,17 @@ If an existing version is in progress, then that version will be finalized in an
|
|
|
2602
4005
|
<dd>
|
|
2603
4006
|
|
|
2604
4007
|
```typescript
|
|
2605
|
-
await client.
|
|
2606
|
-
|
|
2607
|
-
|
|
2608
|
-
|
|
2609
|
-
|
|
2610
|
-
|
|
2611
|
-
|
|
4008
|
+
await client.organizations.getConversationChart({
|
|
4009
|
+
type: "pieChart",
|
|
4010
|
+
conversationFilter: {
|
|
4011
|
+
languages: ["en", "es"],
|
|
4012
|
+
},
|
|
4013
|
+
groupBy: {
|
|
4014
|
+
field: "Category",
|
|
4015
|
+
},
|
|
4016
|
+
metric: {
|
|
4017
|
+
type: "count",
|
|
2612
4018
|
},
|
|
2613
|
-
type: "FULL",
|
|
2614
|
-
status: "IN_PROGRESS",
|
|
2615
4019
|
});
|
|
2616
4020
|
```
|
|
2617
4021
|
|
|
@@ -2628,15 +4032,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
|
2628
4032
|
<dl>
|
|
2629
4033
|
<dd>
|
|
2630
4034
|
|
|
2631
|
-
**
|
|
2632
|
-
|
|
2633
|
-
</dd>
|
|
2634
|
-
</dl>
|
|
2635
|
-
|
|
2636
|
-
<dl>
|
|
2637
|
-
<dd>
|
|
2638
|
-
|
|
2639
|
-
**request:** `MavenAGI.KnowledgeBaseVersion`
|
|
4035
|
+
**request:** `MavenAGI.ConversationChartRequest`
|
|
2640
4036
|
|
|
2641
4037
|
</dd>
|
|
2642
4038
|
</dl>
|
|
@@ -2644,7 +4040,7 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
|
2644
4040
|
<dl>
|
|
2645
4041
|
<dd>
|
|
2646
4042
|
|
|
2647
|
-
**requestOptions:** `
|
|
4043
|
+
**requestOptions:** `Organizations.RequestOptions`
|
|
2648
4044
|
|
|
2649
4045
|
</dd>
|
|
2650
4046
|
</dl>
|
|
@@ -2655,25 +4051,12 @@ await client.knowledge.createKnowledgeBaseVersion("help-center", {
|
|
|
2655
4051
|
</dl>
|
|
2656
4052
|
</details>
|
|
2657
4053
|
|
|
2658
|
-
|
|
2659
|
-
<dl>
|
|
2660
|
-
<dd>
|
|
2661
|
-
|
|
2662
|
-
#### 📝 Description
|
|
2663
|
-
|
|
2664
|
-
<dl>
|
|
2665
|
-
<dd>
|
|
4054
|
+
## Segments
|
|
2666
4055
|
|
|
4056
|
+
<details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">search</a>({ ...params }) -> MavenAGI.SegmentsSearchResponse</code></summary>
|
|
2667
4057
|
<dl>
|
|
2668
4058
|
<dd>
|
|
2669
4059
|
|
|
2670
|
-
Finalize the latest knowledge base version. Required to indicate the version is complete. Will throw an exception if the latest version is not in progress.
|
|
2671
|
-
|
|
2672
|
-
</dd>
|
|
2673
|
-
</dl>
|
|
2674
|
-
</dd>
|
|
2675
|
-
</dl>
|
|
2676
|
-
|
|
2677
4060
|
#### 🔌 Usage
|
|
2678
4061
|
|
|
2679
4062
|
<dl>
|
|
@@ -2683,14 +4066,7 @@ Finalize the latest knowledge base version. Required to indicate the version is
|
|
|
2683
4066
|
<dd>
|
|
2684
4067
|
|
|
2685
4068
|
```typescript
|
|
2686
|
-
await client.
|
|
2687
|
-
versionId: {
|
|
2688
|
-
type: "KNOWLEDGE_BASE_VERSION",
|
|
2689
|
-
referenceId: "versionId",
|
|
2690
|
-
appId: "maven",
|
|
2691
|
-
},
|
|
2692
|
-
status: "SUCCEEDED",
|
|
2693
|
-
});
|
|
4069
|
+
await client.segments.search({});
|
|
2694
4070
|
```
|
|
2695
4071
|
|
|
2696
4072
|
</dd>
|
|
@@ -2706,15 +4082,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
2706
4082
|
<dl>
|
|
2707
4083
|
<dd>
|
|
2708
4084
|
|
|
2709
|
-
**
|
|
2710
|
-
|
|
2711
|
-
</dd>
|
|
2712
|
-
</dl>
|
|
2713
|
-
|
|
2714
|
-
<dl>
|
|
2715
|
-
<dd>
|
|
2716
|
-
|
|
2717
|
-
**request:** `MavenAGI.FinalizeKnowledgeBaseVersionRequest`
|
|
4085
|
+
**request:** `MavenAGI.SegmentsSearchRequest`
|
|
2718
4086
|
|
|
2719
4087
|
</dd>
|
|
2720
4088
|
</dl>
|
|
@@ -2722,7 +4090,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
2722
4090
|
<dl>
|
|
2723
4091
|
<dd>
|
|
2724
4092
|
|
|
2725
|
-
**requestOptions:** `
|
|
4093
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
2726
4094
|
|
|
2727
4095
|
</dd>
|
|
2728
4096
|
</dl>
|
|
@@ -2733,7 +4101,7 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
2733
4101
|
</dl>
|
|
2734
4102
|
</details>
|
|
2735
4103
|
|
|
2736
|
-
<details><summary><code>client.
|
|
4104
|
+
<details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.SegmentResponse</code></summary>
|
|
2737
4105
|
<dl>
|
|
2738
4106
|
<dd>
|
|
2739
4107
|
|
|
@@ -2743,14 +4111,10 @@ await client.knowledge.finalizeKnowledgeBaseVersion("help-center", {
|
|
|
2743
4111
|
<dd>
|
|
2744
4112
|
|
|
2745
4113
|
<dl>
|
|
2746
|
-
<dd>
|
|
2747
|
-
|
|
2748
|
-
|
|
2749
|
-
|
|
2750
|
-
<Tip>
|
|
2751
|
-
This API maintains document version history. If for the same reference ID neither the `title` nor `text` fields
|
|
2752
|
-
have changed, a new document version will not be created. The existing version will be reused.
|
|
2753
|
-
</Tip>
|
|
4114
|
+
<dd>
|
|
4115
|
+
|
|
4116
|
+
Update a segment or create it if it doesn't exist.
|
|
4117
|
+
|
|
2754
4118
|
</dd>
|
|
2755
4119
|
</dl>
|
|
2756
4120
|
</dd>
|
|
@@ -2765,20 +4129,24 @@ have changed, a new document version will not be created. The existing version w
|
|
|
2765
4129
|
<dd>
|
|
2766
4130
|
|
|
2767
4131
|
```typescript
|
|
2768
|
-
await client.
|
|
2769
|
-
|
|
2770
|
-
referenceId: "
|
|
2771
|
-
},
|
|
2772
|
-
versionId: {
|
|
2773
|
-
type: "KNOWLEDGE_BASE_VERSION",
|
|
2774
|
-
referenceId: "versionId",
|
|
2775
|
-
appId: "maven",
|
|
4132
|
+
await client.segments.createOrUpdate({
|
|
4133
|
+
segmentId: {
|
|
4134
|
+
referenceId: "admin-users",
|
|
2776
4135
|
},
|
|
2777
|
-
|
|
2778
|
-
|
|
2779
|
-
|
|
2780
|
-
|
|
2781
|
-
|
|
4136
|
+
name: "Admin users",
|
|
4137
|
+
precondition: {
|
|
4138
|
+
preconditionType: "group",
|
|
4139
|
+
operator: "AND",
|
|
4140
|
+
preconditions: [
|
|
4141
|
+
{
|
|
4142
|
+
preconditionType: "user",
|
|
4143
|
+
key: "userKey",
|
|
4144
|
+
},
|
|
4145
|
+
{
|
|
4146
|
+
preconditionType: "user",
|
|
4147
|
+
key: "userKey2",
|
|
4148
|
+
},
|
|
4149
|
+
],
|
|
2782
4150
|
},
|
|
2783
4151
|
});
|
|
2784
4152
|
```
|
|
@@ -2796,15 +4164,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
2796
4164
|
<dl>
|
|
2797
4165
|
<dd>
|
|
2798
4166
|
|
|
2799
|
-
**
|
|
2800
|
-
|
|
2801
|
-
</dd>
|
|
2802
|
-
</dl>
|
|
2803
|
-
|
|
2804
|
-
<dl>
|
|
2805
|
-
<dd>
|
|
2806
|
-
|
|
2807
|
-
**request:** `MavenAGI.KnowledgeDocumentRequest`
|
|
4167
|
+
**request:** `MavenAGI.SegmentRequest`
|
|
2808
4168
|
|
|
2809
4169
|
</dd>
|
|
2810
4170
|
</dl>
|
|
@@ -2812,7 +4172,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
2812
4172
|
<dl>
|
|
2813
4173
|
<dd>
|
|
2814
4174
|
|
|
2815
|
-
**requestOptions:** `
|
|
4175
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
2816
4176
|
|
|
2817
4177
|
</dd>
|
|
2818
4178
|
</dl>
|
|
@@ -2823,7 +4183,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
2823
4183
|
</dl>
|
|
2824
4184
|
</details>
|
|
2825
4185
|
|
|
2826
|
-
<details><summary><code>client.
|
|
4186
|
+
<details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">get</a>(segmentReferenceId, { ...params }) -> MavenAGI.SegmentResponse</code></summary>
|
|
2827
4187
|
<dl>
|
|
2828
4188
|
<dd>
|
|
2829
4189
|
|
|
@@ -2835,7 +4195,7 @@ await client.knowledge.createKnowledgeDocument("help-center", {
|
|
|
2835
4195
|
<dl>
|
|
2836
4196
|
<dd>
|
|
2837
4197
|
|
|
2838
|
-
|
|
4198
|
+
Get a segment by its supplied ID
|
|
2839
4199
|
|
|
2840
4200
|
</dd>
|
|
2841
4201
|
</dl>
|
|
@@ -2851,22 +4211,7 @@ Not yet implemented. Update knowledge document. Requires an existing knowledge b
|
|
|
2851
4211
|
<dd>
|
|
2852
4212
|
|
|
2853
4213
|
```typescript
|
|
2854
|
-
await client.
|
|
2855
|
-
knowledgeDocumentId: {
|
|
2856
|
-
referenceId: "getting-started",
|
|
2857
|
-
},
|
|
2858
|
-
versionId: {
|
|
2859
|
-
type: "KNOWLEDGE_BASE_VERSION",
|
|
2860
|
-
referenceId: "versionId",
|
|
2861
|
-
appId: "maven",
|
|
2862
|
-
},
|
|
2863
|
-
contentType: "MARKDOWN",
|
|
2864
|
-
content: "## Getting started\\nThis is a getting started guide for the help center.",
|
|
2865
|
-
title: "Getting started",
|
|
2866
|
-
metadata: {
|
|
2867
|
-
category: "getting-started",
|
|
2868
|
-
},
|
|
2869
|
-
});
|
|
4214
|
+
await client.segments.get("admin-users");
|
|
2870
4215
|
```
|
|
2871
4216
|
|
|
2872
4217
|
</dd>
|
|
@@ -2882,7 +4227,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
|
2882
4227
|
<dl>
|
|
2883
4228
|
<dd>
|
|
2884
4229
|
|
|
2885
|
-
**
|
|
4230
|
+
**segmentReferenceId:** `string` — The reference ID of the segment to get. All other entity ID fields are inferred from the request.
|
|
2886
4231
|
|
|
2887
4232
|
</dd>
|
|
2888
4233
|
</dl>
|
|
@@ -2890,7 +4235,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
|
2890
4235
|
<dl>
|
|
2891
4236
|
<dd>
|
|
2892
4237
|
|
|
2893
|
-
**request:** `MavenAGI.
|
|
4238
|
+
**request:** `MavenAGI.SegmentGetRequest`
|
|
2894
4239
|
|
|
2895
4240
|
</dd>
|
|
2896
4241
|
</dl>
|
|
@@ -2898,7 +4243,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
|
2898
4243
|
<dl>
|
|
2899
4244
|
<dd>
|
|
2900
4245
|
|
|
2901
|
-
**requestOptions:** `
|
|
4246
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
2902
4247
|
|
|
2903
4248
|
</dd>
|
|
2904
4249
|
</dl>
|
|
@@ -2909,7 +4254,7 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
|
2909
4254
|
</dl>
|
|
2910
4255
|
</details>
|
|
2911
4256
|
|
|
2912
|
-
<details><summary><code>client.
|
|
4257
|
+
<details><summary><code>client.segments.<a href="/src/api/resources/segments/client/Client.ts">patch</a>(segmentReferenceId, { ...params }) -> MavenAGI.SegmentResponse</code></summary>
|
|
2913
4258
|
<dl>
|
|
2914
4259
|
<dd>
|
|
2915
4260
|
|
|
@@ -2921,7 +4266,10 @@ await client.knowledge.updateKnowledgeDocument("help-center", {
|
|
|
2921
4266
|
<dl>
|
|
2922
4267
|
<dd>
|
|
2923
4268
|
|
|
2924
|
-
|
|
4269
|
+
Update mutable segment fields
|
|
4270
|
+
|
|
4271
|
+
The `appId` field can be provided to update a segment owned by a different app.
|
|
4272
|
+
All other fields will overwrite the existing value on the segment only if provided.
|
|
2925
4273
|
|
|
2926
4274
|
</dd>
|
|
2927
4275
|
</dl>
|
|
@@ -2937,7 +4285,7 @@ Not yet implemented. Delete knowledge document. Requires an existing knowledge b
|
|
|
2937
4285
|
<dd>
|
|
2938
4286
|
|
|
2939
4287
|
```typescript
|
|
2940
|
-
await client.
|
|
4288
|
+
await client.segments.patch("segmentReferenceId", {});
|
|
2941
4289
|
```
|
|
2942
4290
|
|
|
2943
4291
|
</dd>
|
|
@@ -2953,7 +4301,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
|
|
|
2953
4301
|
<dl>
|
|
2954
4302
|
<dd>
|
|
2955
4303
|
|
|
2956
|
-
**
|
|
4304
|
+
**segmentReferenceId:** `string` — The reference ID of the segment to update. All other entity ID fields are inferred from the request.
|
|
2957
4305
|
|
|
2958
4306
|
</dd>
|
|
2959
4307
|
</dl>
|
|
@@ -2961,7 +4309,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
|
|
|
2961
4309
|
<dl>
|
|
2962
4310
|
<dd>
|
|
2963
4311
|
|
|
2964
|
-
**
|
|
4312
|
+
**request:** `MavenAGI.SegmentPatchRequest`
|
|
2965
4313
|
|
|
2966
4314
|
</dd>
|
|
2967
4315
|
</dl>
|
|
@@ -2969,7 +4317,7 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
|
|
|
2969
4317
|
<dl>
|
|
2970
4318
|
<dd>
|
|
2971
4319
|
|
|
2972
|
-
**requestOptions:** `
|
|
4320
|
+
**requestOptions:** `Segments.RequestOptions`
|
|
2973
4321
|
|
|
2974
4322
|
</dd>
|
|
2975
4323
|
</dl>
|
|
@@ -2980,9 +4328,9 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
|
|
|
2980
4328
|
</dl>
|
|
2981
4329
|
</details>
|
|
2982
4330
|
|
|
2983
|
-
##
|
|
4331
|
+
## Translations
|
|
2984
4332
|
|
|
2985
|
-
<details><summary><code>client.
|
|
4333
|
+
<details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
|
|
2986
4334
|
<dl>
|
|
2987
4335
|
<dd>
|
|
2988
4336
|
|
|
@@ -2994,12 +4342,8 @@ await client.knowledge.deleteKnowledgeDocument("help-center", "getting-started")
|
|
|
2994
4342
|
<dl>
|
|
2995
4343
|
<dd>
|
|
2996
4344
|
|
|
2997
|
-
|
|
2998
|
-
allowing users to group, filter, and define specific metrics to display as columns.
|
|
4345
|
+
Translate text from one language to another
|
|
2999
4346
|
|
|
3000
|
-
<Tip>
|
|
3001
|
-
This endpoint requires additional permissions. Contact support to request access.
|
|
3002
|
-
</Tip>
|
|
3003
4347
|
</dd>
|
|
3004
4348
|
</dl>
|
|
3005
4349
|
</dd>
|
|
@@ -3014,39 +4358,9 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
3014
4358
|
<dd>
|
|
3015
4359
|
|
|
3016
4360
|
```typescript
|
|
3017
|
-
await client.
|
|
3018
|
-
|
|
3019
|
-
|
|
3020
|
-
},
|
|
3021
|
-
timeGrouping: "DAY",
|
|
3022
|
-
fieldGroupings: [
|
|
3023
|
-
{
|
|
3024
|
-
field: "Category",
|
|
3025
|
-
},
|
|
3026
|
-
],
|
|
3027
|
-
columnDefinitions: [
|
|
3028
|
-
{
|
|
3029
|
-
header: "count",
|
|
3030
|
-
metric: {
|
|
3031
|
-
type: "count",
|
|
3032
|
-
},
|
|
3033
|
-
},
|
|
3034
|
-
{
|
|
3035
|
-
header: "avg_first_response_time",
|
|
3036
|
-
metric: {
|
|
3037
|
-
type: "average",
|
|
3038
|
-
targetField: "FirstResponseTime",
|
|
3039
|
-
},
|
|
3040
|
-
},
|
|
3041
|
-
{
|
|
3042
|
-
header: "percentile_handle_time",
|
|
3043
|
-
metric: {
|
|
3044
|
-
type: "percentile",
|
|
3045
|
-
targetField: "HandleTime",
|
|
3046
|
-
percentile: 25,
|
|
3047
|
-
},
|
|
3048
|
-
},
|
|
3049
|
-
],
|
|
4361
|
+
await client.translations.translate({
|
|
4362
|
+
text: "Hello world",
|
|
4363
|
+
targetLanguage: "es",
|
|
3050
4364
|
});
|
|
3051
4365
|
```
|
|
3052
4366
|
|
|
@@ -3063,7 +4377,7 @@ await client.organizations.getConversationTable({
|
|
|
3063
4377
|
<dl>
|
|
3064
4378
|
<dd>
|
|
3065
4379
|
|
|
3066
|
-
**request:** `MavenAGI.
|
|
4380
|
+
**request:** `MavenAGI.TranslationRequest`
|
|
3067
4381
|
|
|
3068
4382
|
</dd>
|
|
3069
4383
|
</dl>
|
|
@@ -3071,7 +4385,7 @@ await client.organizations.getConversationTable({
|
|
|
3071
4385
|
<dl>
|
|
3072
4386
|
<dd>
|
|
3073
4387
|
|
|
3074
|
-
**requestOptions:** `
|
|
4388
|
+
**requestOptions:** `Translations.RequestOptions`
|
|
3075
4389
|
|
|
3076
4390
|
</dd>
|
|
3077
4391
|
</dl>
|
|
@@ -3082,29 +4396,12 @@ await client.organizations.getConversationTable({
|
|
|
3082
4396
|
</dl>
|
|
3083
4397
|
</details>
|
|
3084
4398
|
|
|
3085
|
-
|
|
3086
|
-
<dl>
|
|
3087
|
-
<dd>
|
|
3088
|
-
|
|
3089
|
-
#### 📝 Description
|
|
3090
|
-
|
|
3091
|
-
<dl>
|
|
3092
|
-
<dd>
|
|
4399
|
+
## Triggers
|
|
3093
4400
|
|
|
4401
|
+
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
|
|
3094
4402
|
<dl>
|
|
3095
4403
|
<dd>
|
|
3096
4404
|
|
|
3097
|
-
Fetches conversation data across all organizations, visualized in a chart format.
|
|
3098
|
-
Supported chart types include pie chart, date histogram, and stacked bar charts.
|
|
3099
|
-
|
|
3100
|
-
<Tip>
|
|
3101
|
-
This endpoint requires additional permissions. Contact support to request access.
|
|
3102
|
-
</Tip>
|
|
3103
|
-
</dd>
|
|
3104
|
-
</dl>
|
|
3105
|
-
</dd>
|
|
3106
|
-
</dl>
|
|
3107
|
-
|
|
3108
4405
|
#### 🔌 Usage
|
|
3109
4406
|
|
|
3110
4407
|
<dl>
|
|
@@ -3114,18 +4411,7 @@ This endpoint requires additional permissions. Contact support to request access
|
|
|
3114
4411
|
<dd>
|
|
3115
4412
|
|
|
3116
4413
|
```typescript
|
|
3117
|
-
await client.
|
|
3118
|
-
type: "pieChart",
|
|
3119
|
-
conversationFilter: {
|
|
3120
|
-
languages: ["en", "es"],
|
|
3121
|
-
},
|
|
3122
|
-
groupBy: {
|
|
3123
|
-
field: "Category",
|
|
3124
|
-
},
|
|
3125
|
-
metric: {
|
|
3126
|
-
type: "count",
|
|
3127
|
-
},
|
|
3128
|
-
});
|
|
4414
|
+
await client.triggers.search({});
|
|
3129
4415
|
```
|
|
3130
4416
|
|
|
3131
4417
|
</dd>
|
|
@@ -3141,7 +4427,7 @@ await client.organizations.getConversationChart({
|
|
|
3141
4427
|
<dl>
|
|
3142
4428
|
<dd>
|
|
3143
4429
|
|
|
3144
|
-
**request:** `MavenAGI.
|
|
4430
|
+
**request:** `MavenAGI.EventTriggersSearchRequest`
|
|
3145
4431
|
|
|
3146
4432
|
</dd>
|
|
3147
4433
|
</dl>
|
|
@@ -3149,7 +4435,7 @@ await client.organizations.getConversationChart({
|
|
|
3149
4435
|
<dl>
|
|
3150
4436
|
<dd>
|
|
3151
4437
|
|
|
3152
|
-
**requestOptions:** `
|
|
4438
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
3153
4439
|
|
|
3154
4440
|
</dd>
|
|
3155
4441
|
</dl>
|
|
@@ -3160,9 +4446,7 @@ await client.organizations.getConversationChart({
|
|
|
3160
4446
|
</dl>
|
|
3161
4447
|
</details>
|
|
3162
4448
|
|
|
3163
|
-
|
|
3164
|
-
|
|
3165
|
-
<details><summary><code>client.translations.<a href="/src/api/resources/translations/client/Client.ts">translate</a>({ ...params }) -> MavenAGI.TranslationResponse</code></summary>
|
|
4449
|
+
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
|
|
3166
4450
|
<dl>
|
|
3167
4451
|
<dd>
|
|
3168
4452
|
|
|
@@ -3174,7 +4458,7 @@ await client.organizations.getConversationChart({
|
|
|
3174
4458
|
<dl>
|
|
3175
4459
|
<dd>
|
|
3176
4460
|
|
|
3177
|
-
|
|
4461
|
+
Update an event trigger or create it if it doesn't exist.
|
|
3178
4462
|
|
|
3179
4463
|
</dd>
|
|
3180
4464
|
</dl>
|
|
@@ -3190,9 +4474,12 @@ Translate text from one language to another
|
|
|
3190
4474
|
<dd>
|
|
3191
4475
|
|
|
3192
4476
|
```typescript
|
|
3193
|
-
await client.
|
|
3194
|
-
|
|
3195
|
-
|
|
4477
|
+
await client.triggers.createOrUpdate({
|
|
4478
|
+
triggerId: {
|
|
4479
|
+
referenceId: "store-in-snowflake",
|
|
4480
|
+
},
|
|
4481
|
+
description: "Stores conversation data in Snowflake",
|
|
4482
|
+
type: "CONVERSATION_CREATED",
|
|
3196
4483
|
});
|
|
3197
4484
|
```
|
|
3198
4485
|
|
|
@@ -3209,7 +4496,7 @@ await client.translations.translate({
|
|
|
3209
4496
|
<dl>
|
|
3210
4497
|
<dd>
|
|
3211
4498
|
|
|
3212
|
-
**request:** `MavenAGI.
|
|
4499
|
+
**request:** `MavenAGI.EventTriggerRequest`
|
|
3213
4500
|
|
|
3214
4501
|
</dd>
|
|
3215
4502
|
</dl>
|
|
@@ -3217,7 +4504,7 @@ await client.translations.translate({
|
|
|
3217
4504
|
<dl>
|
|
3218
4505
|
<dd>
|
|
3219
4506
|
|
|
3220
|
-
**requestOptions:** `
|
|
4507
|
+
**requestOptions:** `Triggers.RequestOptions`
|
|
3221
4508
|
|
|
3222
4509
|
</dd>
|
|
3223
4510
|
</dl>
|
|
@@ -3228,12 +4515,25 @@ await client.translations.translate({
|
|
|
3228
4515
|
</dl>
|
|
3229
4516
|
</details>
|
|
3230
4517
|
|
|
3231
|
-
|
|
4518
|
+
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">get</a>(triggerReferenceId) -> MavenAGI.EventTriggerResponse</code></summary>
|
|
4519
|
+
<dl>
|
|
4520
|
+
<dd>
|
|
4521
|
+
|
|
4522
|
+
#### 📝 Description
|
|
4523
|
+
|
|
4524
|
+
<dl>
|
|
4525
|
+
<dd>
|
|
3232
4526
|
|
|
3233
|
-
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">search</a>({ ...params }) -> MavenAGI.EventTriggersSearchResponse</code></summary>
|
|
3234
4527
|
<dl>
|
|
3235
4528
|
<dd>
|
|
3236
4529
|
|
|
4530
|
+
Get an event trigger by its supplied ID
|
|
4531
|
+
|
|
4532
|
+
</dd>
|
|
4533
|
+
</dl>
|
|
4534
|
+
</dd>
|
|
4535
|
+
</dl>
|
|
4536
|
+
|
|
3237
4537
|
#### 🔌 Usage
|
|
3238
4538
|
|
|
3239
4539
|
<dl>
|
|
@@ -3243,7 +4543,7 @@ await client.translations.translate({
|
|
|
3243
4543
|
<dd>
|
|
3244
4544
|
|
|
3245
4545
|
```typescript
|
|
3246
|
-
await client.triggers.
|
|
4546
|
+
await client.triggers.get("store-in-snowflake");
|
|
3247
4547
|
```
|
|
3248
4548
|
|
|
3249
4549
|
</dd>
|
|
@@ -3259,7 +4559,7 @@ await client.triggers.search({});
|
|
|
3259
4559
|
<dl>
|
|
3260
4560
|
<dd>
|
|
3261
4561
|
|
|
3262
|
-
**
|
|
4562
|
+
**triggerReferenceId:** `string` — The reference ID of the event trigger to get. All other entity ID fields are inferred from the request.
|
|
3263
4563
|
|
|
3264
4564
|
</dd>
|
|
3265
4565
|
</dl>
|
|
@@ -3278,7 +4578,7 @@ await client.triggers.search({});
|
|
|
3278
4578
|
</dl>
|
|
3279
4579
|
</details>
|
|
3280
4580
|
|
|
3281
|
-
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">
|
|
4581
|
+
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">delete</a>(triggerReferenceId) -> void</code></summary>
|
|
3282
4582
|
<dl>
|
|
3283
4583
|
<dd>
|
|
3284
4584
|
|
|
@@ -3290,7 +4590,7 @@ await client.triggers.search({});
|
|
|
3290
4590
|
<dl>
|
|
3291
4591
|
<dd>
|
|
3292
4592
|
|
|
3293
|
-
|
|
4593
|
+
Delete an event trigger
|
|
3294
4594
|
|
|
3295
4595
|
</dd>
|
|
3296
4596
|
</dl>
|
|
@@ -3306,13 +4606,7 @@ Update an event trigger or create it if it doesn't exist.
|
|
|
3306
4606
|
<dd>
|
|
3307
4607
|
|
|
3308
4608
|
```typescript
|
|
3309
|
-
await client.triggers.
|
|
3310
|
-
triggerId: {
|
|
3311
|
-
referenceId: "store-in-snowflake",
|
|
3312
|
-
},
|
|
3313
|
-
description: "Stores conversation data in Snowflake",
|
|
3314
|
-
type: "CONVERSATION_CREATED",
|
|
3315
|
-
});
|
|
4609
|
+
await client.triggers.delete("store-in-snowflake");
|
|
3316
4610
|
```
|
|
3317
4611
|
|
|
3318
4612
|
</dd>
|
|
@@ -3328,7 +4622,7 @@ await client.triggers.createOrUpdate({
|
|
|
3328
4622
|
<dl>
|
|
3329
4623
|
<dd>
|
|
3330
4624
|
|
|
3331
|
-
**
|
|
4625
|
+
**triggerReferenceId:** `string` — The reference ID of the event trigger to delete. All other entity ID fields are inferred from the request.
|
|
3332
4626
|
|
|
3333
4627
|
</dd>
|
|
3334
4628
|
</dl>
|
|
@@ -3347,7 +4641,7 @@ await client.triggers.createOrUpdate({
|
|
|
3347
4641
|
</dl>
|
|
3348
4642
|
</details>
|
|
3349
4643
|
|
|
3350
|
-
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">
|
|
4644
|
+
<details><summary><code>client.triggers.<a href="/src/api/resources/triggers/client/Client.ts">partialUpdate</a>(triggerReferenceId, { ...params }) -> MavenAGI.EventTriggerResponse</code></summary>
|
|
3351
4645
|
<dl>
|
|
3352
4646
|
<dd>
|
|
3353
4647
|
|
|
@@ -3359,7 +4653,7 @@ await client.triggers.createOrUpdate({
|
|
|
3359
4653
|
<dl>
|
|
3360
4654
|
<dd>
|
|
3361
4655
|
|
|
3362
|
-
|
|
4656
|
+
Updates an event trigger. Only the enabled field is editable.
|
|
3363
4657
|
|
|
3364
4658
|
</dd>
|
|
3365
4659
|
</dl>
|
|
@@ -3375,7 +4669,9 @@ Get an event trigger by its supplied ID
|
|
|
3375
4669
|
<dd>
|
|
3376
4670
|
|
|
3377
4671
|
```typescript
|
|
3378
|
-
await client.triggers.
|
|
4672
|
+
await client.triggers.partialUpdate("triggerReferenceId", {
|
|
4673
|
+
body: {},
|
|
4674
|
+
});
|
|
3379
4675
|
```
|
|
3380
4676
|
|
|
3381
4677
|
</dd>
|
|
@@ -3391,7 +4687,15 @@ await client.triggers.get("store-in-snowflake");
|
|
|
3391
4687
|
<dl>
|
|
3392
4688
|
<dd>
|
|
3393
4689
|
|
|
3394
|
-
**triggerReferenceId:** `string` — The reference ID of the event trigger to
|
|
4690
|
+
**triggerReferenceId:** `string` — The reference ID of the event trigger to update. All other entity ID fields are inferred from the request.
|
|
4691
|
+
|
|
4692
|
+
</dd>
|
|
4693
|
+
</dl>
|
|
4694
|
+
|
|
4695
|
+
<dl>
|
|
4696
|
+
<dd>
|
|
4697
|
+
|
|
4698
|
+
**request:** `MavenAGI.PartialUpdateRequest`
|
|
3395
4699
|
|
|
3396
4700
|
</dd>
|
|
3397
4701
|
</dl>
|
|
@@ -3410,7 +4714,9 @@ await client.triggers.get("store-in-snowflake");
|
|
|
3410
4714
|
</dl>
|
|
3411
4715
|
</details>
|
|
3412
4716
|
|
|
3413
|
-
|
|
4717
|
+
## Users
|
|
4718
|
+
|
|
4719
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">search</a>({ ...params }) -> MavenAGI.AgentUserSearchResponse</code></summary>
|
|
3414
4720
|
<dl>
|
|
3415
4721
|
<dd>
|
|
3416
4722
|
|
|
@@ -3422,7 +4728,9 @@ await client.triggers.get("store-in-snowflake");
|
|
|
3422
4728
|
<dl>
|
|
3423
4729
|
<dd>
|
|
3424
4730
|
|
|
3425
|
-
|
|
4731
|
+
Search across all agent users on an agent.
|
|
4732
|
+
|
|
4733
|
+
Agent users are a merged view of the users created by individual apps.
|
|
3426
4734
|
|
|
3427
4735
|
</dd>
|
|
3428
4736
|
</dl>
|
|
@@ -3438,7 +4746,7 @@ Delete an event trigger
|
|
|
3438
4746
|
<dd>
|
|
3439
4747
|
|
|
3440
4748
|
```typescript
|
|
3441
|
-
await client.
|
|
4749
|
+
await client.users.search({});
|
|
3442
4750
|
```
|
|
3443
4751
|
|
|
3444
4752
|
</dd>
|
|
@@ -3454,7 +4762,7 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
3454
4762
|
<dl>
|
|
3455
4763
|
<dd>
|
|
3456
4764
|
|
|
3457
|
-
**
|
|
4765
|
+
**request:** `MavenAGI.AgentUserSearchRequest`
|
|
3458
4766
|
|
|
3459
4767
|
</dd>
|
|
3460
4768
|
</dl>
|
|
@@ -3462,7 +4770,7 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
3462
4770
|
<dl>
|
|
3463
4771
|
<dd>
|
|
3464
4772
|
|
|
3465
|
-
**requestOptions:** `
|
|
4773
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3466
4774
|
|
|
3467
4775
|
</dd>
|
|
3468
4776
|
</dl>
|
|
@@ -3473,7 +4781,7 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
3473
4781
|
</dl>
|
|
3474
4782
|
</details>
|
|
3475
4783
|
|
|
3476
|
-
<details><summary><code>client.
|
|
4784
|
+
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">getAgentUser</a>(userId) -> MavenAGI.AgentUser</code></summary>
|
|
3477
4785
|
<dl>
|
|
3478
4786
|
<dd>
|
|
3479
4787
|
|
|
@@ -3485,7 +4793,9 @@ await client.triggers.delete("store-in-snowflake");
|
|
|
3485
4793
|
<dl>
|
|
3486
4794
|
<dd>
|
|
3487
4795
|
|
|
3488
|
-
|
|
4796
|
+
Get an agent user by its supplied ID.
|
|
4797
|
+
|
|
4798
|
+
Agent users are a merged view of the users created by individual apps.
|
|
3489
4799
|
|
|
3490
4800
|
</dd>
|
|
3491
4801
|
</dl>
|
|
@@ -3501,9 +4811,7 @@ Updates an event trigger. Only the enabled field is editable.
|
|
|
3501
4811
|
<dd>
|
|
3502
4812
|
|
|
3503
4813
|
```typescript
|
|
3504
|
-
await client.
|
|
3505
|
-
body: {},
|
|
3506
|
-
});
|
|
4814
|
+
await client.users.getAgentUser("userId");
|
|
3507
4815
|
```
|
|
3508
4816
|
|
|
3509
4817
|
</dd>
|
|
@@ -3519,15 +4827,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
3519
4827
|
<dl>
|
|
3520
4828
|
<dd>
|
|
3521
4829
|
|
|
3522
|
-
**
|
|
3523
|
-
|
|
3524
|
-
</dd>
|
|
3525
|
-
</dl>
|
|
3526
|
-
|
|
3527
|
-
<dl>
|
|
3528
|
-
<dd>
|
|
3529
|
-
|
|
3530
|
-
**request:** `MavenAGI.PartialUpdateRequest`
|
|
4830
|
+
**userId:** `string` — The ID of the agent user to get.
|
|
3531
4831
|
|
|
3532
4832
|
</dd>
|
|
3533
4833
|
</dl>
|
|
@@ -3535,7 +4835,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
3535
4835
|
<dl>
|
|
3536
4836
|
<dd>
|
|
3537
4837
|
|
|
3538
|
-
**requestOptions:** `
|
|
4838
|
+
**requestOptions:** `Users.RequestOptions`
|
|
3539
4839
|
|
|
3540
4840
|
</dd>
|
|
3541
4841
|
</dl>
|
|
@@ -3546,8 +4846,6 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
3546
4846
|
</dl>
|
|
3547
4847
|
</details>
|
|
3548
4848
|
|
|
3549
|
-
## Users
|
|
3550
|
-
|
|
3551
4849
|
<details><summary><code>client.users.<a href="/src/api/resources/users/client/Client.ts">createOrUpdate</a>({ ...params }) -> MavenAGI.AppUserResponse</code></summary>
|
|
3552
4850
|
<dl>
|
|
3553
4851
|
<dd>
|
|
@@ -3560,7 +4858,7 @@ await client.triggers.partialUpdate("triggerReferenceId", {
|
|
|
3560
4858
|
<dl>
|
|
3561
4859
|
<dd>
|
|
3562
4860
|
|
|
3563
|
-
Update
|
|
4861
|
+
Update an app user or create it if it doesn't exist.
|
|
3564
4862
|
|
|
3565
4863
|
</dd>
|
|
3566
4864
|
</dl>
|
|
@@ -3580,12 +4878,12 @@ await client.users.createOrUpdate({
|
|
|
3580
4878
|
userId: {
|
|
3581
4879
|
referenceId: "user-0",
|
|
3582
4880
|
},
|
|
3583
|
-
identifiers:
|
|
4881
|
+
identifiers: [
|
|
3584
4882
|
{
|
|
3585
4883
|
value: "joe@myapp.com",
|
|
3586
4884
|
type: "EMAIL",
|
|
3587
4885
|
},
|
|
3588
|
-
]
|
|
4886
|
+
],
|
|
3589
4887
|
data: {
|
|
3590
4888
|
name: {
|
|
3591
4889
|
value: "Joe",
|
|
@@ -3639,7 +4937,7 @@ await client.users.createOrUpdate({
|
|
|
3639
4937
|
<dl>
|
|
3640
4938
|
<dd>
|
|
3641
4939
|
|
|
3642
|
-
Get
|
|
4940
|
+
Get an app user by its supplied ID
|
|
3643
4941
|
|
|
3644
4942
|
</dd>
|
|
3645
4943
|
</dl>
|
|
@@ -3671,7 +4969,7 @@ await client.users.get("user-0");
|
|
|
3671
4969
|
<dl>
|
|
3672
4970
|
<dd>
|
|
3673
4971
|
|
|
3674
|
-
**userId:** `string` — The reference ID of the user to get. All other entity ID fields are inferred from the request.
|
|
4972
|
+
**userId:** `string` — The reference ID of the app user to get. All other entity ID fields are inferred from the request.
|
|
3675
4973
|
|
|
3676
4974
|
</dd>
|
|
3677
4975
|
</dl>
|
|
@@ -3747,7 +5045,7 @@ await client.users.delete("user-0");
|
|
|
3747
5045
|
<dl>
|
|
3748
5046
|
<dd>
|
|
3749
5047
|
|
|
3750
|
-
**userId:** `string` — The reference ID of the user to delete. All other entity ID fields are inferred from the request.
|
|
5048
|
+
**userId:** `string` — The reference ID of the app user to delete. All other entity ID fields are inferred from the request.
|
|
3751
5049
|
|
|
3752
5050
|
</dd>
|
|
3753
5051
|
</dl>
|