From 3461b4f03f8deecffb193e740d65a3af14b26b2a Mon Sep 17 00:00:00 2001 From: "docsreference@microsoft.com" Date: Mon, 20 Jul 2026 17:37:57 +0000 Subject: [PATCH 1/3] CI Update Build.Reason:Manual by Sai Cai (BEYONDSOFT CONSULTING INC) Build.Url:https://apidrop.visualstudio.com/Content%20CI/_build/results?buildId=618243&view=results --- .../@microsoft/teams-ai/AI.yml | 423 ------- .../@microsoft/teams-ai/AIOptions.yml | 131 -- .../teams-ai/ActionAugmentationSection.yml | 199 --- .../@microsoft/teams-ai/ActionHandler.yml | 15 - .../teams-ai/ActionOutputMessage.yml | 148 --- .../@microsoft/teams-ai/ActionPlanner.yml | 256 ---- .../teams-ai/ActionPlannerOptions.yml | 144 --- .../teams-ai/ActionPlannerPromptFactory.yml | 14 - .../teams-ai/ActionResponseValidator.yml | 86 -- .../@microsoft/teams-ai/AdaptiveCard.yml | 22 - .../AdaptiveCardActionExecuteResponseType.yml | 30 - .../teams-ai/AdaptiveCardSearchResult.yml | 34 - .../@microsoft/teams-ai/AdaptiveCards.yml | 141 --- .../teams-ai/AdaptiveCardsOptions.yml | 49 - .../teams-ai/AdaptiveCardsSearchParams.yml | 34 - .../@microsoft/teams-ai/Application.yml | 911 -------------- .../teams-ai/ApplicationBuilder.yml | 187 --- .../teams-ai/ApplicationOptions.yml | 187 --- .../@microsoft/teams-ai/AssistantMessage.yml | 185 --- .../@microsoft/teams-ai/Augmentation.yml | 87 -- .../teams-ai/AugmentationConfig.yml | 36 - .../@microsoft/teams-ai/AuthError.yml | 217 ---- .../@microsoft/teams-ai/AuthErrorReason.yml | 16 - .../@microsoft/teams-ai/Authentication.yml | 169 --- .../teams-ai/AuthenticationManager.yml | 111 -- .../teams-ai/AuthenticationOptions.yml | 62 - .../teams-ai/AuthenticatorResult.yml | 36 - .../teams-ai/AzureContentSafetyModerator.yml | 88 -- .../teams-ai/AzureOpenAIEmbeddingsOptions.yml | 126 -- .../teams-ai/AzureOpenAIModelOptions.yml | 224 ---- .../teams-ai/AzureOpenAIModeratorOptions.yml | 176 --- .../teams-ai/BaseOpenAIEmbeddingsOptions.yml | 62 - .../teams-ai/BaseOpenAIModelOptions.yml | 131 -- .../teams-ai/ChatCompletionAction.yml | 55 - .../@microsoft/teams-ai/Citation.yml | 58 - .../teams-ai/ConfiguredAIOptions.yml | 102 -- .../teams-ai/ConfiguredLLMClientOptions.yml | 122 -- .../ConfiguredPromptManagerOptions.yml | 71 -- .../teams-ai/ConversationHistory.yml | 175 --- .../teams-ai/ConversationUpdateEvents.yml | 24 - .../@microsoft/teams-ai/DataSource.yml | 53 - .../@microsoft/teams-ai/DataSourceSection.yml | 148 --- .../teams-ai/DefaultAugmentation.yml | 82 -- .../teams-ai/DefaultConversationState.yml | 13 - .../@microsoft/teams-ai/DefaultModerator.yml | 55 - .../teams-ai/DefaultResponseValidator.yml | 44 - .../@microsoft/teams-ai/DefaultTempState.yml | 86 -- .../@microsoft/teams-ai/DefaultUserState.yml | 13 - .../teams-ai/EEMethodReturnType.yml | 12 - .../@microsoft/teams-ai/EmitEventNames.yml | 10 - .../@microsoft/teams-ai/EventNames.yml | 12 - .../@microsoft/teams-ai/FeedbackLoopData.yml | 52 - .../@microsoft/teams-ai/FunctionCall.yml | 34 - .../teams-ai/FunctionCallMessage.yml | 172 --- .../teams-ai/FunctionResponseMessage.yml | 184 --- .../@microsoft/teams-ai/GPT3Tokenizer.yml | 40 - .../@microsoft/teams-ai/GPTTokenizer.yml | 42 - .../@microsoft/teams-ai/GroupSection.yml | 191 --- .../@microsoft/teams-ai/ImageContentPart.yml | 34 - .../teams-ai/InnerEEMethodReturnType.yml | 15 - .../@microsoft/teams-ai/InputFile.yml | 46 - .../teams-ai/InputFileDownloader.yml | 32 - .../teams-ai/JSONResponseValidator.yml | 106 -- .../@microsoft/teams-ai/LLMClient.yml | 236 ---- .../@microsoft/teams-ai/LLMClientOptions.yml | 196 --- .../@microsoft/teams-ai/LayoutEngine.yml | 93 -- .../@microsoft/teams-ai/ListenerType.yml | 14 - .../@microsoft/teams-ai/LlamaModel.yml | 68 - .../@microsoft/teams-ai/LlamaModelOptions.yml | 46 - .../@microsoft/teams-ai/MatchingKeys.yml | 14 - .../@microsoft/teams-ai/Memory.yml | 75 -- .../@microsoft/teams-ai/MemoryFork.yml | 92 -- .../@microsoft/teams-ai/Message.yml | 99 -- .../teams-ai/MessageContentParts.yml | 10 - .../@microsoft/teams-ai/MessageContext.yml | 34 - .../@microsoft/teams-ai/MessageExtensions.yml | 386 ------ .../teams-ai/MessageExtensionsInvokeNames.yml | 46 - .../teams-ai/MessageReactionEvents.yml | 10 - .../teams-ai/ModerationSeverity.yml | 29 - .../@microsoft/teams-ai/Moderator.yml | 96 -- .../teams-ai/MonologueAugmentation.yml | 98 -- .../@microsoft/teams-ai/NoUndefined.yml | 10 - .../@microsoft/teams-ai/OAuthSettings.yml | 13 - .../@microsoft/teams-ai/OnEventNames.yml | 10 - .../@microsoft/teams-ai/OpenAIEmbeddings.yml | 67 - .../teams-ai/OpenAIEmbeddingsOptions.yml | 128 -- .../teams-ai/OpenAILikeEmbeddingsOptions.yml | 118 -- .../@microsoft/teams-ai/OpenAIModel.yml | 115 -- .../teams-ai/OpenAIModelOptions.yml | 222 ---- .../@microsoft/teams-ai/OpenAIModerator.yml | 87 -- .../teams-ai/OpenAIModeratorOptions.yml | 82 -- .../@microsoft/teams-ai/OverriddenKeys.yml | 10 - .../@microsoft/teams-ai/OverriddenMethods.yml | 24 - .../@microsoft/teams-ai/Plan.yml | 34 - .../@microsoft/teams-ai/Planner.yml | 82 -- .../@microsoft/teams-ai/PredictedCommand.yml | 26 - .../teams-ai/PredictedDoCommand.yml | 63 - .../teams-ai/PredictedDoCommandAndHandler.yml | 92 -- .../teams-ai/PredictedSayCommand.yml | 35 - .../@microsoft/teams-ai/Prompt.yml | 106 -- .../@microsoft/teams-ai/PromptChunk.yml | 24 - .../teams-ai/PromptCompletionModel.yml | 55 - ...ptCompletionModelBeforeCompletionEvent.yml | 17 - ...romptCompletionModelChunkReceivedEvent.yml | 14 - .../teams-ai/PromptCompletionModelEmitter.yml | 15 - .../teams-ai/PromptCompletionModelEvents.yml | 58 - ...ptCompletionModelResponseReceivedEvent.yml | 15 - .../@microsoft/teams-ai/PromptFunction.yml | 16 - .../@microsoft/teams-ai/PromptFunctions.yml | 69 -- .../@microsoft/teams-ai/PromptManager.yml | 233 ---- .../teams-ai/PromptManagerOptions.yml | 95 -- .../teams-ai/PromptResponseValidator.yml | 44 - .../@microsoft/teams-ai/PromptSection.yml | 109 -- .../@microsoft/teams-ai/PromptSectionBase.yml | 177 --- .../@microsoft/teams-ai/PromptTemplate.yml | 70 -- .../teams-ai/PromptTemplateConfig.yml | 87 -- .../@microsoft/teams-ai/Query.yml | 46 - .../teams-ai/RenderedPromptSection.yml | 48 - .../teams-ai/ReturnTypeOfMethod.yml | 12 - .../teams-ai/ReturnTypeOfMethodIfExists.yml | 12 - .../@microsoft/teams-ai/RouteHandler.yml | 13 - .../@microsoft/teams-ai/RouteSelector.yml | 10 - .../@microsoft/teams-ai/Selector.yml | 10 - .../teams-ai/SequenceAugmentation.yml | 95 -- .../@microsoft/teams-ai/SignInResponse.yml | 14 - .../@microsoft/teams-ai/SignInStatus.yml | 16 - .../@microsoft/teams-ai/StreamingResponse.yml | 213 ---- .../@microsoft/teams-ai/StrictBroadcast.yml | 13 - .../teams-ai/StrictEventEmitter.yml | 23 - .../@microsoft/teams-ai/SystemMessage.yml | 178 --- .../teams-ai/TaskModuleInvokeNames.yml | 29 - .../@microsoft/teams-ai/TaskModules.yml | 139 --- .../teams-ai/TaskModulesOptions.yml | 29 - .../@microsoft/teams-ai/TeamsAdapter.yml | 442 ------- .../teams-ai/TeamsAttachmentDownloader.yml | 43 - .../TeamsAttachmentDownloaderOptions.yml | 34 - .../teams-ai/TeamsMessageEvents.yml | 13 - .../@microsoft/teams-ai/TemplateSection.yml | 210 ---- .../@microsoft/teams-ai/TestModel.yml | 200 --- .../@microsoft/teams-ai/TextContentPart.yml | 34 - .../@microsoft/teams-ai/TextDataSource.yml | 73 -- .../@microsoft/teams-ai/TextSection.yml | 189 --- .../@microsoft/teams-ai/Tokenizer.yml | 42 - .../@microsoft/teams-ai/ToolsAugmentation.yml | 97 -- .../@microsoft/teams-ai/TurnEvents.yml | 26 - .../@microsoft/teams-ai/TurnState.yml | 206 ---- .../@microsoft/teams-ai/TurnStateEntry.yml | 99 -- .../@microsoft/teams-ai/TypeRecord.yml | 46 - .../@microsoft/teams-ai/UserInputMessage.yml | 157 --- .../@microsoft/teams-ai/UserMessage.yml | 183 --- .../@microsoft/teams-ai/Utilities.yml | 95 -- .../ValidatedChatCompletionAction.yml | 34 - .../@microsoft/teams-ai/Validation.yml | 66 - .../@microsoft/teams-ai/VoidKeys.yml | 10 - .../@microsoft/teams-ai/index.yml | 165 --- .../teams-ai/preview.AssistantsPlanner.yml | 141 --- .../preview.AssistantsPlannerOptions.yml | 85 -- .../@microsoft/teams-ai/preview.yml | 10 - .../teamsfx-react/BaseDashboard.yml | 623 ---------- .../@microsoft/teamsfx-react/BaseWidget.yml | 712 ----------- .../teamsfx-react/IWidgetClassNames.yml | 58 - .../TeamsContextWithCredential.yml | 18 - .../@microsoft/teamsfx-react/index.yml | 111 -- .../teamsfx/AdaptiveCardResponse.yml | 31 - ...lderCloudAdapter.BotSsoExecutionDialog.yml | 504 -------- ...AgentBuilderCloudAdapter.CardActionBot.yml | 69 -- .../AgentBuilderCloudAdapter.Channel.yml | 149 --- .../AgentBuilderCloudAdapter.CommandBot.yml | 111 -- ...entBuilderCloudAdapter.ConversationBot.yml | 228 ---- ...uilderCloudAdapter.ConversationOptions.yml | 108 -- .../AgentBuilderCloudAdapter.Member.yml | 142 --- ...entBuilderCloudAdapter.NotificationBot.yml | 263 ---- ...uilderCloudAdapter.NotificationOptions.yml | 49 - .../AgentBuilderCloudAdapter.SearchScope.yml | 43 - ...ilderCloudAdapter.TeamsBotInstallation.yml | 214 ---- .../teamsfx/AgentBuilderCloudAdapter.yml | 89 -- .../@microsoft/teamsfx/ApiKeyLocation.yml | 22 - .../@microsoft/teamsfx/ApiKeyProvider.yml | 63 - .../@microsoft/teamsfx/AppCredential.yml | 101 -- .../teamsfx/AppCredentialAuthConfig.yml | 13 - .../@microsoft/teamsfx/AuthProvider.yml | 33 - .../@microsoft/teamsfx/AxiosInstance.yml | 349 ------ .../@microsoft/teamsfx/BasicAuthProvider.yml | 58 - .../teamsfx/BearerTokenAuthProvider.yml | 57 - .../@microsoft/teamsfx/BotSsoConfig.yml | 47 - .../BotSsoExecutionActivityHandler.yml | 133 -- .../teamsfx/BotSsoExecutionDialog.yml | 489 -------- .../teamsfx/BotSsoExecutionDialogHandler.yml | 17 - .../@microsoft/teamsfx/CardActionOptions.yml | 31 - .../teamsfx/CertificateAuthProvider.yml | 55 - .../@microsoft/teamsfx/CommandMessage.yml | 41 - .../@microsoft/teamsfx/CommandOptions.yml | 47 - .../teamsfx/ConversationReferenceStore.yml | 89 -- .../ConversationReferenceStoreAddOptions.yml | 25 - .../@microsoft/teamsfx/ErrorCode.yml | 88 -- .../@microsoft/teamsfx/ErrorWithCode.yml | 224 ---- .../teamsfx/GetTeamsUserTokenOptions.yml | 128 -- .../teamsfx/InvokeResponseErrorCode.yml | 22 - .../teamsfx/InvokeResponseFactory.yml | 151 --- .../@microsoft/teamsfx/LogFunction.yml | 13 - .../@microsoft/teamsfx/LogLevel.yml | 32 - .../@microsoft/teamsfx/Logger.yml | 61 - .../@microsoft/teamsfx/MessageBuilder.yml | 268 ---- .../teamsfx/MessageExtensionTokenResponse.yml | 97 -- .../@microsoft/teamsfx/NotificationTarget.yml | 76 -- .../teamsfx/NotificationTargetType.yml | 34 - .../OnBehalfOfCredentialAuthConfig.yml | 20 - .../teamsfx/OnBehalfOfUserCredential.yml | 136 -- .../@microsoft/teamsfx/PagedData.yml | 37 - .../@microsoft/teamsfx/TeamsBotSsoPrompt.yml | 441 ------- .../teamsfx/TeamsBotSsoPromptSettings.yml | 65 - .../TeamsBotSsoPromptTokenResponse.yml | 97 -- .../TeamsFxAdaptiveCardActionHandler.yml | 91 -- .../teamsfx/TeamsFxBotCommandHandler.yml | 55 - .../teamsfx/TeamsFxBotSsoCommandHandler.yml | 63 - .../teamsfx/TeamsUserCredential.yml | 99 -- .../teamsfx/TeamsUserCredentialAuthConfig.yml | 18 - .../@microsoft/teamsfx/TriggerPatterns.yml | 16 - .../@microsoft/teamsfx/UserInfo.yml | 61 - .../@microsoft/teamsfx/index.yml | 348 ------ nodejs/docs-ref-autogen/toc.yml | 1095 ----------------- 221 files changed, 23512 deletions(-) delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AI.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AIOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionAugmentationSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionOutputMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlanner.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerPromptFactory.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionResponseValidator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCard.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardActionExecuteResponseType.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardSearchResult.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCards.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsSearchParams.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Application.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationBuilder.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AssistantMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Augmentation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AugmentationConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthError.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthErrorReason.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Authentication.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationManager.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticatorResult.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureContentSafetyModerator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIEmbeddingsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModelOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModeratorOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIEmbeddingsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIModelOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ChatCompletionAction.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Citation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredAIOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredLLMClientOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredPromptManagerOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationHistory.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationUpdateEvents.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSource.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSourceSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultAugmentation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultConversationState.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultModerator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultResponseValidator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultTempState.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultUserState.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/EEMethodReturnType.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/EmitEventNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/EventNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/FeedbackLoopData.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCall.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCallMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionResponseMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/GPT3Tokenizer.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/GPTTokenizer.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/GroupSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ImageContentPart.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/InnerEEMethodReturnType.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFile.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFileDownloader.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/JSONResponseValidator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClient.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClientOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/LayoutEngine.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ListenerType.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModelOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MatchingKeys.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Memory.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MemoryFork.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Message.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContentParts.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContext.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensionsInvokeNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageReactionEvents.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ModerationSeverity.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Moderator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/MonologueAugmentation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/NoUndefined.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OAuthSettings.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OnEventNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddings.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddingsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAILikeEmbeddingsOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModelOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModerator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModeratorOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenKeys.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenMethods.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Plan.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Planner.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedCommand.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommand.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommandAndHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedSayCommand.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Prompt.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptChunk.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelBeforeCompletionEvent.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelChunkReceivedEvent.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEmitter.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEvents.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelResponseReceivedEvent.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunction.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunctions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManager.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManagerOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptResponseValidator.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSectionBase.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplate.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplateConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Query.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/RenderedPromptSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethod.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethodIfExists.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteSelector.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Selector.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/SequenceAugmentation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInResponse.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInStatus.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/StreamingResponse.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictBroadcast.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictEventEmitter.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/SystemMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModuleInvokeNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModules.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModulesOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAdapter.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloader.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloaderOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsMessageEvents.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TemplateSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TestModel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TextContentPart.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TextDataSource.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TextSection.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Tokenizer.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ToolsAugmentation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnEvents.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnState.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnStateEntry.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/TypeRecord.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/UserInputMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/UserMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Utilities.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/ValidatedChatCompletionAction.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/Validation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/VoidKeys.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/index.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlanner.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlannerOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseDashboard.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseWidget.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx-react/IWidgetClassNames.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx-react/TeamsContextWithCredential.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx-react/index.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AdaptiveCardResponse.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.BotSsoExecutionDialog.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CardActionBot.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Channel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CommandBot.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationBot.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Member.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationBot.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.SearchScope.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.TeamsBotInstallation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyLocation.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyProvider.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredential.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredentialAuthConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AuthProvider.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/AxiosInstance.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BasicAuthProvider.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BearerTokenAuthProvider.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionActivityHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialog.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialogHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/CardActionOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/CertificateAuthProvider.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandMessage.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStore.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStoreAddOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorCode.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorWithCode.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/GetTeamsUserTokenOptions.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseErrorCode.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseFactory.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/LogFunction.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/LogLevel.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/Logger.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageBuilder.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageExtensionTokenResponse.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTarget.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTargetType.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfCredentialAuthConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfUserCredential.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/PagedData.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPrompt.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptSettings.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptTokenResponse.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxAdaptiveCardActionHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotCommandHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotSsoCommandHandler.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredential.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredentialAuthConfig.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/TriggerPatterns.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/UserInfo.yml delete mode 100644 nodejs/docs-ref-autogen/@microsoft/teamsfx/index.yml diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AI.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AI.yml deleted file mode 100644 index bd67e1a9..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AI.yml +++ /dev/null @@ -1,423 +0,0 @@ -### YamlMime:TSType -name: AI -uid: '@microsoft/teams-ai.AI' -package: '@microsoft/teams-ai' -summary: AI System. -fullName: AI -remarks: >- - The AI system is responsible for generating plans, moderating input and - output, and - - generating prompts. It can be used free standing or routed to by the - Application object. -isDeprecated: false -type: class -constructors: - - name: AI(AIOptions) - uid: '@microsoft/teams-ai.AI.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new AI system. - remarks: '' - isDeprecated: false - syntax: - content: 'new AI(options: AIOptions)' - parameters: - - id: options - type: <TState> - description: The options used to configure the AI system. -properties: - - name: DoCommandActionName - uid: '@microsoft/teams-ai.AI.DoCommandActionName' - package: '@microsoft/teams-ai' - summary: An action that is called to DO an action. - fullName: DoCommandActionName - remarks: >- - The action system is used to do other actions. Overriding this action lets - you customize the - - execution of an individual action. You can use it to log actions being - used or to prevent - - certain actions from being executed based on policy. - - - The default behavior is to simply execute the action handler passed in so - you will need to - - perform that logic yourself should you override this action. - isDeprecated: false - syntax: - content: 'static DoCommandActionName: "___DO___" = "___DO___"' - return: - description: '' - type: '"___DO___"' - - name: enableFeedbackLoop - uid: '@microsoft/teams-ai.AI.enableFeedbackLoop' - package: '@microsoft/teams-ai' - summary: '' - fullName: enableFeedbackLoop - remarks: '' - isDeprecated: false - syntax: - content: boolean enableFeedbackLoop - return: - description: Returns the feedback loop flag. - type: boolean - - name: feedbackLoopType - uid: '@microsoft/teams-ai.AI.feedbackLoopType' - package: '@microsoft/teams-ai' - summary: '' - fullName: feedbackLoopType - remarks: '' - isDeprecated: false - syntax: - content: undefined | "default" | "custom" feedbackLoopType - return: - description: Returns the feedback loop type. - type: undefined | "default" | "custom" - - name: FlaggedInputActionName - uid: '@microsoft/teams-ai.AI.FlaggedInputActionName' - package: '@microsoft/teams-ai' - summary: >- - An action that will be called anytime an input is flagged by the - moderator. - fullName: FlaggedInputActionName - remarks: >- - The default behavior is to simply log an error to the console. Override to - send a custom - - message to the user. - isDeprecated: false - syntax: - content: >- - static FlaggedInputActionName: "___FlaggedInput___" = - "___FlaggedInput___" - return: - description: '' - type: '"___FlaggedInput___"' - - name: FlaggedOutputActionName - uid: '@microsoft/teams-ai.AI.FlaggedOutputActionName' - package: '@microsoft/teams-ai' - summary: >- - An action that will be called anytime an output is flagged by the - moderator. - fullName: FlaggedOutputActionName - remarks: >- - The default behavior is to simply log an error to the console. Override to - send a custom - - message to the user. - isDeprecated: false - syntax: - content: >- - static FlaggedOutputActionName: "___FlaggedOutput___" = - "___FlaggedOutput___" - return: - description: '' - type: '"___FlaggedOutput___"' - - name: HttpErrorActionName - uid: '@microsoft/teams-ai.AI.HttpErrorActionName' - package: '@microsoft/teams-ai' - summary: >- - An action that will be called anytime the planner encounters an HTTP - response with - - status code >= `400`. - fullName: HttpErrorActionName - remarks: '' - isDeprecated: false - syntax: - content: 'static HttpErrorActionName: "___HttpError___" = "___HttpError___"' - return: - description: '' - type: '"___HttpError___"' - - name: moderator - uid: '@microsoft/teams-ai.AI.moderator' - package: '@microsoft/teams-ai' - summary: Returns the moderator being used by the AI system. - fullName: moderator - remarks: '' - isDeprecated: false - syntax: - content: Moderator moderator - return: - description: The AI's moderator - type: <TState> - - name: planner - uid: '@microsoft/teams-ai.AI.planner' - package: '@microsoft/teams-ai' - summary: '' - fullName: planner - remarks: '' - isDeprecated: false - syntax: - content: Planner planner - return: - description: Returns the planner being used by the AI system. - type: <TState> - - name: PlanReadyActionName - uid: '@microsoft/teams-ai.AI.PlanReadyActionName' - package: '@microsoft/teams-ai' - summary: >- - An action that will be called after the plan has been predicted by the - planner and it has - - passed moderation. - fullName: PlanReadyActionName - remarks: >- - Overriding this action lets you customize the decision to execute a plan - separately from the - - moderator. The default behavior is to proceed with the plans execution - only with a plan - - contains one or more commands. Returning false from this action can be - used to prevent the plan - - from being executed. - isDeprecated: false - syntax: - content: 'static PlanReadyActionName: "___PlanReady___" = "___PlanReady___"' - return: - description: '' - type: '"___PlanReady___"' - - name: SayCommandActionName - uid: '@microsoft/teams-ai.AI.SayCommandActionName' - package: '@microsoft/teams-ai' - summary: An action that is called to SAY something. - fullName: SayCommandActionName - remarks: >- - Overriding this action lets you customize the execution of the SAY - command. You can use it - - to log the output being generated or to add support for sending certain - types of output as - - message attachments. - - - The default behavior attempts to look for an Adaptive Card in the output - and if found sends - - it as an attachment. If no Adaptive Card is found then the output is sent - as a plain text - - message. - - - If you override this action and want to automatically send Adaptive Cards - as attachments you - - will need to handle that yourself. - isDeprecated: false - syntax: - content: 'static SayCommandActionName: "___SAY___" = "___SAY___"' - return: - description: '' - type: '"___SAY___"' - - name: StopCommandName - uid: '@microsoft/teams-ai.AI.StopCommandName' - package: '@microsoft/teams-ai' - summary: >- - A text string that can be returned from an action to stop the AI system - from continuing - - to execute the current plan. - fullName: StopCommandName - remarks: >- - This command is incompatible and should not be used with `tools` - augmentation - isDeprecated: false - syntax: - content: 'static StopCommandName: "STOP" = "STOP"' - return: - description: '' - type: '"STOP"' - - name: TooManyStepsActionName - uid: '@microsoft/teams-ai.AI.TooManyStepsActionName' - package: '@microsoft/teams-ai' - summary: The task either executed too many steps or timed out. - fullName: TooManyStepsActionName - remarks: '' - isDeprecated: false - syntax: - content: >- - static TooManyStepsActionName: "___TooManySteps___" = - "___TooManySteps___" - return: - description: '' - type: '"___TooManySteps___"' - - name: UnknownActionName - uid: '@microsoft/teams-ai.AI.UnknownActionName' - package: '@microsoft/teams-ai' - summary: >- - An action that will be called anytime an unknown action is predicted by - the planner. - fullName: UnknownActionName - remarks: >- - The default behavior is to simply log an error to the console. The plan is - allowed to - - continue execution by default. - isDeprecated: false - syntax: - content: 'static UnknownActionName: "___UnknownAction___" = "___UnknownAction___"' - return: - description: '' - type: '"___UnknownAction___"' -methods: - - name: action(string | string[], ActionHandler) - uid: '@microsoft/teams-ai.AI.action' - package: '@microsoft/teams-ai' - summary: Registers a handler for a named action. - remarks: >- - The AI systems planner returns plans that are made up of a series of - commands or actions - - that should be performed. Registering a handler lets you provide code that - should be run in - - response to one of the predicted actions. - - - Plans support a DO command which specifies the name of an action to call - and an optional - - set of entities that should be passed to the action. The internal plan - executor will call - - the registered handler for the action passing in the current context, - state, and entities. - - - Additionally, the AI system itself uses actions to handle things like - unknown actions, - - flagged input, and flagged output. You can override these actions by - registering your own - - handler for them. The names of the built-in actions are available as - static properties on - - the AI class. - isDeprecated: false - syntax: - content: >- - function action(name: string | string[], handler: - ActionHandler): AI - parameters: - - id: name - type: string | string[] - description: Unique name of the action. - - id: handler - type: >- - <TState, - TParameters> - description: The code to execute when the action's name is triggered. - return: - description: The AI system instance for chaining purposes. - type: <TState> - - name: >- - defaultAction(string | string[], ActionHandler) - uid: '@microsoft/teams-ai.AI.defaultAction' - package: '@microsoft/teams-ai' - summary: Registers the default handler for a named action. - remarks: '' - isDeprecated: false - syntax: - content: >- - function defaultAction(name: string | string[], handler: - ActionHandler): AI - parameters: - - id: name - type: string | string[] - description: Unique name of the action. - - id: handler - type: >- - <TState, - TParameters> - description: >- - The code to execute when the action's name is triggered. - - Default handlers can be replaced by calling the action() method with - the same name. - return: - description: The AI system instance for chaining purposes. - type: <TState> - - name: doAction(TurnContext, TState, string, TParameters) - uid: '@microsoft/teams-ai.AI.doAction' - package: '@microsoft/teams-ai' - summary: Manually executes a named action. - remarks: '' - isDeprecated: false - syntax: - content: >- - function doAction(context: TurnContext, state: TState, - action: string, parameters?: TParameters): Promise - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: state - type: TState - description: Current turn state. - - id: action - type: string - description: Name of the action to execute. - - id: parameters - type: TParameters - description: Optional. Entities to pass to the action. - return: - description: The result of the action. - type: Promise<string> - - name: hasAction(string) - uid: '@microsoft/teams-ai.AI.hasAction' - package: '@microsoft/teams-ai' - summary: Checks to see if the AI system has a handler for a given action. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasAction(action: string): boolean' - parameters: - - id: action - type: string - description: Name of the action to check. - return: - description: True if the AI system has a handler for the given action. - type: boolean - - name: run(TurnContext, TState, number, number) - uid: '@microsoft/teams-ai.AI.run' - package: '@microsoft/teams-ai' - summary: >- - Calls the configured planner to generate a plan and executes the plan that - is returned. - remarks: >- - The moderator is called to review the input and output of the plan. If the - moderator flags - - the input or output then the appropriate action is called. If the - moderator allows the input - - and output then the plan is executed. - isDeprecated: false - syntax: - content: >- - function run(context: TurnContext, state: TState, start_time?: number, - step_count?: number): Promise - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: state - type: TState - description: Current turn state. - - id: start_time - type: number - description: Optional. Time the AI system started running - - id: step_count - type: number - description: Optional. Number of steps that have been executed. - return: - description: True if the plan was completely executed, otherwise false. - type: Promise<boolean> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AIOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AIOptions.yml deleted file mode 100644 index 2c74bdfe..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AIOptions.yml +++ /dev/null @@ -1,131 +0,0 @@ -### YamlMime:TSType -name: AIOptions -uid: '@microsoft/teams-ai.AIOptions' -package: '@microsoft/teams-ai' -summary: Options for configuring the AI system. -fullName: AIOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: allow_looping - uid: '@microsoft/teams-ai.AIOptions.allow_looping' - package: '@microsoft/teams-ai' - summary: Optional. If true, the AI system will allow the planner to loop. - fullName: allow_looping - remarks: >- - The default value is `true`. - - - Looping is needed for augmentations like `functions` and `monologue` where - the LLM needs to - - see the result of the last action that was performed. The AI system will - attempt to autodetect - - if it needs to loop so you generally don't need to worry about this - setting. - - - If you're using an augmentation like `sequence` you can set this to - `false` to guard against - - any accidental looping. - isDeprecated: false - syntax: - content: 'allow_looping?: boolean' - return: - description: '' - type: boolean - - name: enable_feedback_loop - uid: '@microsoft/teams-ai.AIOptions.enable_feedback_loop' - package: '@microsoft/teams-ai' - summary: >- - Optional. If true, the AI system will enable the feedback loop in Teams - that allows a user to give thumbs up or down to a response. Default is - `false`. - fullName: enable_feedback_loop - remarks: >- - At this time, there is no activity handler support in the Teams AI Library - to handle when a user gives feedback. - - To make use of the feedback loop, use the app.feedbackLoop route - registration. - - https://github.com/microsoft/teams-ai/blob/main/getting-started/CONCEPTS/POWERED-BY-AI.md - isDeprecated: false - syntax: - content: 'enable_feedback_loop?: boolean' - return: - description: '' - type: boolean - - name: feedback_loop_type - uid: '@microsoft/teams-ai.AIOptions.feedback_loop_type' - package: '@microsoft/teams-ai' - summary: >- - Optional. Only used when `enable_feedback_loop` == `true`. When set to - `custom` the user will be presented with a text input - - to provide feedback. - fullName: feedback_loop_type - remarks: '' - isDeprecated: false - syntax: - content: 'feedback_loop_type?: "default" | "custom"' - return: - description: '' - type: '"default" | "custom"' - - name: max_actions - uid: '@microsoft/teams-ai.AIOptions.max_actions' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of actions to execute in a single turn. - fullName: max_actions - remarks: The default value is 25. - isDeprecated: false - syntax: - content: 'max_actions?: number' - return: - description: '' - type: number - - name: max_time - uid: '@microsoft/teams-ai.AIOptions.max_time' - package: '@microsoft/teams-ai' - summary: >- - Optional. Maximum amount of time to spend executing a single turn in - milliseconds. - fullName: max_time - remarks: The default value is 300000 or 5 minutes. - isDeprecated: false - syntax: - content: 'max_time?: number' - return: - description: '' - type: number - - name: moderator - uid: '@microsoft/teams-ai.AIOptions.moderator' - package: '@microsoft/teams-ai' - summary: >- - Optional. The moderator to use for moderating input passed to the model - and the output - - returned by the model. - fullName: moderator - remarks: '' - isDeprecated: false - syntax: - content: 'moderator?: Moderator' - return: - description: '' - type: <TState> - - name: planner - uid: '@microsoft/teams-ai.AIOptions.planner' - package: '@microsoft/teams-ai' - summary: The planner to use for generating plans. - fullName: planner - remarks: '' - isDeprecated: false - syntax: - content: 'planner: Planner' - return: - description: '' - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionAugmentationSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionAugmentationSection.yml deleted file mode 100644 index d1722ddb..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionAugmentationSection.yml +++ /dev/null @@ -1,199 +0,0 @@ -### YamlMime:TSType -name: ActionAugmentationSection -uid: '@microsoft/teams-ai.ActionAugmentationSection' -package: '@microsoft/teams-ai' -summary: A prompt section that renders a list of actions to the prompt. -fullName: ActionAugmentationSection -remarks: '' -isDeprecated: false -type: class -constructors: - - name: ActionAugmentationSection(ChatCompletionAction[], string) - uid: '@microsoft/teams-ai.ActionAugmentationSection.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `ActionAugmentationSection` instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new ActionAugmentationSection(actions: ChatCompletionAction[], - callToAction: string) - parameters: - - id: actions - type: [] - description: List of actions to render. - - id: callToAction - type: string - description: Text to display after the list of actions. -properties: - - name: actions - uid: '@microsoft/teams-ai.ActionAugmentationSection.actions' - package: '@microsoft/teams-ai' - summary: '' - fullName: actions - remarks: '' - isDeprecated: false - syntax: - content: Map actions - return: - description: Map of action names to actions. - type: >- - Map<string, > -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.ActionAugmentationSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.ActionAugmentationSection.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.ActionAugmentationSection.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.ActionAugmentationSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.ActionAugmentationSection.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.ActionAugmentationSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -methods: - - name: renderAsMessages(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.ActionAugmentationSection.renderAsMessages' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a list of `Message` objects. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsMessages(context: TurnContext, memory: Memory, - functions: PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise[]>> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<<string>[]>> -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionHandler.yml deleted file mode 100644 index 8b77e71c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionHandler.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: ActionHandler -uid: '@microsoft/teams-ai.ActionHandler' -package: '@microsoft/teams-ai' -summary: The code to execute when the action's name is triggered. -fullName: ActionHandler -remarks: '' -isDeprecated: false -syntax: | - type ActionHandler = ( - context: TurnContext, - state: TState, - data: TData, - action?: string - ) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionOutputMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionOutputMessage.yml deleted file mode 100644 index b66386d0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionOutputMessage.yml +++ /dev/null @@ -1,148 +0,0 @@ -### YamlMime:TSType -name: ActionOutputMessage -uid: '@microsoft/teams-ai.ActionOutputMessage' -package: '@microsoft/teams-ai' -summary: A section capable of rendering user input text and images as a user message. -fullName: ActionOutputMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: ActionOutputMessage(string, number) - uid: '@microsoft/teams-ai.ActionOutputMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'ActionOutputMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new ActionOutputMessage(historyVariable?: string, tokens?: number)' - parameters: - - id: historyVariable - type: string - description: Optional. Name of the variable containing the conversation history. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.ActionOutputMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.ActionOutputMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.ActionOutputMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.ActionOutputMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.ActionOutputMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.ActionOutputMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlanner.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlanner.yml deleted file mode 100644 index 3814a938..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlanner.yml +++ /dev/null @@ -1,256 +0,0 @@ -### YamlMime:TSType -name: ActionPlanner -uid: '@microsoft/teams-ai.ActionPlanner' -package: '@microsoft/teams-ai' -summary: A planner that uses a Large Language Model (LLM) to generate plans. -fullName: ActionPlanner -remarks: >- - The ActionPlanner is a powerful planner that uses a LLM to generate plans. The - planner can - - trigger parameterized actions and send text based responses to the user. The - ActionPlanner - - supports the following advanced features: - - - **Augmentations:** Augmentations virtually eliminate the need for prompt - engineering. Prompts - can be configured to use a named augmentation which will be automatically appended to the outgoing - prompt. Augmentations let the developer specify whether they want to support multi-step plans (sequence), - use OpenAI's functions support (functions), or create an AutoGPT style agent (monologue). - - **Validations:** Validators are used to validate the response returned by - the LLM and can guarantee - that the parameters passed to an action mach a supplied schema. The validator used is automatically - selected based on the augmentation being used. Validators also prevent hallucinated action names - making it impossible for the LLM to trigger an action that doesn't exist. - - **Repair:** The ActionPlanner will automatically attempt to repair invalid - responses returned by the - LLM using a feedback loop. When a validation fails, the ActionPlanner sends the error back to the - model, along with an instruction asking it to fix its mistake. This feedback technique leads to a - dramatic reduction in the number of invalid responses returned by the model. -isDeprecated: false -type: class -constructors: - - name: ActionPlanner(ActionPlannerOptions) - uid: '@microsoft/teams-ai.ActionPlanner.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `ActionPlanner` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new ActionPlanner(options: ActionPlannerOptions)' - parameters: - - id: options - type: >- - <TState> - description: Options used to configure the planner. -properties: - - name: defaultPrompt - uid: '@microsoft/teams-ai.ActionPlanner.defaultPrompt' - package: '@microsoft/teams-ai' - summary: '' - fullName: defaultPrompt - remarks: '' - isDeprecated: false - syntax: - content: undefined | string defaultPrompt - return: - description: '' - type: undefined | string - - name: model - uid: '@microsoft/teams-ai.ActionPlanner.model' - package: '@microsoft/teams-ai' - summary: '' - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: PromptCompletionModel model - return: - description: '' - type: - - name: prompts - uid: '@microsoft/teams-ai.ActionPlanner.prompts' - package: '@microsoft/teams-ai' - summary: '' - fullName: prompts - remarks: '' - isDeprecated: false - syntax: - content: PromptManager prompts - return: - description: '' - type: -methods: - - name: addSemanticFunction(string | PromptTemplate, PromptResponseValidator) - uid: '@microsoft/teams-ai.ActionPlanner.addSemanticFunction' - package: '@microsoft/teams-ai' - summary: >- - Creates a semantic function that can be registered with the apps prompt - manager. - remarks: >- - Semantic functions are functions that make model calls and return their - results as template - - parameters to other prompts. For example, you could define a semantic - function called - - 'translator' that first translates the user's input to English before - calling your main prompt: - - - ```JavaScript - - app.ai.prompts.addFunction('translator', - app.ai.createSemanticFunction('translator-prompt')); - - ``` - - - You would then create a prompt called "translator-prompt" that does the - translation and then in - - your main prompt you can call it using the template expression - `{{translator}}`. - isDeprecated: false - syntax: - content: >- - function addSemanticFunction(prompt: string | PromptTemplate, - validator?: PromptResponseValidator): ActionPlanner - parameters: - - id: prompt - type: string | - description: The name of the prompt to use. - - id: validator - type: >- - <any> - description: >- - Optional. A validator to use to validate the response returned by - the model. - return: - description: A promise that resolves to the result of the semantic function. - type: <TState> - - name: beginTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.ActionPlanner.beginTask' - package: '@microsoft/teams-ai' - summary: Starts a new task. - remarks: >- - This method is called when the AI system is ready to start a new task. The - planner should - - generate a plan that the AI system will execute. Returning an empty plan - signals that - - there is no work to be performed. - - - The planner should take the users input from `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function beginTask(context: TurnContext, state: TState, ai: AI): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> - - name: >- - completePrompt(TurnContext, Memory, string | PromptTemplate, - PromptResponseValidator) - uid: '@microsoft/teams-ai.ActionPlanner.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt using an optional validator. - remarks: >- - This method allows the developer to manually complete a prompt and access - the models - - response. If a validator is specified, the response will be validated and - repaired if - - necessary. If no validator is specified, the response will be returned - as-is. - - - If a validator like the `JSONResponseValidator` is used, the response - returned will be - - a message containing a JSON object. If no validator is used, the response - will be a - - message containing the response text as a string. - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, - prompt: string | PromptTemplate, validator?: - PromptResponseValidator): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: >- - A memory interface used to access state variables (the turn state - object implements this interface.) - - id: prompt - type: string | - description: Name of the prompt to use or a prompt template. - - id: validator - type: >- - <TContent> - description: >- - Optional. A validator to use to validate the response returned by - the model. - return: - description: The result of the LLM call. - type: Promise<PromptResponse<TContent>> - - name: continueTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.ActionPlanner.continueTask' - package: '@microsoft/teams-ai' - summary: Continues the current task. - remarks: >- - This method is called when the AI system has finished executing the - previous plan and is - - ready to continue the current task. The planner should generate a plan - that the AI system - - will execute. Returning an empty plan signals that the task is completed - and there is no work - - to be performed. - - - The output from the last plan step that was executed is passed to the - planner via `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function continueTask(context: TurnContext, state: TState, ai: - AI): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerOptions.yml deleted file mode 100644 index e7578fdb..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerOptions.yml +++ /dev/null @@ -1,144 +0,0 @@ -### YamlMime:TSType -name: ActionPlannerOptions -uid: '@microsoft/teams-ai.ActionPlannerOptions' -package: '@microsoft/teams-ai' -summary: Options used to configure an `ActionPlanner` instance. -fullName: ActionPlannerOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: defaultPrompt - uid: '@microsoft/teams-ai.ActionPlannerOptions.defaultPrompt' - package: '@microsoft/teams-ai' - summary: The default prompt to use. - fullName: defaultPrompt - remarks: >- - This can either be the name of a prompt template or a function that - returns a prompt template. - isDeprecated: false - syntax: - content: 'defaultPrompt: string | ActionPlannerPromptFactory' - return: - description: '' - type: >- - string | <TState> - - name: enableFeedbackLoop - uid: '@microsoft/teams-ai.ActionPlannerOptions.enableFeedbackLoop' - package: '@microsoft/teams-ai' - summary: If true, the feedback loop will be enabled for streaming responses. - fullName: enableFeedbackLoop - remarks: '' - isDeprecated: false - syntax: - content: 'enableFeedbackLoop?: boolean' - return: - description: '' - type: boolean - - name: endStreamHandler - uid: '@microsoft/teams-ai.ActionPlannerOptions.endStreamHandler' - package: '@microsoft/teams-ai' - summary: Optional handler to run when a stream is about to conclude. - fullName: endStreamHandler - remarks: '' - isDeprecated: false - syntax: - content: 'endStreamHandler?: PromptCompletionModelResponseReceivedEvent' - return: - description: '' - type: >- - - - name: feedbackLoopType - uid: '@microsoft/teams-ai.ActionPlannerOptions.feedbackLoopType' - package: '@microsoft/teams-ai' - summary: The feedback loop type. - fullName: feedbackLoopType - remarks: '' - isDeprecated: false - syntax: - content: 'feedbackLoopType?: "default" | "custom"' - return: - description: '' - type: '"default" | "custom"' - - name: logRepairs - uid: '@microsoft/teams-ai.ActionPlannerOptions.logRepairs' - package: '@microsoft/teams-ai' - summary: If true, repair attempts will be logged to the console. - fullName: logRepairs - remarks: The default value is false. - isDeprecated: false - syntax: - content: 'logRepairs?: boolean' - return: - description: '' - type: boolean - - name: max_repair_attempts - uid: '@microsoft/teams-ai.ActionPlannerOptions.max_repair_attempts' - package: '@microsoft/teams-ai' - summary: Maximum number of repair attempts to make. - fullName: max_repair_attempts - remarks: >- - The ActionPlanner uses validators and a feedback loop to repair invalid - responses returned - - by the model. This value controls the maximum number of repair attempts - that will be made - - before returning an error. The default value is 3. - isDeprecated: false - syntax: - content: 'max_repair_attempts?: number' - return: - description: '' - type: number - - name: model - uid: '@microsoft/teams-ai.ActionPlannerOptions.model' - package: '@microsoft/teams-ai' - summary: Model instance to use. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model: PromptCompletionModel' - return: - description: '' - type: - - name: prompts - uid: '@microsoft/teams-ai.ActionPlannerOptions.prompts' - package: '@microsoft/teams-ai' - summary: Prompt manager used to manage prompts. - fullName: prompts - remarks: '' - isDeprecated: false - syntax: - content: 'prompts: PromptManager' - return: - description: '' - type: - - name: startStreamingMessage - uid: '@microsoft/teams-ai.ActionPlannerOptions.startStreamingMessage' - package: '@microsoft/teams-ai' - summary: Optional message to send a client at the start of a streaming response. - fullName: startStreamingMessage - remarks: '' - isDeprecated: false - syntax: - content: 'startStreamingMessage?: string' - return: - description: '' - type: string - - name: tokenizer - uid: '@microsoft/teams-ai.ActionPlannerOptions.tokenizer' - package: '@microsoft/teams-ai' - summary: Optional tokenizer to use. - fullName: tokenizer - remarks: If not specified, a new `GPTTokenizer` instance will be created. - isDeprecated: false - syntax: - content: 'tokenizer?: Tokenizer' - return: - description: '' - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerPromptFactory.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerPromptFactory.yml deleted file mode 100644 index 4e33df46..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerPromptFactory.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: ActionPlannerPromptFactory -uid: '@microsoft/teams-ai.ActionPlannerPromptFactory' -package: '@microsoft/teams-ai' -summary: Factory function used to create a prompt template. -fullName: ActionPlannerPromptFactory -remarks: '' -isDeprecated: false -syntax: | - type ActionPlannerPromptFactory = ( - context: TurnContext, - state: TState, - planner: ActionPlanner - ) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionResponseValidator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionResponseValidator.yml deleted file mode 100644 index d22770ea..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionResponseValidator.yml +++ /dev/null @@ -1,86 +0,0 @@ -### YamlMime:TSType -name: ActionResponseValidator -uid: '@microsoft/teams-ai.ActionResponseValidator' -package: '@microsoft/teams-ai' -summary: Validates action calls returned by the model. -fullName: ActionResponseValidator -remarks: '' -isDeprecated: false -type: class -constructors: - - name: ActionResponseValidator(ChatCompletionAction[], boolean, string, string) - uid: '@microsoft/teams-ai.ActionResponseValidator.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `ActionResponseValidator` instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new ActionResponseValidator(actions: ChatCompletionAction[], isRequired: - boolean, noun?: string, Noun?: string) - parameters: - - id: actions - type: [] - description: List of supported actions. - - id: isRequired - type: boolean - description: Whether the response is required to call an action. - - id: noun - type: string - description: >- - Optional. Name of the action to use in feedback messages. Defaults - to `action`. - - id: Noun - type: string - description: >- - Optional. Name of the action to use in feedback messages. Defaults - to `Action`. -properties: - - name: actions - uid: '@microsoft/teams-ai.ActionResponseValidator.actions' - package: '@microsoft/teams-ai' - summary: Gets a list of the actions configured for the validator. - fullName: actions - remarks: '' - isDeprecated: false - syntax: - content: ChatCompletionAction[] actions - return: - description: A list of the actions configured for the validator. - type: [] -methods: - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.ActionResponseValidator.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCard.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCard.yml deleted file mode 100644 index 68ecdffc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCard.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSType -name: AdaptiveCard -uid: '@microsoft/teams-ai.AdaptiveCard' -package: '@microsoft/teams-ai' -summary: Strongly typed Adaptive Card. -fullName: AdaptiveCard -remarks: see https://adaptivecards.io/explorer/ for schema details. -isDeprecated: false -type: interface -properties: - - name: type - uid: '@microsoft/teams-ai.AdaptiveCard.type' - package: '@microsoft/teams-ai' - summary: Required type field. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "AdaptiveCard"' - return: - description: '' - type: '"AdaptiveCard"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardActionExecuteResponseType.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardActionExecuteResponseType.yml deleted file mode 100644 index c07b0448..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardActionExecuteResponseType.yml +++ /dev/null @@ -1,30 +0,0 @@ -### YamlMime:TSEnum -name: AdaptiveCardActionExecuteResponseType -uid: '@microsoft/teams-ai.AdaptiveCardActionExecuteResponseType' -package: '@microsoft/teams-ai' -summary: '' -fullName: AdaptiveCardActionExecuteResponseType -remarks: '' -isDeprecated: false -fields: - - name: REPLACE_FOR_INTERACTOR - uid: >- - @microsoft/teams-ai.AdaptiveCardActionExecuteResponseType.REPLACE_FOR_INTERACTOR - package: '@microsoft/teams-ai' - summary: >- - The response card will be replaced the current one for the interactor who - trigger the action. - numericValue: 0 - - name: REPLACE_FOR_ALL - uid: '@microsoft/teams-ai.AdaptiveCardActionExecuteResponseType.REPLACE_FOR_ALL' - package: '@microsoft/teams-ai' - summary: >- - The response card will be replaced the current one for all users in the - chat. - numericValue: 1 - - name: NEW_MESSAGE_FOR_ALL - uid: >- - @microsoft/teams-ai.AdaptiveCardActionExecuteResponseType.NEW_MESSAGE_FOR_ALL - package: '@microsoft/teams-ai' - summary: The response card will be sent as a new message for all users in the chat. - numericValue: 2 diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardSearchResult.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardSearchResult.yml deleted file mode 100644 index 62f0b5c0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardSearchResult.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: AdaptiveCardSearchResult -uid: '@microsoft/teams-ai.AdaptiveCardSearchResult' -package: '@microsoft/teams-ai' -summary: Individual result returned from AdaptiveCards.search() handler. -fullName: AdaptiveCardSearchResult -remarks: '' -isDeprecated: false -type: interface -properties: - - name: title - uid: '@microsoft/teams-ai.AdaptiveCardSearchResult.title' - package: '@microsoft/teams-ai' - summary: The title of the result. - fullName: title - remarks: '' - isDeprecated: false - syntax: - content: 'title: string' - return: - description: '' - type: string - - name: value - uid: '@microsoft/teams-ai.AdaptiveCardSearchResult.value' - package: '@microsoft/teams-ai' - summary: The subtitle of the result. - fullName: value - remarks: '' - isDeprecated: false - syntax: - content: 'value: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCards.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCards.yml deleted file mode 100644 index 2fc1a2a8..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCards.yml +++ /dev/null @@ -1,141 +0,0 @@ -### YamlMime:TSType -name: AdaptiveCards -uid: '@microsoft/teams-ai.AdaptiveCards' -package: '@microsoft/teams-ai' -summary: >- - AdaptiveCards class to enable fluent style registration of handlers related to - Adaptive Cards. -fullName: AdaptiveCards -remarks: '' -isDeprecated: false -type: class -constructors: - - name: AdaptiveCards(Application) - uid: '@microsoft/teams-ai.AdaptiveCards.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the AdaptiveCards class. - remarks: '' - isDeprecated: false - syntax: - content: 'new AdaptiveCards(app: Application)' - parameters: - - id: app - type: <TState> - description: The top level application class to register handlers with. -methods: - - name: >- - actionExecute(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, data: TData) => - Promise) - uid: '@microsoft/teams-ai.AdaptiveCards.actionExecute' - package: '@microsoft/teams-ai' - summary: >- - Adds a route to the application for handling Adaptive Card Action.Execute - events. - remarks: '' - isDeprecated: false - syntax: - content: >- - function actionExecute(verb: string | RegExp | Selector | (string - | RegExp | Selector)[], handler: (context: TurnContext, state: TState, - data: TData) => Promise): Application - parameters: - - id: verb - type: >- - string | RegExp | | - (string | RegExp | )[] - description: The named action(s) to be handled. - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<string | AdaptiveCard> - description: The code to execute when the action is triggered. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - actionSubmit(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, data: TData) => - Promise) - uid: '@microsoft/teams-ai.AdaptiveCards.actionSubmit' - package: '@microsoft/teams-ai' - summary: >- - Adds a route to the application for handling Adaptive Card Action.Submit - events. - remarks: >- - The route will be added for the specified verb(s) and will be filtered - using the - - `actionSubmitFilter` option. The default filter is to use the `verb` - field. - - - For outgoing AdaptiveCards you will need to include the verb's name in the - cards Action.Submit. - - For example: - - - ```JSON - - { - "type": "Action.Submit", - "title": "OK", - "data": { - "verb": "ok" - } - } - - ``` - isDeprecated: false - syntax: - content: >- - function actionSubmit(verb: string | RegExp | Selector | (string - | RegExp | Selector)[], handler: (context: TurnContext, state: TState, - data: TData) => Promise): Application - parameters: - - id: verb - type: >- - string | RegExp | | - (string | RegExp | )[] - description: The named action(s) to be handled. - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<void> - description: The code to execute when the action is triggered. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - search(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState, query: - Query) => Promise) - uid: '@microsoft/teams-ai.AdaptiveCards.search' - package: '@microsoft/teams-ai' - summary: >- - Adds a route to the application for handling the `Data.Query` request for - an `Input.ChoiceSet`. - remarks: '' - isDeprecated: false - syntax: - content: >- - function search(dataset: string | RegExp | Selector | (string | RegExp | - Selector)[], handler: (context: TurnContext, state: TState, query: - Query) => - Promise): Application - parameters: - - id: dataset - type: >- - string | RegExp | | - (string | RegExp | )[] - description: The named dataset(s) to be handled. - - id: handler - type: >- - (context: TurnContext, state: TState, query: - Query<AdaptiveCardsSearchParams>) => - Promise<AdaptiveCardSearchResult[]> - description: The code to execute when the query is triggered. - return: - description: The application for chaining purposes. - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsOptions.yml deleted file mode 100644 index 92813fca..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsOptions.yml +++ /dev/null @@ -1,49 +0,0 @@ -### YamlMime:TSType -name: AdaptiveCardsOptions -uid: '@microsoft/teams-ai.AdaptiveCardsOptions' -package: '@microsoft/teams-ai' -summary: Options for AdaptiveCards class. -fullName: AdaptiveCardsOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: actionExecuteResponseType - uid: '@microsoft/teams-ai.AdaptiveCardsOptions.actionExecuteResponseType' - package: '@microsoft/teams-ai' - summary: >- - Data field used to specify how the response card will be presented after - an action is executed. - fullName: actionExecuteResponseType - remarks: >- - When an Action.Execute is triggered, the field name specified here will be - used to determine - - how the response card will be presented. - isDeprecated: false - syntax: - content: 'actionExecuteResponseType?: AdaptiveCardActionExecuteResponseType' - return: - description: '' - type: >- - - - name: actionSubmitFilter - uid: '@microsoft/teams-ai.AdaptiveCardsOptions.actionSubmitFilter' - package: '@microsoft/teams-ai' - summary: Data field used to identify the Action.Submit handler to trigger. - fullName: actionSubmitFilter - remarks: >- - When an Action.Submit is triggered, the field name specified here will be - used to determine - - the handler to route the request to. - - - Defaults to a value of 'verb'. - isDeprecated: false - syntax: - content: 'actionSubmitFilter?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsSearchParams.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsSearchParams.yml deleted file mode 100644 index f00cf9c2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsSearchParams.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: AdaptiveCardsSearchParams -uid: '@microsoft/teams-ai.AdaptiveCardsSearchParams' -package: '@microsoft/teams-ai' -summary: Parameters passed to AdaptiveCards.search() handler. -fullName: AdaptiveCardsSearchParams -remarks: '' -isDeprecated: false -type: interface -properties: - - name: dataset - uid: '@microsoft/teams-ai.AdaptiveCardsSearchParams.dataset' - package: '@microsoft/teams-ai' - summary: The dataset to search. - fullName: dataset - remarks: '' - isDeprecated: false - syntax: - content: 'dataset: string' - return: - description: '' - type: string - - name: queryText - uid: '@microsoft/teams-ai.AdaptiveCardsSearchParams.queryText' - package: '@microsoft/teams-ai' - summary: The query text. - fullName: queryText - remarks: '' - isDeprecated: false - syntax: - content: 'queryText: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Application.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Application.yml deleted file mode 100644 index 912fa597..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Application.yml +++ /dev/null @@ -1,911 +0,0 @@ -### YamlMime:TSType -name: Application -uid: '@microsoft/teams-ai.Application' -package: '@microsoft/teams-ai' -summary: Application class for routing and processing incoming requests. -fullName: Application -remarks: >- - The Application object replaces the traditional ActivityHandler that a bot - would use. It supports - - a simpler fluent style of authoring bots versus the inheritance based approach - used by the - - ActivityHandler class. - - - Additionally, it has built-in support for calling into the SDK's AI system and - can be used to create - - bots that leverage Large Language Models (LLM) and other AI capabilities. -isDeprecated: false -type: class -constructors: - - name: Application(Partial>) - uid: '@microsoft/teams-ai.Application.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new Application instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new Application(options?: Partial>)' - parameters: - - id: options - type: >- - Partial<<TState>> - description: Optional. Options used to configure the application. -properties: - - name: adapter - uid: '@microsoft/teams-ai.Application.adapter' - package: '@microsoft/teams-ai' - summary: The bot's adapter. - fullName: adapter - remarks: '' - isDeprecated: false - syntax: - content: BotAdapter adapter - return: - description: The bot's adapter that is configured for the application. - type: BotAdapter - - name: adaptiveCards - uid: '@microsoft/teams-ai.Application.adaptiveCards' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing Adaptive Card specific features. - fullName: adaptiveCards - remarks: '' - isDeprecated: false - syntax: - content: AdaptiveCards adaptiveCards - return: - description: The AdaptiveCards instance. - type: <TState> - - name: ai - uid: '@microsoft/teams-ai.Application.ai' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing AI specific features. - fullName: ai - remarks: '' - isDeprecated: false - syntax: - content: AI ai - return: - description: The AI instance. - type: <TState> - - name: authentication - uid: '@microsoft/teams-ai.Application.authentication' - package: '@microsoft/teams-ai' - summary: >- - This property is only available if the Application was configured with - `authentication` options. An - - exception will be thrown if you attempt to access it otherwise. - fullName: authentication - remarks: '' - isDeprecated: false - syntax: - content: AuthenticationManager authentication - return: - description: The Authentication instance. - type: <TState> - - name: meetings - uid: '@microsoft/teams-ai.Application.meetings' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing Meetings specific features. - fullName: meetings - remarks: '' - isDeprecated: false - syntax: - content: Meetings meetings - return: - description: The Meetings instance. - type: Meetings<TState> - - name: messageExtensions - uid: '@microsoft/teams-ai.Application.messageExtensions' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing Message Extensions' specific features. - fullName: messageExtensions - remarks: '' - isDeprecated: false - syntax: - content: MessageExtensions messageExtensions - return: - description: The MessageExtensions instance. - type: <TState> - - name: messages - uid: '@microsoft/teams-ai.Application.messages' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing Messages specific features. - fullName: messages - remarks: '' - isDeprecated: false - syntax: - content: Messages messages - return: - description: The Messages instance. - type: Messages<TState> - - name: options - uid: '@microsoft/teams-ai.Application.options' - package: '@microsoft/teams-ai' - summary: The application's configured options. - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: ApplicationOptions options - return: - description: The application's configured options. - type: <TState> - - name: taskModules - uid: '@microsoft/teams-ai.Application.taskModules' - package: '@microsoft/teams-ai' - summary: Fluent interface for accessing Task Module specific features. - fullName: taskModules - remarks: '' - isDeprecated: false - syntax: - content: TaskModules taskModules - return: - description: The TaskModules instance. - type: <TState> -methods: - - name: >- - activity(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState) => Promise) - uid: '@microsoft/teams-ai.Application.activity' - package: '@microsoft/teams-ai' - summary: Handles incoming activities of a given type. - remarks: '' - isDeprecated: false - syntax: - content: >- - function activity(type: string | RegExp | Selector | (string | RegExp | - Selector)[], handler: (context: TurnContext, state: TState) => - Promise): Application - parameters: - - id: type - type: >- - string | RegExp | | - (string | RegExp | )[] - description: >- - Name of the activity type to match or a regular expression to match - against the incoming activity type. An array of type names or - expression can also be passed in. - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: addRoute(Selector, RouteHandler, boolean) - uid: '@microsoft/teams-ai.Application.addRoute' - package: '@microsoft/teams-ai' - summary: Adds a new route to the application. - remarks: >- - Developers won't typically need to call this method directly as it's used - internally by all - - of the fluent interfaces to register routes for their specific activity - types. - - - Routes will be matched in the order they're added to the application. The - first selector to - - return `true` when an activity is received will have its handler called. - - - Invoke-based activities receive special treatment and are matched - separately as they typically - - have shorter execution timeouts. - isDeprecated: false - syntax: - content: >- - function addRoute(selector: Selector, handler: RouteHandler, - isInvokeRoute?: boolean): Application - parameters: - - id: selector - type: - description: >- - Function thats used to select a route. The function should return - true to trigger the route. - - id: handler - type: <TState> - description: Function to call when the route is triggered. - - id: isInvokeRoute - type: boolean - description: >- - Optional. Boolean indicating if the RouteSelector is for an activity - that uses "invoke" which require special handling. Defaults to - `false`. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - conversationUpdate(ConversationUpdateEvents, (context: TurnContext, state: - TState) => Promise) - uid: '@microsoft/teams-ai.Application.conversationUpdate' - package: '@microsoft/teams-ai' - summary: Handles conversation update events. - remarks: '' - isDeprecated: false - syntax: - content: >- - function conversationUpdate(event: ConversationUpdateEvents, handler: - (context: TurnContext, state: TState) => Promise): - Application - parameters: - - id: event - type: - description: Name of the conversation update event to handle. - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: 'error((context: TurnContext, error: Error) => Promise)' - uid: '@microsoft/teams-ai.Application.error' - package: '@microsoft/teams-ai' - summary: Sets the bot's error handler - remarks: '' - isDeprecated: false - syntax: - content: >- - function error(handler: (context: TurnContext, error: Error) => - Promise): Application - parameters: - - id: handler - type: '(context: TurnContext, error: Error) => Promise<void>' - description: Function to call when an error is encountered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - feedbackLoop((context: TurnContext, state: TState, feedbackLoopData: - FeedbackLoopData) => Promise) - uid: '@microsoft/teams-ai.Application.feedbackLoop' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler for feedbackloop events when a user clicks the - thumbsup or thumbsdown button on a response from AI. enable_feedback_loop - must be set to true in the AI Module. - remarks: '' - isDeprecated: false - syntax: - content: >- - function feedbackLoop(handler: (context: TurnContext, state: TState, - feedbackLoopData: FeedbackLoopData) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, feedbackLoopData: - FeedbackLoopData) => Promise<void> - description: Function to call when the route is triggered - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - fileConsentAccept((context: TurnContext, state: TState, - fileConsentResponse: FileConsentCardResponse) => Promise) - uid: '@microsoft/teams-ai.Application.fileConsentAccept' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process when a file consent card is accepted by the - user. - remarks: '' - isDeprecated: false - syntax: - content: >- - function fileConsentAccept(handler: (context: TurnContext, state: - TState, fileConsentResponse: FileConsentCardResponse) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, fileConsentResponse: - FileConsentCardResponse) => Promise<void> - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - fileConsentDecline((context: TurnContext, state: TState, - fileConsentResponse: FileConsentCardResponse) => Promise) - uid: '@microsoft/teams-ai.Application.fileConsentDecline' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process when a file consent card is declined by the - user. - remarks: '' - isDeprecated: false - syntax: - content: >- - function fileConsentDecline(handler: (context: TurnContext, state: - TState, fileConsentResponse: FileConsentCardResponse) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, fileConsentResponse: - FileConsentCardResponse) => Promise<void> - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: getPagedMembers(Partial, number, string) - uid: '@microsoft/teams-ai.Application.getPagedMembers_2' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getPagedMembers(activity: Partial, pageSize?: number, - continuationToken?: string): Promise - parameters: - - id: activity - type: Partial<Activity> - description: '' - - id: pageSize - type: number - description: '' - - id: continuationToken - type: string - description: '' - return: - description: '' - type: Promise<TeamsPagedMembersResult> - - name: getPagedMembers(Partial, number, string) - uid: '@microsoft/teams-ai.Application.getPagedMembers_1' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getPagedMembers(reference: Partial, - pageSize?: number, continuationToken?: string): - Promise - parameters: - - id: reference - type: Partial<ConversationReference> - description: '' - - id: pageSize - type: number - description: '' - - id: continuationToken - type: string - description: '' - return: - description: '' - type: Promise<TeamsPagedMembersResult> - - name: getPagedMembers(TurnContext, number, string) - uid: '@microsoft/teams-ai.Application.getPagedMembers' - package: '@microsoft/teams-ai' - summary: >- - Gets a paginated list of members of one-on-one, group, or team - conversation. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getPagedMembers(context: TurnContext, pageSize?: number, - continuationToken?: string): Promise - parameters: - - id: context - type: TurnContext - description: The context for the current turn with the user. - - id: pageSize - type: number - description: >- - Suggested number of entries on a page. Page sizes with less than 50 - are treated as 50, and greater than 500, are capped at 500. - - id: continuationToken - type: string - description: A continuation token. - return: - description: The TeamsPagedMembersResult with the list of members. - type: Promise<TeamsPagedMembersResult> - - name: getTeamChannels(Partial) - uid: '@microsoft/teams-ai.Application.getTeamChannels_2' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTeamChannels(activity: Partial): - Promise - parameters: - - id: activity - type: Partial<Activity> - description: '' - return: - description: '' - type: Promise<ChannelInfo[]> - - name: getTeamChannels(Partial) - uid: '@microsoft/teams-ai.Application.getTeamChannels_1' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTeamChannels(conversationReference: - Partial): Promise - parameters: - - id: conversationReference - type: Partial<ConversationReference> - description: '' - return: - description: '' - type: Promise<ChannelInfo[]> - - name: getTeamChannels(TurnContext) - uid: '@microsoft/teams-ai.Application.getTeamChannels' - package: '@microsoft/teams-ai' - summary: Retrieves the list of team channels for a given context. - remarks: '' - isDeprecated: false - syntax: - content: 'function getTeamChannels(context: TurnContext): Promise' - parameters: - - id: context - type: TurnContext - description: |- - The context of the conversation, which can be a TurnContext, - Partial, or Partial. - return: - description: >- - A promise that resolves to an array of ChannelInfo objects if the bot - is installed into a team, otherwise returns an empty array. - type: Promise<ChannelInfo[]> - - name: getTeamDetails(Partial) - uid: '@microsoft/teams-ai.Application.getTeamDetails_2' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTeamDetails(activity: Partial): Promise - parameters: - - id: activity - type: Partial<Activity> - description: '' - return: - description: '' - type: Promise<undefined | TeamDetails> - - name: getTeamDetails(Partial) - uid: '@microsoft/teams-ai.Application.getTeamDetails_1' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTeamDetails(conversationReference: - Partial): Promise - parameters: - - id: conversationReference - type: Partial<ConversationReference> - description: '' - return: - description: '' - type: Promise<undefined | TeamDetails> - - name: getTeamDetails(TurnContext) - uid: '@microsoft/teams-ai.Application.getTeamDetails' - package: '@microsoft/teams-ai' - summary: Retrieves the team details for a given context. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTeamDetails(context: TurnContext): Promise - parameters: - - id: context - type: TurnContext - description: |- - The context of the conversation, which can be a TurnContext, - Partial, or Partial. - return: - description: >- - A promise that resolves to an array of ChannelInfo objects if the bot - is installed into a team, otherwise returns an empty array. - type: Promise<undefined | TeamDetails> - - name: getTokenOrStartSignIn(TurnContext, TState, string) - uid: '@microsoft/teams-ai.Application.getTokenOrStartSignIn' - package: '@microsoft/teams-ai' - summary: >- - If the user is signed in, get the access token. If not, triggers the sign - in flow for the provided authentication setting name - - and returns. In this case, the bot should end the turn until the sign in - flow is completed. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getTokenOrStartSignIn(context: TurnContext, state: TState, - settingName: string): Promise - parameters: - - id: context - type: TurnContext - description: The context for the current turn with the user. - - id: state - type: TState - description: The current state of the conversation. - - id: settingName - type: string - description: The name of the authentication setting. - return: - description: The token for the user if they are signed in, otherwise undefined. - type: Promise<undefined | string> - - name: >- - handoff((context: TurnContext, state: TState, continuation: string) => - Promise) - uid: '@microsoft/teams-ai.Application.handoff' - package: '@microsoft/teams-ai' - summary: Registers a handler to handoff conversations from one copilot to another. - remarks: '' - isDeprecated: false - syntax: - content: >- - function handoff(handler: (context: TurnContext, state: TState, - continuation: string) => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, continuation: string) => - Promise<void> - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - message(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState) => Promise) - uid: '@microsoft/teams-ai.Application.message' - package: '@microsoft/teams-ai' - summary: Handles incoming messages with a given keyword. - remarks: >- - This method provides a simple way to have a bot respond anytime a user - sends your bot a - - message with a specific word or phrase. - - - For example, you can easily clear the current conversation anytime a user - sends "/reset": - - - ```JavaScript - - bot.message('/reset', async (context, state) => { - await state.conversation.delete(); - await context.sendActivity(`I have reset your state.`); - }); - - ``` - isDeprecated: false - syntax: - content: >- - function message(keyword: string | RegExp | Selector | (string | RegExp - | Selector)[], handler: (context: TurnContext, state: TState) => - Promise): Application - parameters: - - id: keyword - type: >- - string | RegExp | | - (string | RegExp | )[] - description: >- - Substring of text or a regular expression to match against the text - of an incoming message. An array of keywords or expression can also - be passed in. - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - messageEventUpdate(TeamsMessageEvents, (context: TurnContext, state: - TState) => Promise) - uid: '@microsoft/teams-ai.Application.messageEventUpdate' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function messageEventUpdate(event: TeamsMessageEvents, handler: - (context: TurnContext, state: TState) => Promise): - Application - parameters: - - id: event - type: - description: '' - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: '' - return: - description: '' - type: <TState> - - name: >- - messageReactions(MessageReactionEvents, (context: TurnContext, state: - TState) => Promise) - uid: '@microsoft/teams-ai.Application.messageReactions' - package: '@microsoft/teams-ai' - summary: Handles message reaction events. - remarks: '' - isDeprecated: false - syntax: - content: >- - function messageReactions(event: MessageReactionEvents, handler: - (context: TurnContext, state: TState) => Promise): - Application - parameters: - - id: event - type: - description: Name of the message reaction event(s) to handle. - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - O365ConnectorCardAction((context: TurnContext, state: TState, query: - O365ConnectorCardActionQuery) => Promise) - uid: '@microsoft/teams-ai.Application.O365ConnectorCardAction' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process when a O365 Connector Card Action activity - is received from the user. - remarks: '' - isDeprecated: false - syntax: - content: >- - function O365ConnectorCardAction(handler: (context: TurnContext, state: - TState, query: O365ConnectorCardActionQuery) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, query: - O365ConnectorCardActionQuery) => Promise<void> - description: Function to call when the route is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: run(TurnContext) - uid: '@microsoft/teams-ai.Application.run' - package: '@microsoft/teams-ai' - summary: >- - Dispatches an incoming activity to a handler registered with the - application. - remarks: >- - This method should be called from your bot's "turn handler" (its primary - message handler) - - - ```JavaScript - - server.post('/api/messages', async (req, res) => { - await adapter.processActivity(req, res, async (context) => { - await bot.run(context); - }); - }); - - ``` - isDeprecated: false - syntax: - content: 'function run(turnContext: TurnContext): Promise' - parameters: - - id: turnContext - type: TurnContext - description: Context class for the current turn of conversation with the user. - return: - description: >- - True if the activity was successfully dispatched to a handler. False - if no matching handlers could be found. - type: Promise<boolean> - - name: >- - sendProactiveActivity(Partial, string | Partial, - string, string) - uid: '@microsoft/teams-ai.Application.sendProactiveActivity_2' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendProactiveActivity(activity: Partial, - activityOrText: string | Partial, speak?: string, inputHint?: - string): Promise - parameters: - - id: activity - type: Partial<Activity> - description: '' - - id: activityOrText - type: string | Partial<Activity> - description: '' - - id: speak - type: string - description: '' - - id: inputHint - type: string - description: '' - return: - description: '' - type: Promise<undefined | ResourceResponse> - - name: >- - sendProactiveActivity(Partial, string | - Partial, string, string) - uid: '@microsoft/teams-ai.Application.sendProactiveActivity_1' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendProactiveActivity(conversationReference: - Partial, activityOrText: string | - Partial, speak?: string, inputHint?: string): - Promise - parameters: - - id: conversationReference - type: Partial<ConversationReference> - description: '' - - id: activityOrText - type: string | Partial<Activity> - description: '' - - id: speak - type: string - description: '' - - id: inputHint - type: string - description: '' - return: - description: '' - type: Promise<undefined | ResourceResponse> - - name: >- - sendProactiveActivity(TurnContext, string | Partial, string, - string) - uid: '@microsoft/teams-ai.Application.sendProactiveActivity' - package: '@microsoft/teams-ai' - summary: >- - Sends a proactive activity to an existing conversation the bot is a member - of. - remarks: >- - This method provides a simple way to send a proactive message to a - conversation the bot is a member of. - - - Use of the method requires you configure the Application with the - `adapter.appId` - - options. An exception will be thrown if either is missing. - isDeprecated: false - syntax: - content: >- - function sendProactiveActivity(context: TurnContext, activityOrText: - string | Partial, speak?: string, inputHint?: string): - Promise - parameters: - - id: context - type: TurnContext - description: >- - Context of the conversation to proactively message. This can be - derived from either a TurnContext, ConversationReference, or - Activity. - - id: activityOrText - type: string | Partial<Activity> - description: Activity or message to send to the conversation. - - id: speak - type: string - description: Optional. Text to speak for channels that support voice. - - id: inputHint - type: string - description: Optional. Input hint for channels that support voice. - return: - description: A Resource response containing the ID of the activity that was sent. - type: Promise<undefined | ResourceResponse> - - name: startTypingTimer(TurnContext) - uid: '@microsoft/teams-ai.Application.startTypingTimer' - package: '@microsoft/teams-ai' - summary: Manually start a timer to periodically send "typing" activities. - remarks: >- - The timer waits 1000ms to send its initial "typing" activity and then send - an additional - - "typing" activity every 1000ms. The timer will automatically end once an - outgoing activity - - has been sent. If the timer is already running or the current activity, is - not a "message" - - the call is ignored. - isDeprecated: false - syntax: - content: 'function startTypingTimer(context: TurnContext)' - parameters: - - id: context - type: TurnContext - description: The context for the current turn with the user. - - name: stopTypingTimer() - uid: '@microsoft/teams-ai.Application.stopTypingTimer' - package: '@microsoft/teams-ai' - summary: Manually stop the typing timer. - remarks: If the timer isn't running nothing happens. - isDeprecated: false - syntax: - content: function stopTypingTimer() - - name: >- - teamsReadReceipt((context: TurnContext, state: TState, readReceiptInfo: - ReadReceiptInfo) => Promise) - uid: '@microsoft/teams-ai.Application.teamsReadReceipt' - package: '@microsoft/teams-ai' - summary: Adds a handler for Teams' readReceiptInfo event - remarks: '' - isDeprecated: false - syntax: - content: >- - function teamsReadReceipt(handler: (context: TurnContext, state: TState, - readReceiptInfo: ReadReceiptInfo) => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, readReceiptInfo: - ReadReceiptInfo) => Promise<void> - description: Function to call when the event is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> - - name: >- - turn(TurnEvents | TurnEvents[], (context: TurnContext, state: TState) => - Promise) - uid: '@microsoft/teams-ai.Application.turn' - package: '@microsoft/teams-ai' - summary: Registers a turn event handler. - remarks: >- - Turn events let you do something before or after a turn is run. Returning - false from - - `beforeTurn` lets you prevent the turn from running and returning false - from `afterTurn` - - lets you prevent the bots state from being saved. - - - Returning false from `beforeTurn` does result in the bots state being - saved which lets you - - track the reason why the turn was not processed. It also means you can use - `beforeTurn` as - - a way to call into the dialog system. For example, you could use the - OAuthPrompt to sign the - - user in before allowing the AI system to run. - isDeprecated: false - syntax: - content: >- - function turn(event: TurnEvents | TurnEvents[], handler: (context: - TurnContext, state: TState) => Promise): Application - parameters: - - id: event - type: >- - | [] - description: Name of the turn event to handle. - - id: handler - type: '(context: TurnContext, state: TState) => Promise<boolean>' - description: Function to call when the event is triggered. - return: - description: The application instance for chaining purposes. - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationBuilder.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationBuilder.yml deleted file mode 100644 index 2f2caf69..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationBuilder.yml +++ /dev/null @@ -1,187 +0,0 @@ -### YamlMime:TSType -name: ApplicationBuilder -uid: '@microsoft/teams-ai.ApplicationBuilder' -package: '@microsoft/teams-ai' -summary: A builder class for simplifying the creation of an Application instance. -fullName: ApplicationBuilder -remarks: '' -isDeprecated: false -type: class -methods: - - name: build() - uid: '@microsoft/teams-ai.ApplicationBuilder.build' - package: '@microsoft/teams-ai' - summary: Builds and returns a new Application instance. - remarks: '' - isDeprecated: false - syntax: - content: 'function build(): Application' - return: - description: The Application instance. - type: <TState> - - name: setRemoveRecipientMention(boolean) - uid: '@microsoft/teams-ai.ApplicationBuilder.setRemoveRecipientMention' - package: '@microsoft/teams-ai' - summary: >- - Configures the removing of mentions of the bot's name from incoming - messages. - - Default state for removeRecipientMention is true - remarks: '' - isDeprecated: false - syntax: - content: >- - function setRemoveRecipientMention(removeRecipientMention: boolean): - ApplicationBuilder - parameters: - - id: removeRecipientMention - type: boolean - description: The boolean for removing reciepient mentions. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: setStartTypingTimer(boolean) - uid: '@microsoft/teams-ai.ApplicationBuilder.setStartTypingTimer' - package: '@microsoft/teams-ai' - summary: |- - Configures the typing timer when messages are received. - Default state for startTypingTimer is true - remarks: '' - isDeprecated: false - syntax: - content: >- - function setStartTypingTimer(startTypingTimer: boolean): - ApplicationBuilder - parameters: - - id: startTypingTimer - type: boolean - description: The boolean for starting the typing timer. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withAdaptiveCardOptions(AdaptiveCardsOptions) - uid: '@microsoft/teams-ai.ApplicationBuilder.withAdaptiveCardOptions' - package: '@microsoft/teams-ai' - summary: Configures the processing of Adaptive Card requests. - remarks: '' - isDeprecated: false - syntax: - content: >- - function withAdaptiveCardOptions(adaptiveCardOptions: - AdaptiveCardsOptions): ApplicationBuilder - parameters: - - id: adaptiveCardOptions - type: - description: The options for the Adaptive Cards. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withAIOptions(AIOptions) - uid: '@microsoft/teams-ai.ApplicationBuilder.withAIOptions' - package: '@microsoft/teams-ai' - summary: Configures the AI system to use for processing incoming messages. - remarks: '' - isDeprecated: false - syntax: - content: >- - function withAIOptions(aiOptions: AIOptions): - ApplicationBuilder - parameters: - - id: aiOptions - type: <TState> - description: The options for the AI system. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withAuthentication(TeamsAdapter, AuthenticationOptions) - uid: '@microsoft/teams-ai.ApplicationBuilder.withAuthentication' - package: '@microsoft/teams-ai' - summary: Configures user authentication settings. - remarks: '' - isDeprecated: false - syntax: - content: >- - function withAuthentication(adapter: TeamsAdapter, - authenticationOptions: AuthenticationOptions): - ApplicationBuilder - parameters: - - id: adapter - type: - description: The adapter to use for user authentication. - - id: authenticationOptions - type: - description: The options to configure the authentication manager. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withLongRunningMessages(TeamsAdapter, string) - uid: '@microsoft/teams-ai.ApplicationBuilder.withLongRunningMessages' - package: '@microsoft/teams-ai' - summary: |- - Configures the application to use long running messages. - Default state for longRunningMessages is false - remarks: '' - isDeprecated: false - syntax: - content: >- - function withLongRunningMessages(adapter: TeamsAdapter, botAppId: - string): ApplicationBuilder - parameters: - - id: adapter - type: - description: The adapter to use for routing incoming requests. - - id: botAppId - type: string - description: The Microsoft App ID for the bot. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withStorage(Storage) - uid: '@microsoft/teams-ai.ApplicationBuilder.withStorage' - package: '@microsoft/teams-ai' - summary: Configures the storage system to use for storing the bot's state. - remarks: '' - isDeprecated: false - syntax: - content: 'function withStorage(storage: Storage): ApplicationBuilder' - parameters: - - id: storage - type: Storage - description: The storage system to use. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withTaskModuleOptions(TaskModulesOptions) - uid: '@microsoft/teams-ai.ApplicationBuilder.withTaskModuleOptions' - package: '@microsoft/teams-ai' - summary: Configures the processing of Task Module requests. - remarks: '' - isDeprecated: false - syntax: - content: >- - function withTaskModuleOptions(taskModuleOptions: TaskModulesOptions): - ApplicationBuilder - parameters: - - id: taskModuleOptions - type: - description: The options for the Task Modules. - return: - description: The ApplicationBuilder instance. - type: <TState> - - name: withTurnStateFactory(() => TState) - uid: '@microsoft/teams-ai.ApplicationBuilder.withTurnStateFactory' - package: '@microsoft/teams-ai' - summary: Configures the turn state factory for managing the bot's turn state. - remarks: '' - isDeprecated: false - syntax: - content: >- - function withTurnStateFactory(turnStateFactory: () => TState): - ApplicationBuilder - parameters: - - id: turnStateFactory - type: () => TState - description: Factory used to create a custom turn state instance. - return: - description: The ApplicationBuilder instance. - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationOptions.yml deleted file mode 100644 index f614fbfa..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationOptions.yml +++ /dev/null @@ -1,187 +0,0 @@ -### YamlMime:TSType -name: ApplicationOptions -uid: '@microsoft/teams-ai.ApplicationOptions' -package: '@microsoft/teams-ai' -summary: Options for the Application class. -fullName: ApplicationOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: adapter - uid: '@microsoft/teams-ai.ApplicationOptions.adapter' - package: '@microsoft/teams-ai' - summary: Optional. Options used to initialize your `BotAdapter` - fullName: adapter - remarks: '' - isDeprecated: false - syntax: - content: 'adapter?: TeamsAdapter' - return: - description: '' - type: - - name: adaptiveCards - uid: '@microsoft/teams-ai.ApplicationOptions.adaptiveCards' - package: '@microsoft/teams-ai' - summary: >- - Optional. Options used to customize the processing of Adaptive Card - requests. - fullName: adaptiveCards - remarks: '' - isDeprecated: false - syntax: - content: 'adaptiveCards?: AdaptiveCardsOptions' - return: - description: '' - type: - - name: ai - uid: '@microsoft/teams-ai.ApplicationOptions.ai' - package: '@microsoft/teams-ai' - summary: >- - Optional. AI options to use. When provided, a new instance of the AI - system will be created. - fullName: ai - remarks: '' - isDeprecated: false - syntax: - content: 'ai?: AIOptions' - return: - description: '' - type: <TState> - - name: authentication - uid: '@microsoft/teams-ai.ApplicationOptions.authentication' - package: '@microsoft/teams-ai' - summary: Optional. OAuth prompt settings to use for authentication. - fullName: authentication - remarks: '' - isDeprecated: false - syntax: - content: 'authentication?: AuthenticationOptions' - return: - description: '' - type: - - name: botAppId - uid: '@microsoft/teams-ai.ApplicationOptions.botAppId' - package: '@microsoft/teams-ai' - summary: Optional. Application ID of the bot. - fullName: botAppId - remarks: >- - If using the `longRunningMessages` option or calling the - continueConversationAsync() method, - - this property is required. - isDeprecated: false - syntax: - content: 'botAppId?: string' - return: - description: '' - type: string - - name: fileDownloaders - uid: '@microsoft/teams-ai.ApplicationOptions.fileDownloaders' - package: '@microsoft/teams-ai' - summary: Optional. Array of input file download plugins to use. - fullName: fileDownloaders - remarks: '' - isDeprecated: false - syntax: - content: 'fileDownloaders?: InputFileDownloader[]' - return: - description: '' - type: <TState>[] - - name: longRunningMessages - uid: '@microsoft/teams-ai.ApplicationOptions.longRunningMessages' - package: '@microsoft/teams-ai' - summary: >- - Optional. If true, the bot supports long running messages that can take - longer then the 10 - 15 - - second timeout imposed by most channels. Defaults to false. - fullName: longRunningMessages - remarks: >- - This works by immediately converting the incoming request to a proactive - conversation. Care should - - be used for bots that operate in a shared hosting environment. The - incoming request is immediately - - completed and many shared hosting environments will mark the bot's process - as idle and shut it down. - isDeprecated: false - syntax: - content: 'longRunningMessages: boolean' - return: - description: '' - type: boolean - - name: removeRecipientMention - uid: '@microsoft/teams-ai.ApplicationOptions.removeRecipientMention' - package: '@microsoft/teams-ai' - summary: >- - Optional. If true, the bot will automatically remove mentions of the bot's - name from incoming - - messages. Defaults to true. - fullName: removeRecipientMention - remarks: '' - isDeprecated: false - syntax: - content: 'removeRecipientMention: boolean' - return: - description: '' - type: boolean - - name: startTypingTimer - uid: '@microsoft/teams-ai.ApplicationOptions.startTypingTimer' - package: '@microsoft/teams-ai' - summary: >- - Optional. If true, the bot will automatically start a typing timer when - messages are received. - - This allows the bot to automatically indicate that it's received the - message and is processing - - the request. Defaults to true. - fullName: startTypingTimer - remarks: '' - isDeprecated: false - syntax: - content: 'startTypingTimer: boolean' - return: - description: '' - type: boolean - - name: storage - uid: '@microsoft/teams-ai.ApplicationOptions.storage' - package: '@microsoft/teams-ai' - summary: Optional. Storage provider to use for the application. - fullName: storage - remarks: '' - isDeprecated: false - syntax: - content: 'storage?: Storage' - return: - description: '' - type: Storage - - name: taskModules - uid: '@microsoft/teams-ai.ApplicationOptions.taskModules' - package: '@microsoft/teams-ai' - summary: >- - Optional. Options used to customize the processing of task module - requests. - fullName: taskModules - remarks: '' - isDeprecated: false - syntax: - content: 'taskModules?: TaskModulesOptions' - return: - description: '' - type: - - name: turnStateFactory - uid: '@microsoft/teams-ai.ApplicationOptions.turnStateFactory' - package: '@microsoft/teams-ai' - summary: Optional. Factory used to create a custom turn state instance. - fullName: turnStateFactory - remarks: '' - isDeprecated: false - syntax: - content: 'turnStateFactory: () => TState' - return: - description: '' - type: () => TState diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AssistantMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AssistantMessage.yml deleted file mode 100644 index b4563ba6..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AssistantMessage.yml +++ /dev/null @@ -1,185 +0,0 @@ -### YamlMime:TSType -name: AssistantMessage -uid: '@microsoft/teams-ai.AssistantMessage' -package: '@microsoft/teams-ai' -summary: A message sent by the assistant. -fullName: AssistantMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: AssistantMessage(string, number, string) - uid: '@microsoft/teams-ai.AssistantMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'AssistantMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new AssistantMessage(template: string, tokens?: number, - assistantPrefix?: string) - parameters: - - id: template - type: string - description: Template to use for this section. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to -1, `auto`. - - id: assistantPrefix - type: string - description: >- - Optional. Prefix to use for assistant messages when rendering as - text. Defaults to `assistant: `. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.AssistantMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [TemplateSection.required](xref:@microsoft/teams-ai.TemplateSection.required) - - name: role - uid: '@microsoft/teams-ai.AssistantMessage.role' - package: '@microsoft/teams-ai' - summary: '' - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.role](xref:@microsoft/teams-ai.TemplateSection.role) - - name: separator - uid: '@microsoft/teams-ai.AssistantMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.separator](xref:@microsoft/teams-ai.TemplateSection.separator) - - name: template - uid: '@microsoft/teams-ai.AssistantMessage.template' - package: '@microsoft/teams-ai' - summary: '' - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.template](xref:@microsoft/teams-ai.TemplateSection.template) - - name: textPrefix - uid: '@microsoft/teams-ai.AssistantMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.textPrefix](xref:@microsoft/teams-ai.TemplateSection.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.AssistantMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [TemplateSection.tokens](xref:@microsoft/teams-ai.TemplateSection.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.AssistantMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.getMessageText](xref:@microsoft/teams-ai.TemplateSection.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.AssistantMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [TemplateSection.renderAsText](xref:@microsoft/teams-ai.TemplateSection.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Augmentation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Augmentation.yml deleted file mode 100644 index 14c306b0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Augmentation.yml +++ /dev/null @@ -1,87 +0,0 @@ -### YamlMime:TSType -name: Augmentation -uid: '@microsoft/teams-ai.Augmentation' -package: '@microsoft/teams-ai' -summary: >- - An augmentation is a component that can be added to a prompt template to add - additional - - functionality to the prompt. -fullName: Augmentation -remarks: '' -isDeprecated: false -type: interface -inheritedMethods: - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.Augmentation.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<TContent>> - inheritanceDescription: >- - Inherited From - [PromptResponseValidator.validateResponse](xref:@microsoft/teams-ai.PromptResponseValidator.validateResponse) -methods: - - name: createPlanFromResponse(TurnContext, Memory, PromptResponse) - uid: '@microsoft/teams-ai.Augmentation.createPlanFromResponse' - package: '@microsoft/teams-ai' - summary: Creates a plan given validated response value. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createPlanFromResponse(context: TurnContext, memory: Memory, - response: PromptResponse): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: An interface for accessing state variables. - - id: response - type: PromptResponse<TContent> - description: The validated and transformed response for the prompt. - return: - description: The created plan. - type: Promise<> - - name: createPromptSection() - uid: '@microsoft/teams-ai.Augmentation.createPromptSection' - package: '@microsoft/teams-ai' - summary: Creates an optional prompt section for the augmentation. - remarks: '' - isDeprecated: false - syntax: - content: 'function createPromptSection(): undefined | PromptSection' - return: - description: '' - type: undefined | -extends: <TContent> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AugmentationConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AugmentationConfig.yml deleted file mode 100644 index a66e789f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AugmentationConfig.yml +++ /dev/null @@ -1,36 +0,0 @@ -### YamlMime:TSType -name: AugmentationConfig -uid: '@microsoft/teams-ai.AugmentationConfig' -package: '@microsoft/teams-ai' -summary: Interface for the augmentation configuration portion of a prompt template. -fullName: AugmentationConfig -remarks: New in schema version 1.1. -isDeprecated: false -type: interface -properties: - - name: augmentation_type - uid: '@microsoft/teams-ai.AugmentationConfig.augmentation_type' - package: '@microsoft/teams-ai' - summary: The type of augmentation to use. - fullName: augmentation_type - remarks: '' - isDeprecated: false - syntax: - content: 'augmentation_type: "none" | "monologue" | "sequence" | "tools"' - return: - description: '' - type: '"none" | "monologue" | "sequence" | "tools"' - - name: data_sources - uid: '@microsoft/teams-ai.AugmentationConfig.data_sources' - package: '@microsoft/teams-ai' - summary: Optional. List of named data sources to augment the prompt with. - fullName: data_sources - remarks: >- - For each data source, the value is the max number of tokens to use from - the data source. - isDeprecated: false - syntax: - content: 'data_sources?: {[name: string]: number}' - return: - description: '' - type: '{[name: string]: number}' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthError.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthError.yml deleted file mode 100644 index 1a466f57..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthError.yml +++ /dev/null @@ -1,217 +0,0 @@ -### YamlMime:TSType -name: AuthError -uid: '@microsoft/teams-ai.AuthError' -package: '@microsoft/teams-ai' -summary: An error thrown when an authentication error occurs. -fullName: AuthError -remarks: '' -isDeprecated: false -type: class -constructors: - - name: AuthError(string, AuthErrorReason) - uid: '@microsoft/teams-ai.AuthError.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the `AuthError` class. - remarks: '' - isDeprecated: false - syntax: - content: 'new AuthError(message?: string, reason?: AuthErrorReason)' - parameters: - - id: message - type: string - description: The error message. - - id: reason - type: - description: Optional. Cause of the error. Defaults to `other`. -properties: - - name: cause - uid: '@microsoft/teams-ai.AuthError.cause' - package: '@microsoft/teams-ai' - summary: The cause of the error. - fullName: cause - remarks: '' - isDeprecated: false - syntax: - content: 'cause: AuthErrorReason' - return: - description: '' - type: -inheritedProperties: - - name: message - uid: '@microsoft/teams-ai.AuthError.message' - package: '@microsoft/teams-ai' - summary: '' - fullName: message - remarks: '' - isDeprecated: false - syntax: - content: 'message: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.message - - name: name - uid: '@microsoft/teams-ai.AuthError.name' - package: '@microsoft/teams-ai' - summary: '' - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@microsoft/teams-ai.AuthError.stack' - package: '@microsoft/teams-ai' - summary: '' - fullName: stack - remarks: '' - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack - - name: stackTraceLimit - uid: '@microsoft/teams-ai.AuthError.stackTraceLimit' - package: '@microsoft/teams-ai' - summary: >- - The `Error.stackTraceLimit` property specifies the number of stack frames - - collected by a stack trace (whether generated by `new Error().stack` or - - `Error.captureStackTrace(obj)`). - - - The default value is `10` but may be set to any valid JavaScript number. - Changes - - will affect any stack trace captured _after_ the value has been changed. - - - If set to a non-number value, or set to a negative number, stack traces - will - - not capture any frames. - fullName: stackTraceLimit - remarks: '' - isDeprecated: false - syntax: - content: 'static stackTraceLimit: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Error.stackTraceLimit -inheritedMethods: - - name: captureStackTrace(object, Function) - uid: '@microsoft/teams-ai.AuthError.captureStackTrace' - package: '@microsoft/teams-ai' - summary: >- - Creates a `.stack` property on `targetObject`, which when accessed returns - - a string representing the location in the code at which - - `Error.captureStackTrace()` was called. - - - ```js - - const myObject = {}; - - Error.captureStackTrace(myObject); - - myObject.stack; // Similar to `new Error().stack` - - ``` - - - The first line of the trace will be prefixed with - - `${myObject.name}: ${myObject.message}`. - - - The optional `constructorOpt` argument accepts a function. If given, all - frames - - above `constructorOpt`, including `constructorOpt`, will be omitted from - the - - generated stack trace. - - - The `constructorOpt` argument is useful for hiding implementation - - details of error generation from the user. For instance: - - - ```js - - function a() { - b(); - } - - - function b() { - c(); - } - - - function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; - } - - - a(); - - ``` - remarks: '' - isDeprecated: false - syntax: - content: >- - static function captureStackTrace(targetObject: object, constructorOpt?: - Function) - parameters: - - id: targetObject - type: object - description: '' - - id: constructorOpt - type: Function - description: '' - inheritanceDescription: Inherited From Error.captureStackTrace - - name: prepareStackTrace(Error, CallSite[]) - uid: '@microsoft/teams-ai.AuthError.prepareStackTrace' - package: '@microsoft/teams-ai' - summary: |- - - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - remarks: '' - isDeprecated: false - syntax: - content: >- - static function prepareStackTrace(err: Error, stackTraces: CallSite[]): - any - parameters: - - id: err - type: Error - description: '' - - id: stackTraces - type: CallSite[] - description: '' - return: - description: '' - type: any - inheritanceDescription: Inherited From Error.prepareStackTrace -extends: Error diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthErrorReason.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthErrorReason.yml deleted file mode 100644 index 17b77e26..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthErrorReason.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: AuthErrorReason -uid: '@microsoft/teams-ai.AuthErrorReason' -package: '@microsoft/teams-ai' -summary: Cause of an authentication error. -fullName: AuthErrorReason -remarks: >- - `invalidActivity` - The activity is not a valid activity to initiate - authentication flow. - - `completionWithoutToken` - The authentication flow completed without a token. - - `other` - Other error. -isDeprecated: false -syntax: | - type AuthErrorReason = "invalidActivity" | "completionWithoutToken" | "other" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Authentication.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Authentication.yml deleted file mode 100644 index b5485df6..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Authentication.yml +++ /dev/null @@ -1,169 +0,0 @@ -### YamlMime:TSType -name: Authentication -uid: '@microsoft/teams-ai.Authentication' -package: '@microsoft/teams-ai' -summary: User authentication service. -fullName: Authentication -remarks: '' -isDeprecated: false -type: class -constructors: - - name: >- - Authentication(Application, string, OAuthSettings | - TeamsSsoSettings, Storage, MessageExtensionAuthenticationBase, - BotAuthenticationBase, AdaptiveCardAuthenticationBase) - uid: '@microsoft/teams-ai.Authentication.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the `Authentication` class. - remarks: '' - isDeprecated: false - syntax: - content: >- - new Authentication(app: Application, name: string, settings: - OAuthSettings | TeamsSsoSettings, storage?: Storage, - messageExtensionsAuth?: MessageExtensionAuthenticationBase, botAuth?: - BotAuthenticationBase, adaptiveCardAuth?: - AdaptiveCardAuthenticationBase) - parameters: - - id: app - type: <TState> - description: The application instance. - - id: name - type: string - description: The name of the connection. - - id: settings - type: | TeamsSsoSettings - description: Authentication settings. - - id: storage - type: Storage - description: A storage instance otherwise Memory Storage is used. - - id: messageExtensionsAuth - type: MessageExtensionAuthenticationBase - description: Handles message extension flow authentication. - - id: botAuth - type: BotAuthenticationBase<TState> - description: Handles bot-flow authentication. - - id: adaptiveCardAuth - type: AdaptiveCardAuthenticationBase - description: Handles adaptive card authentication. -properties: - - name: settings - uid: '@microsoft/teams-ai.Authentication.settings' - package: '@microsoft/teams-ai' - summary: The authentication settings. - fullName: settings - remarks: '' - isDeprecated: false - syntax: - content: 'settings: OAuthSettings | TeamsSsoSettings' - return: - description: '' - type: | TeamsSsoSettings -methods: - - name: isUserSignedIn(TurnContext) - uid: '@microsoft/teams-ai.Authentication.isUserSignedIn' - package: '@microsoft/teams-ai' - summary: Check if the user is signed, if they are then return the token. - remarks: '' - isDeprecated: false - syntax: - content: >- - function isUserSignedIn(context: TurnContext): Promise - parameters: - - id: context - type: TurnContext - description: Current turn context. - return: - description: The token string or undefined if the user is not signed in. - type: Promise<undefined | string> - - name: >- - onUserSignInFailure((context: TurnContext, state: TState, error: - AuthError) => Promise) - uid: '@microsoft/teams-ai.Authentication.onUserSignInFailure' - package: '@microsoft/teams-ai' - summary: >- - This handler function is called when the user sign in flow fails. - - This only applies if sign in was initiated by the user sending a message - to the bot. - - This handler will not be triggered if a message extension triggered the - authentication flow. - remarks: '' - isDeprecated: false - syntax: - content: >- - function onUserSignInFailure(handler: (context: TurnContext, state: - TState, error: AuthError) => Promise) - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, error: AuthError) => - Promise<void> - description: The handler function to call when the user failed to signed in. - - name: >- - onUserSignInSuccess((context: TurnContext, state: TState) => - Promise) - uid: '@microsoft/teams-ai.Authentication.onUserSignInSuccess' - package: '@microsoft/teams-ai' - summary: >- - The handler function is called when the user has successfully signed in. - - This only applies if sign in was initiated by the user sending a message - to the bot. - - This handler will not be triggered if a message extension triggered the - authentication flow. - remarks: '' - isDeprecated: false - syntax: - content: >- - function onUserSignInSuccess(handler: (context: TurnContext, state: - TState) => Promise) - parameters: - - id: handler - type: '(context: TurnContext, state: TState) => Promise<void>' - description: >- - The handler function to call when the user has successfully signed - in - - name: signInUser(TurnContext, TState) - uid: '@microsoft/teams-ai.Authentication.signInUser' - package: '@microsoft/teams-ai' - summary: |- - Signs in a user. - This method will be called automatically by the Application class. - remarks: '' - isDeprecated: false - syntax: - content: >- - function signInUser(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: state - type: TState - description: Application state. - return: - description: The authentication token or undefined if the user is still login in. - type: Promise<undefined | string> - - name: signOutUser(TurnContext, TState) - uid: '@microsoft/teams-ai.Authentication.signOutUser' - package: '@microsoft/teams-ai' - summary: Signs out a user. - remarks: '' - isDeprecated: false - syntax: - content: 'function signOutUser(context: TurnContext, state: TState): Promise' - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: state - type: TState - description: Application state. - return: - description: A Promise representing the asynchronous operation. - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationManager.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationManager.yml deleted file mode 100644 index f878dc67..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationManager.yml +++ /dev/null @@ -1,111 +0,0 @@ -### YamlMime:TSType -name: AuthenticationManager -uid: '@microsoft/teams-ai.AuthenticationManager' -package: '@microsoft/teams-ai' -summary: The user authentication manager. -fullName: AuthenticationManager -remarks: '' -isDeprecated: false -type: class -constructors: - - name: >- - AuthenticationManager(Application, AuthenticationOptions, - Storage) - uid: '@microsoft/teams-ai.AuthenticationManager.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the `AuthenticationManager` class. - remarks: '' - isDeprecated: false - syntax: - content: >- - new AuthenticationManager(app: Application, options: - AuthenticationOptions, storage?: Storage) - parameters: - - id: app - type: <TState> - description: The application instance. - - id: options - type: - description: Authentication options. - - id: storage - type: Storage - description: A storage instance otherwise Memory Storage is used. -properties: - - name: default - uid: '@microsoft/teams-ai.AuthenticationManager.default' - package: '@microsoft/teams-ai' - summary: '' - fullName: default - remarks: '' - isDeprecated: false - syntax: - content: 'default: string' - return: - description: '' - type: string -methods: - - name: get(string) - uid: '@microsoft/teams-ai.AuthenticationManager.get' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function get(name: string): Authentication' - parameters: - - id: name - type: string - description: The setting name. - return: - description: The authentication instance. - type: <TState> - - name: signOutUser(TurnContext, TState, string) - uid: '@microsoft/teams-ai.AuthenticationManager.signOutUser' - package: '@microsoft/teams-ai' - summary: Signs out a user. - remarks: '' - isDeprecated: false - syntax: - content: >- - function signOutUser(context: TurnContext, state: TState, settingName?: - string): Promise - parameters: - - id: context - type: TurnContext - description: The turn context. - - id: state - type: TState - description: The turn state. - - id: settingName - type: string - description: >- - Optional. The name of the setting to use. If not specified, the - default setting name is used. - return: - description: '' - type: Promise<void> - - name: signUserIn(TurnContext, TState, string) - uid: '@microsoft/teams-ai.AuthenticationManager.signUserIn' - package: '@microsoft/teams-ai' - summary: Signs in a user. - remarks: '' - isDeprecated: false - syntax: - content: >- - function signUserIn(context: TurnContext, state: TState, settingName?: - string): Promise - parameters: - - id: context - type: TurnContext - description: The turn context. - - id: state - type: TState - description: The turn state. - - id: settingName - type: string - description: >- - Optional. The name of the setting to use. If not specified, the - default setting name is used. - return: - description: The sign in response. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationOptions.yml deleted file mode 100644 index 338a3cfc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationOptions.yml +++ /dev/null @@ -1,62 +0,0 @@ -### YamlMime:TSType -name: AuthenticationOptions -uid: '@microsoft/teams-ai.AuthenticationOptions' -package: '@microsoft/teams-ai' -summary: The options to configure the authentication manager -fullName: AuthenticationOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: autoSignIn - uid: '@microsoft/teams-ai.AuthenticationOptions.autoSignIn' - package: '@microsoft/teams-ai' - summary: >- - Defaults to true. - - Indicates whether the bot should start the sign in flow when the user - sends a message to the bot or triggers a message extension. - - If set to false, the bot will not start the sign in flow before routing - the activity to the bot logic. - - - To set custom logic, set this property to the selector function. - fullName: autoSignIn - remarks: '' - isDeprecated: false - syntax: - content: 'autoSignIn?: boolean | Selector' - return: - description: '' - type: boolean | - - name: default - uid: '@microsoft/teams-ai.AuthenticationOptions.default' - package: '@microsoft/teams-ai' - summary: >- - Describes the setting the bot should use if the user does not specify a - setting name. - fullName: default - remarks: '' - isDeprecated: false - syntax: - content: 'default?: string' - return: - description: '' - type: string - - name: settings - uid: '@microsoft/teams-ai.AuthenticationOptions.settings' - package: '@microsoft/teams-ai' - summary: |- - The authentication settings. - Key uniquely identifies the connection string. - fullName: settings - remarks: '' - isDeprecated: false - syntax: - content: 'settings: {[key: string]: OAuthSettings | TeamsSsoSettings}' - return: - description: '' - type: >- - {[key: string]: | - TeamsSsoSettings} diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticatorResult.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticatorResult.yml deleted file mode 100644 index 58c9aaa7..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticatorResult.yml +++ /dev/null @@ -1,36 +0,0 @@ -### YamlMime:TSType -name: AuthenticatorResult -uid: '@microsoft/teams-ai.AuthenticatorResult' -package: '@microsoft/teams-ai' -summary: '' -fullName: AuthenticatorResult -remarks: '' -isDeprecated: false -type: interface -properties: - - name: accessToken - uid: '@microsoft/teams-ai.AuthenticatorResult.accessToken' - package: '@microsoft/teams-ai' - summary: The value of the access token resulting from an authentication process. - fullName: accessToken - remarks: '' - isDeprecated: false - syntax: - content: 'accessToken: string' - return: - description: '' - type: string - - name: expiresOn - uid: '@microsoft/teams-ai.AuthenticatorResult.expiresOn' - package: '@microsoft/teams-ai' - summary: >- - The date and time of expiration relative to Coordinated Universal Time - (UTC). - fullName: expiresOn - remarks: '' - isDeprecated: false - syntax: - content: 'expiresOn: Date' - return: - description: '' - type: Date diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureContentSafetyModerator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureContentSafetyModerator.yml deleted file mode 100644 index af2285cb..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureContentSafetyModerator.yml +++ /dev/null @@ -1,88 +0,0 @@ -### YamlMime:TSType -name: AzureContentSafetyModerator -uid: '@microsoft/teams-ai.AzureContentSafetyModerator' -package: '@microsoft/teams-ai' -summary: >- - An Azure OpenAI moderator that uses OpenAI's moderation API to review prompts - and plans for safety. -fullName: AzureContentSafetyModerator -remarks: >- - This moderation can be configured to review the input from the user, output - from the model, or both. -isDeprecated: false -type: class -constructors: - - name: AzureContentSafetyModerator(AzureOpenAIModeratorOptions) - uid: '@microsoft/teams-ai.AzureContentSafetyModerator.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the OpenAI based moderator. - remarks: '' - isDeprecated: false - syntax: - content: 'new AzureContentSafetyModerator(options: AzureOpenAIModeratorOptions)' - parameters: - - id: options - type: - description: Configuration options for the moderator. -properties: - - name: options - uid: '@microsoft/teams-ai.AzureContentSafetyModerator.options' - package: '@microsoft/teams-ai' - summary: '' - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: OpenAIModeratorOptions options - return: - description: '' - type: -methods: - - name: reviewInput(TurnContext, TState) - uid: '@microsoft/teams-ai.AzureContentSafetyModerator.reviewInput' - package: '@microsoft/teams-ai' - summary: Reviews an incoming prompt for safety violations. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewInput(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - return: - description: >- - An undefined value to approve the prompt or a new plan to redirect to - if not approved. - type: Promise<undefined | > - - name: reviewOutput(TurnContext, TState, Plan) - uid: '@microsoft/teams-ai.AzureContentSafetyModerator.reviewOutput' - package: '@microsoft/teams-ai' - summary: Reviews the SAY commands generated by the planner for safety violations. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewOutput(context: TurnContext, state: TState, plan: Plan): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: plan - type: - description: Plan generated by the planner. - return: - description: >- - The plan to execute. Either the current plan passed in for review or a - new plan. - type: Promise<> -extends: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIEmbeddingsOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIEmbeddingsOptions.yml deleted file mode 100644 index 6f6f271a..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIEmbeddingsOptions.yml +++ /dev/null @@ -1,126 +0,0 @@ -### YamlMime:TSType -name: AzureOpenAIEmbeddingsOptions -uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions' -package: '@microsoft/teams-ai' -summary: >- - Options for configuring an `OpenAIEmbeddings` to generate embeddings using an - Azure OpenAI hosted model. -fullName: AzureOpenAIEmbeddingsOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: azureApiKey - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.azureApiKey' - package: '@microsoft/teams-ai' - summary: API key to use when making requests to Azure OpenAI. - fullName: azureApiKey - remarks: '' - isDeprecated: false - syntax: - content: 'azureApiKey: string' - return: - description: '' - type: string - - name: azureApiVersion - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.azureApiVersion' - package: '@microsoft/teams-ai' - summary: Optional. Version of the API being called. Defaults to `2023-05-15`. - fullName: azureApiVersion - remarks: '' - isDeprecated: false - syntax: - content: 'azureApiVersion?: string' - return: - description: '' - type: string - - name: azureDeployment - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.azureDeployment' - package: '@microsoft/teams-ai' - summary: Name of the Azure OpenAI deployment (model) to use. - fullName: azureDeployment - remarks: '' - isDeprecated: false - syntax: - content: 'azureDeployment: string' - return: - description: '' - type: string - - name: azureEndpoint - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.azureEndpoint' - package: '@microsoft/teams-ai' - summary: Deployment endpoint to use. - fullName: azureEndpoint - remarks: '' - isDeprecated: false - syntax: - content: 'azureEndpoint: string' - return: - description: '' - type: string -inheritedProperties: - - name: dimensions - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.dimensions' - package: '@microsoft/teams-ai' - summary: Optional. Number of dimensions to use when generating embeddings. - fullName: dimensions - remarks: Only valid for embedding models that support dynamic dimensionality. - isDeprecated: false - syntax: - content: 'dimensions?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.dimensions](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.dimensions) - - name: logRequests - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.logRequests](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.logRequests) - - name: requestConfig - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: Optional. Request options to use when calling the OpenAI API. - fullName: requestConfig - remarks: '' - isDeprecated: false - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.requestConfig](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.requestConfig) - - name: retryPolicy - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: Optional. Retry policy to use when calling the OpenAI API. - fullName: retryPolicy - remarks: >- - The default retry policy is `[2000, 5000]` which means that the first - retry will be after - - 2 seconds and the second retry will be after 5 seconds. - isDeprecated: false - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.retryPolicy](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.retryPolicy) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModelOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModelOptions.yml deleted file mode 100644 index 296c2176..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModelOptions.yml +++ /dev/null @@ -1,224 +0,0 @@ -### YamlMime:TSType -name: AzureOpenAIModelOptions -uid: '@microsoft/teams-ai.AzureOpenAIModelOptions' -package: '@microsoft/teams-ai' -summary: Options for configuring an `OpenAIModel` to call an Azure OpenAI hosted model. -fullName: AzureOpenAIModelOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: azureADTokenProvider - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.azureADTokenProvider' - package: '@microsoft/teams-ai' - summary: >- - Optional. A function that returns an access token for Microsoft Entra - (formerly known as Azure Active Directory), - - which will be invoked on every request. - fullName: azureADTokenProvider - remarks: '' - isDeprecated: false - syntax: - content: 'azureADTokenProvider?: () => Promise' - return: - description: '' - type: () => Promise<string> - - name: azureApiKey - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.azureApiKey' - package: '@microsoft/teams-ai' - summary: API key to use when making requests to Azure OpenAI. - fullName: azureApiKey - remarks: '' - isDeprecated: false - syntax: - content: 'azureApiKey?: string' - return: - description: '' - type: string - - name: azureApiVersion - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.azureApiVersion' - package: '@microsoft/teams-ai' - summary: Optional. Version of the API being called. Defaults to `2023-05-15`. - fullName: azureApiVersion - remarks: '' - isDeprecated: false - syntax: - content: 'azureApiVersion?: string' - return: - description: '' - type: string - - name: azureDefaultDeployment - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.azureDefaultDeployment' - package: '@microsoft/teams-ai' - summary: Default name of the Azure OpenAI deployment (model) to use. - fullName: azureDefaultDeployment - remarks: '' - isDeprecated: false - syntax: - content: 'azureDefaultDeployment: string' - return: - description: '' - type: string - - name: azureEndpoint - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.azureEndpoint' - package: '@microsoft/teams-ai' - summary: Deployment endpoint to use. - fullName: azureEndpoint - remarks: '' - isDeprecated: false - syntax: - content: 'azureEndpoint: string' - return: - description: '' - type: string -inheritedProperties: - - name: clientOptions - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.clientOptions' - package: '@microsoft/teams-ai' - summary: Optional. Custom client options to use when calling the OpenAI API. - fullName: clientOptions - remarks: '' - isDeprecated: false - syntax: - content: 'clientOptions?: ClientOptions' - return: - description: '' - type: ClientOptions - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.clientOptions](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.clientOptions) - - name: logRequests - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.logRequests](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.logRequests) - - name: maxRetries - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.maxRetries' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of retries to use when calling the OpenAI API. - fullName: maxRetries - remarks: The default is to retry twice. - isDeprecated: false - syntax: - content: 'maxRetries?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.maxRetries](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.maxRetries) - - name: requestConfig - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: '' - fullName: requestConfig - remarks: '' - isDeprecated: true - customDeprecatedMessage: Optional. Request options to use when calling the OpenAI API. - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.requestConfig](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.requestConfig) - - name: responseFormat - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.responseFormat' - package: '@microsoft/teams-ai' - summary: Optional. Forces the model return a specific response format. - fullName: responseFormat - remarks: This can be used to force the model to always return a valid JSON object. - isDeprecated: false - syntax: - content: 'responseFormat?: { type: "json_object" }' - return: - description: '' - type: '{ type: "json_object" }' - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.responseFormat](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.responseFormat) - - name: retryPolicy - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: '' - fullName: retryPolicy - remarks: Use `maxRetries` instead. - isDeprecated: true - customDeprecatedMessage: Optional. Retry policy to use when calling the OpenAI API. - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.retryPolicy](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.retryPolicy) - - name: seed - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.seed' - package: '@microsoft/teams-ai' - summary: Optional. A static seed to use when making model calls. - fullName: seed - remarks: >- - The default is to use a random seed. Specifying a seed will make the model - deterministic. - isDeprecated: false - syntax: - content: 'seed?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.seed](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.seed) - - name: stream - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.stream' - package: '@microsoft/teams-ai' - summary: >- - Optional. Whether the models responses should be streamed back using - Server Sent Events (SSE.) - fullName: stream - remarks: Defaults to `false`. - isDeprecated: false - syntax: - content: 'stream?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.stream](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.stream) - - name: useSystemMessages - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions.useSystemMessages' - package: '@microsoft/teams-ai' - summary: Optional. Whether to use `system` messages when calling the OpenAI API. - fullName: useSystemMessages - remarks: >- - The current generation of models tend to follow instructions from `user` - messages better - - then `system` messages so the default is `false`, which causes any - `system` message in the - - prompt to be sent as `user` messages instead. - isDeprecated: false - syntax: - content: 'useSystemMessages?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.useSystemMessages](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.useSystemMessages) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModeratorOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModeratorOptions.yml deleted file mode 100644 index 53b0ef07..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModeratorOptions.yml +++ /dev/null @@ -1,176 +0,0 @@ -### YamlMime:TSType -name: AzureOpenAIModeratorOptions -uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions' -package: '@microsoft/teams-ai' -summary: Options for the OpenAI based moderator. -fullName: AzureOpenAIModeratorOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: blocklistNames - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.blocklistNames' - package: '@microsoft/teams-ai' - summary: >- - Text blocklist Name. Only support following characters: 0-9 A-Z a-z - . _ - ~. You could attach multiple lists name here. - fullName: blocklistNames - remarks: '' - isDeprecated: false - syntax: - content: 'blocklistNames?: string[]' - return: - description: '' - type: string[] - - name: breakByBlocklists - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.breakByBlocklists' - package: '@microsoft/teams-ai' - summary: '' - fullName: breakByBlocklists - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - use `haltOnBlocklistHit` - - - When set to true, further analyses of harmful content will not be - performed in cases where blocklists are hit. - - When set to false, all analyses of harmful content will be performed, - whether or not blocklists are hit. - - Default value is false. - syntax: - content: 'breakByBlocklists?: boolean' - return: - description: '' - type: boolean - - name: categories - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.categories' - package: '@microsoft/teams-ai' - summary: >- - Azure OpenAI Content Safety Categories. - - Each category is provided with a severity level threshold from 0 to 6. - - If the severity level of a category is greater than or equal to the - threshold, the category is flagged. - fullName: categories - remarks: '' - isDeprecated: false - syntax: - content: 'categories?: ContentSafetyHarmCategory[]' - return: - description: '' - type: ContentSafetyHarmCategory[] - - name: haltOnBlocklistHit - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.haltOnBlocklistHit' - package: '@microsoft/teams-ai' - summary: >- - When set to true, further analyses of harmful content will not be - performed in cases where blocklists are hit. - - When set to false, all analyses of harmful content will be performed, - whether or not blocklists are hit. - - Default value is false. - fullName: haltOnBlocklistHit - remarks: '' - isDeprecated: false - syntax: - content: 'haltOnBlocklistHit?: boolean' - return: - description: '' - type: boolean -inheritedProperties: - - name: apiKey - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.apiKey' - package: '@microsoft/teams-ai' - summary: OpenAI API key - fullName: apiKey - remarks: '' - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.apiKey](xref:@microsoft/teams-ai.OpenAIModeratorOptions.apiKey) - - name: apiVersion - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.apiVersion' - package: '@microsoft/teams-ai' - summary: Optional. Azure Content Safety API version. - fullName: apiVersion - remarks: '' - isDeprecated: false - syntax: - content: 'apiVersion?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.apiVersion](xref:@microsoft/teams-ai.OpenAIModeratorOptions.apiVersion) - - name: endpoint - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.endpoint' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI endpoint. - fullName: endpoint - remarks: '' - isDeprecated: false - syntax: - content: 'endpoint?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.endpoint](xref:@microsoft/teams-ai.OpenAIModeratorOptions.endpoint) - - name: model - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.model' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI model to use. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.model](xref:@microsoft/teams-ai.OpenAIModeratorOptions.model) - - name: moderate - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.moderate' - package: '@microsoft/teams-ai' - summary: Which parts of the conversation to moderate. - fullName: moderate - remarks: '' - isDeprecated: false - syntax: - content: 'moderate: "input" | "output" | "both"' - return: - description: '' - type: '"input" | "output" | "both"' - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.moderate](xref:@microsoft/teams-ai.OpenAIModeratorOptions.moderate) - - name: organization - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions.organization' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI organization. - fullName: organization - remarks: '' - isDeprecated: false - syntax: - content: 'organization?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [OpenAIModeratorOptions.organization](xref:@microsoft/teams-ai.OpenAIModeratorOptions.organization) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIEmbeddingsOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIEmbeddingsOptions.yml deleted file mode 100644 index 4bc484d4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIEmbeddingsOptions.yml +++ /dev/null @@ -1,62 +0,0 @@ -### YamlMime:TSType -name: BaseOpenAIEmbeddingsOptions -uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions' -package: '@microsoft/teams-ai' -summary: Base model options common to both OpenAI and Azure OpenAI services. -fullName: BaseOpenAIEmbeddingsOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: dimensions - uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.dimensions' - package: '@microsoft/teams-ai' - summary: Optional. Number of dimensions to use when generating embeddings. - fullName: dimensions - remarks: Only valid for embedding models that support dynamic dimensionality. - isDeprecated: false - syntax: - content: 'dimensions?: number' - return: - description: '' - type: number - - name: logRequests - uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - - name: requestConfig - uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: Optional. Request options to use when calling the OpenAI API. - fullName: requestConfig - remarks: '' - isDeprecated: false - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - - name: retryPolicy - uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: Optional. Retry policy to use when calling the OpenAI API. - fullName: retryPolicy - remarks: >- - The default retry policy is `[2000, 5000]` which means that the first - retry will be after - - 2 seconds and the second retry will be after 5 seconds. - isDeprecated: false - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIModelOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIModelOptions.yml deleted file mode 100644 index 9c57e3c3..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIModelOptions.yml +++ /dev/null @@ -1,131 +0,0 @@ -### YamlMime:TSType -name: BaseOpenAIModelOptions -uid: '@microsoft/teams-ai.BaseOpenAIModelOptions' -package: '@microsoft/teams-ai' -summary: Base model options common to both OpenAI and Azure OpenAI services. -fullName: BaseOpenAIModelOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: clientOptions - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.clientOptions' - package: '@microsoft/teams-ai' - summary: Optional. Custom client options to use when calling the OpenAI API. - fullName: clientOptions - remarks: '' - isDeprecated: false - syntax: - content: 'clientOptions?: ClientOptions' - return: - description: '' - type: ClientOptions - - name: logRequests - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - - name: maxRetries - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.maxRetries' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of retries to use when calling the OpenAI API. - fullName: maxRetries - remarks: The default is to retry twice. - isDeprecated: false - syntax: - content: 'maxRetries?: number' - return: - description: '' - type: number - - name: requestConfig - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: '' - fullName: requestConfig - remarks: '' - isDeprecated: true - customDeprecatedMessage: Optional. Request options to use when calling the OpenAI API. - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - - name: responseFormat - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.responseFormat' - package: '@microsoft/teams-ai' - summary: Optional. Forces the model return a specific response format. - fullName: responseFormat - remarks: This can be used to force the model to always return a valid JSON object. - isDeprecated: false - syntax: - content: 'responseFormat?: { type: "json_object" }' - return: - description: '' - type: '{ type: "json_object" }' - - name: retryPolicy - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: '' - fullName: retryPolicy - remarks: Use `maxRetries` instead. - isDeprecated: true - customDeprecatedMessage: Optional. Retry policy to use when calling the OpenAI API. - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - - name: seed - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.seed' - package: '@microsoft/teams-ai' - summary: Optional. A static seed to use when making model calls. - fullName: seed - remarks: >- - The default is to use a random seed. Specifying a seed will make the model - deterministic. - isDeprecated: false - syntax: - content: 'seed?: number' - return: - description: '' - type: number - - name: stream - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.stream' - package: '@microsoft/teams-ai' - summary: >- - Optional. Whether the models responses should be streamed back using - Server Sent Events (SSE.) - fullName: stream - remarks: Defaults to `false`. - isDeprecated: false - syntax: - content: 'stream?: boolean' - return: - description: '' - type: boolean - - name: useSystemMessages - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions.useSystemMessages' - package: '@microsoft/teams-ai' - summary: Optional. Whether to use `system` messages when calling the OpenAI API. - fullName: useSystemMessages - remarks: >- - The current generation of models tend to follow instructions from `user` - messages better - - then `system` messages so the default is `false`, which causes any - `system` message in the - - prompt to be sent as `user` messages instead. - isDeprecated: false - syntax: - content: 'useSystemMessages?: boolean' - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ChatCompletionAction.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ChatCompletionAction.yml deleted file mode 100644 index 143e1093..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ChatCompletionAction.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: ChatCompletionAction -uid: '@microsoft/teams-ai.ChatCompletionAction' -package: '@microsoft/teams-ai' -summary: An action that can be called by an LLM. -fullName: ChatCompletionAction -remarks: '' -isDeprecated: false -type: interface -properties: - - name: description - uid: '@microsoft/teams-ai.ChatCompletionAction.description' - package: '@microsoft/teams-ai' - summary: Optional. Description of what the action does. - fullName: description - remarks: '' - isDeprecated: false - syntax: - content: 'description?: string' - return: - description: '' - type: string - - name: name - uid: '@microsoft/teams-ai.ChatCompletionAction.name' - package: '@microsoft/teams-ai' - summary: Name of the action to be called. - fullName: name - remarks: >- - Must be a-z, A-Z, 0-9, or contain underscores and dashes, with a maximum - length of 64. - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: parameters - uid: '@microsoft/teams-ai.ChatCompletionAction.parameters' - package: '@microsoft/teams-ai' - summary: >- - Optional. Parameters the action accepts, described as a JSON Schema - object. - fullName: parameters - remarks: >- - See [JSON Schema - reference](https://json-schema.org/understanding-json-schema/) for - documentation - - about the format. - isDeprecated: false - syntax: - content: 'parameters?: Schema' - return: - description: '' - type: Schema diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Citation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Citation.yml deleted file mode 100644 index 6f4f8cf4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Citation.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: Citation -uid: '@microsoft/teams-ai.Citation' -package: '@microsoft/teams-ai' -summary: Citations returned by the model. -fullName: Citation -remarks: '' -isDeprecated: false -type: interface -properties: - - name: content - uid: '@microsoft/teams-ai.Citation.content' - package: '@microsoft/teams-ai' - summary: The content of the citation. - fullName: content - remarks: '' - isDeprecated: false - syntax: - content: 'content: string' - return: - description: '' - type: string - - name: filepath - uid: '@microsoft/teams-ai.Citation.filepath' - package: '@microsoft/teams-ai' - summary: The filepath of the document. - fullName: filepath - remarks: '' - isDeprecated: false - syntax: - content: 'filepath: null | string' - return: - description: '' - type: null | string - - name: title - uid: '@microsoft/teams-ai.Citation.title' - package: '@microsoft/teams-ai' - summary: The title of the citation. - fullName: title - remarks: '' - isDeprecated: false - syntax: - content: 'title: null | string' - return: - description: '' - type: null | string - - name: url - uid: '@microsoft/teams-ai.Citation.url' - package: '@microsoft/teams-ai' - summary: The URL of the citation. - fullName: url - remarks: '' - isDeprecated: false - syntax: - content: 'url: null | string' - return: - description: '' - type: null | string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredAIOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredAIOptions.yml deleted file mode 100644 index 21e5cb15..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredAIOptions.yml +++ /dev/null @@ -1,102 +0,0 @@ -### YamlMime:TSType -name: ConfiguredAIOptions -uid: '@microsoft/teams-ai.ConfiguredAIOptions' -package: '@microsoft/teams-ai' -summary: The configured options for the AI system after all defaults have been applied. -fullName: ConfiguredAIOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: allow_looping - uid: '@microsoft/teams-ai.ConfiguredAIOptions.allow_looping' - package: '@microsoft/teams-ai' - summary: If true, the AI system will allow the planner to loop. - fullName: allow_looping - remarks: '' - isDeprecated: false - syntax: - content: 'allow_looping: boolean' - return: - description: '' - type: boolean - - name: enable_feedback_loop - uid: '@microsoft/teams-ai.ConfiguredAIOptions.enable_feedback_loop' - package: '@microsoft/teams-ai' - summary: >- - If true, the AI system will enable the feedback loop in Teams that allows - a user to give thumbs up or down to a response. - fullName: enable_feedback_loop - remarks: '' - isDeprecated: false - syntax: - content: 'enable_feedback_loop: boolean' - return: - description: '' - type: boolean - - name: feedback_loop_type - uid: '@microsoft/teams-ai.ConfiguredAIOptions.feedback_loop_type' - package: '@microsoft/teams-ai' - summary: >- - Optional. Only used when `enable_feedback_loop` == `true`. When set to - `custom` the user will be presented with a text input - - to provide feedback. - fullName: feedback_loop_type - remarks: '' - isDeprecated: false - syntax: - content: 'feedback_loop_type?: "default" | "custom"' - return: - description: '' - type: '"default" | "custom"' - - name: max_steps - uid: '@microsoft/teams-ai.ConfiguredAIOptions.max_steps' - package: '@microsoft/teams-ai' - summary: Maximum number of actions to execute in a single turn. - fullName: max_steps - remarks: '' - isDeprecated: false - syntax: - content: 'max_steps: number' - return: - description: '' - type: number - - name: max_time - uid: '@microsoft/teams-ai.ConfiguredAIOptions.max_time' - package: '@microsoft/teams-ai' - summary: Maximum amount of time to spend executing a single turn in milliseconds. - fullName: max_time - remarks: '' - isDeprecated: false - syntax: - content: 'max_time: number' - return: - description: '' - type: number - - name: moderator - uid: '@microsoft/teams-ai.ConfiguredAIOptions.moderator' - package: '@microsoft/teams-ai' - summary: >- - The moderator being used for moderating input passed to the model and the - output - fullName: moderator - remarks: '' - isDeprecated: false - syntax: - content: 'moderator: Moderator' - return: - description: '' - type: <TState> - - name: planner - uid: '@microsoft/teams-ai.ConfiguredAIOptions.planner' - package: '@microsoft/teams-ai' - summary: The planner being used for generating plans. - fullName: planner - remarks: '' - isDeprecated: false - syntax: - content: 'planner: Planner' - return: - description: '' - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredLLMClientOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredLLMClientOptions.yml deleted file mode 100644 index 2b2358da..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredLLMClientOptions.yml +++ /dev/null @@ -1,122 +0,0 @@ -### YamlMime:TSType -name: ConfiguredLLMClientOptions -uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions' -package: '@microsoft/teams-ai' -summary: The configuration of the LLMClient instance. -fullName: ConfiguredLLMClientOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: history_variable - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.history_variable' - package: '@microsoft/teams-ai' - summary: Memory variable used for storing conversation history. - fullName: history_variable - remarks: '' - isDeprecated: false - syntax: - content: 'history_variable: string' - return: - description: '' - type: string - - name: input_variable - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.input_variable' - package: '@microsoft/teams-ai' - summary: Memory variable used for storing the users input message. - fullName: input_variable - remarks: '' - isDeprecated: false - syntax: - content: 'input_variable: string' - return: - description: '' - type: string - - name: logRepairs - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.logRepairs' - package: '@microsoft/teams-ai' - summary: If true, any repair attempts will be logged to the console. - fullName: logRepairs - remarks: '' - isDeprecated: false - syntax: - content: 'logRepairs: boolean' - return: - description: '' - type: boolean - - name: max_history_messages - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.max_history_messages' - package: '@microsoft/teams-ai' - summary: >- - Maximum number of conversation history messages that will be persisted to - memory. - fullName: max_history_messages - remarks: '' - isDeprecated: false - syntax: - content: 'max_history_messages: number' - return: - description: '' - type: number - - name: max_repair_attempts - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.max_repair_attempts' - package: '@microsoft/teams-ai' - summary: Maximum number of automatic repair attempts that will be made. - fullName: max_repair_attempts - remarks: '' - isDeprecated: false - syntax: - content: 'max_repair_attempts: number' - return: - description: '' - type: number - - name: model - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.model' - package: '@microsoft/teams-ai' - summary: AI model used for completing prompts. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model: PromptCompletionModel' - return: - description: '' - type: - - name: template - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.template' - package: '@microsoft/teams-ai' - summary: Prompt used for the conversation. - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: PromptTemplate' - return: - description: '' - type: - - name: tokenizer - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.tokenizer' - package: '@microsoft/teams-ai' - summary: Tokenizer used when rendering the prompt or counting tokens. - fullName: tokenizer - remarks: '' - isDeprecated: false - syntax: - content: 'tokenizer: Tokenizer' - return: - description: '' - type: - - name: validator - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions.validator' - package: '@microsoft/teams-ai' - summary: Response validator used when completing prompts. - fullName: validator - remarks: '' - isDeprecated: false - syntax: - content: 'validator: PromptResponseValidator' - return: - description: '' - type: >- - <TContent> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredPromptManagerOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredPromptManagerOptions.yml deleted file mode 100644 index 4193ee64..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredPromptManagerOptions.yml +++ /dev/null @@ -1,71 +0,0 @@ -### YamlMime:TSType -name: ConfiguredPromptManagerOptions -uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions' -package: '@microsoft/teams-ai' -summary: The configured PromptManager options. -fullName: ConfiguredPromptManagerOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: max_conversation_history_tokens - uid: >- - @microsoft/teams-ai.ConfiguredPromptManagerOptions.max_conversation_history_tokens - package: '@microsoft/teams-ai' - summary: Maximum number of tokens of conversation history to include in prompts. - fullName: max_conversation_history_tokens - remarks: '' - isDeprecated: false - syntax: - content: 'max_conversation_history_tokens: number' - return: - description: '' - type: number - - name: max_history_messages - uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions.max_history_messages' - package: '@microsoft/teams-ai' - summary: Maximum number of messages to use when rendering conversation_history. - fullName: max_history_messages - remarks: '' - isDeprecated: false - syntax: - content: 'max_history_messages: number' - return: - description: '' - type: number - - name: max_input_tokens - uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions.max_input_tokens' - package: '@microsoft/teams-ai' - summary: Maximum number of tokens of user input to include in prompts. - fullName: max_input_tokens - remarks: '' - isDeprecated: false - syntax: - content: 'max_input_tokens: number' - return: - description: '' - type: number - - name: promptsFolder - uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions.promptsFolder' - package: '@microsoft/teams-ai' - summary: Path to the filesystem folder containing all the applications prompts. - fullName: promptsFolder - remarks: '' - isDeprecated: false - syntax: - content: 'promptsFolder: string' - return: - description: '' - type: string - - name: role - uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions.role' - package: '@microsoft/teams-ai' - summary: Message role to use for loaded prompts. - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationHistory.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationHistory.yml deleted file mode 100644 index 6b34b63a..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationHistory.yml +++ /dev/null @@ -1,175 +0,0 @@ -### YamlMime:TSType -name: ConversationHistory -uid: '@microsoft/teams-ai.ConversationHistory' -package: '@microsoft/teams-ai' -summary: A section that renders the conversation history. -fullName: ConversationHistory -remarks: '' -isDeprecated: false -type: class -constructors: - - name: ConversationHistory(string, number, boolean, string, string, string) - uid: '@microsoft/teams-ai.ConversationHistory.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'ConversationHistory' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new ConversationHistory(variable: string, tokens?: number, required?: - boolean, userPrefix?: string, assistantPrefix?: string, separator?: - string) - parameters: - - id: variable - type: string - description: Name of memory variable used to store the histories `Message[]`. - - id: tokens - type: number - description: >- - Optional. Sizing strategy for this section. Defaults to - `proportional` with a value of `1.0`. - - id: required - type: boolean - description: >- - Optional. Indicates if this section is required. Defaults to - `false`. - - id: userPrefix - type: string - description: >- - Optional. Prefix to use for user messages when rendering as text. - Defaults to `user: `. - - id: assistantPrefix - type: string - description: >- - Optional. Prefix to use for assistant messages when rendering as - text. Defaults to `assistant: `. - - id: separator - type: string - description: >- - Optional. Separator to use between messages when rendering as text. - Defaults to `\n`. -properties: - - name: assistantPrefix - uid: '@microsoft/teams-ai.ConversationHistory.assistantPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: assistantPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'assistantPrefix: string' - return: - description: '' - type: string - - name: userPrefix - uid: '@microsoft/teams-ai.ConversationHistory.userPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: userPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'userPrefix: string' - return: - description: '' - type: string - - name: variable - uid: '@microsoft/teams-ai.ConversationHistory.variable' - package: '@microsoft/teams-ai' - summary: '' - fullName: variable - remarks: '' - isDeprecated: false - syntax: - content: 'variable: string' - return: - description: '' - type: string -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.ConversationHistory.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.ConversationHistory.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.ConversationHistory.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.ConversationHistory.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.ConversationHistory.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationUpdateEvents.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationUpdateEvents.yml deleted file mode 100644 index 6cd2f4f4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationUpdateEvents.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSTypeAlias -name: ConversationUpdateEvents -uid: '@microsoft/teams-ai.ConversationUpdateEvents' -package: '@microsoft/teams-ai' -summary: Conversation update events. -fullName: ConversationUpdateEvents -remarks: '' -isDeprecated: false -syntax: | - type ConversationUpdateEvents = - | "channelCreated" - | "channelRenamed" - | "channelDeleted" - | "channelRestored" - | "membersAdded" - | "membersRemoved" - | "teamRenamed" - | "teamDeleted" - | "teamHardDeleted" - | "teamArchived" - | "teamUnarchived" - | "teamRestored" - | "topicName" - | "historyDisclosed" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSource.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSource.yml deleted file mode 100644 index 1d59684e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSource.yml +++ /dev/null @@ -1,53 +0,0 @@ -### YamlMime:TSType -name: DataSource -uid: '@microsoft/teams-ai.DataSource' -package: '@microsoft/teams-ai' -summary: A data source that can be used to render text that's added to a prompt. -fullName: DataSource -remarks: '' -isDeprecated: false -type: interface -properties: - - name: name - uid: '@microsoft/teams-ai.DataSource.name' - package: '@microsoft/teams-ai' - summary: Name of the data source. - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string -methods: - - name: renderData(TurnContext, Memory, Tokenizer, number) - uid: '@microsoft/teams-ai.DataSource.renderData' - package: '@microsoft/teams-ai' - summary: Renders the data source as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderData(context: TurnContext, memory: Memory, tokenizer: - Tokenizer, maxTokens: number): Promise> - parameters: - - id: context - type: TurnContext - description: Turn context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use when rendering the data source. - - id: maxTokens - type: number - description: Maximum number of tokens allowed to be rendered. - return: - description: >- - The text to inject into the prompt as a `RenderedPromptSection` - object. - type: >- - Promise<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSourceSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSourceSection.yml deleted file mode 100644 index 111f05f1..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSourceSection.yml +++ /dev/null @@ -1,148 +0,0 @@ -### YamlMime:TSType -name: DataSourceSection -uid: '@microsoft/teams-ai.DataSourceSection' -package: '@microsoft/teams-ai' -summary: A section that renders a data source to a prompt. -fullName: DataSourceSection -remarks: '' -isDeprecated: false -type: class -constructors: - - name: DataSourceSection(DataSource, number) - uid: '@microsoft/teams-ai.DataSourceSection.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `DataSourceSection` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new DataSourceSection(dataSource: DataSource, tokens: number)' - parameters: - - id: dataSource - type: - description: The data source to render. - - id: tokens - type: number - description: Desired number of tokens to render. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.DataSourceSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.DataSourceSection.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.DataSourceSection.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.DataSourceSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.DataSourceSection.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.DataSourceSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultAugmentation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultAugmentation.yml deleted file mode 100644 index 91ea88ca..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultAugmentation.yml +++ /dev/null @@ -1,82 +0,0 @@ -### YamlMime:TSType -name: DefaultAugmentation -uid: '@microsoft/teams-ai.DefaultAugmentation' -package: '@microsoft/teams-ai' -summary: The default 'none' augmentation. -fullName: DefaultAugmentation -remarks: >- - This augmentation does not add any additional functionality to the prompt. It - always - - returns a `Plan` with a single `SAY` command containing the models response. -isDeprecated: false -type: class -methods: - - name: createPlanFromResponse(TurnContext, Memory, PromptResponse) - uid: '@microsoft/teams-ai.DefaultAugmentation.createPlanFromResponse' - package: '@microsoft/teams-ai' - summary: Creates a plan given validated response value. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createPlanFromResponse(context: TurnContext, memory: Memory, - response: PromptResponse): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: An interface for accessing state variables. - - id: response - type: PromptResponse<string> - description: The validated and transformed response for the prompt. - return: - description: The created plan. - type: Promise<> - - name: createPromptSection() - uid: '@microsoft/teams-ai.DefaultAugmentation.createPromptSection' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function createPromptSection(): undefined | PromptSection' - return: - description: Returns an optional prompt section for the augmentation. - type: undefined | - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.DefaultAugmentation.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultConversationState.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultConversationState.yml deleted file mode 100644 index ba13da6f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultConversationState.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSType -name: DefaultConversationState -uid: '@microsoft/teams-ai.DefaultConversationState' -package: '@microsoft/teams-ai' -summary: Default conversation state -fullName: DefaultConversationState -remarks: >- - Inherit a new interface from this base interface to strongly type the - applications conversation - - state. -isDeprecated: false -type: interface diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultModerator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultModerator.yml deleted file mode 100644 index a5383183..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultModerator.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: DefaultModerator -uid: '@microsoft/teams-ai.DefaultModerator' -package: '@microsoft/teams-ai' -summary: Default moderator created by the AI system if one isn't configured. -fullName: DefaultModerator -remarks: >- - The default moderator is a pass-through and always approves all inputs and - outputs. -isDeprecated: false -type: class -methods: - - name: reviewInput(TurnContext, TState) - uid: '@microsoft/teams-ai.DefaultModerator.reviewInput' - package: '@microsoft/teams-ai' - summary: Allows all prompts by returning undefined. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewInput(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: The context object for the turn. - - id: state - type: TState - description: The current turn state. - return: - description: A promise that resolves to undefined. - type: Promise<undefined | > - - name: reviewOutput(TurnContext, TState, Plan) - uid: '@microsoft/teams-ai.DefaultModerator.reviewOutput' - package: '@microsoft/teams-ai' - summary: Allows all plans by returning the plan as-is. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewOutput(context: TurnContext, state: TState, plan: Plan): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: plan - type: - description: Plan generated by the planner. - return: - description: A promise that resolves to the plan. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultResponseValidator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultResponseValidator.yml deleted file mode 100644 index eb9c4f00..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultResponseValidator.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: DefaultResponseValidator -uid: '@microsoft/teams-ai.DefaultResponseValidator' -package: '@microsoft/teams-ai' -summary: Default response validator that always returns true. -fullName: DefaultResponseValidator -remarks: '' -isDeprecated: false -type: class -methods: - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.DefaultResponseValidator.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<TValue>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultTempState.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultTempState.yml deleted file mode 100644 index d6d0a4dc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultTempState.yml +++ /dev/null @@ -1,86 +0,0 @@ -### YamlMime:TSType -name: DefaultTempState -uid: '@microsoft/teams-ai.DefaultTempState' -package: '@microsoft/teams-ai' -summary: Default temp state -fullName: DefaultTempState -remarks: >- - Inherit a new interface from this base interface to strongly type the - applications temp - - state. -isDeprecated: false -type: interface -properties: - - name: actionOutputs - uid: '@microsoft/teams-ai.DefaultTempState.actionOutputs' - package: '@microsoft/teams-ai' - summary: All outputs returned from the action sequence that was executed - fullName: actionOutputs - remarks: '' - isDeprecated: false - syntax: - content: 'actionOutputs: Record' - return: - description: '' - type: Record<string, string> - - name: authTokens - uid: '@microsoft/teams-ai.DefaultTempState.authTokens' - package: '@microsoft/teams-ai' - summary: User authentication tokens - fullName: authTokens - remarks: '' - isDeprecated: false - syntax: - content: 'authTokens: {[key: string]: string}' - return: - description: '' - type: '{[key: string]: string}' - - name: duplicateTokenExchange - uid: '@microsoft/teams-ai.DefaultTempState.duplicateTokenExchange' - package: '@microsoft/teams-ai' - summary: Flag indicating whether a token exchange event has already been processed - fullName: duplicateTokenExchange - remarks: '' - isDeprecated: false - syntax: - content: 'duplicateTokenExchange?: boolean' - return: - description: '' - type: boolean - - name: input - uid: '@microsoft/teams-ai.DefaultTempState.input' - package: '@microsoft/teams-ai' - summary: Input passed from the user to the AI Library - fullName: input - remarks: '' - isDeprecated: false - syntax: - content: 'input: string' - return: - description: '' - type: string - - name: inputFiles - uid: '@microsoft/teams-ai.DefaultTempState.inputFiles' - package: '@microsoft/teams-ai' - summary: Downloaded files passed by the user to the AI Library - fullName: inputFiles - remarks: '' - isDeprecated: false - syntax: - content: 'inputFiles: InputFile[]' - return: - description: '' - type: [] - - name: lastOutput - uid: '@microsoft/teams-ai.DefaultTempState.lastOutput' - package: '@microsoft/teams-ai' - summary: Output returned from the last executed action - fullName: lastOutput - remarks: '' - isDeprecated: false - syntax: - content: 'lastOutput: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultUserState.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultUserState.yml deleted file mode 100644 index 43379e8a..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultUserState.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSType -name: DefaultUserState -uid: '@microsoft/teams-ai.DefaultUserState' -package: '@microsoft/teams-ai' -summary: Default user state -fullName: DefaultUserState -remarks: >- - Inherit a new interface from this base interface to strongly type the - applications user - - state. -isDeprecated: false -type: interface diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EEMethodReturnType.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/EEMethodReturnType.yml deleted file mode 100644 index 1f289389..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EEMethodReturnType.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:TSTypeAlias -name: EEMethodReturnType -uid: '@microsoft/teams-ai.EEMethodReturnType' -package: '@microsoft/teams-ai' -summary: '' -fullName: EEMethodReturnType -remarks: '' -isDeprecated: false -syntax: | - type EEMethodReturnType = S extends keyof T - ? InnerEEMethodReturnType - : FValue diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EmitEventNames.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/EmitEventNames.yml deleted file mode 100644 index 36f1f6ab..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EmitEventNames.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: EmitEventNames -uid: '@microsoft/teams-ai.EmitEventNames' -package: '@microsoft/teams-ai' -summary: '' -fullName: EmitEventNames -remarks: '' -isDeprecated: false -syntax: | - type EmitEventNames = keyof TEmitRecord diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EventNames.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/EventNames.yml deleted file mode 100644 index 2696ed55..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/EventNames.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:TSTypeAlias -name: EventNames -uid: '@microsoft/teams-ai.EventNames' -package: '@microsoft/teams-ai' -summary: '' -fullName: EventNames -remarks: '' -isDeprecated: false -syntax: | - type EventNames = - | keyof TEmitRecord - | keyof TEventRecord diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FeedbackLoopData.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/FeedbackLoopData.yml deleted file mode 100644 index ffcfa44f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FeedbackLoopData.yml +++ /dev/null @@ -1,52 +0,0 @@ -### YamlMime:TSType -name: FeedbackLoopData -uid: '@microsoft/teams-ai.FeedbackLoopData' -package: '@microsoft/teams-ai' -summary: >- - Data returned when the thumbsup or thumbsdown button is clicked and response - sent when enable_feedback_loop is set to true in the AI Module. -fullName: FeedbackLoopData -remarks: '' -isDeprecated: false -type: interface -properties: - - name: actionName - uid: '@microsoft/teams-ai.FeedbackLoopData.actionName' - package: '@microsoft/teams-ai' - summary: '' - fullName: actionName - remarks: '' - isDeprecated: false - syntax: - content: 'actionName: "feedback"' - return: - description: '' - type: '"feedback"' - - name: actionValue - uid: '@microsoft/teams-ai.FeedbackLoopData.actionValue' - package: '@microsoft/teams-ai' - summary: '' - fullName: actionValue - remarks: '' - isDeprecated: false - syntax: - content: >- - actionValue: { feedback: string | Record, reaction: "like" - | "dislike" } - return: - description: '' - type: >- - { feedback: string | Record<string, any>, reaction: "like" | - "dislike" } - - name: replyToId - uid: '@microsoft/teams-ai.FeedbackLoopData.replyToId' - package: '@microsoft/teams-ai' - summary: The activity ID that the feedback was provided on. - fullName: replyToId - remarks: '' - isDeprecated: false - syntax: - content: 'replyToId: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCall.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCall.yml deleted file mode 100644 index 4ab24be8..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCall.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: FunctionCall -uid: '@microsoft/teams-ai.FunctionCall' -package: '@microsoft/teams-ai' -summary: A named function to call. -fullName: FunctionCall -remarks: '' -isDeprecated: false -type: interface -properties: - - name: arguments - uid: '@microsoft/teams-ai.FunctionCall.arguments' - package: '@microsoft/teams-ai' - summary: Optional. Arguments to pass to the function. Must be deserialized. - fullName: arguments - remarks: '' - isDeprecated: false - syntax: - content: 'arguments?: string' - return: - description: '' - type: string - - name: name - uid: '@microsoft/teams-ai.FunctionCall.name' - package: '@microsoft/teams-ai' - summary: Name of the function to call. - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCallMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCallMessage.yml deleted file mode 100644 index db331b80..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCallMessage.yml +++ /dev/null @@ -1,172 +0,0 @@ -### YamlMime:TSType -name: FunctionCallMessage -uid: '@microsoft/teams-ai.FunctionCallMessage' -package: '@microsoft/teams-ai' -summary: An `assistant` message containing a function to call. -fullName: FunctionCallMessage -remarks: >- - The function call information is returned by the model so we use an - "assistant" message to - - represent it in conversation history. -isDeprecated: false -type: class -constructors: - - name: FunctionCallMessage(FunctionCall, number, string) - uid: '@microsoft/teams-ai.FunctionCallMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'FunctionCallMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new FunctionCallMessage(function_call: FunctionCall, tokens?: number, - assistantPrefix?: string) - parameters: - - id: function_call - type: - description: name and arguments of the function to call. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: assistantPrefix - type: string - description: >- - Optional. Prefix to use for assistant messages when rendering as - text. Defaults to `assistant: `. -properties: - - name: function_call - uid: '@microsoft/teams-ai.FunctionCallMessage.function_call' - package: '@microsoft/teams-ai' - summary: Name and arguments of the function to call. - fullName: function_call - remarks: '' - isDeprecated: false - syntax: - content: 'function_call: FunctionCall' - return: - description: '' - type: -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.FunctionCallMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.FunctionCallMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.FunctionCallMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.FunctionCallMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.FunctionCallMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.FunctionCallMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionResponseMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionResponseMessage.yml deleted file mode 100644 index 25157431..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionResponseMessage.yml +++ /dev/null @@ -1,184 +0,0 @@ -### YamlMime:TSType -name: FunctionResponseMessage -uid: '@microsoft/teams-ai.FunctionResponseMessage' -package: '@microsoft/teams-ai' -summary: Message containing the response to a function call. -fullName: FunctionResponseMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: FunctionResponseMessage(string, any, number, string) - uid: '@microsoft/teams-ai.FunctionResponseMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'FunctionResponseMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new FunctionResponseMessage(name: string, response: any, tokens?: - number, functionPrefix?: string) - parameters: - - id: name - type: string - description: Name of the function that was called. - - id: response - type: any - description: The response returned by the called function. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: functionPrefix - type: string - description: >- - Optional. Prefix to use for function messages when rendering as - text. Defaults to `user: ` to simulate the response coming from the - user. -properties: - - name: name - uid: '@microsoft/teams-ai.FunctionResponseMessage.name' - package: '@microsoft/teams-ai' - summary: '' - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: response - uid: '@microsoft/teams-ai.FunctionResponseMessage.response' - package: '@microsoft/teams-ai' - summary: '' - fullName: response - remarks: '' - isDeprecated: false - syntax: - content: 'response: any' - return: - description: '' - type: any -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.FunctionResponseMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.FunctionResponseMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.FunctionResponseMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.FunctionResponseMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.FunctionResponseMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.FunctionResponseMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPT3Tokenizer.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPT3Tokenizer.yml deleted file mode 100644 index 654113da..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPT3Tokenizer.yml +++ /dev/null @@ -1,40 +0,0 @@ -### YamlMime:TSType -name: GPT3Tokenizer -uid: '@microsoft/teams-ai.GPT3Tokenizer' -package: '@microsoft/teams-ai' -summary: Tokenizer that uses GPT-3's encoder. -fullName: GPT3Tokenizer -remarks: '' -isDeprecated: false -type: class -methods: - - name: decode(number[]) - uid: '@microsoft/teams-ai.GPT3Tokenizer.decode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function decode(tokens: number[]): string' - parameters: - - id: tokens - type: number[] - description: '' - return: - description: '' - type: string - - name: encode(string) - uid: '@microsoft/teams-ai.GPT3Tokenizer.encode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function encode(text: string): number[]' - parameters: - - id: text - type: string - description: '' - return: - description: '' - type: number[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPTTokenizer.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPTTokenizer.yml deleted file mode 100644 index 818078d8..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPTTokenizer.yml +++ /dev/null @@ -1,42 +0,0 @@ -### YamlMime:TSType -name: GPTTokenizer -uid: '@microsoft/teams-ai.GPTTokenizer' -package: '@microsoft/teams-ai' -summary: |- - Tokenizer that uses GPT's cl100k_base encoding. - To use GPT-3 encoding, pass in an instance of GPT3Tokenizer. -fullName: GPTTokenizer -remarks: '' -isDeprecated: false -type: class -methods: - - name: decode(number[]) - uid: '@microsoft/teams-ai.GPTTokenizer.decode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function decode(tokens: number[]): string' - parameters: - - id: tokens - type: number[] - description: '' - return: - description: '' - type: string - - name: encode(string) - uid: '@microsoft/teams-ai.GPTTokenizer.encode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function encode(text: string): number[]' - parameters: - - id: text - type: string - description: '' - return: - description: '' - type: number[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GroupSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/GroupSection.yml deleted file mode 100644 index 4a16f0ee..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/GroupSection.yml +++ /dev/null @@ -1,191 +0,0 @@ -### YamlMime:TSType -name: GroupSection -uid: '@microsoft/teams-ai.GroupSection' -package: '@microsoft/teams-ai' -summary: A group of sections that will rendered as a single message. -fullName: GroupSection -remarks: '' -isDeprecated: false -type: class -constructors: - - name: GroupSection(PromptSection[], string, number, boolean, string, string) - uid: '@microsoft/teams-ai.GroupSection.constructor' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - new GroupSection(sections: PromptSection[], role?: string, tokens?: - number, required?: boolean, separator?: string, textPrefix?: string) - parameters: - - id: sections - type: [] - description: List of sections to group together. - - id: role - type: string - description: >- - Optional. Message role to use for this section. Defaults to - `system`. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: required - type: boolean - description: Optional. Indicates if this section is required. Defaults to `true`. - - id: separator - type: string - description: >- - Optional. Separator to use between sections when rendering as text. - Defaults to `\n\n`. - - id: textPrefix - type: string - description: Optional. Prefix to use for text output. Defaults to `undefined`. -properties: - - name: role - uid: '@microsoft/teams-ai.GroupSection.role' - package: '@microsoft/teams-ai' - summary: '' - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - - name: sections - uid: '@microsoft/teams-ai.GroupSection.sections' - package: '@microsoft/teams-ai' - summary: '' - fullName: sections - remarks: '' - isDeprecated: false - syntax: - content: 'sections: PromptSection[]' - return: - description: '' - type: [] -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.GroupSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.GroupSection.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.GroupSection.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.GroupSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.GroupSection.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.GroupSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ImageContentPart.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ImageContentPart.yml deleted file mode 100644 index 8018ebf9..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ImageContentPart.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: ImageContentPart -uid: '@microsoft/teams-ai.ImageContentPart' -package: '@microsoft/teams-ai' -summary: '' -fullName: ImageContentPart -remarks: '' -isDeprecated: false -type: interface -properties: - - name: image_url - uid: '@microsoft/teams-ai.ImageContentPart.image_url' - package: '@microsoft/teams-ai' - summary: The URL of the image. - fullName: image_url - remarks: '' - isDeprecated: false - syntax: - content: 'image_url: string | { url: string }' - return: - description: '' - type: 'string | { url: string }' - - name: type - uid: '@microsoft/teams-ai.ImageContentPart.type' - package: '@microsoft/teams-ai' - summary: Type of the message content. Should always be 'image_url'. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "image_url"' - return: - description: '' - type: '"image_url"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InnerEEMethodReturnType.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/InnerEEMethodReturnType.yml deleted file mode 100644 index bd26d066..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InnerEEMethodReturnType.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: InnerEEMethodReturnType -uid: '@microsoft/teams-ai.InnerEEMethodReturnType' -package: '@microsoft/teams-ai' -summary: '' -fullName: InnerEEMethodReturnType -remarks: '' -isDeprecated: false -syntax: > - type InnerEEMethodReturnType = T extends (args: any[]) => - any - ? ReturnType extends void | undefined - ? FValue - : TValue - : FValue diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFile.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFile.yml deleted file mode 100644 index 7fbe0c94..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFile.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSType -name: InputFile -uid: '@microsoft/teams-ai.InputFile' -package: '@microsoft/teams-ai' -summary: A file sent by the user to the bot. -fullName: InputFile -remarks: '' -isDeprecated: false -type: interface -properties: - - name: content - uid: '@microsoft/teams-ai.InputFile.content' - package: '@microsoft/teams-ai' - summary: The downloaded content of the file. - fullName: content - remarks: '' - isDeprecated: false - syntax: - content: 'content: Buffer' - return: - description: '' - type: Buffer - - name: contentType - uid: '@microsoft/teams-ai.InputFile.contentType' - package: '@microsoft/teams-ai' - summary: The content type of the file. - fullName: contentType - remarks: '' - isDeprecated: false - syntax: - content: 'contentType: string' - return: - description: '' - type: string - - name: contentUrl - uid: '@microsoft/teams-ai.InputFile.contentUrl' - package: '@microsoft/teams-ai' - summary: Optional. URL to the content of the file. - fullName: contentUrl - remarks: '' - isDeprecated: false - syntax: - content: 'contentUrl?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFileDownloader.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFileDownloader.yml deleted file mode 100644 index 7da0f847..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFileDownloader.yml +++ /dev/null @@ -1,32 +0,0 @@ -### YamlMime:TSType -name: InputFileDownloader -uid: '@microsoft/teams-ai.InputFileDownloader' -package: '@microsoft/teams-ai' -summary: >- - A plugin responsible for downloading files relative to the current user's - input. -fullName: InputFileDownloader -remarks: '' -isDeprecated: false -type: interface -methods: - - name: downloadFiles(TurnContext, TState) - uid: '@microsoft/teams-ai.InputFileDownloader.downloadFiles' - package: '@microsoft/teams-ai' - summary: Download any files relative to the current user's input. - remarks: '' - isDeprecated: false - syntax: - content: >- - function downloadFiles(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - return: - description: '' - type: Promise<[]> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/JSONResponseValidator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/JSONResponseValidator.yml deleted file mode 100644 index 1ed8b321..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/JSONResponseValidator.yml +++ /dev/null @@ -1,106 +0,0 @@ -### YamlMime:TSType -name: JSONResponseValidator -uid: '@microsoft/teams-ai.JSONResponseValidator' -package: '@microsoft/teams-ai' -summary: >- - Parses any JSON returned by the model and optionally verifies it against a - JSON schema. -fullName: JSONResponseValidator -remarks: '' -isDeprecated: false -type: class -constructors: - - name: JSONResponseValidator(Schema, string, string) - uid: '@microsoft/teams-ai.JSONResponseValidator.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `JSONResponseValidator` instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new JSONResponseValidator(schema?: Schema, missingJsonFeedback?: string, - errorFeedback?: string) - parameters: - - id: schema - type: Schema - description: Optional. JSON schema to validate the response against. - - id: missingJsonFeedback - type: string - description: Optional. Custom feedback to give when no JSON is returned. - - id: errorFeedback - type: string - description: >- - Optional. Custom feedback prefix to use when schema errors are - detected. -properties: - - name: errorFeedback - uid: '@microsoft/teams-ai.JSONResponseValidator.errorFeedback' - package: '@microsoft/teams-ai' - summary: Feedback prefix given when schema errors are detected. - fullName: errorFeedback - remarks: '' - isDeprecated: false - syntax: - content: 'errorFeedback: string' - return: - description: '' - type: string - - name: missingJsonFeedback - uid: '@microsoft/teams-ai.JSONResponseValidator.missingJsonFeedback' - package: '@microsoft/teams-ai' - summary: Feedback given when no JSON is returned. - fullName: missingJsonFeedback - remarks: '' - isDeprecated: false - syntax: - content: 'missingJsonFeedback: string' - return: - description: '' - type: string - - name: schema - uid: '@microsoft/teams-ai.JSONResponseValidator.schema' - package: '@microsoft/teams-ai' - summary: JSON schema to validate the response against. - fullName: schema - remarks: '' - isDeprecated: false - syntax: - content: 'schema?: Schema' - return: - description: '' - type: Schema -methods: - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.JSONResponseValidator.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<TValue>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClient.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClient.yml deleted file mode 100644 index af7a90ab..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClient.yml +++ /dev/null @@ -1,236 +0,0 @@ -### YamlMime:TSType -name: LLMClient -uid: '@microsoft/teams-ai.LLMClient' -package: '@microsoft/teams-ai' -summary: LLMClient class that's used to complete prompts. -fullName: LLMClient -remarks: >- - Each wave, at a minimum needs to be configured with a `client`, `prompt`, and - `prompt_options`. - - - Configuring the wave to use a `validator` is optional but recommended. The - primary benefit to - - using LLMClient is it's response validation and automatic response repair - features. The - - validator acts as guard and guarantees that you never get an malformed - response back from the - - model. At least not without it being flagged as an `invalid_response`. - - - Using the `JSONResponseValidator`, for example, guarantees that you only ever - get a valid - - object back from `completePrompt()`. In fact, you'll get back a fully parsed - object and any - - additional response text from the model will be dropped. If you give the - `JSONResponseValidator` - - a JSON Schema, you will get back a strongly typed and validated instance of an - object in - - the returned `response.message.content`. - - - When a validator detects a bad response from the model, it gives the model - "feedback" as to the - - problem it detected with its response and more importantly an instruction that - tells the model - - how it should repair the problem. This puts the wave into a special repair - mode where it first - - forks the memory for the conversation and then has a side conversation with - the model in an - - effort to get it to repair its response. By forking the conversation, this - isolates the bad - - response and prevents it from contaminating the main conversation history. If - the response can - - be repaired, the wave will un-fork the memory and use the repaired response in - place of the - - original bad response. To the model it's as if it never made a mistake which - is important for - - future turns with the model. If the response can't be repaired, a response - status of - - `invalid_response` will be returned. - - - When using a well designed validator, like the `JSONResponseValidator`, the - wave can typically - - repair a bad response in a single additional model call. Sometimes it takes a - couple of calls - - to effect a repair and occasionally it won't be able to repair it at all. If - your prompt is - - well designed and you only occasionally see failed repair attempts, I'd - recommend just calling - - the wave a second time. Given the stochastic nature of these models, there's a - decent chance - - it won't make the same mistake on the second call. A well designed prompt - coupled with a well - - designed validator should get the reliability of calling these models - somewhere close to 99% - - reliable. - - - This "feedback" technique works with all the GPT-3 generation of models and - I've tested it with - - `text-davinci-003`, `gpt-3.5-turbo`, and `gpt-4`. There's a good chance it - will work with other - - open source models like `LLaMA` and Googles `Bard` but I have yet to test it - with those models. - - - LLMClient supports OpenAI's functions feature and can validate the models - response against the - - schema for the supported functions. When an LLMClient is configured with both - a `OpenAIModel` - - and a `FunctionResponseValidator`, the model will be cloned and configured to - send the - - validators configured list of functions with the request. There's no need to - separately - - configure the models `functions` list, but if you do, the models functions - list will be sent - - instead. -isDeprecated: false -type: class -constructors: - - name: LLMClient(LLMClientOptions) - uid: '@microsoft/teams-ai.LLMClient.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `LLMClient` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new LLMClient(options: LLMClientOptions)' - parameters: - - id: options - type: <TContent> - description: Options to configure the instance with. -properties: - - name: options - uid: '@microsoft/teams-ai.LLMClient.options' - package: '@microsoft/teams-ai' - summary: Configured options for this LLMClient instance. - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: 'options: ConfiguredLLMClientOptions' - return: - description: '' - type: >- - <TContent> -methods: - - name: completePrompt(TurnContext, Memory, PromptFunctions) - uid: '@microsoft/teams-ai.LLMClient.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt. - remarks: >- - The `input` parameter is optional but if passed in, will be assigned to - memory using the - - configured `input_variable`. If it's not passed in an attempt will be made - to read it - - from memory so passing it in or assigning to memory works. In either case, - the `input` - - variable is only used when constructing a user message that, will be added - to the - - conversation history and formatted like `{ role: 'user', content: input - }`. - - - It's important to note that if you want the users input sent to the model - as part of the - - prompt, you will need to add a `UserMessage` section to your prompt. The - wave does not do - - anything to modify your prompt, except when performing repairs and those - changes are - - temporary. - - - When the model successfully returns a valid (or repaired) response, a - 'user' message (if - - input was detected) and 'assistant' message will be automatically added to - the conversation - - history. You can disable that behavior by setting `max_history_messages` - to `0`. - - - The response returned by `completePrompt()` will be strongly typed by the - validator you're - - using. The `DefaultResponseValidator` returns a `string` and the - `JSONResponseValidator` - - will return either an `object` or if a JSON Schema is provided, an - instance of `TContent`. - - When using a custom validator, the validator is return any type of content - it likes. - - - A successful response is indicated by `response.status == 'success'` and - the content can be - - accessed via `response.message.content`. If a response is invalid it will - have a - - `response.status == 'invalid_response'` and the `response.message` will be - a string containing - - the validator feedback message. There are other status codes for various - errors and in all - - cases except `success` the `response.message` will be of type `string`. - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, functions: - PromptFunctions): Promise> - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Functions to use when rendering the prompt. - return: - description: A `PromptResponse` with the status and message. - type: Promise<PromptResponse<TContent>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClientOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClientOptions.yml deleted file mode 100644 index 810a032f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClientOptions.yml +++ /dev/null @@ -1,196 +0,0 @@ -### YamlMime:TSType -name: LLMClientOptions -uid: '@microsoft/teams-ai.LLMClientOptions' -package: '@microsoft/teams-ai' -summary: Options for an LLMClient instance. -fullName: LLMClientOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: enableFeedbackLoop - uid: '@microsoft/teams-ai.LLMClientOptions.enableFeedbackLoop' - package: '@microsoft/teams-ai' - summary: If true, the feedback loop will be enabled for streaming responses. - fullName: enableFeedbackLoop - remarks: '' - isDeprecated: false - syntax: - content: 'enableFeedbackLoop?: boolean' - return: - description: '' - type: boolean - - name: endStreamHandler - uid: '@microsoft/teams-ai.LLMClientOptions.endStreamHandler' - package: '@microsoft/teams-ai' - summary: Optional handler to run when a stream is about to conclude. - fullName: endStreamHandler - remarks: '' - isDeprecated: false - syntax: - content: 'endStreamHandler?: PromptCompletionModelResponseReceivedEvent' - return: - description: '' - type: >- - - - name: feedbackLoopType - uid: '@microsoft/teams-ai.LLMClientOptions.feedbackLoopType' - package: '@microsoft/teams-ai' - summary: The type of the feedback loop. - fullName: feedbackLoopType - remarks: '' - isDeprecated: false - syntax: - content: 'feedbackLoopType?: "default" | "custom"' - return: - description: '' - type: '"default" | "custom"' - - name: history_variable - uid: '@microsoft/teams-ai.LLMClientOptions.history_variable' - package: '@microsoft/teams-ai' - summary: Optional. Memory variable used for storing conversation history. - fullName: history_variable - remarks: >- - The history will be stored as a `Message[]` and the variable defaults to - `conversation.history`. - isDeprecated: false - syntax: - content: 'history_variable?: string' - return: - description: '' - type: string - - name: input_variable - uid: '@microsoft/teams-ai.LLMClientOptions.input_variable' - package: '@microsoft/teams-ai' - summary: Optional. Memory variable used for storing the users input message. - fullName: input_variable - remarks: >- - The users input is expected to be a `string` but it's optional and - defaults to `temp.input`. - isDeprecated: false - syntax: - content: 'input_variable?: string' - return: - description: '' - type: string - - name: logRepairs - uid: '@microsoft/teams-ai.LLMClientOptions.logRepairs' - package: '@microsoft/teams-ai' - summary: Optional. If true, any repair attempts will be logged to the console. - fullName: logRepairs - remarks: '' - isDeprecated: false - syntax: - content: 'logRepairs?: boolean' - return: - description: '' - type: boolean - - name: max_history_messages - uid: '@microsoft/teams-ai.LLMClientOptions.max_history_messages' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of conversation history messages to maintain. - fullName: max_history_messages - remarks: >- - The number of tokens worth of history included in the prompt is controlled - by the - - `ConversationHistory` section of the prompt. This controls the automatic - pruning of the - - conversation history that's done by the LLMClient instance. This helps - keep your memory from - - getting too big and defaults to a value of `10` (or 5 turns.) - isDeprecated: false - syntax: - content: 'max_history_messages?: number' - return: - description: '' - type: number - - name: max_repair_attempts - uid: '@microsoft/teams-ai.LLMClientOptions.max_repair_attempts' - package: '@microsoft/teams-ai' - summary: >- - Optional. Maximum number of automatic repair attempts the LLMClient - instance will make. - fullName: max_repair_attempts - remarks: >- - This defaults to a value of `3` and can be set to `0` if you wish to - disable repairing of bad responses. - isDeprecated: false - syntax: - content: 'max_repair_attempts?: number' - return: - description: '' - type: number - - name: model - uid: '@microsoft/teams-ai.LLMClientOptions.model' - package: '@microsoft/teams-ai' - summary: AI model to use for completing prompts. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model: PromptCompletionModel' - return: - description: '' - type: - - name: startStreamingMessage - uid: '@microsoft/teams-ai.LLMClientOptions.startStreamingMessage' - package: '@microsoft/teams-ai' - summary: Optional message to send a client at the start of a streaming response. - fullName: startStreamingMessage - remarks: '' - isDeprecated: false - syntax: - content: 'startStreamingMessage?: string' - return: - description: '' - type: string - - name: template - uid: '@microsoft/teams-ai.LLMClientOptions.template' - package: '@microsoft/teams-ai' - summary: Prompt to use for the conversation. - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: PromptTemplate' - return: - description: '' - type: - - name: tokenizer - uid: '@microsoft/teams-ai.LLMClientOptions.tokenizer' - package: '@microsoft/teams-ai' - summary: Optional. Tokenizer to use when rendering the prompt or counting tokens. - fullName: tokenizer - remarks: >- - If not specified, a new instance of `GPTTokenizer` will be created. - GPT3Tokenizer can be passed in for gpt-3 models. - isDeprecated: false - syntax: - content: 'tokenizer?: Tokenizer' - return: - description: '' - type: - - name: validator - uid: '@microsoft/teams-ai.LLMClientOptions.validator' - package: '@microsoft/teams-ai' - summary: Optional. Response validator to use when completing prompts. - fullName: validator - remarks: >- - If not specified a new instance of `DefaultResponseValidator` will be - created. The - - DefaultResponseValidator returns a `Validation` that says all responses - are valid. - isDeprecated: false - syntax: - content: 'validator?: PromptResponseValidator' - return: - description: '' - type: >- - <TContent> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LayoutEngine.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/LayoutEngine.yml deleted file mode 100644 index b94e401b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LayoutEngine.yml +++ /dev/null @@ -1,93 +0,0 @@ -### YamlMime:TSType -name: LayoutEngine -uid: '@microsoft/teams-ai.LayoutEngine' -package: '@microsoft/teams-ai' -summary: >- - Base layout engine that renders a set of `auto`, `fixed`, or `proportional` - length sections. -fullName: LayoutEngine -remarks: >- - This class is used internally by the `Prompt` and `GroupSection` classes to - render their sections. -isDeprecated: false -type: class -constructors: - - name: LayoutEngine(PromptSection[], number, boolean, string) - uid: '@microsoft/teams-ai.LayoutEngine.constructor' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - new LayoutEngine(sections: PromptSection[], tokens: number, required: - boolean, separator: string) - parameters: - - id: sections - type: [] - description: List of sections to layout. - - id: tokens - type: number - description: Sizing strategy for this section. - - id: required - type: boolean - description: Indicates if this section is required. - - id: separator - type: string - description: Separator to use between sections when rendering as text. -properties: - - name: required - uid: '@microsoft/teams-ai.LayoutEngine.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - - name: sections - uid: '@microsoft/teams-ai.LayoutEngine.sections' - package: '@microsoft/teams-ai' - summary: '' - fullName: sections - remarks: '' - isDeprecated: false - syntax: - content: 'sections: PromptSection[]' - return: - description: '' - type: [] - - name: separator - uid: '@microsoft/teams-ai.LayoutEngine.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - - name: tokens - uid: '@microsoft/teams-ai.LayoutEngine.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ListenerType.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ListenerType.yml deleted file mode 100644 index 9b15517c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ListenerType.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: ListenerType -uid: '@microsoft/teams-ai.ListenerType' -package: '@microsoft/teams-ai' -summary: '' -fullName: ListenerType -remarks: '' -isDeprecated: false -syntax: | - type ListenerType = [T] extends [(args: U) => any] - ? U - : [T] extends [void] - ? Object - : [T] diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModel.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModel.yml deleted file mode 100644 index 318f30a2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModel.yml +++ /dev/null @@ -1,68 +0,0 @@ -### YamlMime:TSType -name: LlamaModel -uid: '@microsoft/teams-ai.LlamaModel' -package: '@microsoft/teams-ai' -summary: An AI model that can be used to complete prompts. -fullName: LlamaModel -remarks: '' -isDeprecated: false -type: class -constructors: - - name: LlamaModel(LlamaModelOptions) - uid: '@microsoft/teams-ai.LlamaModel.constructor' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'new LlamaModel(options: LlamaModelOptions)' - parameters: - - id: options - type: - description: '' -properties: - - name: options - uid: '@microsoft/teams-ai.LlamaModel.options' - package: '@microsoft/teams-ai' - summary: '' - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: 'options: LlamaModelOptions' - return: - description: '' - type: -methods: - - name: >- - completePrompt(TurnContext, Memory, PromptFunctions, Tokenizer, - PromptTemplate) - uid: '@microsoft/teams-ai.LlamaModel.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): - Promise> - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Functions to use when rendering the prompt. - - id: tokenizer - type: - description: Tokenizer to use when rendering the prompt. - - id: template - type: - description: Prompt template to complete. - return: - description: A `PromptResponse` with the status and message. - type: Promise<PromptResponse<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModelOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModelOptions.yml deleted file mode 100644 index c08de321..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModelOptions.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSType -name: LlamaModelOptions -uid: '@microsoft/teams-ai.LlamaModelOptions' -package: '@microsoft/teams-ai' -summary: '' -fullName: LlamaModelOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.LlamaModelOptions.apiKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: apiKey - remarks: '' - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.LlamaModelOptions.endpoint' - package: '@microsoft/teams-ai' - summary: '' - fullName: endpoint - remarks: '' - isDeprecated: false - syntax: - content: 'endpoint: string' - return: - description: '' - type: string - - name: logRequests - uid: '@microsoft/teams-ai.LlamaModelOptions.logRequests' - package: '@microsoft/teams-ai' - summary: '' - fullName: logRequests - remarks: '' - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MatchingKeys.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MatchingKeys.yml deleted file mode 100644 index 8cccd055..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MatchingKeys.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: MatchingKeys -uid: '@microsoft/teams-ai.MatchingKeys' -package: '@microsoft/teams-ai' -summary: '' -fullName: MatchingKeys -remarks: '' -isDeprecated: false -syntax: | - type MatchingKeys = K extends ( - TRecord[K] extends TMatch ? K : never - ) - ? K - : never diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Memory.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Memory.yml deleted file mode 100644 index b6a6e4c6..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Memory.yml +++ /dev/null @@ -1,75 +0,0 @@ -### YamlMime:TSType -name: Memory -uid: '@microsoft/teams-ai.Memory' -package: '@microsoft/teams-ai' -summary: Represents a memory. -fullName: Memory -remarks: A memory is a key-value store that can be used to store and retrieve values. -isDeprecated: false -type: interface -methods: - - name: deleteValue(string) - uid: '@microsoft/teams-ai.Memory.deleteValue' - package: '@microsoft/teams-ai' - summary: Deletes a value from the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function deleteValue(path: string)' - parameters: - - id: path - type: string - description: >- - Path to the value to delete in the form of `[scope].property`. If - scope is omitted, the value is deleted from the temporary scope. - - name: getValue(string) - uid: '@microsoft/teams-ai.Memory.getValue' - package: '@microsoft/teams-ai' - summary: Retrieves a value from the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function getValue(path: string): TValue' - parameters: - - id: path - type: string - description: >- - Path to the value to retrieve in the form of `[scope].property`. If - scope is omitted, the value is retrieved from the temporary scope. - return: - description: The value or undefined if not found. - type: TValue - - name: hasValue(string) - uid: '@microsoft/teams-ai.Memory.hasValue' - package: '@microsoft/teams-ai' - summary: Checks if a value exists in the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasValue(path: string): boolean' - parameters: - - id: path - type: string - description: >- - Path to the value to check in the form of `[scope].property`. If - scope is omitted, the value is checked in the temporary scope. - return: - description: True if the value exists, false otherwise. - type: boolean - - name: setValue(string, unknown) - uid: '@microsoft/teams-ai.Memory.setValue' - package: '@microsoft/teams-ai' - summary: Assigns a value to the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function setValue(path: string, value: unknown)' - parameters: - - id: path - type: string - description: >- - Path to the value to assign in the form of `[scope].property`. If - scope is omitted, the value is assigned to the temporary scope. - - id: value - type: unknown - description: Value to assign. diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MemoryFork.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MemoryFork.yml deleted file mode 100644 index faa632d0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MemoryFork.yml +++ /dev/null @@ -1,92 +0,0 @@ -### YamlMime:TSType -name: MemoryFork -uid: '@microsoft/teams-ai.MemoryFork' -package: '@microsoft/teams-ai' -summary: Forks an existing memory. -fullName: MemoryFork -remarks: >- - A memory fork is a memory that is a copy of another memory, but can be - modified without - - affecting the original memory. -isDeprecated: false -type: class -constructors: - - name: MemoryFork(Memory) - uid: '@microsoft/teams-ai.MemoryFork.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `MemoryFork` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new MemoryFork(memory: Memory)' - parameters: - - id: memory - type: - description: Memory to fork. -methods: - - name: deleteValue(string) - uid: '@microsoft/teams-ai.MemoryFork.deleteValue' - package: '@microsoft/teams-ai' - summary: Deletes a value from the memory. - remarks: Only forked values will be deleted. - isDeprecated: false - syntax: - content: 'function deleteValue(path: string)' - parameters: - - id: path - type: string - description: >- - Path to the value to delete in the form of `[scope].property`. If - scope is omitted, the value is deleted from the temporary scope. - - name: getValue(string) - uid: '@microsoft/teams-ai.MemoryFork.getValue' - package: '@microsoft/teams-ai' - summary: Retrieves a value from the memory. - remarks: The forked memory is checked first, then the original memory. - isDeprecated: false - syntax: - content: 'function getValue(path: string): TValue' - parameters: - - id: path - type: string - description: >- - Path to the value to retrieve in the form of `[scope].property`. If - scope is omitted, the value is retrieved from the temporary scope. - return: - description: The value or undefined if not found. - type: TValue - - name: hasValue(string) - uid: '@microsoft/teams-ai.MemoryFork.hasValue' - package: '@microsoft/teams-ai' - summary: Checks if a value exists in the memory. - remarks: The forked memory is checked first, then the original memory. - isDeprecated: false - syntax: - content: 'function hasValue(path: string): boolean' - parameters: - - id: path - type: string - description: >- - Path to the value to check in the form of `[scope].property`. If - scope is omitted, the value is checked in the temporary scope. - return: - description: True if the value exists, false otherwise. - type: boolean - - name: setValue(string, unknown) - uid: '@microsoft/teams-ai.MemoryFork.setValue' - package: '@microsoft/teams-ai' - summary: Assigns a value to the memory. - remarks: The value is assigned to the forked memory. - isDeprecated: false - syntax: - content: 'function setValue(path: string, value: unknown)' - parameters: - - id: path - type: string - description: >- - Path to the value to assign in the form of `[scope].property`. If - scope is omitted, the value is assigned to the temporary scope. - - id: value - type: unknown - description: Value to assign. diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Message.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Message.yml deleted file mode 100644 index fc5631fc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Message.yml +++ /dev/null @@ -1,99 +0,0 @@ -### YamlMime:TSType -name: Message -uid: '@microsoft/teams-ai.Message' -package: '@microsoft/teams-ai' -summary: A message object sent to or received from an LLM. -fullName: Message -remarks: '' -isDeprecated: false -type: interface -properties: - - name: action_calls - uid: '@microsoft/teams-ai.Message.action_calls' - package: '@microsoft/teams-ai' - summary: >- - Optional. The action or tool to be called by the model when using 'tools' - augmentation. In OpenAI, this is the tool_calls property returned from the - model. - fullName: action_calls - remarks: '' - isDeprecated: false - syntax: - content: 'action_calls?: ActionCall[]' - return: - description: '' - type: ActionCall[] - - name: action_call_id - uid: '@microsoft/teams-ai.Message.action_call_id' - package: '@microsoft/teams-ai' - summary: Optional. The id of the action called. - fullName: action_call_id - remarks: '' - isDeprecated: false - syntax: - content: 'action_call_id?: string' - return: - description: '' - type: string - - name: content - uid: '@microsoft/teams-ai.Message.content' - package: '@microsoft/teams-ai' - summary: Text of the message. - fullName: content - remarks: '' - isDeprecated: false - syntax: - content: 'content: undefined | TContent' - return: - description: '' - type: undefined | TContent - - name: context - uid: '@microsoft/teams-ai.Message.context' - package: '@microsoft/teams-ai' - summary: The context used for the message. - fullName: context - remarks: '' - isDeprecated: false - syntax: - content: 'context?: MessageContext' - return: - description: '' - type: - - name: function_call - uid: '@microsoft/teams-ai.Message.function_call' - package: '@microsoft/teams-ai' - summary: Optional. A named function to call. - fullName: function_call - remarks: '' - isDeprecated: false - syntax: - content: 'function_call?: FunctionCall' - return: - description: '' - type: - - name: name - uid: '@microsoft/teams-ai.Message.name' - package: '@microsoft/teams-ai' - summary: Optional. Name of the function that was called. - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name?: string' - return: - description: '' - type: string - - name: role - uid: '@microsoft/teams-ai.Message.role' - package: '@microsoft/teams-ai' - summary: >- - The messages role. Typically 'system', 'user', 'assistant', 'tool', - 'function'. - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContentParts.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContentParts.yml deleted file mode 100644 index 9c6fff15..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContentParts.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: MessageContentParts -uid: '@microsoft/teams-ai.MessageContentParts' -package: '@microsoft/teams-ai' -summary: '' -fullName: MessageContentParts -remarks: '' -isDeprecated: false -syntax: | - type MessageContentParts = TextContentPart | ImageContentPart diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContext.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContext.yml deleted file mode 100644 index 52377633..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContext.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: MessageContext -uid: '@microsoft/teams-ai.MessageContext' -package: '@microsoft/teams-ai' -summary: '' -fullName: MessageContext -remarks: '' -isDeprecated: false -type: interface -properties: - - name: citations - uid: '@microsoft/teams-ai.MessageContext.citations' - package: '@microsoft/teams-ai' - summary: Citations used in the message. - fullName: citations - remarks: '' - isDeprecated: false - syntax: - content: 'citations: Citation[]' - return: - description: '' - type: [] - - name: intent - uid: '@microsoft/teams-ai.MessageContext.intent' - package: '@microsoft/teams-ai' - summary: The intent of the message (what the user wrote). - fullName: intent - remarks: '' - isDeprecated: false - syntax: - content: 'intent: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensions.yml deleted file mode 100644 index dc264a25..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensions.yml +++ /dev/null @@ -1,386 +0,0 @@ -### YamlMime:TSType -name: MessageExtensions -uid: '@microsoft/teams-ai.MessageExtensions' -package: '@microsoft/teams-ai' -summary: >- - MessageExtensions class to enable fluent style registration of handlers - related to Message Extensions. -fullName: MessageExtensions -remarks: '' -isDeprecated: false -type: class -constructors: - - name: MessageExtensions(Application) - uid: '@microsoft/teams-ai.MessageExtensions.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the MessageExtensions class. - remarks: '' - isDeprecated: false - syntax: - content: 'new MessageExtensions(app: Application)' - parameters: - - id: app - type: <TState> - description: Top level application class to register handlers with. -methods: - - name: >- - anonymousQueryLink((context: TurnContext, state: TState, url: string) => - Promise) - uid: '@microsoft/teams-ai.MessageExtensions.anonymousQueryLink' - package: '@microsoft/teams-ai' - summary: Registers a handler for a command that performs anonymous link unfurling. - remarks: >- - The `composeExtension/anonymousQueryLink` INVOKE activity does not contain - any sort of command ID, - - so only a single select item handler can be registered. - - For more information visit - https://learn.microsoft.com/microsoftteams/platform/messaging-extensions/how-to/link-unfurling?#enable-zero-install-link-unfurling - isDeprecated: false - syntax: - content: >- - function anonymousQueryLink(handler: (context: TurnContext, state: - TState, url: string) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, url: string) => - Promise<MessagingExtensionResult> - description: >- - Function to call when the command is received. The handler should - return a `MessagingExtensionResult`. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - botMessagePreviewEdit(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, previewActivity: - Partial) => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.botMessagePreviewEdit' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process the 'edit' action of a message that's being - previewed by the - - user prior to sending. - remarks: >- - This handler is called when the user clicks the 'Edit' button on a message - that's being - - previewed prior to insertion into the current chat. The handler should - return a new - - view that allows the user to edit the message. - isDeprecated: false - syntax: - content: >- - function botMessagePreviewEdit(commandId: string | RegExp | Selector | - (string | RegExp | Selector)[], handler: (context: TurnContext, state: - TState, previewActivity: Partial) => Promise): - Application - parameters: - - id: commandId - type: >- - string | RegExp | | - (string | RegExp | )[] - description: ID of the command(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, previewActivity: - Partial<Activity>) => Promise<undefined | null | string - | MessagingExtensionResult | TaskModuleTaskInfo> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - botMessagePreviewSend(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, previewActivity: - Partial) => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.botMessagePreviewSend' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process the 'send' action of a message that's being - previewed by the - - user prior to sending. - remarks: >- - This handler is called when the user clicks the 'Send' button on a message - that's being - - previewed prior to insertion into the current chat. The handler should - complete the flow - - by sending the message to the current chat. - isDeprecated: false - syntax: - content: >- - function botMessagePreviewSend(commandId: string | RegExp | Selector | - (string | RegExp | Selector)[], handler: (context: TurnContext, state: - TState, previewActivity: Partial) => Promise): - Application - parameters: - - id: commandId - type: >- - string | RegExp | | - (string | RegExp | )[] - description: ID of the command(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, previewActivity: - Partial<Activity>) => Promise<void> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - configureSettings((context: TurnContext, state: TState, settings: - TData) => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.configureSettings' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that implements the logic to invoke configuring - Message Extension settings - remarks: >- - The `composeExtension/setting` INVOKE activity does not contain a command - ID, so only a single select item handler can be registered. - isDeprecated: false - syntax: - content: >- - function configureSettings(handler: (context: TurnContext, state: - TState, settings: TData) => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, settings: TData) => - Promise<void> - description: >- - Function defined by the developer to call when the command is - received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - fetchTask(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState) => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.fetchTask' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler to process the initial fetch task for an Action based - message extension. - remarks: >- - Handlers should response with either an initial TaskInfo object or a - string containing - - a message to display to the user. - isDeprecated: false - syntax: - content: >- - function fetchTask(commandId: string | RegExp | Selector | (string | - RegExp | Selector)[], handler: (context: TurnContext, state: TState) => - Promise): Application - parameters: - - id: commandId - type: >- - string | RegExp | | - (string | RegExp | )[] - description: ID of the command(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState) => Promise<string | - TaskModuleTaskInfo> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - handleOnButtonClicked((context: TurnContext, state: TState, data: - TData) => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.handleOnButtonClicked' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that implements the logic when a user has clicked on a - button in a Message Extension card. - remarks: >- - The `composeExtension/onCardButtonClicked` INVOKE activity does not - contain any sort of command ID, - - so only a single select item handler can be registered. Developers will - need to include a - - type name of some sort in the preview item they return if they need to - support multiple select item handlers. - isDeprecated: false - syntax: - content: >- - function handleOnButtonClicked(handler: (context: TurnContext, - state: TState, data: TData) => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<void> - description: >- - Function defined by the developer to call when the command is - received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - query(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, query: Query) - => Promise) - uid: '@microsoft/teams-ai.MessageExtensions.query' - package: '@microsoft/teams-ai' - summary: Registers a handler that implements a Search based Message Extension. - remarks: >- - This handler is called when the user submits a query to a Search based - Message Extension. - - The handler should return a MessagingExtensionResult containing the - results of the query. - isDeprecated: false - syntax: - content: >- - function query(commandId: string | RegExp | Selector | (string - | RegExp | Selector)[], handler: (context: TurnContext, state: TState, - query: Query) => Promise): - Application - parameters: - - id: commandId - type: >- - string | RegExp | | - (string | RegExp | )[] - description: ID of the command(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, query: Query<TParams>) - => Promise<MessagingExtensionResult> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - queryLink((context: TurnContext, state: TState, url: string) => - Promise) - uid: '@microsoft/teams-ai.MessageExtensions.queryLink' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that implements a Link Unfurling based Message - Extension. - remarks: '' - isDeprecated: false - syntax: - content: >- - function queryLink(handler: (context: TurnContext, state: TState, url: - string) => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, url: string) => - Promise<MessagingExtensionResult> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - queryUrlSetting((context: TurnContext, state: TState) => - Promise) - uid: '@microsoft/teams-ai.MessageExtensions.queryUrlSetting' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that invokes the fetch of the configuration settings - for a Message Extension. - remarks: >- - The `composeExtension/querySettingUrl` INVOKE activity does not contain a - command ID, so only a single select item handler can be registered. - isDeprecated: false - syntax: - content: >- - function queryUrlSetting(handler: (context: TurnContext, state: TState) - => Promise): Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState) => - Promise<MessagingExtensionResult> - description: >- - Function defined by the developer to call when the command is - received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - selectItem((context: TurnContext, state: TState, item: TItem) => - Promise) - uid: '@microsoft/teams-ai.MessageExtensions.selectItem' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that implements the logic to handle the tap actions - for items returned - - by a Search based message extension. - remarks: >- - The `composeExtension/selectItem` INVOKE activity does not contain any - sort of command ID, - - so only a single select item handler can be registered. Developers will - need to include a - - type name of some sort in the preview item they return if they need to - support multiple - - select item handlers. - isDeprecated: false - syntax: - content: >- - function selectItem(handler: (context: TurnContext, state: - TState, item: TItem) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, item: TItem) => - Promise<MessagingExtensionResult> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - submitAction(string | RegExp | Selector | (string | RegExp | - Selector)[], (context: TurnContext, state: TState, data: TData) => - Promise) - uid: '@microsoft/teams-ai.MessageExtensions.submitAction' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler that implements the submit action for an Action based - Message Extension. - remarks: '' - isDeprecated: false - syntax: - content: >- - function submitAction(commandId: string | RegExp | Selector | - (string | RegExp | Selector)[], handler: (context: TurnContext, state: - TState, data: TData) => Promise): Application - parameters: - - id: commandId - type: >- - string | RegExp | | - (string | RegExp | )[] - description: ID of the command(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<undefined | null | string | MessagingExtensionResult | - TaskModuleTaskInfo> - description: Function to call when the command is received. - return: - description: The application for chaining purposes. - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensionsInvokeNames.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensionsInvokeNames.yml deleted file mode 100644 index 3ade1bf8..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensionsInvokeNames.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSEnum -name: MessageExtensionsInvokeNames -uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames' -package: '@microsoft/teams-ai' -summary: Names of the invoke activities for Message Extensions. -fullName: MessageExtensionsInvokeNames -remarks: '' -isDeprecated: false -fields: - - name: ANONYMOUS_QUERY_LINK_INVOKE - uid: >- - @microsoft/teams-ai.MessageExtensionsInvokeNames.ANONYMOUS_QUERY_LINK_INVOKE - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for anonymous link unfurling. - - name: CONFIGURE_SETTINGS - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.CONFIGURE_SETTINGS' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for configuring settings. - - name: FETCH_TASK_INVOKE - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.FETCH_TASK_INVOKE' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for fetching task module. - - name: QUERY_CARD_BUTTON_CLICKED - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.QUERY_CARD_BUTTON_CLICKED' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for handling on card button clicked. - - name: QUERY_INVOKE - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.QUERY_INVOKE' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for query. - - name: QUERY_LINK_INVOKE - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.QUERY_LINK_INVOKE' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for query link. - - name: QUERY_SETTING_URL - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.QUERY_SETTING_URL' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for querying configuration settings. - - name: SELECT_ITEM_INVOKE - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.SELECT_ITEM_INVOKE' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for selecting an item. - - name: SUBMIT_ACTION_INVOKE - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames.SUBMIT_ACTION_INVOKE' - package: '@microsoft/teams-ai' - summary: Name of the invoke activity for submit action. diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageReactionEvents.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageReactionEvents.yml deleted file mode 100644 index 81a8275e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageReactionEvents.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: MessageReactionEvents -uid: '@microsoft/teams-ai.MessageReactionEvents' -package: '@microsoft/teams-ai' -summary: Message reaction event types. -fullName: MessageReactionEvents -remarks: '' -isDeprecated: false -syntax: | - type MessageReactionEvents = "reactionsAdded" | "reactionsRemoved" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ModerationSeverity.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ModerationSeverity.yml deleted file mode 100644 index f4abc02a..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ModerationSeverity.yml +++ /dev/null @@ -1,29 +0,0 @@ -### YamlMime:TSEnum -name: ModerationSeverity -uid: '@microsoft/teams-ai.ModerationSeverity' -package: '@microsoft/teams-ai' -summary: The moderation severity level. -fullName: ModerationSeverity -remarks: '' -isDeprecated: false -fields: - - name: Safe - uid: '@microsoft/teams-ai.ModerationSeverity.Safe' - package: '@microsoft/teams-ai' - summary: '' - numericValue: 0 - - name: Low - uid: '@microsoft/teams-ai.ModerationSeverity.Low' - package: '@microsoft/teams-ai' - summary: '' - numericValue: 2 - - name: Medium - uid: '@microsoft/teams-ai.ModerationSeverity.Medium' - package: '@microsoft/teams-ai' - summary: '' - numericValue: 4 - - name: High - uid: '@microsoft/teams-ai.ModerationSeverity.High' - package: '@microsoft/teams-ai' - summary: '' - numericValue: 6 diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Moderator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Moderator.yml deleted file mode 100644 index 3a25e2fb..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Moderator.yml +++ /dev/null @@ -1,96 +0,0 @@ -### YamlMime:TSType -name: Moderator -uid: '@microsoft/teams-ai.Moderator' -package: '@microsoft/teams-ai' -summary: A moderator is responsible for reviewing and approving AI prompts and plans. -fullName: Moderator -remarks: '' -isDeprecated: false -type: interface -methods: - - name: reviewInput(TurnContext, TState) - uid: '@microsoft/teams-ai.Moderator.reviewInput' - package: '@microsoft/teams-ai' - summary: >- - Reviews an incoming utterance and generated prompt before it's sent to the - planner. - remarks: >- - The moderator can review the incoming utterance for things like prompt - injection attacks - - or the leakage of sensitive information. The moderator can also review the - generated prompt - - to ensure it's appropriate for the current conversation. - - - To approve a prompt, simply return undefined. Returning a new plan - bypasses the planner and - - redirects to a new set of actions. Typically the moderator will return a - new plan with a - - single DO command that calls `AI.FlaggedInputActionName` to flag the input - for review. - - - The moderator can pass any entities that make sense to the redirected - action. - isDeprecated: false - syntax: - content: >- - function reviewInput(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - return: - description: >- - An undefined value to approve the prompt or a new plan to redirect to - if not approved. - type: Promise<undefined | > - - name: reviewOutput(TurnContext, TState, Plan) - uid: '@microsoft/teams-ai.Moderator.reviewOutput' - package: '@microsoft/teams-ai' - summary: Reviews a plan generated by the planner before its executed. - remarks: >- - The moderator can review the plan to ensure it's appropriate for the - current conversation. - - - To approve a plan simply return the plan that was passed in. A new plan - can be returned to - - redirect to a new set of actions. Typically the moderator will return a - new plan with a - - single DO command that calls `AI.FlaggedOutputActionName` to flag the - output for review. - - - The moderator can pass any entities that make sense to the redirected - action. - isDeprecated: false - syntax: - content: >- - function reviewOutput(context: TurnContext, state: TState, plan: Plan): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: plan - type: - description: Plan generated by the planner. - return: - description: >- - The plan to execute. Either the current plan passed in for review or a - new plan. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MonologueAugmentation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/MonologueAugmentation.yml deleted file mode 100644 index 1a2b7f9c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/MonologueAugmentation.yml +++ /dev/null @@ -1,98 +0,0 @@ -### YamlMime:TSType -name: MonologueAugmentation -uid: '@microsoft/teams-ai.MonologueAugmentation' -package: '@microsoft/teams-ai' -summary: The 'monologue' augmentation. -fullName: MonologueAugmentation -remarks: >- - This augmentation adds support for an inner monologue to the prompt. The - monologue helps the LLM - - to perform chain-of-thought reasoning across multiple turns of conversation. -isDeprecated: false -type: class -constructors: - - name: MonologueAugmentation(ChatCompletionAction[]) - uid: '@microsoft/teams-ai.MonologueAugmentation.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `MonologueAugmentation` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new MonologueAugmentation(actions: ChatCompletionAction[])' - parameters: - - id: actions - type: [] - description: List of actions supported by the prompt. -methods: - - name: >- - createPlanFromResponse(TurnContext, Memory, PromptResponse) - uid: '@microsoft/teams-ai.MonologueAugmentation.createPlanFromResponse' - package: '@microsoft/teams-ai' - summary: Creates a plan given validated response value. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createPlanFromResponse(context: TurnContext, memory: Memory, - response: PromptResponse): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: An interface for accessing state variables. - - id: response - type: PromptResponse<undefined | InnerMonologue> - description: The validated and transformed response for the prompt. - return: - description: The created plan. - type: Promise<> - - name: createPromptSection() - uid: '@microsoft/teams-ai.MonologueAugmentation.createPromptSection' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function createPromptSection(): undefined | PromptSection' - return: - description: Returns an optional prompt section for the augmentation. - type: undefined | - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.MonologueAugmentation.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<undefined - | InnerMonologue>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/NoUndefined.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/NoUndefined.yml deleted file mode 100644 index 1b4ea555..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/NoUndefined.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: NoUndefined -uid: '@microsoft/teams-ai.NoUndefined' -package: '@microsoft/teams-ai' -summary: '' -fullName: NoUndefined -remarks: '' -isDeprecated: false -syntax: | - type NoUndefined = T extends undefined ? never : T diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OAuthSettings.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OAuthSettings.yml deleted file mode 100644 index d6bc14ba..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OAuthSettings.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: OAuthSettings -uid: '@microsoft/teams-ai.OAuthSettings' -package: '@microsoft/teams-ai' -summary: Settings used to configure user authentication through the OAuthPrompt. -fullName: OAuthSettings -remarks: '' -isDeprecated: false -syntax: | - type OAuthSettings = OAuthPromptSettings & { - enableSso?: boolean - tokenExchangeUri?: string - } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OnEventNames.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OnEventNames.yml deleted file mode 100644 index 2e2de562..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OnEventNames.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: OnEventNames -uid: '@microsoft/teams-ai.OnEventNames' -package: '@microsoft/teams-ai' -summary: '' -fullName: OnEventNames -remarks: '' -isDeprecated: false -syntax: | - type OnEventNames = keyof TEventRecord diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddings.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddings.yml deleted file mode 100644 index 9936c301..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddings.yml +++ /dev/null @@ -1,67 +0,0 @@ -### YamlMime:TSType -name: OpenAIEmbeddings -uid: '@microsoft/teams-ai.OpenAIEmbeddings' -package: '@microsoft/teams-ai' -summary: A `EmbeddingsModel` for calling OpenAI and Azure OpenAI hosted models. -fullName: OpenAIEmbeddings -remarks: '' -isDeprecated: false -type: class -constructors: - - name: OpenAIEmbeddings(OpenAIEmbeddingsOptions | AzureOpenAIEmbeddingsOptions) - uid: '@microsoft/teams-ai.OpenAIEmbeddings.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `OpenAIEmbeddings` instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new OpenAIEmbeddings(options: OpenAIEmbeddingsOptions | - AzureOpenAIEmbeddingsOptions) - parameters: - - id: options - type: >- - | - description: Options for configuring the embeddings client. -properties: - - name: options - uid: '@microsoft/teams-ai.OpenAIEmbeddings.options' - package: '@microsoft/teams-ai' - summary: Options the client was configured with. - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: >- - options: OpenAIEmbeddingsOptions | OpenAILikeEmbeddingsOptions | - AzureOpenAIEmbeddingsOptions - return: - description: '' - type: >- - | | -methods: - - name: createEmbeddings(string, string | string[]) - uid: '@microsoft/teams-ai.OpenAIEmbeddings.createEmbeddings' - package: '@microsoft/teams-ai' - summary: Creates embeddings for the given inputs using the OpenAI API. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createEmbeddings(model: string, inputs: string | string[]): - Promise - parameters: - - id: model - type: string - description: Name of the model to use (or deployment for Azure). - - id: inputs - type: string | string[] - description: Text inputs to create embeddings for. - return: - description: >- - A `EmbeddingsResponse` with a status and the generated embeddings or a - message when an error occurs. - type: Promise<EmbeddingsResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddingsOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddingsOptions.yml deleted file mode 100644 index 5d1a0f31..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddingsOptions.yml +++ /dev/null @@ -1,128 +0,0 @@ -### YamlMime:TSType -name: OpenAIEmbeddingsOptions -uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions' -package: '@microsoft/teams-ai' -summary: >- - Options for configuring an `OpenAIEmbeddings` to generate embeddings using an - OpenAI hosted model. -fullName: OpenAIEmbeddingsOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.apiKey' - package: '@microsoft/teams-ai' - summary: API key to use when calling the OpenAI API. - fullName: apiKey - remarks: >- - A new API key can be created at - https://platform.openai.com/account/api-keys. - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.endpoint' - package: '@microsoft/teams-ai' - summary: Optional. Endpoint to use when calling the OpenAI API. - fullName: endpoint - remarks: For Azure OpenAI this is the deployment endpoint. - isDeprecated: false - syntax: - content: 'endpoint?: string' - return: - description: '' - type: string - - name: model - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.model' - package: '@microsoft/teams-ai' - summary: Embeddings Model to use. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model: string' - return: - description: '' - type: string - - name: organization - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.organization' - package: '@microsoft/teams-ai' - summary: Optional. Organization to use when calling the OpenAI API. - fullName: organization - remarks: '' - isDeprecated: false - syntax: - content: 'organization?: string' - return: - description: '' - type: string -inheritedProperties: - - name: dimensions - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.dimensions' - package: '@microsoft/teams-ai' - summary: Optional. Number of dimensions to use when generating embeddings. - fullName: dimensions - remarks: Only valid for embedding models that support dynamic dimensionality. - isDeprecated: false - syntax: - content: 'dimensions?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.dimensions](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.dimensions) - - name: logRequests - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.logRequests](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.logRequests) - - name: requestConfig - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: Optional. Request options to use when calling the OpenAI API. - fullName: requestConfig - remarks: '' - isDeprecated: false - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.requestConfig](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.requestConfig) - - name: retryPolicy - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: Optional. Retry policy to use when calling the OpenAI API. - fullName: retryPolicy - remarks: >- - The default retry policy is `[2000, 5000]` which means that the first - retry will be after - - 2 seconds and the second retry will be after 5 seconds. - isDeprecated: false - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.retryPolicy](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.retryPolicy) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAILikeEmbeddingsOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAILikeEmbeddingsOptions.yml deleted file mode 100644 index ab28dc50..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAILikeEmbeddingsOptions.yml +++ /dev/null @@ -1,118 +0,0 @@ -### YamlMime:TSType -name: OpenAILikeEmbeddingsOptions -uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions' -package: '@microsoft/teams-ai' -summary: >- - Options for configuring an embeddings object that calls an `OpenAI` compliant - endpoint. -fullName: OpenAILikeEmbeddingsOptions -remarks: |- - The endpoint should comply with the OpenAPI spec for OpenAI's API: - https://github.com/openai/openai-openapi - And an example of a compliant endpoint is LLaMA.cpp's reference server: - https://github.com/ggerganov/llama.cpp/blob/master/examples/server/README.md -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.apiKey' - package: '@microsoft/teams-ai' - summary: Optional. API key to use when calling the embeddings server. - fullName: apiKey - remarks: '' - isDeprecated: false - syntax: - content: 'apiKey?: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.endpoint' - package: '@microsoft/teams-ai' - summary: Endpoint of the embeddings server to call. - fullName: endpoint - remarks: '' - isDeprecated: false - syntax: - content: 'endpoint: string' - return: - description: '' - type: string - - name: model - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.model' - package: '@microsoft/teams-ai' - summary: Embeddings Model to use. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model: string' - return: - description: '' - type: string -inheritedProperties: - - name: dimensions - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.dimensions' - package: '@microsoft/teams-ai' - summary: Optional. Number of dimensions to use when generating embeddings. - fullName: dimensions - remarks: Only valid for embedding models that support dynamic dimensionality. - isDeprecated: false - syntax: - content: 'dimensions?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.dimensions](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.dimensions) - - name: logRequests - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.logRequests](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.logRequests) - - name: requestConfig - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: Optional. Request options to use when calling the OpenAI API. - fullName: requestConfig - remarks: '' - isDeprecated: false - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.requestConfig](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.requestConfig) - - name: retryPolicy - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: Optional. Retry policy to use when calling the OpenAI API. - fullName: retryPolicy - remarks: >- - The default retry policy is `[2000, 5000]` which means that the first - retry will be after - - 2 seconds and the second retry will be after 5 seconds. - isDeprecated: false - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - inheritanceDescription: >- - Inherited From - [BaseOpenAIEmbeddingsOptions.retryPolicy](xref:@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions.retryPolicy) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModel.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModel.yml deleted file mode 100644 index 33030003..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModel.yml +++ /dev/null @@ -1,115 +0,0 @@ -### YamlMime:TSType -name: OpenAIModel -uid: '@microsoft/teams-ai.OpenAIModel' -package: '@microsoft/teams-ai' -summary: A `PromptCompletionModel` for calling OpenAI and Azure OpenAI hosted models. -fullName: OpenAIModel -remarks: >- - The model has been updated to support calling OpenAI's new o1 family of - models. That currently - - comes with a few constraints. These constraints are mostly handled for you but - are worth noting: - - - The o1 models introduce a new `max_completion_tokens` parameter and they've - deprecated the - `max_tokens` parameter. The model will automatically convert the incoming `max_tokens` parameter - to `max_completion_tokens` for you. But you should be aware that o1 has hidden - token usage and costs - - that aren't constrained by the `max_completion_tokens` parameter. This means - that you may see an - - increase in token usage and costs when using the o1 models. - - - The o1 models do not currently support the sending of system messages which - just means that the - - `useSystemMessages` parameter is ignored when calling the o1 models. - - - The o1 models do not currently support setting the `temperature`, `top_p`, - and `presence_penalty` - - parameters so they will be ignored. - - - The o1 models do not currently support the use of tools so you will need to - use the "monologue" - - augmentation to call actions. -isDeprecated: false -type: class -constructors: - - name: OpenAIModel(OpenAIModelOptions | AzureOpenAIModelOptions) - uid: '@microsoft/teams-ai.OpenAIModel.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `OpenAIModel` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new OpenAIModel(options: OpenAIModelOptions | AzureOpenAIModelOptions)' - parameters: - - id: options - type: >- - | - description: Options for configuring the model client. -properties: - - name: events - uid: '@microsoft/teams-ai.OpenAIModel.events' - package: '@microsoft/teams-ai' - summary: Events emitted by the model. - fullName: events - remarks: '' - isDeprecated: false - syntax: - content: PromptCompletionModelEmitter events - return: - description: The events emitted by the model. - type: - - name: options - uid: '@microsoft/teams-ai.OpenAIModel.options' - package: '@microsoft/teams-ai' - summary: Options the client was configured with. - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: 'options: OpenAIModelOptions | AzureOpenAIModelOptions' - return: - description: '' - type: >- - | -methods: - - name: >- - completePrompt(TurnContext, Memory, PromptFunctions, Tokenizer, - PromptTemplate) - uid: '@microsoft/teams-ai.OpenAIModel.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt using OpenAI or Azure OpenAI. - remarks: '' - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): - Promise> - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Functions to use when rendering the prompt. - - id: tokenizer - type: - description: Tokenizer to use when rendering the prompt. - - id: template - type: - description: Prompt template to complete. - return: - description: A `PromptResponse` with the status and message. - type: Promise<PromptResponse<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModelOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModelOptions.yml deleted file mode 100644 index 79cd2920..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModelOptions.yml +++ /dev/null @@ -1,222 +0,0 @@ -### YamlMime:TSType -name: OpenAIModelOptions -uid: '@microsoft/teams-ai.OpenAIModelOptions' -package: '@microsoft/teams-ai' -summary: Options for configuring an `OpenAIModel` to call an OpenAI hosted model. -fullName: OpenAIModelOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.OpenAIModelOptions.apiKey' - package: '@microsoft/teams-ai' - summary: API key to use when calling the OpenAI API. - fullName: apiKey - remarks: >- - A new API key can be created at - https://platform.openai.com/account/api-keys. - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - - name: defaultModel - uid: '@microsoft/teams-ai.OpenAIModelOptions.defaultModel' - package: '@microsoft/teams-ai' - summary: Default model to use for completions. - fullName: defaultModel - remarks: '' - isDeprecated: false - syntax: - content: 'defaultModel: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.OpenAIModelOptions.endpoint' - package: '@microsoft/teams-ai' - summary: Optional. Endpoint to use when calling the OpenAI API. - fullName: endpoint - remarks: For Azure OpenAI this is the deployment endpoint. - isDeprecated: false - syntax: - content: 'endpoint?: string' - return: - description: '' - type: string - - name: organization - uid: '@microsoft/teams-ai.OpenAIModelOptions.organization' - package: '@microsoft/teams-ai' - summary: Optional. Organization to use when calling the OpenAI API. - fullName: organization - remarks: '' - isDeprecated: false - syntax: - content: 'organization?: string' - return: - description: '' - type: string - - name: project - uid: '@microsoft/teams-ai.OpenAIModelOptions.project' - package: '@microsoft/teams-ai' - summary: Optional. Project to use when calling the OpenAI API. - fullName: project - remarks: '' - isDeprecated: false - syntax: - content: 'project?: string' - return: - description: '' - type: string -inheritedProperties: - - name: clientOptions - uid: '@microsoft/teams-ai.OpenAIModelOptions.clientOptions' - package: '@microsoft/teams-ai' - summary: Optional. Custom client options to use when calling the OpenAI API. - fullName: clientOptions - remarks: '' - isDeprecated: false - syntax: - content: 'clientOptions?: ClientOptions' - return: - description: '' - type: ClientOptions - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.clientOptions](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.clientOptions) - - name: logRequests - uid: '@microsoft/teams-ai.OpenAIModelOptions.logRequests' - package: '@microsoft/teams-ai' - summary: Optional. Whether to log requests to the console. - fullName: logRequests - remarks: This is useful for debugging prompts and defaults to `false`. - isDeprecated: false - syntax: - content: 'logRequests?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.logRequests](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.logRequests) - - name: maxRetries - uid: '@microsoft/teams-ai.OpenAIModelOptions.maxRetries' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of retries to use when calling the OpenAI API. - fullName: maxRetries - remarks: The default is to retry twice. - isDeprecated: false - syntax: - content: 'maxRetries?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.maxRetries](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.maxRetries) - - name: requestConfig - uid: '@microsoft/teams-ai.OpenAIModelOptions.requestConfig' - package: '@microsoft/teams-ai' - summary: '' - fullName: requestConfig - remarks: '' - isDeprecated: true - customDeprecatedMessage: Optional. Request options to use when calling the OpenAI API. - syntax: - content: 'requestConfig?: AxiosRequestConfig' - return: - description: '' - type: AxiosRequestConfig<any> - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.requestConfig](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.requestConfig) - - name: responseFormat - uid: '@microsoft/teams-ai.OpenAIModelOptions.responseFormat' - package: '@microsoft/teams-ai' - summary: Optional. Forces the model return a specific response format. - fullName: responseFormat - remarks: This can be used to force the model to always return a valid JSON object. - isDeprecated: false - syntax: - content: 'responseFormat?: { type: "json_object" }' - return: - description: '' - type: '{ type: "json_object" }' - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.responseFormat](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.responseFormat) - - name: retryPolicy - uid: '@microsoft/teams-ai.OpenAIModelOptions.retryPolicy' - package: '@microsoft/teams-ai' - summary: '' - fullName: retryPolicy - remarks: Use `maxRetries` instead. - isDeprecated: true - customDeprecatedMessage: Optional. Retry policy to use when calling the OpenAI API. - syntax: - content: 'retryPolicy?: number[]' - return: - description: '' - type: number[] - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.retryPolicy](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.retryPolicy) - - name: seed - uid: '@microsoft/teams-ai.OpenAIModelOptions.seed' - package: '@microsoft/teams-ai' - summary: Optional. A static seed to use when making model calls. - fullName: seed - remarks: >- - The default is to use a random seed. Specifying a seed will make the model - deterministic. - isDeprecated: false - syntax: - content: 'seed?: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.seed](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.seed) - - name: stream - uid: '@microsoft/teams-ai.OpenAIModelOptions.stream' - package: '@microsoft/teams-ai' - summary: >- - Optional. Whether the models responses should be streamed back using - Server Sent Events (SSE.) - fullName: stream - remarks: Defaults to `false`. - isDeprecated: false - syntax: - content: 'stream?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.stream](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.stream) - - name: useSystemMessages - uid: '@microsoft/teams-ai.OpenAIModelOptions.useSystemMessages' - package: '@microsoft/teams-ai' - summary: Optional. Whether to use `system` messages when calling the OpenAI API. - fullName: useSystemMessages - remarks: >- - The current generation of models tend to follow instructions from `user` - messages better - - then `system` messages so the default is `false`, which causes any - `system` message in the - - prompt to be sent as `user` messages instead. - isDeprecated: false - syntax: - content: 'useSystemMessages?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [BaseOpenAIModelOptions.useSystemMessages](xref:@microsoft/teams-ai.BaseOpenAIModelOptions.useSystemMessages) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModerator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModerator.yml deleted file mode 100644 index 80b20a6d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModerator.yml +++ /dev/null @@ -1,87 +0,0 @@ -### YamlMime:TSType -name: OpenAIModerator -uid: '@microsoft/teams-ai.OpenAIModerator' -package: '@microsoft/teams-ai' -summary: >- - A moderator that uses OpenAI's moderation API to review prompts and plans for - safety. -fullName: OpenAIModerator -remarks: >- - This moderation can be configure to review the input from the user, output - from the model, or both. -isDeprecated: false -type: class -constructors: - - name: OpenAIModerator(OpenAIModeratorOptions) - uid: '@microsoft/teams-ai.OpenAIModerator.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the OpenAI based moderator. - remarks: '' - isDeprecated: false - syntax: - content: 'new OpenAIModerator(options: OpenAIModeratorOptions)' - parameters: - - id: options - type: - description: Configuration options for the moderator. -properties: - - name: options - uid: '@microsoft/teams-ai.OpenAIModerator.options' - package: '@microsoft/teams-ai' - summary: '' - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: OpenAIModeratorOptions options - return: - description: '' - type: -methods: - - name: reviewInput(TurnContext, TState) - uid: '@microsoft/teams-ai.OpenAIModerator.reviewInput' - package: '@microsoft/teams-ai' - summary: Reviews an incoming utterance for safety violations. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewInput(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - return: - description: >- - An undefined value to approve the prompt or a new plan to redirect to - if not approved. - type: Promise<undefined | > - - name: reviewOutput(TurnContext, TState, Plan) - uid: '@microsoft/teams-ai.OpenAIModerator.reviewOutput' - package: '@microsoft/teams-ai' - summary: Reviews the SAY commands generated by the planner for safety violations. - remarks: '' - isDeprecated: false - syntax: - content: >- - function reviewOutput(context: TurnContext, state: TState, plan: Plan): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: plan - type: - description: Plan generated by the planner. - return: - description: >- - The plan to execute. Either the current plan passed in for review or a - new plan. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModeratorOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModeratorOptions.yml deleted file mode 100644 index 3a4e629e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModeratorOptions.yml +++ /dev/null @@ -1,82 +0,0 @@ -### YamlMime:TSType -name: OpenAIModeratorOptions -uid: '@microsoft/teams-ai.OpenAIModeratorOptions' -package: '@microsoft/teams-ai' -summary: Options for the OpenAI based moderator. -fullName: OpenAIModeratorOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.apiKey' - package: '@microsoft/teams-ai' - summary: OpenAI API key - fullName: apiKey - remarks: '' - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - - name: apiVersion - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.apiVersion' - package: '@microsoft/teams-ai' - summary: Optional. Azure Content Safety API version. - fullName: apiVersion - remarks: '' - isDeprecated: false - syntax: - content: 'apiVersion?: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.endpoint' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI endpoint. - fullName: endpoint - remarks: '' - isDeprecated: false - syntax: - content: 'endpoint?: string' - return: - description: '' - type: string - - name: model - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.model' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI model to use. - fullName: model - remarks: '' - isDeprecated: false - syntax: - content: 'model?: string' - return: - description: '' - type: string - - name: moderate - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.moderate' - package: '@microsoft/teams-ai' - summary: Which parts of the conversation to moderate. - fullName: moderate - remarks: '' - isDeprecated: false - syntax: - content: 'moderate: "input" | "output" | "both"' - return: - description: '' - type: '"input" | "output" | "both"' - - name: organization - uid: '@microsoft/teams-ai.OpenAIModeratorOptions.organization' - package: '@microsoft/teams-ai' - summary: Optional. OpenAI organization. - fullName: organization - remarks: '' - isDeprecated: false - syntax: - content: 'organization?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenKeys.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenKeys.yml deleted file mode 100644 index cb6dd506..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenKeys.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: OverriddenKeys -uid: '@microsoft/teams-ai.OverriddenKeys' -package: '@microsoft/teams-ai' -summary: '' -fullName: OverriddenKeys -remarks: '' -isDeprecated: false -syntax: | - type OverriddenKeys = keyof OverriddenMethods diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenMethods.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenMethods.yml deleted file mode 100644 index d0aec0d2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenMethods.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSTypeAlias -name: OverriddenMethods -uid: '@microsoft/teams-ai.OverriddenMethods' -package: '@microsoft/teams-ai' -summary: '' -fullName: OverriddenMethods -remarks: '' -isDeprecated: false -syntax: >- - type OverriddenMethods = { - addEventListener(this: T, event: P, listener: (args: - ListenerType) => void) => EEMethodReturnType, addListener(this: T, event: P, listener: (args: - ListenerType) => void) => EEMethodReturnType, emit(this: T, event: P, args: - ListenerType) => EEMethodReturnType, on(this: T, event: P, listener: (args: ListenerType) - => void) => EEMethodReturnType, once(this: T, event: - P, listener: (args: ListenerType) => void) => - EEMethodReturnType, removeEventListener(this: T, - event: P, listener: (args: any[]) => any) => EEMethodReturnType, removeListener(this: T, event: P, listener: - (args: any[]) => any) => EEMethodReturnType } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Plan.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Plan.yml deleted file mode 100644 index 0bab74b3..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Plan.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: Plan -uid: '@microsoft/teams-ai.Plan' -package: '@microsoft/teams-ai' -summary: A plan is a set of commands that the AI system will execute. -fullName: Plan -remarks: '' -isDeprecated: false -type: interface -properties: - - name: commands - uid: '@microsoft/teams-ai.Plan.commands' - package: '@microsoft/teams-ai' - summary: Array of predicted commands that the AI system should execute. - fullName: commands - remarks: '' - isDeprecated: false - syntax: - content: 'commands: PredictedCommand[]' - return: - description: '' - type: [] - - name: type - uid: '@microsoft/teams-ai.Plan.type' - package: '@microsoft/teams-ai' - summary: Type to indicate that a plan is being returned. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "plan"' - return: - description: '' - type: '"plan"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Planner.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Planner.yml deleted file mode 100644 index c9d30d18..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Planner.yml +++ /dev/null @@ -1,82 +0,0 @@ -### YamlMime:TSType -name: Planner -uid: '@microsoft/teams-ai.Planner' -package: '@microsoft/teams-ai' -summary: >- - A planner is responsible for generating a plan that the AI system will - execute. -fullName: Planner -remarks: '' -isDeprecated: false -type: interface -methods: - - name: beginTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.Planner.beginTask' - package: '@microsoft/teams-ai' - summary: Starts a new task. - remarks: >- - This method is called when the AI system is ready to start a new task. The - planner should - - generate a plan that the AI system will execute. Returning an empty plan - signals that - - there is no work to be performed. - - - The planner should take the users input from `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function beginTask(context: TurnContext, state: TState, ai: AI): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> - - name: continueTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.Planner.continueTask' - package: '@microsoft/teams-ai' - summary: Continues the current task. - remarks: >- - This method is called when the AI system has finished executing the - previous plan and is - - ready to continue the current task. The planner should generate a plan - that the AI system - - will execute. Returning an empty plan signals that the task is completed - and there is no work - - to be performed. - - - The output from the last plan step that was executed is passed to the - planner via `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function continueTask(context: TurnContext, state: TState, ai: - AI): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedCommand.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedCommand.yml deleted file mode 100644 index 3b24713d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedCommand.yml +++ /dev/null @@ -1,26 +0,0 @@ -### YamlMime:TSType -name: PredictedCommand -uid: '@microsoft/teams-ai.PredictedCommand' -package: '@microsoft/teams-ai' -summary: A predicted command is a command that the AI system should execute. -fullName: PredictedCommand -remarks: '' -isDeprecated: false -type: interface -properties: - - name: type - uid: '@microsoft/teams-ai.PredictedCommand.type' - package: '@microsoft/teams-ai' - summary: Type of command to execute. - fullName: type - remarks: >- - DO commands are actions that the AI system should perform. SAY commands - are responses that - - the AI system should say. - isDeprecated: false - syntax: - content: 'type: "DO" | "SAY"' - return: - description: '' - type: '"DO" | "SAY"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommand.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommand.yml deleted file mode 100644 index 697e9cf9..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommand.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: PredictedDoCommand -uid: '@microsoft/teams-ai.PredictedDoCommand' -package: '@microsoft/teams-ai' -summary: A predicted DO command is an action that the AI system should perform. -fullName: PredictedDoCommand -remarks: '' -isDeprecated: false -type: interface -properties: - - name: action - uid: '@microsoft/teams-ai.PredictedDoCommand.action' - package: '@microsoft/teams-ai' - summary: The named action that the AI system should perform. - fullName: action - remarks: '' - isDeprecated: false - syntax: - content: 'action: string' - return: - description: '' - type: string - - name: actionId - uid: '@microsoft/teams-ai.PredictedDoCommand.actionId' - package: '@microsoft/teams-ai' - summary: >- - Optional. The id mapped to the name action that the AI system should - perform. - - In OpenAI, this is associated with the action_id tool calls. - fullName: actionId - remarks: '' - isDeprecated: false - syntax: - content: 'actionId?: string' - return: - description: '' - type: string - - name: parameters - uid: '@microsoft/teams-ai.PredictedDoCommand.parameters' - package: '@microsoft/teams-ai' - summary: Any parameters that the AI system should use to perform the action. - fullName: parameters - remarks: '' - isDeprecated: false - syntax: - content: 'parameters: Record' - return: - description: '' - type: Record<string, any> - - name: type - uid: '@microsoft/teams-ai.PredictedDoCommand.type' - package: '@microsoft/teams-ai' - summary: Type to indicate that a DO command is being returned. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "DO"' - return: - description: '' - type: '"DO"' -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommandAndHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommandAndHandler.yml deleted file mode 100644 index 9f19e9a6..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommandAndHandler.yml +++ /dev/null @@ -1,92 +0,0 @@ -### YamlMime:TSType -name: PredictedDoCommandAndHandler -uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler' -package: '@microsoft/teams-ai' -summary: Entities argument passed to the action handler for AI.DoCommandActionName. -fullName: PredictedDoCommandAndHandler -remarks: '' -isDeprecated: false -type: interface -properties: - - name: handler - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler.handler' - package: '@microsoft/teams-ai' - summary: The handler that should be called to execute the command. - fullName: handler - remarks: '' - isDeprecated: false - syntax: - content: >- - handler: (context: TurnContext, state: TState, parameters?: - Record, action?: string) => Promise - return: - description: '' - type: >- - (context: TurnContext, state: TState, parameters?: Record<string, - any>, action?: string) => Promise<string> -inheritedProperties: - - name: action - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler.action' - package: '@microsoft/teams-ai' - summary: The named action that the AI system should perform. - fullName: action - remarks: '' - isDeprecated: false - syntax: - content: 'action: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PredictedDoCommand.action](xref:@microsoft/teams-ai.PredictedDoCommand.action) - - name: actionId - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler.actionId' - package: '@microsoft/teams-ai' - summary: >- - Optional. The id mapped to the name action that the AI system should - perform. - - In OpenAI, this is associated with the action_id tool calls. - fullName: actionId - remarks: '' - isDeprecated: false - syntax: - content: 'actionId?: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PredictedDoCommand.actionId](xref:@microsoft/teams-ai.PredictedDoCommand.actionId) - - name: parameters - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler.parameters' - package: '@microsoft/teams-ai' - summary: Any parameters that the AI system should use to perform the action. - fullName: parameters - remarks: '' - isDeprecated: false - syntax: - content: 'parameters: Record' - return: - description: '' - type: Record<string, any> - inheritanceDescription: >- - Inherited From - [PredictedDoCommand.parameters](xref:@microsoft/teams-ai.PredictedDoCommand.parameters) - - name: type - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler.type' - package: '@microsoft/teams-ai' - summary: Type to indicate that a DO command is being returned. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "DO"' - return: - description: '' - type: '"DO"' - inheritanceDescription: >- - Inherited From - [PredictedDoCommand.type](xref:@microsoft/teams-ai.PredictedDoCommand.type) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedSayCommand.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedSayCommand.yml deleted file mode 100644 index 857872d5..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedSayCommand.yml +++ /dev/null @@ -1,35 +0,0 @@ -### YamlMime:TSType -name: PredictedSayCommand -uid: '@microsoft/teams-ai.PredictedSayCommand' -package: '@microsoft/teams-ai' -summary: A predicted SAY command is a response that the AI system should say. -fullName: PredictedSayCommand -remarks: '' -isDeprecated: false -type: interface -properties: - - name: response - uid: '@microsoft/teams-ai.PredictedSayCommand.response' - package: '@microsoft/teams-ai' - summary: The response that the AI system should say. - fullName: response - remarks: '' - isDeprecated: false - syntax: - content: 'response: Message' - return: - description: '' - type: <string> - - name: type - uid: '@microsoft/teams-ai.PredictedSayCommand.type' - package: '@microsoft/teams-ai' - summary: Type to indicate that a SAY command is being returned. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "SAY"' - return: - description: '' - type: '"SAY"' -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Prompt.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Prompt.yml deleted file mode 100644 index 8b76d704..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Prompt.yml +++ /dev/null @@ -1,106 +0,0 @@ -### YamlMime:TSType -name: Prompt -uid: '@microsoft/teams-ai.Prompt' -package: '@microsoft/teams-ai' -summary: Top level prompt section. -fullName: Prompt -remarks: >- - Prompts are compositional such that they can be nested to create complex - prompt hierarchies. -isDeprecated: false -type: class -constructors: - - name: Prompt(PromptSection[], number, boolean, string) - uid: '@microsoft/teams-ai.Prompt.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'Prompt' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new Prompt(sections: PromptSection[], tokens?: number, required?: - boolean, separator?: string) - parameters: - - id: sections - type: [] - description: Sections to render. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to -1, 'auto'. - - id: required - type: boolean - description: Optional. Indicates if this section is required. Defaults to `true`. - - id: separator - type: string - description: >- - Optional. Separator to use between sections when rendering as text. - Defaults to `\n\n`. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.Prompt.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [LayoutEngine.required](xref:@microsoft/teams-ai.LayoutEngine.required) - - name: sections - uid: '@microsoft/teams-ai.Prompt.sections' - package: '@microsoft/teams-ai' - summary: '' - fullName: sections - remarks: '' - isDeprecated: false - syntax: - content: 'sections: PromptSection[]' - return: - description: '' - type: [] - inheritanceDescription: >- - Inherited From - [LayoutEngine.sections](xref:@microsoft/teams-ai.LayoutEngine.sections) - - name: separator - uid: '@microsoft/teams-ai.Prompt.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [LayoutEngine.separator](xref:@microsoft/teams-ai.LayoutEngine.separator) - - name: tokens - uid: '@microsoft/teams-ai.Prompt.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [LayoutEngine.tokens](xref:@microsoft/teams-ai.LayoutEngine.tokens) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptChunk.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptChunk.yml deleted file mode 100644 index 11d63e1d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptChunk.yml +++ /dev/null @@ -1,24 +0,0 @@ -### YamlMime:TSType -name: PromptChunk -uid: '@microsoft/teams-ai.PromptChunk' -package: '@microsoft/teams-ai' -summary: Streaming chunk passed in the `sendChunk` event of a `PromptCompletionClient`. -fullName: PromptChunk -remarks: '' -isDeprecated: false -type: interface -properties: - - name: delta - uid: '@microsoft/teams-ai.PromptChunk.delta' - package: '@microsoft/teams-ai' - summary: Delta for the response message being buffered up. - fullName: delta - remarks: '' - isDeprecated: false - syntax: - content: 'delta?: Partial>' - return: - description: '' - type: >- - Partial<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModel.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModel.yml deleted file mode 100644 index f6ba8f4f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModel.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: PromptCompletionModel -uid: '@microsoft/teams-ai.PromptCompletionModel' -package: '@microsoft/teams-ai' -summary: An AI model that can be used to complete prompts. -fullName: PromptCompletionModel -remarks: '' -isDeprecated: false -type: interface -properties: - - name: events - uid: '@microsoft/teams-ai.PromptCompletionModel.events' - package: '@microsoft/teams-ai' - summary: Optional. Events emitted by the model. - fullName: events - remarks: '' - isDeprecated: false - syntax: - content: 'events?: PromptCompletionModelEmitter' - return: - description: '' - type: -methods: - - name: >- - completePrompt(TurnContext, Memory, PromptFunctions, Tokenizer, - PromptTemplate) - uid: '@microsoft/teams-ai.PromptCompletionModel.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): - Promise> - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Functions to use when rendering the prompt. - - id: tokenizer - type: - description: Tokenizer to use when rendering the prompt. - - id: template - type: - description: Prompt template to complete. - return: - description: A `PromptResponse` with the status and message. - type: Promise<PromptResponse<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelBeforeCompletionEvent.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelBeforeCompletionEvent.yml deleted file mode 100644 index bd23c948..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelBeforeCompletionEvent.yml +++ /dev/null @@ -1,17 +0,0 @@ -### YamlMime:TSTypeAlias -name: PromptCompletionModelBeforeCompletionEvent -uid: '@microsoft/teams-ai.PromptCompletionModelBeforeCompletionEvent' -package: '@microsoft/teams-ai' -summary: Type signature for the `beforeCompletion` event of a `PromptCompletionModel`. -fullName: PromptCompletionModelBeforeCompletionEvent -remarks: '' -isDeprecated: false -syntax: | - type PromptCompletionModelBeforeCompletionEvent = ( - context: TurnContext, - memory: Memory, - functions: PromptFunctions, - tokenizer: Tokenizer, - template: PromptTemplate, - streaming: boolean - ) => void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelChunkReceivedEvent.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelChunkReceivedEvent.yml deleted file mode 100644 index 7ba3881f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelChunkReceivedEvent.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: PromptCompletionModelChunkReceivedEvent -uid: '@microsoft/teams-ai.PromptCompletionModelChunkReceivedEvent' -package: '@microsoft/teams-ai' -summary: Type signature for the `chunkReceived` event of a `PromptCompletionModel`. -fullName: PromptCompletionModelChunkReceivedEvent -remarks: '' -isDeprecated: false -syntax: | - type PromptCompletionModelChunkReceivedEvent = ( - context: TurnContext, - memory: Memory, - chunk: PromptChunk - ) => void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEmitter.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEmitter.yml deleted file mode 100644 index 436df810..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEmitter.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: PromptCompletionModelEmitter -uid: '@microsoft/teams-ai.PromptCompletionModelEmitter' -package: '@microsoft/teams-ai' -summary: >- - Helper type that strongly types the the EventEmitter for a - PromptCOmpletionModel instance. -fullName: PromptCompletionModelEmitter -remarks: '' -isDeprecated: false -syntax: | - type PromptCompletionModelEmitter = StrictEventEmitter< - EventEmitter, - PromptCompletionModelEvents - > diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEvents.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEvents.yml deleted file mode 100644 index 111925d8..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEvents.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: PromptCompletionModelEvents -uid: '@microsoft/teams-ai.PromptCompletionModelEvents' -package: '@microsoft/teams-ai' -summary: Events emitted by a PromptCompletionModel. -fullName: PromptCompletionModelEvents -remarks: '' -isDeprecated: false -type: interface -properties: - - name: beforeCompletion - uid: '@microsoft/teams-ai.PromptCompletionModelEvents.beforeCompletion' - package: '@microsoft/teams-ai' - summary: Triggered before the model is called to complete a prompt. - fullName: beforeCompletion - remarks: '' - isDeprecated: false - syntax: - content: >- - beforeCompletion: (context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate, - streaming: boolean) => void - return: - description: '' - type: >- - (context: TurnContext, memory: Memory, functions: PromptFunctions, - tokenizer: Tokenizer, template: PromptTemplate, streaming: boolean) - => void - - name: chunkReceived - uid: '@microsoft/teams-ai.PromptCompletionModelEvents.chunkReceived' - package: '@microsoft/teams-ai' - summary: Triggered when a chunk is received from the model via streaming. - fullName: chunkReceived - remarks: '' - isDeprecated: false - syntax: - content: >- - chunkReceived: (context: TurnContext, memory: Memory, chunk: - PromptChunk) => void - return: - description: '' - type: '(context: TurnContext, memory: Memory, chunk: PromptChunk) => void' - - name: responseReceived - uid: '@microsoft/teams-ai.PromptCompletionModelEvents.responseReceived' - package: '@microsoft/teams-ai' - summary: Triggered after the model finishes returning a response. - fullName: responseReceived - remarks: '' - isDeprecated: false - syntax: - content: >- - responseReceived: (context: TurnContext, memory: Memory, response: - PromptResponse, streamer: StreamingResponse) => void - return: - description: '' - type: >- - (context: TurnContext, memory: Memory, response: - PromptResponse<string>, streamer: StreamingResponse) => void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelResponseReceivedEvent.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelResponseReceivedEvent.yml deleted file mode 100644 index 02adb869..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelResponseReceivedEvent.yml +++ /dev/null @@ -1,15 +0,0 @@ -### YamlMime:TSTypeAlias -name: PromptCompletionModelResponseReceivedEvent -uid: '@microsoft/teams-ai.PromptCompletionModelResponseReceivedEvent' -package: '@microsoft/teams-ai' -summary: Type signature for the `responseReceived` event of a `PromptCompletionModel`. -fullName: PromptCompletionModelResponseReceivedEvent -remarks: '' -isDeprecated: false -syntax: | - type PromptCompletionModelResponseReceivedEvent = ( - context: TurnContext, - memory: Memory, - response: PromptResponse, - streamer: StreamingResponse - ) => void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunction.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunction.yml deleted file mode 100644 index eed40e87..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunction.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: PromptFunction -uid: '@microsoft/teams-ai.PromptFunction' -package: '@microsoft/teams-ai' -summary: A function that can be called from a prompt template string. -fullName: PromptFunction -remarks: '' -isDeprecated: false -syntax: | - type PromptFunction = ( - context: TurnContext, - memory: Memory, - functions: PromptFunctions, - tokenizer: Tokenizer, - args: string[] - ) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunctions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunctions.yml deleted file mode 100644 index 6b3b2dea..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunctions.yml +++ /dev/null @@ -1,69 +0,0 @@ -### YamlMime:TSType -name: PromptFunctions -uid: '@microsoft/teams-ai.PromptFunctions' -package: '@microsoft/teams-ai' -summary: A collection of functions that can be called from a prompt template string. -fullName: PromptFunctions -remarks: '' -isDeprecated: false -type: interface -methods: - - name: getFunction(string) - uid: '@microsoft/teams-ai.PromptFunctions.getFunction' - package: '@microsoft/teams-ai' - summary: Looks up the given function. - remarks: Throws an error if the function is not defined. - isDeprecated: false - syntax: - content: 'function getFunction(name: string): PromptFunction' - parameters: - - id: name - type: string - description: Name of the function to lookup. - return: - description: '' - type: - - name: hasFunction(string) - uid: '@microsoft/teams-ai.PromptFunctions.hasFunction' - package: '@microsoft/teams-ai' - summary: Returns true if the given function is defined. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasFunction(name: string): boolean' - parameters: - - id: name - type: string - description: Name of the function to lookup. - return: - description: '' - type: boolean - - name: invokeFunction(string, TurnContext, Memory, Tokenizer, string[]) - uid: '@microsoft/teams-ai.PromptFunctions.invokeFunction' - package: '@microsoft/teams-ai' - summary: Calls the given function. - remarks: Throws an error if the function is not defined. - isDeprecated: false - syntax: - content: >- - function invokeFunction(name: string, context: TurnContext, memory: - Memory, tokenizer: Tokenizer, args: string[]): Promise - parameters: - - id: name - type: string - description: Name of the function to invoke. - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface used to access state variables. - - id: tokenizer - type: - description: Tokenizer used to encode/decode strings. - - id: args - type: string[] - description: Arguments to pass to the function as an array of strings. - return: - description: '' - type: Promise<any> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManager.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManager.yml deleted file mode 100644 index 18da364c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManager.yml +++ /dev/null @@ -1,233 +0,0 @@ -### YamlMime:TSType -name: PromptManager -uid: '@microsoft/teams-ai.PromptManager' -package: '@microsoft/teams-ai' -summary: A filesystem based prompt manager. -fullName: PromptManager -remarks: >- - The default prompt manager uses the file system to define prompts that are - compatible with - - Microsoft's Semantic Kernel SDK (see: - https://github.com/microsoft/semantic-kernel) - - - Each prompt is a separate folder under a root prompts folder. The folder - should contain the following files: - - - - "config.json": Required. Contains the prompts configuration and is a - serialized instance of `PromptTemplateConfig`. - - - "skprompt.txt": Required. Contains the text of the prompt and supports - Semantic Kernels prompt template syntax. - - - "actions.json": Optional. Contains a list of actions that can be called by - the prompt. - - - Prompts can be loaded and used by name and new dynamically defined prompt - templates can be - - registered with the prompt manager. -isDeprecated: false -type: class -constructors: - - name: PromptManager(PromptManagerOptions) - uid: '@microsoft/teams-ai.PromptManager.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'PromptManager' instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new PromptManager(options: PromptManagerOptions)' - parameters: - - id: options - type: - description: Options used to configure the prompt manager. -properties: - - name: options - uid: '@microsoft/teams-ai.PromptManager.options' - package: '@microsoft/teams-ai' - summary: Gets the configured prompt manager options. - fullName: options - remarks: '' - isDeprecated: false - syntax: - content: ConfiguredPromptManagerOptions options - return: - description: The configured prompt manager options. - type: -methods: - - name: addDataSource(DataSource) - uid: '@microsoft/teams-ai.PromptManager.addDataSource' - package: '@microsoft/teams-ai' - summary: Registers a new data source with the prompt manager. - remarks: '' - isDeprecated: false - syntax: - content: 'function addDataSource(dataSource: DataSource): PromptManager' - parameters: - - id: dataSource - type: - description: Data source to add. - return: - description: The prompt manager for chaining. - type: - - name: addFunction(string, PromptFunction) - uid: '@microsoft/teams-ai.PromptManager.addFunction' - package: '@microsoft/teams-ai' - summary: Registers a new prompt template function with the prompt manager. - remarks: '' - isDeprecated: false - syntax: - content: 'function addFunction(name: string, fn: PromptFunction): PromptManager' - parameters: - - id: name - type: string - description: Name of the function to add. - - id: fn - type: - description: Function to add. - return: - description: '- The prompt manager for chaining.' - type: - - name: addPrompt(PromptTemplate) - uid: '@microsoft/teams-ai.PromptManager.addPrompt' - package: '@microsoft/teams-ai' - summary: Registers a new prompt template with the prompt manager. - remarks: '' - isDeprecated: false - syntax: - content: 'function addPrompt(prompt: PromptTemplate): PromptManager' - parameters: - - id: prompt - type: - description: Prompt template to add. - return: - description: The prompt manager for chaining. - type: - - name: getDataSource(string) - uid: '@microsoft/teams-ai.PromptManager.getDataSource' - package: '@microsoft/teams-ai' - summary: Looks up a data source by name. - remarks: '' - isDeprecated: false - syntax: - content: 'function getDataSource(name: string): DataSource' - parameters: - - id: name - type: string - description: Name of the data source to lookup. - return: - description: The data source. - type: - - name: getFunction(string) - uid: '@microsoft/teams-ai.PromptManager.getFunction' - package: '@microsoft/teams-ai' - summary: Looks up a prompt template function by name. - remarks: '' - isDeprecated: false - syntax: - content: 'function getFunction(name: string): PromptFunction' - parameters: - - id: name - type: string - description: Name of the function to lookup. - return: - description: The function. - type: - - name: getPrompt(string) - uid: '@microsoft/teams-ai.PromptManager.getPrompt' - package: '@microsoft/teams-ai' - summary: Loads a named prompt template from the filesystem. - remarks: >- - The template will be pre-parsed and cached for use when the template is - rendered by name. - - - Any augmentations will also be added to the template. - isDeprecated: false - syntax: - content: 'function getPrompt(name: string): Promise' - parameters: - - id: name - type: string - description: Name of the prompt to load. - return: - description: The loaded and parsed prompt template. - type: Promise<> - - name: hasDataSource(string) - uid: '@microsoft/teams-ai.PromptManager.hasDataSource' - package: '@microsoft/teams-ai' - summary: Checks for the existence of a named data source. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasDataSource(name: string): boolean' - parameters: - - id: name - type: string - description: Name of the data source to lookup. - return: - description: True if the data source exists. - type: boolean - - name: hasFunction(string) - uid: '@microsoft/teams-ai.PromptManager.hasFunction' - package: '@microsoft/teams-ai' - summary: Checks for the existence of a named prompt template function. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasFunction(name: string): boolean' - parameters: - - id: name - type: string - description: Name of the function to lookup. - return: - description: True if the function exists. - type: boolean - - name: hasPrompt(string) - uid: '@microsoft/teams-ai.PromptManager.hasPrompt' - package: '@microsoft/teams-ai' - summary: Checks for the existence of a named prompt. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasPrompt(name: string): Promise' - parameters: - - id: name - type: string - description: Name of the prompt to load. - return: - description: True if the prompt exists. - type: Promise<boolean> - - name: invokeFunction(string, TurnContext, Memory, Tokenizer, string[]) - uid: '@microsoft/teams-ai.PromptManager.invokeFunction' - package: '@microsoft/teams-ai' - summary: Invokes a prompt template function by name. - remarks: '' - isDeprecated: false - syntax: - content: >- - function invokeFunction(name: string, context: TurnContext, memory: - Memory, tokenizer: Tokenizer, args: string[]): Promise - parameters: - - id: name - type: string - description: Name of the function to invoke. - - id: context - type: TurnContext - description: Turn context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use when rendering the prompt. - - id: args - type: string[] - description: Arguments to pass to the function. - return: - description: Value returned by the function. - type: Promise<any> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManagerOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManagerOptions.yml deleted file mode 100644 index 7edba3a9..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManagerOptions.yml +++ /dev/null @@ -1,95 +0,0 @@ -### YamlMime:TSType -name: PromptManagerOptions -uid: '@microsoft/teams-ai.PromptManagerOptions' -package: '@microsoft/teams-ai' -summary: Options used to configure the prompt manager. -fullName: PromptManagerOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: max_conversation_history_tokens - uid: '@microsoft/teams-ai.PromptManagerOptions.max_conversation_history_tokens' - package: '@microsoft/teams-ai' - summary: >- - Optional. Maximum number of tokens of conversation history to include in - prompts. - fullName: max_conversation_history_tokens - remarks: >- - The default is to let conversation history consume the remainder of the - prompts - - `max_input_tokens` budget. Setting this to a value greater than 1 will - override that and - - all prompts will use a fixed token budget. - isDeprecated: false - syntax: - content: 'max_conversation_history_tokens?: number' - return: - description: '' - type: number - - name: max_history_messages - uid: '@microsoft/teams-ai.PromptManagerOptions.max_history_messages' - package: '@microsoft/teams-ai' - summary: >- - Optional. Maximum number of messages to use when rendering - conversation_history. - fullName: max_history_messages - remarks: >- - This controls the automatic pruning of the conversation history that's - done by the planners - - LLMClient instance. This helps keep your memory from getting too big and - defaults to a value - - of `10` (or 5 turns.) - isDeprecated: false - syntax: - content: 'max_history_messages?: number' - return: - description: '' - type: number - - name: max_input_tokens - uid: '@microsoft/teams-ai.PromptManagerOptions.max_input_tokens' - package: '@microsoft/teams-ai' - summary: Optional. Maximum number of tokens user input to include in prompts. - fullName: max_input_tokens - remarks: >- - This defaults to unlimited but can be set to a value greater than `1` to - limit the length of - - user input included in prompts. For example, if set to `100` then the any - user input over - - 100 tokens in length will be truncated. - isDeprecated: false - syntax: - content: 'max_input_tokens?: number' - return: - description: '' - type: number - - name: promptsFolder - uid: '@microsoft/teams-ai.PromptManagerOptions.promptsFolder' - package: '@microsoft/teams-ai' - summary: Path to the filesystem folder containing all the application's prompts. - fullName: promptsFolder - remarks: '' - isDeprecated: false - syntax: - content: 'promptsFolder: string' - return: - description: '' - type: string - - name: role - uid: '@microsoft/teams-ai.PromptManagerOptions.role' - package: '@microsoft/teams-ai' - summary: Optional. Message role to use for loaded prompts. - fullName: role - remarks: Defaults to 'system'. - isDeprecated: false - syntax: - content: 'role?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptResponseValidator.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptResponseValidator.yml deleted file mode 100644 index 29ebd87d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptResponseValidator.yml +++ /dev/null @@ -1,44 +0,0 @@ -### YamlMime:TSType -name: PromptResponseValidator -uid: '@microsoft/teams-ai.PromptResponseValidator' -package: '@microsoft/teams-ai' -summary: A validator that can be used to validate prompt responses. -fullName: PromptResponseValidator -remarks: '' -isDeprecated: false -type: interface -methods: - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.PromptResponseValidator.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<TValue>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSection.yml deleted file mode 100644 index 8ccce5ed..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSection.yml +++ /dev/null @@ -1,109 +0,0 @@ -### YamlMime:TSType -name: PromptSection -uid: '@microsoft/teams-ai.PromptSection' -package: '@microsoft/teams-ai' -summary: >- - A section that can be rendered to a prompt as either text or an array of - `Message` objects. -fullName: PromptSection -remarks: '' -isDeprecated: false -type: interface -properties: - - name: required - uid: '@microsoft/teams-ai.PromptSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - - name: tokens - uid: '@microsoft/teams-ai.PromptSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number -methods: - - name: renderAsMessages(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.PromptSection.renderAsMessages' - package: '@microsoft/teams-ai' - summary: Renders the section as a list of messages. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsMessages(context: TurnContext, memory: Memory, - functions: PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise[]>> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Registry of functions that can be used by the section. - - id: tokenizer - type: - description: Tokenizer to use when rendering the section. - - id: maxTokens - type: number - description: Maximum number of tokens allowed to be rendered. - return: - description: '' - type: >- - Promise<<<string>[]>> - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.PromptSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Registry of functions that can be used by the section. - - id: tokenizer - type: - description: Tokenizer to use when rendering the section. - - id: maxTokens - type: number - description: Maximum number of tokens allowed to be rendered. - return: - description: '' - type: >- - Promise<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSectionBase.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSectionBase.yml deleted file mode 100644 index ee914ef7..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSectionBase.yml +++ /dev/null @@ -1,177 +0,0 @@ -### YamlMime:TSType -name: PromptSectionBase -uid: '@microsoft/teams-ai.PromptSectionBase' -package: '@microsoft/teams-ai' -summary: Abstract Base class for most prompt sections. -fullName: PromptSectionBase -remarks: >- - This class provides a default implementation of `renderAsText()` so that - derived classes only - - need to implement `renderAsMessages()`. -isDeprecated: false -type: class -constructors: - - name: PromptSectionBase(number, boolean, string, string) - uid: '@microsoft/teams-ai.PromptSectionBase.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'PromptSectionBase' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new PromptSectionBase(tokens?: number, required?: boolean, separator?: - string, textPrefix?: string) - parameters: - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to -1, 'auto'. - - id: required - type: boolean - description: Optional. Indicates if this section is required. Defaults to `true`. - - id: separator - type: string - description: >- - Optional. Separator to use between sections when rendering as text. - Defaults to `\n`. - - id: textPrefix - type: string - description: >- - Optional. Prefix to use for text output. Defaults to an empty - string. -properties: - - name: required - uid: '@microsoft/teams-ai.PromptSectionBase.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - - name: separator - uid: '@microsoft/teams-ai.PromptSectionBase.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - - name: textPrefix - uid: '@microsoft/teams-ai.PromptSectionBase.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - - name: tokens - uid: '@microsoft/teams-ai.PromptSectionBase.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number -methods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.PromptSectionBase.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - - name: renderAsMessages(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.PromptSectionBase.renderAsMessages' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a list of `Message` objects. - remarks: MUST be implemented by derived classes. - isDeprecated: false - syntax: - content: >- - function renderAsMessages(context: TurnContext, memory: Memory, - functions: PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise[]>> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<<any>[]>> - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.PromptSectionBase.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplate.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplate.yml deleted file mode 100644 index 3bd3b9a4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplate.yml +++ /dev/null @@ -1,70 +0,0 @@ -### YamlMime:TSType -name: PromptTemplate -uid: '@microsoft/teams-ai.PromptTemplate' -package: '@microsoft/teams-ai' -summary: Prompt template cached by the prompt manager. -fullName: PromptTemplate -remarks: '' -isDeprecated: false -type: interface -properties: - - name: actions - uid: '@microsoft/teams-ai.PromptTemplate.actions' - package: '@microsoft/teams-ai' - summary: Optional list of actions the model may generate JSON inputs for. - fullName: actions - remarks: '' - isDeprecated: false - syntax: - content: 'actions?: ChatCompletionAction[]' - return: - description: '' - type: [] - - name: augmentation - uid: '@microsoft/teams-ai.PromptTemplate.augmentation' - package: '@microsoft/teams-ai' - summary: Optional augmentation for the prompt template. - fullName: augmentation - remarks: '' - isDeprecated: false - syntax: - content: 'augmentation?: Augmentation' - return: - description: '' - type: <any> - - name: config - uid: '@microsoft/teams-ai.PromptTemplate.config' - package: '@microsoft/teams-ai' - summary: Configuration settings for the prompt template. - fullName: config - remarks: '' - isDeprecated: false - syntax: - content: 'config: PromptTemplateConfig' - return: - description: '' - type: - - name: name - uid: '@microsoft/teams-ai.PromptTemplate.name' - package: '@microsoft/teams-ai' - summary: Name of the prompt template. - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: prompt - uid: '@microsoft/teams-ai.PromptTemplate.prompt' - package: '@microsoft/teams-ai' - summary: Text of the prompt template. - fullName: prompt - remarks: '' - isDeprecated: false - syntax: - content: 'prompt: PromptSection' - return: - description: '' - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplateConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplateConfig.yml deleted file mode 100644 index fb36502c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplateConfig.yml +++ /dev/null @@ -1,87 +0,0 @@ -### YamlMime:TSType -name: PromptTemplateConfig -uid: '@microsoft/teams-ai.PromptTemplateConfig' -package: '@microsoft/teams-ai' -summary: Serialized prompt template configuration. -fullName: PromptTemplateConfig -remarks: '' -isDeprecated: false -type: interface -properties: - - name: augmentation - uid: '@microsoft/teams-ai.PromptTemplateConfig.augmentation' - package: '@microsoft/teams-ai' - summary: Optional. Augmentation settings for the prompt. - fullName: augmentation - remarks: New in schema version 1.1. - isDeprecated: false - syntax: - content: 'augmentation?: AugmentationConfig' - return: - description: '' - type: - - name: completion - uid: '@microsoft/teams-ai.PromptTemplateConfig.completion' - package: '@microsoft/teams-ai' - summary: Completion settings for the prompt. - fullName: completion - remarks: '' - isDeprecated: false - syntax: - content: 'completion: CompletionConfig' - return: - description: '' - type: CompletionConfig - - name: default_backends - uid: '@microsoft/teams-ai.PromptTemplateConfig.default_backends' - package: '@microsoft/teams-ai' - summary: '' - fullName: default_backends - remarks: >- - Passing the name of a model to use here will override the default model - used by a planner. - isDeprecated: true - customDeprecatedMessage: |- - Use `completion.model` instead. - Optional. Array of backends (models) to use for the prompt. - syntax: - content: 'default_backends?: string[]' - return: - description: '' - type: string[] - - name: description - uid: '@microsoft/teams-ai.PromptTemplateConfig.description' - package: '@microsoft/teams-ai' - summary: Optional. Description of the prompts purpose. - fullName: description - remarks: '' - isDeprecated: false - syntax: - content: 'description?: string' - return: - description: '' - type: string - - name: schema - uid: '@microsoft/teams-ai.PromptTemplateConfig.schema' - package: '@microsoft/teams-ai' - summary: The schema version of the prompt template. Can be '1' or '1.1'. - fullName: schema - remarks: '' - isDeprecated: false - syntax: - content: 'schema: number' - return: - description: '' - type: number - - name: type - uid: '@microsoft/teams-ai.PromptTemplateConfig.type' - package: '@microsoft/teams-ai' - summary: Type of prompt template. Should always be 'completion'. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "completion"' - return: - description: '' - type: '"completion"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Query.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Query.yml deleted file mode 100644 index d9b88503..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Query.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSType -name: Query -uid: '@microsoft/teams-ai.Query' -package: '@microsoft/teams-ai' -summary: Query arguments for a search-based message extension. -fullName: Query -remarks: '' -isDeprecated: false -type: interface -properties: - - name: count - uid: '@microsoft/teams-ai.Query.count' - package: '@microsoft/teams-ai' - summary: Number of items to return in the result set. - fullName: count - remarks: '' - isDeprecated: false - syntax: - content: 'count: number' - return: - description: '' - type: number - - name: parameters - uid: '@microsoft/teams-ai.Query.parameters' - package: '@microsoft/teams-ai' - summary: Query parameters. - fullName: parameters - remarks: '' - isDeprecated: false - syntax: - content: 'parameters: TParams' - return: - description: '' - type: TParams - - name: skip - uid: '@microsoft/teams-ai.Query.skip' - package: '@microsoft/teams-ai' - summary: Number of items to skip in the result set. - fullName: skip - remarks: '' - isDeprecated: false - syntax: - content: 'skip: number' - return: - description: '' - type: number diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RenderedPromptSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/RenderedPromptSection.yml deleted file mode 100644 index b09a70cf..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RenderedPromptSection.yml +++ /dev/null @@ -1,48 +0,0 @@ -### YamlMime:TSType -name: RenderedPromptSection -uid: '@microsoft/teams-ai.RenderedPromptSection' -package: '@microsoft/teams-ai' -summary: The result of rendering a section. -fullName: RenderedPromptSection -remarks: '' -isDeprecated: false -type: interface -properties: - - name: length - uid: '@microsoft/teams-ai.RenderedPromptSection.length' - package: '@microsoft/teams-ai' - summary: The number of tokens that were rendered. - fullName: length - remarks: '' - isDeprecated: false - syntax: - content: 'length: number' - return: - description: '' - type: number - - name: output - uid: '@microsoft/teams-ai.RenderedPromptSection.output' - package: '@microsoft/teams-ai' - summary: The section that was rendered. - fullName: output - remarks: '' - isDeprecated: false - syntax: - content: 'output: T' - return: - description: '' - type: T - - name: tooLong - uid: '@microsoft/teams-ai.RenderedPromptSection.tooLong' - package: '@microsoft/teams-ai' - summary: >- - If true the section was truncated because it exceeded the maxTokens - budget. - fullName: tooLong - remarks: '' - isDeprecated: false - syntax: - content: 'tooLong: boolean' - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethod.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethod.yml deleted file mode 100644 index d26b6cc3..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethod.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:TSTypeAlias -name: ReturnTypeOfMethod -uid: '@microsoft/teams-ai.ReturnTypeOfMethod' -package: '@microsoft/teams-ai' -summary: '' -fullName: ReturnTypeOfMethod -remarks: '' -isDeprecated: false -syntax: | - type ReturnTypeOfMethod = T extends (args: any[]) => any - ? ReturnType - : void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethodIfExists.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethodIfExists.yml deleted file mode 100644 index f8107f0f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethodIfExists.yml +++ /dev/null @@ -1,12 +0,0 @@ -### YamlMime:TSTypeAlias -name: ReturnTypeOfMethodIfExists -uid: '@microsoft/teams-ai.ReturnTypeOfMethodIfExists' -package: '@microsoft/teams-ai' -summary: '' -fullName: ReturnTypeOfMethodIfExists -remarks: '' -isDeprecated: false -syntax: | - type ReturnTypeOfMethodIfExists = S extends keyof T - ? ReturnTypeOfMethod - : void diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteHandler.yml deleted file mode 100644 index 42882c0e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteHandler.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: RouteHandler -uid: '@microsoft/teams-ai.RouteHandler' -package: '@microsoft/teams-ai' -summary: Function for handling an incoming request. -fullName: RouteHandler -remarks: '' -isDeprecated: false -syntax: | - type RouteHandler = ( - context: TurnContext, - state: TState - ) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteSelector.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteSelector.yml deleted file mode 100644 index efd02de2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteSelector.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: RouteSelector -uid: '@microsoft/teams-ai.RouteSelector' -package: '@microsoft/teams-ai' -summary: Function for selecting whether a route handler should be triggered. -fullName: RouteSelector -remarks: '' -isDeprecated: false -syntax: | - type RouteSelector = Selector diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Selector.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Selector.yml deleted file mode 100644 index 458cb17d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Selector.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: Selector -uid: '@microsoft/teams-ai.Selector' -package: '@microsoft/teams-ai' -summary: A selector function for matching incoming activities. -fullName: Selector -remarks: '' -isDeprecated: false -syntax: | - type Selector = (context: TurnContext) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SequenceAugmentation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/SequenceAugmentation.yml deleted file mode 100644 index ac97f5de..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SequenceAugmentation.yml +++ /dev/null @@ -1,95 +0,0 @@ -### YamlMime:TSType -name: SequenceAugmentation -uid: '@microsoft/teams-ai.SequenceAugmentation' -package: '@microsoft/teams-ai' -summary: The 'sequence' augmentation. -fullName: SequenceAugmentation -remarks: This augmentation allows the model to return a sequence of actions to perform. -isDeprecated: false -type: class -constructors: - - name: SequenceAugmentation(ChatCompletionAction[]) - uid: '@microsoft/teams-ai.SequenceAugmentation.constructor' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'new SequenceAugmentation(actions: ChatCompletionAction[])' - parameters: - - id: actions - type: [] - description: '' -methods: - - name: >- - createPlanFromResponse(TurnContext, Memory, PromptResponse) - uid: '@microsoft/teams-ai.SequenceAugmentation.createPlanFromResponse' - package: '@microsoft/teams-ai' - summary: Creates a plan given validated response value. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createPlanFromResponse(context: TurnContext, memory: Memory, - response: PromptResponse): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: An interface for accessing state variables. - - id: response - type: >- - PromptResponse<undefined | > - description: The validated and transformed response for the prompt. - return: - description: The created plan. - type: Promise<> - - name: createPromptSection() - uid: '@microsoft/teams-ai.SequenceAugmentation.createPromptSection' - package: '@microsoft/teams-ai' - summary: Creates an optional prompt section for the augmentation. - remarks: '' - isDeprecated: false - syntax: - content: 'function createPromptSection(): undefined | PromptSection' - return: - description: The new PromptSection or undefined. - type: undefined | - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.SequenceAugmentation.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<undefined - | >> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInResponse.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInResponse.yml deleted file mode 100644 index 19cce3ab..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInResponse.yml +++ /dev/null @@ -1,14 +0,0 @@ -### YamlMime:TSTypeAlias -name: SignInResponse -uid: '@microsoft/teams-ai.SignInResponse' -package: '@microsoft/teams-ai' -summary: The sign in response. -fullName: SignInResponse -remarks: '' -isDeprecated: false -syntax: | - type SignInResponse = { - cause?: AuthErrorReason - error?: unknown - status: SignInStatus - } diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInStatus.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInStatus.yml deleted file mode 100644 index e74efd86..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInStatus.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: SignInStatus -uid: '@microsoft/teams-ai.SignInStatus' -package: '@microsoft/teams-ai' -summary: The sign in status. -fullName: SignInStatus -remarks: >- - `pending` - The user is not signed in and the bot has initiated the sign in - flow. - - `complete` - The user has successfully signed in. - - `error` - An error occurred while signing the user in. -isDeprecated: false -syntax: | - type SignInStatus = "pending" | "complete" | "error" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StreamingResponse.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/StreamingResponse.yml deleted file mode 100644 index ec241af0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StreamingResponse.yml +++ /dev/null @@ -1,213 +0,0 @@ -### YamlMime:TSType -name: StreamingResponse -uid: '@microsoft/teams-ai.StreamingResponse' -package: '@microsoft/teams-ai' -summary: A helper class for streaming responses to the client. -fullName: StreamingResponse -remarks: >- - This class is used to send a series of updates to the client in a single - response. The expected - - sequence of calls is: - - - `sendInformativeUpdate()`, `sendTextChunk()`, `sendTextChunk()`, ..., - `endStream()`. - - - Once `endStream()` is called, the stream is considered ended and no further - updates can be sent. -isDeprecated: false -type: class -constructors: - - name: StreamingResponse(TurnContext) - uid: '@microsoft/teams-ai.StreamingResponse.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new StreamingResponse instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new StreamingResponse(context: TurnContext)' - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. -properties: - - name: citations - uid: '@microsoft/teams-ai.StreamingResponse.citations' - package: '@microsoft/teams-ai' - summary: Gets the citations of the current response. - fullName: citations - remarks: '' - isDeprecated: false - syntax: - content: undefined | ClientCitation[] citations - return: - description: '' - type: undefined | ClientCitation[] - - name: streamId - uid: '@microsoft/teams-ai.StreamingResponse.streamId' - package: '@microsoft/teams-ai' - summary: Gets the stream ID of the current response. - fullName: streamId - remarks: '' - isDeprecated: false - syntax: - content: undefined | string streamId - return: - description: '- The stream ID of the current response.' - type: undefined | string - - name: updatesSent - uid: '@microsoft/teams-ai.StreamingResponse.updatesSent' - package: '@microsoft/teams-ai' - summary: Gets the number of updates sent for the stream. - fullName: updatesSent - remarks: '' - isDeprecated: false - syntax: - content: number updatesSent - return: - description: '- The number of updates sent for the stream.' - type: number -methods: - - name: endStream() - uid: '@microsoft/teams-ai.StreamingResponse.endStream' - package: '@microsoft/teams-ai' - summary: Ends the stream by sending the final message to the client. - remarks: '' - isDeprecated: false - syntax: - content: 'function endStream(): Promise' - return: - description: '- A promise representing the async operation' - type: Promise<void> - - name: getMessage() - uid: '@microsoft/teams-ai.StreamingResponse.getMessage' - package: '@microsoft/teams-ai' - summary: Returns the most recently streamed message. - remarks: '' - isDeprecated: false - syntax: - content: 'function getMessage(): string' - return: - description: The streamed message. - type: string - - name: queueInformativeUpdate(string) - uid: '@microsoft/teams-ai.StreamingResponse.queueInformativeUpdate' - package: '@microsoft/teams-ai' - summary: Queues an informative update to be sent to the client. - remarks: '' - isDeprecated: false - syntax: - content: 'function queueInformativeUpdate(text: string)' - parameters: - - id: text - type: string - description: Text of the update to send. - - name: queueTextChunk(string, Citation[]) - uid: '@microsoft/teams-ai.StreamingResponse.queueTextChunk' - package: '@microsoft/teams-ai' - summary: Queues a chunk of partial message text to be sent to the client - remarks: >- - The text we be sent as quickly as possible to the client. Chunks may be - combined before - - delivery to the client. - isDeprecated: false - syntax: - content: 'function queueTextChunk(text: string, citations?: Citation[])' - parameters: - - id: text - type: string - description: Partial text of the message to send. - - id: citations - type: [] - description: Citations to be included in the message. - - name: setAttachments(Attachment[]) - uid: '@microsoft/teams-ai.StreamingResponse.setAttachments' - package: '@microsoft/teams-ai' - summary: Sets the attachments to attach to the final chunk. - remarks: '' - isDeprecated: false - syntax: - content: 'function setAttachments(attachments: Attachment[])' - parameters: - - id: attachments - type: Attachment[] - description: List of attachments. - - name: setCitations(Citation[]) - uid: '@microsoft/teams-ai.StreamingResponse.setCitations' - package: '@microsoft/teams-ai' - summary: Sets the citations for the full message. - remarks: '' - isDeprecated: false - syntax: - content: 'function setCitations(citations: Citation[])' - parameters: - - id: citations - type: [] - description: Citations to be included in the message. - - name: setFeedbackLoop(boolean) - uid: '@microsoft/teams-ai.StreamingResponse.setFeedbackLoop' - package: '@microsoft/teams-ai' - summary: |- - Sets the Feedback Loop in Teams that allows a user to - give thumbs up or down to a response. - Default is `false`. - remarks: '' - isDeprecated: false - syntax: - content: 'function setFeedbackLoop(enableFeedbackLoop: boolean)' - parameters: - - id: enableFeedbackLoop - type: boolean - description: If true, the feedback loop is enabled. - - name: setFeedbackLoopType("default" | "custom") - uid: '@microsoft/teams-ai.StreamingResponse.setFeedbackLoopType' - package: '@microsoft/teams-ai' - summary: Sets the type of UI to use for the feedback loop. - remarks: '' - isDeprecated: false - syntax: - content: 'function setFeedbackLoopType(feedbackLoopType: "default" | "custom")' - parameters: - - id: feedbackLoopType - type: '"default" | "custom"' - description: The type of the feedback loop. - - name: setGeneratedByAILabel(boolean) - uid: '@microsoft/teams-ai.StreamingResponse.setGeneratedByAILabel' - package: '@microsoft/teams-ai' - summary: |- - Sets the the Generated by AI label in Teams - Default is `false`. - remarks: '' - isDeprecated: false - syntax: - content: 'function setGeneratedByAILabel(enableGeneratedByAILabel: boolean)' - parameters: - - id: enableGeneratedByAILabel - type: boolean - description: If true, the label is added. - - name: setSensitivityLabel(SensitivityUsageInfo) - uid: '@microsoft/teams-ai.StreamingResponse.setSensitivityLabel' - package: '@microsoft/teams-ai' - summary: Sets the sensitivity label to attach to the final chunk. - remarks: '' - isDeprecated: false - syntax: - content: 'function setSensitivityLabel(sensitivityLabel: SensitivityUsageInfo)' - parameters: - - id: sensitivityLabel - type: SensitivityUsageInfo - description: The sensitivty label. - - name: waitForQueue() - uid: '@microsoft/teams-ai.StreamingResponse.waitForQueue' - package: '@microsoft/teams-ai' - summary: Waits for the outgoing activity queue to be empty. - remarks: '' - isDeprecated: false - syntax: - content: 'function waitForQueue(): Promise' - return: - description: '- A promise representing the async operation.' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictBroadcast.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictBroadcast.yml deleted file mode 100644 index 82c6299c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictBroadcast.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: StrictBroadcast -uid: '@microsoft/teams-ai.StrictBroadcast' -package: '@microsoft/teams-ai' -summary: '' -fullName: StrictBroadcast -remarks: '' -isDeprecated: false -syntax: | - type StrictBroadcast = ( - event: E, - request: TEmitRecord[E] - ) => any diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictEventEmitter.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictEventEmitter.yml deleted file mode 100644 index d5334c4d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictEventEmitter.yml +++ /dev/null @@ -1,23 +0,0 @@ -### YamlMime:TSTypeAlias -name: StrictEventEmitter -uid: '@microsoft/teams-ai.StrictEventEmitter' -package: '@microsoft/teams-ai' -summary: '' -fullName: >- - StrictEventEmitter -remarks: '' -isDeprecated: false -syntax: | - type StrictEventEmitter< - TEmitterType, - TEventRecord, - TEmitRecord, - UnneededMethods, - NeededMethods - > = TypeRecord & - Pick> & - Pick< - OverriddenMethods, - NeededMethods - > diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SystemMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/SystemMessage.yml deleted file mode 100644 index be40cf6d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/SystemMessage.yml +++ /dev/null @@ -1,178 +0,0 @@ -### YamlMime:TSType -name: SystemMessage -uid: '@microsoft/teams-ai.SystemMessage' -package: '@microsoft/teams-ai' -summary: A system message. -fullName: SystemMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: SystemMessage(string, number) - uid: '@microsoft/teams-ai.SystemMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'SystemMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new SystemMessage(template: string, tokens?: number)' - parameters: - - id: template - type: string - description: Template to use for this section. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.SystemMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [TemplateSection.required](xref:@microsoft/teams-ai.TemplateSection.required) - - name: role - uid: '@microsoft/teams-ai.SystemMessage.role' - package: '@microsoft/teams-ai' - summary: '' - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.role](xref:@microsoft/teams-ai.TemplateSection.role) - - name: separator - uid: '@microsoft/teams-ai.SystemMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.separator](xref:@microsoft/teams-ai.TemplateSection.separator) - - name: template - uid: '@microsoft/teams-ai.SystemMessage.template' - package: '@microsoft/teams-ai' - summary: '' - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.template](xref:@microsoft/teams-ai.TemplateSection.template) - - name: textPrefix - uid: '@microsoft/teams-ai.SystemMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.textPrefix](xref:@microsoft/teams-ai.TemplateSection.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.SystemMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [TemplateSection.tokens](xref:@microsoft/teams-ai.TemplateSection.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.SystemMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.getMessageText](xref:@microsoft/teams-ai.TemplateSection.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.SystemMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [TemplateSection.renderAsText](xref:@microsoft/teams-ai.TemplateSection.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModuleInvokeNames.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModuleInvokeNames.yml deleted file mode 100644 index e1f618f0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModuleInvokeNames.yml +++ /dev/null @@ -1,29 +0,0 @@ -### YamlMime:TSEnum -name: TaskModuleInvokeNames -uid: '@microsoft/teams-ai.TaskModuleInvokeNames' -package: '@microsoft/teams-ai' -summary: '' -fullName: TaskModuleInvokeNames -remarks: '' -isDeprecated: false -fields: - - name: CONFIG_FETCH_INVOKE_NAME - uid: '@microsoft/teams-ai.TaskModuleInvokeNames.CONFIG_FETCH_INVOKE_NAME' - package: '@microsoft/teams-ai' - summary: '' - - name: CONFIG_SUBMIT_INVOKE_NAME - uid: '@microsoft/teams-ai.TaskModuleInvokeNames.CONFIG_SUBMIT_INVOKE_NAME' - package: '@microsoft/teams-ai' - summary: '' - - name: DEFAULT_TASK_DATA_FILTER - uid: '@microsoft/teams-ai.TaskModuleInvokeNames.DEFAULT_TASK_DATA_FILTER' - package: '@microsoft/teams-ai' - summary: '' - - name: FETCH_INVOKE_NAME - uid: '@microsoft/teams-ai.TaskModuleInvokeNames.FETCH_INVOKE_NAME' - package: '@microsoft/teams-ai' - summary: '' - - name: SUBMIT_INVOKE_NAME - uid: '@microsoft/teams-ai.TaskModuleInvokeNames.SUBMIT_INVOKE_NAME' - package: '@microsoft/teams-ai' - summary: '' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModules.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModules.yml deleted file mode 100644 index 907293f0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModules.yml +++ /dev/null @@ -1,139 +0,0 @@ -### YamlMime:TSType -name: TaskModules -uid: '@microsoft/teams-ai.TaskModules' -package: '@microsoft/teams-ai' -summary: >- - TaskModules class to enable fluent style registration of handlers related to - Task Modules. -fullName: TaskModules -remarks: '' -isDeprecated: false -type: class -constructors: - - name: TaskModules(Application) - uid: '@microsoft/teams-ai.TaskModules.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the TaskModules class. - remarks: '' - isDeprecated: false - syntax: - content: 'new TaskModules(app: Application)' - parameters: - - id: app - type: <TState> - description: Top level application class to register handlers with. -methods: - - name: >- - configFetch((context: TurnContext, state: TState, data: TData) => - Promise) - uid: '@microsoft/teams-ai.TaskModules.configFetch' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler for fetching Teams config data for Auth or Task - Modules - remarks: '' - isDeprecated: false - syntax: - content: >- - function configFetch(handler: (context: TurnContext, state: - TState, data: TData) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<BotConfigAuth | TaskModuleResponse> - description: Function to call when the handler is triggered. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - configSubmit((context: TurnContext, state: TState, data: TData) => - Promise) - uid: '@microsoft/teams-ai.TaskModules.configSubmit' - package: '@microsoft/teams-ai' - summary: >- - Registers a handler for submitting Teams config data for Auth or Task - Modules - remarks: '' - isDeprecated: false - syntax: - content: >- - function configSubmit(handler: (context: TurnContext, state: - TState, data: TData) => Promise): - Application - parameters: - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<BotConfigAuth | TaskModuleResponse> - description: Function to call when the handler is triggered. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - fetch(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState, data: TData) => Promise) - uid: '@microsoft/teams-ai.TaskModules.fetch' - package: '@microsoft/teams-ai' - summary: Registers a handler to process the initial fetch of the task module. - remarks: >- - Handlers should respond with either an initial TaskInfo object or a string - containing - - a message to display to the user. - isDeprecated: false - syntax: - content: >- - function fetch(verb: string | RegExp | Selector | (string | - RegExp | Selector)[], handler: (context: TurnContext, state: TState, - data: TData) => Promise): - Application - parameters: - - id: verb - type: >- - string | RegExp | | - (string | RegExp | )[] - description: Name of the verb(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<string | TaskModuleTaskInfo> - description: Function to call when the handler is triggered. - return: - description: The application for chaining purposes. - type: <TState> - - name: >- - submit(string | RegExp | Selector | (string | RegExp | Selector)[], - (context: TurnContext, state: TState, data: TData) => Promise) - uid: '@microsoft/teams-ai.TaskModules.submit' - package: '@microsoft/teams-ai' - summary: Registers a handler to process the submission of a task module. - remarks: >- - Handlers should respond with another TaskInfo object, message string, or - `null` to indicate - - the task is completed. - isDeprecated: false - syntax: - content: >- - function submit(verb: string | RegExp | Selector | (string | - RegExp | Selector)[], handler: (context: TurnContext, state: TState, - data: TData) => Promise): Application - parameters: - - id: verb - type: >- - string | RegExp | | - (string | RegExp | )[] - description: Name of the verb(s) to register the handler for. - - id: handler - type: >- - (context: TurnContext, state: TState, data: TData) => - Promise<undefined | null | string | TaskModuleTaskInfo> - description: Function to call when the handler is triggered. - return: - description: The application for chaining purposes. - type: <TState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModulesOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModulesOptions.yml deleted file mode 100644 index d92d8e1f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModulesOptions.yml +++ /dev/null @@ -1,29 +0,0 @@ -### YamlMime:TSType -name: TaskModulesOptions -uid: '@microsoft/teams-ai.TaskModulesOptions' -package: '@microsoft/teams-ai' -summary: Options for TaskModules class. -fullName: TaskModulesOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: taskDataFilter - uid: '@microsoft/teams-ai.TaskModulesOptions.taskDataFilter' - package: '@microsoft/teams-ai' - summary: Data field to use to ide1ntify the verb of the handler to trigger. - fullName: taskDataFilter - remarks: >- - When a task module is triggered, the field name specified here will be - used to determine - - the name of the verb for the handler to route the request to. - - - Defaults to a value of 'verb'. - isDeprecated: false - syntax: - content: 'taskDataFilter?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAdapter.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAdapter.yml deleted file mode 100644 index 4ccbe897..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAdapter.yml +++ /dev/null @@ -1,442 +0,0 @@ -### YamlMime:TSType -name: TeamsAdapter -uid: '@microsoft/teams-ai.TeamsAdapter' -package: '@microsoft/teams-ai' -summary: >- - An adapter that implements the Bot Framework Protocol and can be hosted in - different cloud environments both public and private. -fullName: TeamsAdapter -remarks: '' -isDeprecated: false -type: class -constructors: - - name: >- - TeamsAdapter(ConfigurationBotFrameworkAuthenticationOptions, - ServiceClientCredentialsFactory, AuthenticationConfiguration, - ConnectorClientOptions) - uid: '@microsoft/teams-ai.TeamsAdapter.constructor' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - new TeamsAdapter(botFrameworkAuthConfig?: - ConfigurationBotFrameworkAuthenticationOptions, credentialsFactory?: - ServiceClientCredentialsFactory, authConfiguration?: - AuthenticationConfiguration, connectorClientOptions?: - ConnectorClientOptions) - parameters: - - id: botFrameworkAuthConfig - type: ConfigurationBotFrameworkAuthenticationOptions - description: '' - - id: credentialsFactory - type: ServiceClientCredentialsFactory - description: '' - - id: authConfiguration - type: AuthenticationConfiguration - description: '' - - id: connectorClientOptions - type: ConnectorClientOptions - description: '' -properties: - - name: botFrameworkAuthConfig - uid: '@microsoft/teams-ai.TeamsAdapter.botFrameworkAuthConfig' - package: '@microsoft/teams-ai' - summary: '' - fullName: botFrameworkAuthConfig - remarks: '' - isDeprecated: false - syntax: - content: 'botFrameworkAuthConfig?: ConfigurationBotFrameworkAuthenticationOptions' - return: - description: '' - type: ConfigurationBotFrameworkAuthenticationOptions - - name: credentialsFactory - uid: '@microsoft/teams-ai.TeamsAdapter.credentialsFactory' - package: '@microsoft/teams-ai' - summary: >- - The credentials factory used by the bot adapter to create a - [ServiceClientCredentials](xref:botframework-connector.ServiceClientCredentials) - object. - fullName: credentialsFactory - remarks: '' - isDeprecated: false - syntax: - content: 'credentialsFactory: ServiceClientCredentialsFactory' - return: - description: '' - type: ServiceClientCredentialsFactory - - name: onTurnError - uid: '@microsoft/teams-ai.TeamsAdapter.onTurnError' - package: '@microsoft/teams-ai' - summary: >- - Gets or sets an error handler that can catch exceptions in the middleware - or application. - fullName: onTurnError - remarks: '' - isDeprecated: false - syntax: - content: '(context: TurnContext, error: Error) => Promise onTurnError' - return: - description: A promise representing the async operation. - type: '(context: TurnContext, error: Error) => Promise<void>' - - name: userAgent - uid: '@microsoft/teams-ai.TeamsAdapter.userAgent' - package: '@microsoft/teams-ai' - summary: '' - fullName: userAgent - remarks: '' - isDeprecated: false - syntax: - content: string userAgent - return: - description: '' - type: string -inheritedProperties: - - name: BotIdentityKey - uid: '@microsoft/teams-ai.TeamsAdapter.BotIdentityKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: BotIdentityKey - remarks: '' - isDeprecated: false - syntax: - content: 'BotIdentityKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapter.BotIdentityKey - - name: ConnectorClientKey - uid: '@microsoft/teams-ai.TeamsAdapter.ConnectorClientKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: ConnectorClientKey - remarks: '' - isDeprecated: false - syntax: - content: 'ConnectorClientKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapter.ConnectorClientKey - - name: ConnectorFactoryKey - uid: '@microsoft/teams-ai.TeamsAdapter.ConnectorFactoryKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: ConnectorFactoryKey - remarks: '' - isDeprecated: false - syntax: - content: 'ConnectorFactoryKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapter.ConnectorFactoryKey - - name: OAuthScopeKey - uid: '@microsoft/teams-ai.TeamsAdapter.OAuthScopeKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: OAuthScopeKey - remarks: '' - isDeprecated: false - syntax: - content: 'OAuthScopeKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapter.OAuthScopeKey - - name: UserTokenClientKey - uid: '@microsoft/teams-ai.TeamsAdapter.UserTokenClientKey' - package: '@microsoft/teams-ai' - summary: '' - fullName: UserTokenClientKey - remarks: '' - isDeprecated: false - syntax: - content: 'UserTokenClientKey: symbol' - return: - description: '' - type: symbol - inheritanceDescription: Inherited From CloudAdapter.UserTokenClientKey -inheritedMethods: - - name: >- - connectNamedPipe(string, (context: TurnContext) => Promise, string, - string, string, number) - uid: '@microsoft/teams-ai.TeamsAdapter.connectNamedPipe' - package: '@microsoft/teams-ai' - summary: Used to connect the adapter to a named pipe. - remarks: '' - isDeprecated: false - syntax: - content: >- - function connectNamedPipe(pipeName: string, logic: (context: - TurnContext) => Promise, appId: string, audience: string, - callerId?: string, retryCount?: number): Promise - parameters: - - id: pipeName - type: string - description: >- - Pipe name to connect to (note: yields two named pipe servers by - appending ".incoming" and ".outgoing" to this name) - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: The logic function to call for resulting bot turns. - - id: appId - type: string - description: The Bot application ID - - id: audience - type: string - description: >- - The audience to use for outbound communication. The will vary by - cloud environment. - - id: callerId - type: string - description: Optional, the caller ID - - id: retryCount - type: number - description: >- - Optional, the number of times to retry a failed connection (defaults - to 7) - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.connectNamedPipe - - name: >- - continueConversation(Partial, (context: - TurnContext) => Promise) - uid: '@microsoft/teams-ai.TeamsAdapter.continueConversation' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: '' - syntax: - content: >- - function continueConversation(_reference: - Partial, _logic: (context: TurnContext) => - Promise): Promise - parameters: - - id: _reference - type: Partial<ConversationReference> - description: '' - - id: _logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.continueConversation - - name: >- - createConversationAsync(string, string, string, string, - ConversationParameters, (context: TurnContext) => Promise) - uid: '@microsoft/teams-ai.TeamsAdapter.createConversationAsync' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function createConversationAsync(botAppId: string, channelId: string, - serviceUrl: string, audience: string, conversationParameters: - ConversationParameters, logic: (context: TurnContext) => Promise): - Promise - parameters: - - id: botAppId - type: string - description: '' - - id: channelId - type: string - description: '' - - id: serviceUrl - type: string - description: '' - - id: audience - type: string - description: '' - - id: conversationParameters - type: ConversationParameters - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.createConversationAsync - - name: deleteActivity(TurnContext, Partial) - uid: '@microsoft/teams-ai.TeamsAdapter.deleteActivity' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function deleteActivity(context: TurnContext, reference: - Partial): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: reference - type: Partial<ConversationReference> - description: '' - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.deleteActivity - - name: >- - processActivityDirect(string | AuthenticateRequestResult, Activity, - (context: TurnContext) => Promise) - uid: '@microsoft/teams-ai.TeamsAdapter.processActivityDirect' - package: '@microsoft/teams-ai' - summary: Asynchronously process an activity running the provided logic function. - remarks: '' - isDeprecated: false - syntax: - content: >- - function processActivityDirect(authorization: string | - AuthenticateRequestResult, activity: Activity, logic: (context: - TurnContext) => Promise): Promise - parameters: - - id: authorization - type: string | AuthenticateRequestResult - description: >- - The authorization header in the format: "Bearer [longString]" or the - AuthenticateRequestResult for this turn. - - id: activity - type: Activity - description: The activity to process. - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: The logic function to apply. - return: - description: a promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From CloudAdapter.processActivityDirect - - name: sendActivities(TurnContext, Partial[]) - uid: '@microsoft/teams-ai.TeamsAdapter.sendActivities' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendActivities(context: TurnContext, activities: - Partial[]): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: activities - type: Partial<Activity>[] - description: '' - return: - description: '' - type: Promise<ResourceResponse[]> - inheritanceDescription: Inherited From CloudAdapter.sendActivities - - name: updateActivity(TurnContext, Partial) - uid: '@microsoft/teams-ai.TeamsAdapter.updateActivity' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function updateActivity(context: TurnContext, activity: - Partial): Promise - parameters: - - id: context - type: TurnContext - description: '' - - id: activity - type: Partial<Activity> - description: '' - return: - description: '' - type: Promise<void | ResourceResponse> - inheritanceDescription: Inherited From CloudAdapter.updateActivity - - name: use((MiddlewareHandler | Middleware)[]) - uid: '@microsoft/teams-ai.TeamsAdapter.use' - package: '@microsoft/teams-ai' - summary: Adds middleware to the adapter's pipeline. - remarks: >- - Middleware is added to the adapter at initialization time. - - Each turn, the adapter calls its middleware in the order in which you - added it. - isDeprecated: false - syntax: - content: >- - function use(middlewares: (MiddlewareHandler | Middleware)[]): - TeamsAdapter - parameters: - - id: middlewares - type: (MiddlewareHandler | Middleware)[] - description: The middleware or middleware handlers to add. - return: - description: The updated adapter object. - type: - inheritanceDescription: Inherited From CloudAdapter.use -methods: - - name: >- - process(Request, Record>, INodeSocket, INodeBuffer, (context: TurnContext) => - Promise) - uid: '@microsoft/teams-ai.TeamsAdapter.process_1' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function process(req: Request, Record>, socket: INodeSocket, head: INodeBuffer, - logic: (context: TurnContext) => Promise): Promise - parameters: - - id: req - type: >- - Request<Record<string, unknown>, Record<string, - undefined | string | string[]>> - description: '' - - id: socket - type: INodeSocket - description: '' - - id: head - type: INodeBuffer - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> - - name: >- - process(Request, Record>, Response, (context: TurnContext) => Promise) - uid: '@microsoft/teams-ai.TeamsAdapter.process' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function process(req: Request, Record>, res: Response, logic: (context: - TurnContext) => Promise): Promise - parameters: - - id: req - type: >- - Request<Record<string, unknown>, Record<string, - undefined | string | string[]>> - description: '' - - id: res - type: Response - description: '' - - id: logic - type: '(context: TurnContext) => Promise<void>' - description: '' - return: - description: '' - type: Promise<void> -extends: CloudAdapter diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloader.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloader.yml deleted file mode 100644 index 1d105d6b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloader.yml +++ /dev/null @@ -1,43 +0,0 @@ -### YamlMime:TSType -name: TeamsAttachmentDownloader -uid: '@microsoft/teams-ai.TeamsAttachmentDownloader' -package: '@microsoft/teams-ai' -summary: Downloads attachments from Teams using the bots access token. -fullName: TeamsAttachmentDownloader -remarks: '' -isDeprecated: false -type: class -constructors: - - name: TeamsAttachmentDownloader(TeamsAttachmentDownloaderOptions) - uid: '@microsoft/teams-ai.TeamsAttachmentDownloader.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the `TeamsAttachmentDownloader` class. - remarks: '' - isDeprecated: false - syntax: - content: 'new TeamsAttachmentDownloader(options: TeamsAttachmentDownloaderOptions)' - parameters: - - id: options - type: - description: Options for the `TeamsAttachmentDownloader` class. -methods: - - name: downloadFiles(TurnContext, TState) - uid: '@microsoft/teams-ai.TeamsAttachmentDownloader.downloadFiles' - package: '@microsoft/teams-ai' - summary: Download any files relative to the current user's input. - remarks: '' - isDeprecated: false - syntax: - content: >- - function downloadFiles(context: TurnContext, state: TState): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - return: - description: Promise that resolves to an array of downloaded input files. - type: Promise<[]> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloaderOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloaderOptions.yml deleted file mode 100644 index 14847628..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloaderOptions.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: TeamsAttachmentDownloaderOptions -uid: '@microsoft/teams-ai.TeamsAttachmentDownloaderOptions' -package: '@microsoft/teams-ai' -summary: Options for the `TeamsAttachmentDownloader` class. -fullName: TeamsAttachmentDownloaderOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: adapter - uid: '@microsoft/teams-ai.TeamsAttachmentDownloaderOptions.adapter' - package: '@microsoft/teams-ai' - summary: ServiceClientCredentialsFactory - fullName: adapter - remarks: '' - isDeprecated: false - syntax: - content: 'adapter: TeamsAdapter' - return: - description: '' - type: - - name: botAppId - uid: '@microsoft/teams-ai.TeamsAttachmentDownloaderOptions.botAppId' - package: '@microsoft/teams-ai' - summary: The Microsoft App ID of the bot. - fullName: botAppId - remarks: '' - isDeprecated: false - syntax: - content: 'botAppId: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsMessageEvents.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsMessageEvents.yml deleted file mode 100644 index 4c192166..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsMessageEvents.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: TeamsMessageEvents -uid: '@microsoft/teams-ai.TeamsMessageEvents' -package: '@microsoft/teams-ai' -summary: Message related events. -fullName: TeamsMessageEvents -remarks: '' -isDeprecated: false -syntax: | - type TeamsMessageEvents = - | "undeleteMessage" - | "softDeleteMessage" - | "editMessage" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TemplateSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TemplateSection.yml deleted file mode 100644 index 51b19597..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TemplateSection.yml +++ /dev/null @@ -1,210 +0,0 @@ -### YamlMime:TSType -name: TemplateSection -uid: '@microsoft/teams-ai.TemplateSection' -package: '@microsoft/teams-ai' -summary: A template section that will be rendered as a message. -fullName: TemplateSection -remarks: >- - This section type is used to render a template as a message. The template can - contain - - parameters that will be replaced with values from memory or call functions to - generate - - dynamic content. - - - Template syntax: - - - `{{$memoryKey}}` - Renders the value of the specified memory key. - - - `{{functionName}}` - Calls the specified function and renders the result. - - - `{{functionName arg1 arg2 ...}}` - Calls the specified function with the - provided list of arguments. - - - Function arguments are optional and separated by spaces. They can be quoted - using `'`, `"`, or `\`` delimiters. -isDeprecated: false -type: class -constructors: - - name: TemplateSection(string, string, number, boolean, string, string) - uid: '@microsoft/teams-ai.TemplateSection.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'TemplateSection' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new TemplateSection(template: string, role: string, tokens?: number, - required?: boolean, separator?: string, textPrefix?: string) - parameters: - - id: template - type: string - description: Template to use for this section. - - id: role - type: string - description: Message role to use for this section. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: required - type: boolean - description: Optional. Indicates if this section is required. Defaults to `true`. - - id: separator - type: string - description: >- - Optional. Separator to use between sections when rendering as text. - Defaults to `\n`. - - id: textPrefix - type: string - description: Optional. Prefix to use for text output. Defaults to `undefined`. -properties: - - name: role - uid: '@microsoft/teams-ai.TemplateSection.role' - package: '@microsoft/teams-ai' - summary: '' - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - - name: template - uid: '@microsoft/teams-ai.TemplateSection.template' - package: '@microsoft/teams-ai' - summary: '' - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: string' - return: - description: '' - type: string -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.TemplateSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.TemplateSection.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.TemplateSection.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.TemplateSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.TemplateSection.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.TemplateSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TestModel.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TestModel.yml deleted file mode 100644 index f8488d0c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TestModel.yml +++ /dev/null @@ -1,200 +0,0 @@ -### YamlMime:TSType -name: TestModel -uid: '@microsoft/teams-ai.TestModel' -package: '@microsoft/teams-ai' -summary: A `PromptCompletionModel` used for testing. -fullName: TestModel -remarks: '' -isDeprecated: false -type: class -constructors: - - name: >- - TestModel((model: TestModel, context: TurnContext, memory: Memory, - functions: PromptFunctions, tokenizer: Tokenizer, template: - PromptTemplate) => Promise>) - uid: '@microsoft/teams-ai.TestModel.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `OpenAIModel` instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new TestModel(handler: (model: TestModel, context: TurnContext, memory: - Memory, functions: PromptFunctions, tokenizer: Tokenizer, template: - PromptTemplate) => Promise>) - parameters: - - id: handler - type: >- - (model: TestModel, context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate) - => Promise<PromptResponse<string>> - description: '' -properties: - - name: events - uid: '@microsoft/teams-ai.TestModel.events' - package: '@microsoft/teams-ai' - summary: Events emitted by the model. - fullName: events - remarks: '' - isDeprecated: false - syntax: - content: PromptCompletionModelEmitter events - return: - description: An event emitter for the model. - type: -methods: - - name: >- - completePrompt(TurnContext, Memory, PromptFunctions, Tokenizer, - PromptTemplate) - uid: '@microsoft/teams-ai.TestModel.completePrompt' - package: '@microsoft/teams-ai' - summary: Completes a prompt using OpenAI or Azure OpenAI. - remarks: '' - isDeprecated: false - syntax: - content: >- - function completePrompt(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate): - Promise> - parameters: - - id: context - type: TurnContext - description: Current turn context. - - id: memory - type: - description: An interface for accessing state values. - - id: functions - type: - description: Functions to use when rendering the prompt. - - id: tokenizer - type: - description: Tokenizer to use when rendering the prompt. - - id: template - type: - description: Prompt template to complete. - return: - description: A `PromptResponse` with the status and message. - type: Promise<PromptResponse<string>> - - name: >- - createTestModel((model: TestModel, context: TurnContext, memory: Memory, - functions: PromptFunctions, tokenizer: Tokenizer, template: - PromptTemplate) => Promise>) - uid: '@microsoft/teams-ai.TestModel.createTestModel' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - static function createTestModel(handler: (model: TestModel, context: - TurnContext, memory: Memory, functions: PromptFunctions, tokenizer: - Tokenizer, template: PromptTemplate) => - Promise>): TestModel - parameters: - - id: handler - type: >- - (model: TestModel, context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, template: PromptTemplate) - => Promise<PromptResponse<string>> - description: '' - return: - description: '' - type: - - name: returnContent(string, number) - uid: '@microsoft/teams-ai.TestModel.returnContent' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - static function returnContent(content: string, delay?: number): - TestModel - parameters: - - id: content - type: string - description: '' - - id: delay - type: number - description: '' - return: - description: '' - type: - - name: returnError(Error, number) - uid: '@microsoft/teams-ai.TestModel.returnError' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'static function returnError(error: Error, delay?: number): TestModel' - parameters: - - id: error - type: Error - description: '' - - id: delay - type: number - description: '' - return: - description: '' - type: - - name: returnRateLimited(Error, number) - uid: '@microsoft/teams-ai.TestModel.returnRateLimited' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - static function returnRateLimited(error: Error, delay?: number): - TestModel - parameters: - - id: error - type: Error - description: '' - - id: delay - type: number - description: '' - return: - description: '' - type: - - name: returnResponse(PromptResponse, number) - uid: '@microsoft/teams-ai.TestModel.returnResponse' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - static function returnResponse(response: PromptResponse, delay?: - number): TestModel - parameters: - - id: response - type: PromptResponse<string> - description: '' - - id: delay - type: number - description: '' - return: - description: '' - type: - - name: streamTextChunks(string[], number) - uid: '@microsoft/teams-ai.TestModel.streamTextChunks' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - static function streamTextChunks(chunks: string[], delay?: number): - TestModel - parameters: - - id: chunks - type: string[] - description: '' - - id: delay - type: number - description: '' - return: - description: '' - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextContentPart.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextContentPart.yml deleted file mode 100644 index a89143c2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextContentPart.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: TextContentPart -uid: '@microsoft/teams-ai.TextContentPart' -package: '@microsoft/teams-ai' -summary: '' -fullName: TextContentPart -remarks: '' -isDeprecated: false -type: interface -properties: - - name: text - uid: '@microsoft/teams-ai.TextContentPart.text' - package: '@microsoft/teams-ai' - summary: The text of the message. - fullName: text - remarks: '' - isDeprecated: false - syntax: - content: 'text: string' - return: - description: '' - type: string - - name: type - uid: '@microsoft/teams-ai.TextContentPart.type' - package: '@microsoft/teams-ai' - summary: Type of the message content. Should always be 'text'. - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: "text"' - return: - description: '' - type: '"text"' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextDataSource.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextDataSource.yml deleted file mode 100644 index 2b3f9172..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextDataSource.yml +++ /dev/null @@ -1,73 +0,0 @@ -### YamlMime:TSType -name: TextDataSource -uid: '@microsoft/teams-ai.TextDataSource' -package: '@microsoft/teams-ai' -summary: A data source that can be used to add a static block of text to a prompt. -fullName: TextDataSource -remarks: >- - Primarily used for testing but could be used to inject some externally define - text into a - - prompt. The text will be truncated to fit within the `maxTokens` limit. -isDeprecated: false -type: class -constructors: - - name: TextDataSource(string, string) - uid: '@microsoft/teams-ai.TextDataSource.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `TextDataSource` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new TextDataSource(name: string, text: string)' - parameters: - - id: name - type: string - description: Name of the data source. - - id: text - type: string - description: Text to inject into the prompt. -properties: - - name: name - uid: '@microsoft/teams-ai.TextDataSource.name' - package: '@microsoft/teams-ai' - summary: '' - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: string name - return: - description: Name of the data source. - type: string -methods: - - name: renderData(TurnContext, Memory, Tokenizer, number) - uid: '@microsoft/teams-ai.TextDataSource.renderData' - package: '@microsoft/teams-ai' - summary: Renders the data source as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderData(context: TurnContext, memory: Memory, tokenizer: - Tokenizer, maxTokens: number): Promise> - parameters: - - id: context - type: TurnContext - description: Turn context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use when rendering the data source. - - id: maxTokens - type: number - description: Maximum number of tokens allowed to be rendered. - return: - description: >- - The text to inject into the prompt as a `RenderedPromptSection` - object. - type: >- - Promise<<string>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextSection.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextSection.yml deleted file mode 100644 index 0d57174b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextSection.yml +++ /dev/null @@ -1,189 +0,0 @@ -### YamlMime:TSType -name: TextSection -uid: '@microsoft/teams-ai.TextSection' -package: '@microsoft/teams-ai' -summary: A section of text that will be rendered as a message. -fullName: TextSection -remarks: '' -isDeprecated: false -type: class -constructors: - - name: TextSection(string, string, number, boolean, string, string) - uid: '@microsoft/teams-ai.TextSection.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'TextSection' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new TextSection(text: string, role: string, tokens?: number, required?: - boolean, separator?: string, textPrefix?: string) - parameters: - - id: text - type: string - description: Text to use for this section. - - id: role - type: string - description: Message role to use for this section. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to -1, `auto`. - - id: required - type: boolean - description: Optional. Indicates if this section is required. Defaults to `true`. - - id: separator - type: string - description: >- - Optional. Separator to use between sections when rendering as text. - Defaults to `\n`. - - id: textPrefix - type: string - description: Optional. Prefix to use for text output. Defaults to `undefined`. -properties: - - name: role - uid: '@microsoft/teams-ai.TextSection.role' - package: '@microsoft/teams-ai' - summary: Message role to use for this section. - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - - name: text - uid: '@microsoft/teams-ai.TextSection.text' - package: '@microsoft/teams-ai' - summary: Text to use for this section. - fullName: text - remarks: '' - isDeprecated: false - syntax: - content: 'text: string' - return: - description: '' - type: string -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.TextSection.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.TextSection.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.TextSection.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.TextSection.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.TextSection.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.TextSection.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Tokenizer.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Tokenizer.yml deleted file mode 100644 index b5351aa7..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Tokenizer.yml +++ /dev/null @@ -1,42 +0,0 @@ -### YamlMime:TSType -name: Tokenizer -uid: '@microsoft/teams-ai.Tokenizer' -package: '@microsoft/teams-ai' -summary: |- - Copyright (c) Microsoft Corporation. All rights reserved. - Licensed under the MIT License. -fullName: Tokenizer -remarks: '' -isDeprecated: false -type: interface -methods: - - name: decode(number[]) - uid: '@microsoft/teams-ai.Tokenizer.decode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function decode(tokens: number[]): string' - parameters: - - id: tokens - type: number[] - description: '' - return: - description: '' - type: string - - name: encode(string) - uid: '@microsoft/teams-ai.Tokenizer.encode' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function encode(text: string): number[]' - parameters: - - id: text - type: string - description: '' - return: - description: '' - type: number[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ToolsAugmentation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ToolsAugmentation.yml deleted file mode 100644 index e9fa1c90..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ToolsAugmentation.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: ToolsAugmentation -uid: '@microsoft/teams-ai.ToolsAugmentation' -package: '@microsoft/teams-ai' -summary: >- - The 'tools' augmentation is for enabling server-side action/tools calling. - - In the Teams AI Library, the equivalent to OpenAI's 'tools' functionality is - called an 'action'. - - More information about OpenAI's tools can be found at [OpenAI API - docs](https://platform.openai.com/docs/api-reference/chat/create#chat-create-tool_choice). - - - Therefore, tools/actions are defined in `actions.json`, and when 'tools' - augmentation is set in `config.json`, the LLM model can specify which - action(s) to call. - - To avoid using server-side tool-calling, do not set augmentation to 'tools' in - `config.json`. - - Server-side tool-calling is not compatible with other augmentation types. -fullName: ToolsAugmentation -remarks: '' -isDeprecated: false -type: class -methods: - - name: >- - createPlanFromResponse(TurnContext, Memory, PromptResponse) - uid: '@microsoft/teams-ai.ToolsAugmentation.createPlanFromResponse' - package: '@microsoft/teams-ai' - summary: Creates a plan given validated response value. - remarks: '' - isDeprecated: false - syntax: - content: >- - function createPlanFromResponse(context: TurnContext, memory: Memory, - response: PromptResponse): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: An interface for accessing state variables. - - id: response - type: PromptResponse<string | ActionCall[]> - description: The validated and transformed response for the prompt. - return: - description: The created plan. - type: Promise<> - - name: createPromptSection() - uid: '@microsoft/teams-ai.ToolsAugmentation.createPromptSection' - package: '@microsoft/teams-ai' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function createPromptSection(): undefined | PromptSection' - return: - description: Returns an optional prompt section for the augmentation. - type: undefined | - - name: >- - validateResponse(TurnContext, Memory, Tokenizer, PromptResponse, - number) - uid: '@microsoft/teams-ai.ToolsAugmentation.validateResponse' - package: '@microsoft/teams-ai' - summary: Validates a response to a prompt. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateResponse(context: TurnContext, memory: Memory, - tokenizer: Tokenizer, response: PromptResponse, - remaining_attempts: number): Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: memory - type: - description: An interface for accessing state values. - - id: tokenizer - type: - description: Tokenizer to use for encoding and decoding text. - - id: response - type: PromptResponse<string> - description: Response to validate. - - id: remaining_attempts - type: number - description: Number of remaining attempts to validate the response. - return: - description: A `Validation` object. - type: >- - Promise<<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnEvents.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnEvents.yml deleted file mode 100644 index eae37022..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnEvents.yml +++ /dev/null @@ -1,26 +0,0 @@ -### YamlMime:TSTypeAlias -name: TurnEvents -uid: '@microsoft/teams-ai.TurnEvents' -package: '@microsoft/teams-ai' -summary: Turn event types. -fullName: TurnEvents -remarks: >- - The `beforeTurn` event is triggered before the turn is processed. This allows - for the turn state to be - - modified before the turn is processed. Returning false from the event handler - will prevent the turn from - - being processed. - - - The `afterTurn` event is triggered after the turn is processed. This allows - for the turn state to be - - modified or inspected after the turn is processed. Returning false from the - event handler will prevent - - the turn state from being saved. -isDeprecated: false -syntax: | - type TurnEvents = "beforeTurn" | "afterTurn" diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnState.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnState.yml deleted file mode 100644 index 0156eefe..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnState.yml +++ /dev/null @@ -1,206 +0,0 @@ -### YamlMime:TSType -name: TurnState -uid: '@microsoft/teams-ai.TurnState' -package: '@microsoft/teams-ai' -summary: |- - Represents the turn state for a conversation. - Turn state includes conversation state, user state, and temporary state. - Provides methods to access, modify, and delete the state objects. -fullName: TurnState -remarks: '' -isDeprecated: false -type: class -properties: - - name: conversation - uid: '@microsoft/teams-ai.TurnState.conversation' - package: '@microsoft/teams-ai' - summary: Gets the conversation state from the turn state. - fullName: conversation - remarks: '' - isDeprecated: false - syntax: - content: TConversationState conversation - return: - description: The conversation state. - type: TConversationState - - name: isLoaded - uid: '@microsoft/teams-ai.TurnState.isLoaded' - package: '@microsoft/teams-ai' - summary: >- - Gets a value indicating whether the applications turn state has been - loaded. - fullName: isLoaded - remarks: '' - isDeprecated: false - syntax: - content: boolean isLoaded - return: - description: True if the applications turn state has been loaded, false otherwise. - type: boolean - - name: temp - uid: '@microsoft/teams-ai.TurnState.temp' - package: '@microsoft/teams-ai' - summary: Accessor for the temp state. - fullName: temp - remarks: '' - isDeprecated: false - syntax: - content: TTempState temp - return: - description: The temp TurnState. - type: TTempState - - name: user - uid: '@microsoft/teams-ai.TurnState.user' - package: '@microsoft/teams-ai' - summary: Accessor for the user state. - fullName: user - remarks: '' - isDeprecated: false - syntax: - content: TUserState user - return: - description: The user TurnState. - type: TUserState -methods: - - name: deleteConversationState() - uid: '@microsoft/teams-ai.TurnState.deleteConversationState' - package: '@microsoft/teams-ai' - summary: Deletes the state object for the current conversation from storage. - remarks: '' - isDeprecated: false - syntax: - content: function deleteConversationState() - - name: deleteTempState() - uid: '@microsoft/teams-ai.TurnState.deleteTempState' - package: '@microsoft/teams-ai' - summary: Deletes the temp state object. - remarks: '' - isDeprecated: false - syntax: - content: function deleteTempState() - - name: deleteUserState() - uid: '@microsoft/teams-ai.TurnState.deleteUserState' - package: '@microsoft/teams-ai' - summary: Deletes the state object for the current user from storage. - remarks: '' - isDeprecated: false - syntax: - content: function deleteUserState() - - name: deleteValue(string) - uid: '@microsoft/teams-ai.TurnState.deleteValue' - package: '@microsoft/teams-ai' - summary: Deletes a value from the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function deleteValue(path: string)' - parameters: - - id: path - type: string - description: >- - Path to the value to delete in the form of `[scope].property`. If - scope is omitted, the value is deleted from the temporary scope. - - name: getScope(string) - uid: '@microsoft/teams-ai.TurnState.getScope' - package: '@microsoft/teams-ai' - summary: Gets a state scope by name. - remarks: '' - isDeprecated: false - syntax: - content: 'function getScope(scope: string): undefined | TurnStateEntry' - parameters: - - id: scope - type: string - description: >- - Name of the state scope to return. (i.e. 'conversation', 'user', or - 'temp') - return: - description: The state scope or undefined if not found. - type: undefined | - - name: getValue(string) - uid: '@microsoft/teams-ai.TurnState.getValue' - package: '@microsoft/teams-ai' - summary: Retrieves a value from the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function getValue(path: string): TValue' - parameters: - - id: path - type: string - description: >- - Path to the value to retrieve in the form of `[scope].property`. If - scope is omitted, the value is retrieved from the temporary scope. - return: - description: The value or undefined if not found. - type: TValue - - name: hasValue(string) - uid: '@microsoft/teams-ai.TurnState.hasValue' - package: '@microsoft/teams-ai' - summary: Checks if a value exists in the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function hasValue(path: string): boolean' - parameters: - - id: path - type: string - description: >- - Path to the value to check in the form of `[scope].property`. If - scope is omitted, the value is checked in the temporary scope. - return: - description: True if the value exists, false otherwise. - type: boolean - - name: load(TurnContext, Storage) - uid: '@microsoft/teams-ai.TurnState.load' - package: '@microsoft/teams-ai' - summary: Loads all of the state scopes for the current turn. - remarks: '' - isDeprecated: false - syntax: - content: 'function load(context: TurnContext, storage?: Storage): Promise' - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: storage - type: Storage - description: Optional. Storage provider to load state scopes from. - return: - description: True if the states needed to be loaded. - type: Promise<boolean> - - name: save(TurnContext, Storage) - uid: '@microsoft/teams-ai.TurnState.save' - package: '@microsoft/teams-ai' - summary: Saves all of the state scopes for the current turn. - remarks: '' - isDeprecated: false - syntax: - content: 'function save(context: TurnContext, storage?: Storage): Promise' - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation with the user. - - id: storage - type: Storage - description: Optional. Storage provider to save state scopes to. - return: - description: '' - type: Promise<void> - - name: setValue(string, unknown) - uid: '@microsoft/teams-ai.TurnState.setValue' - package: '@microsoft/teams-ai' - summary: Assigns a value to the memory. - remarks: '' - isDeprecated: false - syntax: - content: 'function setValue(path: string, value: unknown)' - parameters: - - id: path - type: string - description: >- - Path to the value to assign in the form of `[scope].property`. If - scope is omitted, the value is assigned to the temporary scope. - - id: value - type: unknown - description: Value to assign. diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnStateEntry.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnStateEntry.yml deleted file mode 100644 index ee269809..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnStateEntry.yml +++ /dev/null @@ -1,99 +0,0 @@ -### YamlMime:TSType -name: TurnStateEntry -uid: '@microsoft/teams-ai.TurnStateEntry' -package: '@microsoft/teams-ai' -summary: Accessor class for managing an individual state scope. -fullName: TurnStateEntry -remarks: '' -isDeprecated: false -type: class -constructors: - - name: TurnStateEntry(Record, string) - uid: '@microsoft/teams-ai.TurnStateEntry.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new instance of the `TurnStateEntry` class. - remarks: '' - isDeprecated: false - syntax: - content: 'new TurnStateEntry(value?: Record, storageKey?: string)' - parameters: - - id: value - type: Record<string, unknown> - description: >- - Optional. Value to initialize the state scope with. The default is - an {} object. - - id: storageKey - type: string - description: Optional. Storage key to use when persisting the state scope. -properties: - - name: hasChanged - uid: '@microsoft/teams-ai.TurnStateEntry.hasChanged' - package: '@microsoft/teams-ai' - summary: >- - Gets a value indicating whether the state scope has changed since it was - last loaded. - fullName: hasChanged - remarks: '' - isDeprecated: false - syntax: - content: boolean hasChanged - return: - description: A value indicating whether the state scope has changed. - type: boolean - - name: isDeleted - uid: '@microsoft/teams-ai.TurnStateEntry.isDeleted' - package: '@microsoft/teams-ai' - summary: Gets a value indicating whether the state scope has been deleted. - fullName: isDeleted - remarks: '' - isDeprecated: false - syntax: - content: boolean isDeleted - return: - description: A value indicating whether the state scope has been deleted. - type: boolean - - name: storageKey - uid: '@microsoft/teams-ai.TurnStateEntry.storageKey' - package: '@microsoft/teams-ai' - summary: Gets the storage key used to persist the state scope. - fullName: storageKey - remarks: '' - isDeprecated: false - syntax: - content: undefined | string storageKey - return: - description: The storage key used to persist the state scope. - type: undefined | string - - name: value - uid: '@microsoft/teams-ai.TurnStateEntry.value' - package: '@microsoft/teams-ai' - summary: Gets the value of the state scope. - fullName: value - remarks: '' - isDeprecated: false - syntax: - content: Record value - return: - description: value of the state scope. - type: Record<string, unknown> -methods: - - name: delete() - uid: '@microsoft/teams-ai.TurnStateEntry.delete' - package: '@microsoft/teams-ai' - summary: Clears the state scope. - remarks: '' - isDeprecated: false - syntax: - content: function delete() - - name: replace(Record) - uid: '@microsoft/teams-ai.TurnStateEntry.replace' - package: '@microsoft/teams-ai' - summary: Replaces the state scope with a new value. - remarks: '' - isDeprecated: false - syntax: - content: 'function replace(value?: Record)' - parameters: - - id: value - type: Record<string, unknown> - description: New value to replace the state scope with. diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TypeRecord.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/TypeRecord.yml deleted file mode 100644 index 2920eea0..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/TypeRecord.yml +++ /dev/null @@ -1,46 +0,0 @@ -### YamlMime:TSType -name: TypeRecord -uid: '@microsoft/teams-ai.TypeRecord' -package: '@microsoft/teams-ai' -summary: '' -fullName: TypeRecord -remarks: '' -isDeprecated: false -type: interface -properties: - - name: ' _emitterType' - uid: '@microsoft/teams-ai.TypeRecord. _emitterType' - package: '@microsoft/teams-ai' - summary: '' - fullName: ' _emitterType' - remarks: '' - isDeprecated: false - syntax: - content: ' _emitterType?: T' - return: - description: '' - type: T - - name: ' _emitType' - uid: '@microsoft/teams-ai.TypeRecord. _emitType' - package: '@microsoft/teams-ai' - summary: '' - fullName: ' _emitType' - remarks: '' - isDeprecated: false - syntax: - content: ' _emitType?: V' - return: - description: '' - type: V - - name: ' _eventsType' - uid: '@microsoft/teams-ai.TypeRecord. _eventsType' - package: '@microsoft/teams-ai' - summary: '' - fullName: ' _eventsType' - remarks: '' - isDeprecated: false - syntax: - content: ' _eventsType?: U' - return: - description: '' - type: U diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserInputMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserInputMessage.yml deleted file mode 100644 index 4f0385a9..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserInputMessage.yml +++ /dev/null @@ -1,157 +0,0 @@ -### YamlMime:TSType -name: UserInputMessage -uid: '@microsoft/teams-ai.UserInputMessage' -package: '@microsoft/teams-ai' -summary: A section capable of rendering user input text and images as a user message. -fullName: UserInputMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: UserInputMessage(number, string, string) - uid: '@microsoft/teams-ai.UserInputMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'UserInputMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: >- - new UserInputMessage(tokens?: number, inputVariable?: string, - filesVariable?: string) - parameters: - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: inputVariable - type: string - description: >- - Optional. Name of the variable containing the user input text. - Defaults to `input`. - - id: filesVariable - type: string - description: >- - Optional. Name of the variable containing the user input files. - Defaults to `inputFiles`. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.UserInputMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [PromptSectionBase.required](xref:@microsoft/teams-ai.PromptSectionBase.required) - - name: separator - uid: '@microsoft/teams-ai.UserInputMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.separator](xref:@microsoft/teams-ai.PromptSectionBase.separator) - - name: textPrefix - uid: '@microsoft/teams-ai.UserInputMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.textPrefix](xref:@microsoft/teams-ai.PromptSectionBase.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.UserInputMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [PromptSectionBase.tokens](xref:@microsoft/teams-ai.PromptSectionBase.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.UserInputMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [PromptSectionBase.getMessageText](xref:@microsoft/teams-ai.PromptSectionBase.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.UserInputMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [PromptSectionBase.renderAsText](xref:@microsoft/teams-ai.PromptSectionBase.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserMessage.yml deleted file mode 100644 index 96b08808..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserMessage.yml +++ /dev/null @@ -1,183 +0,0 @@ -### YamlMime:TSType -name: UserMessage -uid: '@microsoft/teams-ai.UserMessage' -package: '@microsoft/teams-ai' -summary: A user message. -fullName: UserMessage -remarks: '' -isDeprecated: false -type: class -constructors: - - name: UserMessage(string, number, string) - uid: '@microsoft/teams-ai.UserMessage.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new 'UserMessage' instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new UserMessage(template: string, tokens?: number, userPrefix?: string)' - parameters: - - id: template - type: string - description: Template to use for this section. - - id: tokens - type: number - description: Optional. Sizing strategy for this section. Defaults to `auto`. - - id: userPrefix - type: string - description: >- - Optional. Prefix to use for user messages when rendering as text. - Defaults to `user: `. -inheritedProperties: - - name: required - uid: '@microsoft/teams-ai.UserMessage.required' - package: '@microsoft/teams-ai' - summary: If true the section is mandatory otherwise it can be safely dropped. - fullName: required - remarks: '' - isDeprecated: false - syntax: - content: 'required: boolean' - return: - description: '' - type: boolean - inheritanceDescription: >- - Inherited From - [TemplateSection.required](xref:@microsoft/teams-ai.TemplateSection.required) - - name: role - uid: '@microsoft/teams-ai.UserMessage.role' - package: '@microsoft/teams-ai' - summary: '' - fullName: role - remarks: '' - isDeprecated: false - syntax: - content: 'role: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.role](xref:@microsoft/teams-ai.TemplateSection.role) - - name: separator - uid: '@microsoft/teams-ai.UserMessage.separator' - package: '@microsoft/teams-ai' - summary: '' - fullName: separator - remarks: '' - isDeprecated: false - syntax: - content: 'separator: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.separator](xref:@microsoft/teams-ai.TemplateSection.separator) - - name: template - uid: '@microsoft/teams-ai.UserMessage.template' - package: '@microsoft/teams-ai' - summary: '' - fullName: template - remarks: '' - isDeprecated: false - syntax: - content: 'template: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.template](xref:@microsoft/teams-ai.TemplateSection.template) - - name: textPrefix - uid: '@microsoft/teams-ai.UserMessage.textPrefix' - package: '@microsoft/teams-ai' - summary: '' - fullName: textPrefix - remarks: '' - isDeprecated: false - syntax: - content: 'textPrefix: string' - return: - description: '' - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.textPrefix](xref:@microsoft/teams-ai.TemplateSection.textPrefix) - - name: tokens - uid: '@microsoft/teams-ai.UserMessage.tokens' - package: '@microsoft/teams-ai' - summary: >- - The requested token budget for this section. - - - Values between 0.0 and 1.0 represent a percentage of the total budget - and the section will be layed out proportionally to all other sections. - - - Values greater than 1.0 represent the max number of tokens the section - should be allowed to consume. - fullName: tokens - remarks: '' - isDeprecated: false - syntax: - content: 'tokens: number' - return: - description: '' - type: number - inheritanceDescription: >- - Inherited From - [TemplateSection.tokens](xref:@microsoft/teams-ai.TemplateSection.tokens) -inheritedMethods: - - name: getMessageText(Message) - uid: '@microsoft/teams-ai.UserMessage.getMessageText' - package: '@microsoft/teams-ai' - summary: Returns the content of a message as a string. - remarks: '' - isDeprecated: false - syntax: - content: 'static function getMessageText(message: Message): string' - parameters: - - id: message - type: <string> - description: Message to get the text of. - return: - description: The message content as a string. - type: string - inheritanceDescription: >- - Inherited From - [TemplateSection.getMessageText](xref:@microsoft/teams-ai.TemplateSection.getMessageText) - - name: renderAsText(TurnContext, Memory, PromptFunctions, Tokenizer, number) - uid: '@microsoft/teams-ai.UserMessage.renderAsText' - package: '@microsoft/teams-ai' - summary: Renders the prompt section as a string of text. - remarks: '' - isDeprecated: false - syntax: - content: >- - function renderAsText(context: TurnContext, memory: Memory, functions: - PromptFunctions, tokenizer: Tokenizer, maxTokens: number): - Promise> - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: memory - type: - description: Interface for accessing state variables. - - id: functions - type: - description: Functions for rendering prompts. - - id: tokenizer - type: - description: Tokenizer to use for encoding/decoding text. - - id: maxTokens - type: number - description: Maximum number of tokens allowed for the rendered prompt. - return: - description: The rendered prompt section. - type: >- - Promise<<string>> - inheritanceDescription: >- - Inherited From - [TemplateSection.renderAsText](xref:@microsoft/teams-ai.TemplateSection.renderAsText) -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Utilities.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Utilities.yml deleted file mode 100644 index 2122dbdc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Utilities.yml +++ /dev/null @@ -1,95 +0,0 @@ -### YamlMime:TSType -name: Utilities -uid: '@microsoft/teams-ai.Utilities' -package: '@microsoft/teams-ai' -summary: Utility functions for manipulating . -fullName: Utilities -remarks: '' -isDeprecated: false -type: class -methods: - - name: formatCitationsResponse(string) - uid: '@microsoft/teams-ai.Utilities.formatCitationsResponse' - package: '@microsoft/teams-ai' - summary: Convert citation tags `[doc(s)n]` to `[n]` where n is a number. - remarks: '' - isDeprecated: false - syntax: - content: 'static function formatCitationsResponse(text: string): string' - parameters: - - id: text - type: string - description: The text to format. - return: - description: The formatted text. - type: string - - name: getUsedCitations(string, ClientCitation[]) - uid: '@microsoft/teams-ai.Utilities.getUsedCitations' - package: '@microsoft/teams-ai' - summary: >- - Get the citations used in the text. This will remove any citations that - are included in the citations array from the response but not referenced - in the text. - remarks: '' - isDeprecated: false - syntax: - content: >- - static function getUsedCitations(text: string, citations: - ClientCitation[]): undefined | ClientCitation[] - parameters: - - id: text - type: string - description: The text to search for citation references, i.e. [1], [2], etc. - - id: citations - type: ClientCitation[] - description: The list of citations to search for. - return: - description: The list of citations used in the text. - type: undefined | ClientCitation[] - - name: snippet(string, number) - uid: '@microsoft/teams-ai.Utilities.snippet' - package: '@microsoft/teams-ai' - summary: Clips the text to a maximum length in case it exceeds the limit. - remarks: '' - isDeprecated: false - syntax: - content: 'static function snippet(text: string, maxLength: number): string' - parameters: - - id: text - type: string - description: The text to clip. - - id: maxLength - type: number - description: >- - The maximum length of the text to return, cutting off the last whole - word. - return: - description: The modified text - type: string - - name: toString(Tokenizer, any, boolean) - uid: '@microsoft/teams-ai.Utilities.toString' - package: '@microsoft/teams-ai' - summary: Converts a value to a string. - remarks: >- - Dates are converted to ISO strings and Objects are converted to JSON or - YAML, whichever is shorter. - isDeprecated: false - syntax: - content: >- - static function toString(tokenizer: Tokenizer, value: any, asJSON?: - boolean): string - parameters: - - id: tokenizer - type: - description: Tokenizer to use for encoding. - - id: value - type: any - description: Value to convert. - - id: asJSON - type: boolean - description: >- - Optional. If true objects will always be converted to JSON instead - of YAML. Defaults to false. - return: - description: Converted value. - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ValidatedChatCompletionAction.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/ValidatedChatCompletionAction.yml deleted file mode 100644 index 74b3eacd..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/ValidatedChatCompletionAction.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSType -name: ValidatedChatCompletionAction -uid: '@microsoft/teams-ai.ValidatedChatCompletionAction' -package: '@microsoft/teams-ai' -summary: A validated action call. -fullName: ValidatedChatCompletionAction -remarks: '' -isDeprecated: false -type: interface -properties: - - name: name - uid: '@microsoft/teams-ai.ValidatedChatCompletionAction.name' - package: '@microsoft/teams-ai' - summary: Name of the action to call. - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - - name: parameters - uid: '@microsoft/teams-ai.ValidatedChatCompletionAction.parameters' - package: '@microsoft/teams-ai' - summary: Arguments to pass to the action. - fullName: parameters - remarks: '' - isDeprecated: false - syntax: - content: 'parameters: Record' - return: - description: '' - type: Record<string, any> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Validation.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/Validation.yml deleted file mode 100644 index f8438e7f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/Validation.yml +++ /dev/null @@ -1,66 +0,0 @@ -### YamlMime:TSType -name: Validation -uid: '@microsoft/teams-ai.Validation' -package: '@microsoft/teams-ai' -summary: Response returned by a `PromptResponseValidator`. -fullName: Validation -remarks: '' -isDeprecated: false -type: interface -properties: - - name: feedback - uid: '@microsoft/teams-ai.Validation.feedback' - package: '@microsoft/teams-ai' - summary: Optional. Repair instructions to send to the model. - fullName: feedback - remarks: Should be set if the validation fails. - isDeprecated: false - syntax: - content: 'feedback?: string' - return: - description: '' - type: string - - name: type - uid: '@microsoft/teams-ai.Validation.type' - package: '@microsoft/teams-ai' - summary: Type of the validation object. - fullName: type - remarks: This is used for type checking. - isDeprecated: false - syntax: - content: 'type: "Validation"' - return: - description: '' - type: '"Validation"' - - name: valid - uid: '@microsoft/teams-ai.Validation.valid' - package: '@microsoft/teams-ai' - summary: Whether the validation is valid. - fullName: valid - remarks: >- - If this is `false` the `feedback` property will be set, otherwise the - `value` property - - MAY be set. - isDeprecated: false - syntax: - content: 'valid: boolean' - return: - description: '' - type: boolean - - name: value - uid: '@microsoft/teams-ai.Validation.value' - package: '@microsoft/teams-ai' - summary: Optional. Replacement value to use for the response. - fullName: value - remarks: >- - Can be set if the validation succeeds. If set, the value will replace the - responses - - `message.content` property. - isDeprecated: false - syntax: - content: 'value?: TValue' - return: - description: '' - type: TValue diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/VoidKeys.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/VoidKeys.yml deleted file mode 100644 index 316ca5ed..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/VoidKeys.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSTypeAlias -name: VoidKeys -uid: '@microsoft/teams-ai.VoidKeys' -package: '@microsoft/teams-ai' -summary: '' -fullName: VoidKeys -remarks: '' -isDeprecated: false -syntax: | - type VoidKeys = MatchingKeys diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/index.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/index.yml deleted file mode 100644 index 2ade2165..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/index.yml +++ /dev/null @@ -1,165 +0,0 @@ -### YamlMime:TSPackage -uid: '@microsoft/teams-ai' -name: '@microsoft/teams-ai' -summary: '' -type: package -classes: - - '@microsoft/teams-ai.preview.AssistantsPlanner' - - '@microsoft/teams-ai.AI' - - '@microsoft/teams-ai.ActionAugmentationSection' - - '@microsoft/teams-ai.ActionOutputMessage' - - '@microsoft/teams-ai.ActionPlanner' - - '@microsoft/teams-ai.ActionResponseValidator' - - '@microsoft/teams-ai.AdaptiveCards' - - '@microsoft/teams-ai.Application' - - '@microsoft/teams-ai.ApplicationBuilder' - - '@microsoft/teams-ai.AssistantMessage' - - '@microsoft/teams-ai.AuthError' - - '@microsoft/teams-ai.Authentication' - - '@microsoft/teams-ai.AuthenticationManager' - - '@microsoft/teams-ai.AzureContentSafetyModerator' - - '@microsoft/teams-ai.ConversationHistory' - - '@microsoft/teams-ai.DataSourceSection' - - '@microsoft/teams-ai.DefaultAugmentation' - - '@microsoft/teams-ai.DefaultModerator' - - '@microsoft/teams-ai.DefaultResponseValidator' - - '@microsoft/teams-ai.FunctionCallMessage' - - '@microsoft/teams-ai.FunctionResponseMessage' - - '@microsoft/teams-ai.GPT3Tokenizer' - - '@microsoft/teams-ai.GPTTokenizer' - - '@microsoft/teams-ai.GroupSection' - - '@microsoft/teams-ai.JSONResponseValidator' - - '@microsoft/teams-ai.LLMClient' - - '@microsoft/teams-ai.LayoutEngine' - - '@microsoft/teams-ai.LlamaModel' - - '@microsoft/teams-ai.MemoryFork' - - '@microsoft/teams-ai.MessageExtensions' - - '@microsoft/teams-ai.MonologueAugmentation' - - '@microsoft/teams-ai.OpenAIEmbeddings' - - '@microsoft/teams-ai.OpenAIModel' - - '@microsoft/teams-ai.OpenAIModerator' - - '@microsoft/teams-ai.Prompt' - - '@microsoft/teams-ai.PromptManager' - - '@microsoft/teams-ai.PromptSectionBase' - - '@microsoft/teams-ai.SequenceAugmentation' - - '@microsoft/teams-ai.StreamingResponse' - - '@microsoft/teams-ai.SystemMessage' - - '@microsoft/teams-ai.TaskModules' - - '@microsoft/teams-ai.TeamsAdapter' - - '@microsoft/teams-ai.TeamsAttachmentDownloader' - - '@microsoft/teams-ai.TemplateSection' - - '@microsoft/teams-ai.TestModel' - - '@microsoft/teams-ai.TextDataSource' - - '@microsoft/teams-ai.TextSection' - - '@microsoft/teams-ai.ToolsAugmentation' - - '@microsoft/teams-ai.TurnState' - - '@microsoft/teams-ai.TurnStateEntry' - - '@microsoft/teams-ai.UserInputMessage' - - '@microsoft/teams-ai.UserMessage' - - '@microsoft/teams-ai.Utilities' -interfaces: - - '@microsoft/teams-ai.preview.AssistantsPlannerOptions' - - '@microsoft/teams-ai.AIOptions' - - '@microsoft/teams-ai.ActionPlannerOptions' - - '@microsoft/teams-ai.AdaptiveCard' - - '@microsoft/teams-ai.AdaptiveCardSearchResult' - - '@microsoft/teams-ai.AdaptiveCardsOptions' - - '@microsoft/teams-ai.AdaptiveCardsSearchParams' - - '@microsoft/teams-ai.ApplicationOptions' - - '@microsoft/teams-ai.Augmentation' - - '@microsoft/teams-ai.AugmentationConfig' - - '@microsoft/teams-ai.AuthenticationOptions' - - '@microsoft/teams-ai.AuthenticatorResult' - - '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions' - - '@microsoft/teams-ai.AzureOpenAIModelOptions' - - '@microsoft/teams-ai.AzureOpenAIModeratorOptions' - - '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions' - - '@microsoft/teams-ai.BaseOpenAIModelOptions' - - '@microsoft/teams-ai.ChatCompletionAction' - - '@microsoft/teams-ai.Citation' - - '@microsoft/teams-ai.ConfiguredAIOptions' - - '@microsoft/teams-ai.ConfiguredLLMClientOptions' - - '@microsoft/teams-ai.ConfiguredPromptManagerOptions' - - '@microsoft/teams-ai.DataSource' - - '@microsoft/teams-ai.DefaultConversationState' - - '@microsoft/teams-ai.DefaultTempState' - - '@microsoft/teams-ai.DefaultUserState' - - '@microsoft/teams-ai.FeedbackLoopData' - - '@microsoft/teams-ai.FunctionCall' - - '@microsoft/teams-ai.ImageContentPart' - - '@microsoft/teams-ai.InputFile' - - '@microsoft/teams-ai.InputFileDownloader' - - '@microsoft/teams-ai.LLMClientOptions' - - '@microsoft/teams-ai.LlamaModelOptions' - - '@microsoft/teams-ai.Memory' - - '@microsoft/teams-ai.Message' - - '@microsoft/teams-ai.MessageContext' - - '@microsoft/teams-ai.Moderator' - - '@microsoft/teams-ai.OpenAIEmbeddingsOptions' - - '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions' - - '@microsoft/teams-ai.OpenAIModelOptions' - - '@microsoft/teams-ai.OpenAIModeratorOptions' - - '@microsoft/teams-ai.Plan' - - '@microsoft/teams-ai.Planner' - - '@microsoft/teams-ai.PredictedCommand' - - '@microsoft/teams-ai.PredictedDoCommand' - - '@microsoft/teams-ai.PredictedDoCommandAndHandler' - - '@microsoft/teams-ai.PredictedSayCommand' - - '@microsoft/teams-ai.PromptChunk' - - '@microsoft/teams-ai.PromptCompletionModel' - - '@microsoft/teams-ai.PromptCompletionModelEvents' - - '@microsoft/teams-ai.PromptFunctions' - - '@microsoft/teams-ai.PromptManagerOptions' - - '@microsoft/teams-ai.PromptResponseValidator' - - '@microsoft/teams-ai.PromptSection' - - '@microsoft/teams-ai.PromptTemplate' - - '@microsoft/teams-ai.PromptTemplateConfig' - - '@microsoft/teams-ai.Query' - - '@microsoft/teams-ai.RenderedPromptSection' - - '@microsoft/teams-ai.TaskModulesOptions' - - '@microsoft/teams-ai.TeamsAttachmentDownloaderOptions' - - '@microsoft/teams-ai.TextContentPart' - - '@microsoft/teams-ai.Tokenizer' - - '@microsoft/teams-ai.TypeRecord' - - '@microsoft/teams-ai.ValidatedChatCompletionAction' - - '@microsoft/teams-ai.Validation' -enums: - - '@microsoft/teams-ai.AdaptiveCardActionExecuteResponseType' - - '@microsoft/teams-ai.MessageExtensionsInvokeNames' - - '@microsoft/teams-ai.ModerationSeverity' - - '@microsoft/teams-ai.TaskModuleInvokeNames' -typeAliases: - - '@microsoft/teams-ai.ActionHandler' - - '@microsoft/teams-ai.ActionPlannerPromptFactory' - - '@microsoft/teams-ai.AuthErrorReason' - - '@microsoft/teams-ai.ConversationUpdateEvents' - - '@microsoft/teams-ai.EEMethodReturnType' - - '@microsoft/teams-ai.EmitEventNames' - - '@microsoft/teams-ai.EventNames' - - '@microsoft/teams-ai.InnerEEMethodReturnType' - - '@microsoft/teams-ai.ListenerType' - - '@microsoft/teams-ai.MatchingKeys' - - '@microsoft/teams-ai.MessageContentParts' - - '@microsoft/teams-ai.MessageReactionEvents' - - '@microsoft/teams-ai.NoUndefined' - - '@microsoft/teams-ai.OAuthSettings' - - '@microsoft/teams-ai.OnEventNames' - - '@microsoft/teams-ai.OverriddenKeys' - - '@microsoft/teams-ai.OverriddenMethods' - - '@microsoft/teams-ai.PromptCompletionModelBeforeCompletionEvent' - - '@microsoft/teams-ai.PromptCompletionModelChunkReceivedEvent' - - '@microsoft/teams-ai.PromptCompletionModelEmitter' - - '@microsoft/teams-ai.PromptCompletionModelResponseReceivedEvent' - - '@microsoft/teams-ai.PromptFunction' - - '@microsoft/teams-ai.ReturnTypeOfMethod' - - '@microsoft/teams-ai.ReturnTypeOfMethodIfExists' - - '@microsoft/teams-ai.RouteHandler' - - '@microsoft/teams-ai.RouteSelector' - - '@microsoft/teams-ai.Selector' - - '@microsoft/teams-ai.SignInResponse' - - '@microsoft/teams-ai.SignInStatus' - - '@microsoft/teams-ai.StrictBroadcast' - - '@microsoft/teams-ai.StrictEventEmitter' - - '@microsoft/teams-ai.TeamsMessageEvents' - - '@microsoft/teams-ai.TurnEvents' - - '@microsoft/teams-ai.VoidKeys' diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlanner.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlanner.yml deleted file mode 100644 index 80a17d05..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlanner.yml +++ /dev/null @@ -1,141 +0,0 @@ -### YamlMime:TSType -name: AssistantsPlanner -uid: '@microsoft/teams-ai.preview.AssistantsPlanner' -package: '@microsoft/teams-ai' -summary: >- - A Planner that uses the OpenAI Assistants API to generate plans for the AI - system. -fullName: AssistantsPlanner -remarks: >- - This planner manages conversations through OpenAI's thread-based system, - handling: - - - Thread creation and management - - - Message submission - - - Tool/function calling - - - Response processing -isDeprecated: false -type: class -constructors: - - name: AssistantsPlanner(AssistantsPlannerOptions) - uid: '@microsoft/teams-ai.preview.AssistantsPlanner.constructor' - package: '@microsoft/teams-ai' - summary: Creates a new `AssistantsPlanner` instance. - remarks: '' - isDeprecated: false - syntax: - content: 'new AssistantsPlanner(options: AssistantsPlannerOptions)' - parameters: - - id: options - type: - description: Options for configuring the AssistantsPlanner. -methods: - - name: beginTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.preview.AssistantsPlanner.beginTask' - package: '@microsoft/teams-ai' - summary: Starts a new task. - remarks: >- - This method is called when the AI system is ready to start a new task. It - delegates the - - task handling to the `continueTask` method. The planner should - - generate a plan that the AI system will execute. Returning an empty plan - signals that - - there is no work to be performed. - - - The planner should take the users input from `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function beginTask(context: TurnContext, state: TState, ai: AI): - Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> - - name: continueTask(TurnContext, TState, AI) - uid: '@microsoft/teams-ai.preview.AssistantsPlanner.continueTask' - package: '@microsoft/teams-ai' - summary: Continues the current task. - remarks: >- - This method is called when the AI system is ready to continue the current - task. It handles: - - - Creating a new thread if one doesn't exist - - - Submitting tool outputs if required - - - Waiting for any in-progress runs to complete - - - Submitting user input and creating a new run - - The method generates a plan that the AI system will execute. Returning an - empty plan signals - - that the task is completed and there is no work to be performed. - - - The output from the last plan step that was executed is passed to the - planner via `state.temp.input`. - isDeprecated: false - syntax: - content: >- - function continueTask(context: TurnContext, state: TState, ai: - AI): Promise - parameters: - - id: context - type: TurnContext - description: Context for the current turn of conversation. - - id: state - type: TState - description: Application state for the current turn of conversation. - - id: ai - type: <TState> - description: The AI system that is generating the plan. - return: - description: The plan that was generated. - type: Promise<> - - name: createAssistant(string, AssistantCreateParams, string, AzureClientOptions) - uid: '@microsoft/teams-ai.preview.AssistantsPlanner.createAssistant' - package: '@microsoft/teams-ai' - summary: Creates a new assistant using the OpenAI Assistants API. - remarks: '' - isDeprecated: false - syntax: - content: >- - static function createAssistant(apiKey: string, request: - AssistantCreateParams, endpoint?: string, azureClientOptions?: - AzureClientOptions): Promise - parameters: - - id: apiKey - type: string - description: OpenAI API key. - - id: request - type: AssistantCreateParams - description: Definition of the assistant to create. - - id: endpoint - type: string - description: >- - Optional. The Azure OpenAI resource endpoint. Required when using - Azure OpenAI. - - id: azureClientOptions - type: AzureClientOptions - description: Optional. The Azure OpenAI client options. - return: - description: The created assistant. - type: Promise<Assistant> diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlannerOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlannerOptions.yml deleted file mode 100644 index 0b6f69ae..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlannerOptions.yml +++ /dev/null @@ -1,85 +0,0 @@ -### YamlMime:TSType -name: AssistantsPlannerOptions -uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions' -package: '@microsoft/teams-ai' -summary: Options for configuring the AssistantsPlanner. -fullName: AssistantsPlannerOptions -remarks: '' -isDeprecated: false -type: interface -properties: - - name: apiKey - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions.apiKey' - package: '@microsoft/teams-ai' - summary: The OpenAI or Azure OpenAI API key. Required. - fullName: apiKey - remarks: '' - isDeprecated: false - syntax: - content: 'apiKey: string' - return: - description: '' - type: string - - name: apiVersion - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions.apiVersion' - package: '@microsoft/teams-ai' - summary: >- - Optional. Version of the API being called. Default is - '2024-02-15-preview'. - fullName: apiVersion - remarks: '' - isDeprecated: false - syntax: - content: 'apiVersion?: string' - return: - description: '' - type: string - - name: assistants_state_variable - uid: >- - @microsoft/teams-ai.preview.AssistantsPlannerOptions.assistants_state_variable - package: '@microsoft/teams-ai' - summary: Optional. The state variable to use for storing the assistants state. - fullName: assistants_state_variable - remarks: Defaults to 'conversation.assistants_state'. - isDeprecated: false - syntax: - content: 'assistants_state_variable?: string' - return: - description: '' - type: string - - name: assistant_id - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions.assistant_id' - package: '@microsoft/teams-ai' - summary: The ID of the assistant to use. Required. - fullName: assistant_id - remarks: '' - isDeprecated: false - syntax: - content: 'assistant_id: string' - return: - description: '' - type: string - - name: endpoint - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions.endpoint' - package: '@microsoft/teams-ai' - summary: The Azure OpenAI resource endpoint. - fullName: endpoint - remarks: Required when using Azure OpenAI. Not used for OpenAI. - isDeprecated: false - syntax: - content: 'endpoint?: string' - return: - description: '' - type: string - - name: polling_interval - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions.polling_interval' - package: '@microsoft/teams-ai' - summary: Optional. Polling interval in milliseconds. - fullName: polling_interval - remarks: Defaults to 1000 (once a second). - isDeprecated: false - syntax: - content: 'polling_interval?: number' - return: - description: '' - type: number diff --git a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.yml b/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.yml deleted file mode 100644 index dd310565..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.yml +++ /dev/null @@ -1,10 +0,0 @@ -### YamlMime:TSPackage -uid: '@microsoft/teams-ai.preview' -name: preview -summary: '' -type: module -classes: - - '@microsoft/teams-ai.preview.AssistantsPlanner' -interfaces: - - '@microsoft/teams-ai.preview.AssistantsPlannerOptions' -package: '@microsoft/teams-ai' diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseDashboard.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseDashboard.yml deleted file mode 100644 index 0d6b359b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseDashboard.yml +++ /dev/null @@ -1,623 +0,0 @@ -### YamlMime:TSType -name: BaseDashboard -uid: '@microsoft/teamsfx-react.BaseDashboard' -package: '@microsoft/teamsfx-react' -summary: The base component that provides basic functionality to create a dashboard. -fullName: BaseDashboard -remarks: '' -isDeprecated: false -type: class -constructors: - - name: BaseDashboard(Readonly

) - uid: '@microsoft/teamsfx-react.BaseDashboard.constructor' - package: '@microsoft/teamsfx-react' - summary: Constructor of BaseDashboard. - remarks: '' - isDeprecated: false - syntax: - content: 'new BaseDashboard(props: Readonly

)' - parameters: - - id: props - type: Readonly<P> - description: The properties for the dashboard. -inheritedProperties: - - name: context - uid: '@microsoft/teamsfx-react.BaseDashboard.context' - package: '@microsoft/teamsfx-react' - summary: |- - If using the new style context, re-declare this in your class to be the - `React.ContextType` of your `static contextType`. - Should be used with type annotation or static contextType. - - **Example** - - ```ts - static contextType = MyContext - // For TS pre-3.7: - context!: React.ContextType - // For TS 3.7 and above: - declare context: React.ContextType - ``` - - - - See [React Docs](https://react.dev/reference/react/Component#context) - fullName: context - remarks: '' - isDeprecated: false - syntax: - content: 'context: unknown' - return: - description: '' - type: unknown - inheritanceDescription: Inherited From Component.context - - name: contextType - uid: '@microsoft/teamsfx-react.BaseDashboard.contextType' - package: '@microsoft/teamsfx-react' - summary: >- - If set, `this.context` will be set at runtime to the current value of the - given Context. - - - **Example** - - - ```ts - - type MyContext = number - - const Ctx = React.createContext(0) - - - class Foo extends React.Component { - static contextType = Ctx - context!: React.ContextType - render () { - return <>My context's value: {this.context}; - } - } - - ``` - - - - - See https://react.dev/reference/react/Component#static-contexttype - fullName: contextType - remarks: '' - isDeprecated: false - syntax: - content: 'static contextType?: Context' - return: - description: '' - type: Context<any> - inheritanceDescription: Inherited From Component.contextType - - name: props - uid: '@microsoft/teamsfx-react.BaseDashboard.props' - package: '@microsoft/teamsfx-react' - summary: '' - fullName: props - remarks: '' - isDeprecated: false - syntax: - content: 'props: Readonly

' - return: - description: '' - type: Readonly<P> - inheritanceDescription: Inherited From Component.props - - name: refs - uid: '@microsoft/teamsfx-react.BaseDashboard.refs' - package: '@microsoft/teamsfx-react' - summary: >- - - - See [Legacy React - Docs](https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs) - fullName: refs - remarks: '' - isDeprecated: true - customDeprecatedMessage: '' - syntax: - content: 'refs: {[key: string]: ReactInstance}' - return: - description: '' - type: '{[key: string]: ReactInstance}' - inheritanceDescription: Inherited From Component.refs - - name: state - uid: '@microsoft/teamsfx-react.BaseDashboard.state' - package: '@microsoft/teamsfx-react' - summary: '' - fullName: state - remarks: '' - isDeprecated: false - syntax: - content: 'state: Readonly' - return: - description: '' - type: Readonly<S & BaseDashboardState> - inheritanceDescription: Inherited From Component.state -inheritedMethods: - - name: componentDidCatch(Error, ErrorInfo) - uid: '@microsoft/teamsfx-react.BaseDashboard.componentDidCatch' - package: '@microsoft/teamsfx-react' - summary: >- - Catches exceptions generated in descendant components. Unhandled - exceptions will cause - - the entire component tree to unmount. - remarks: '' - isDeprecated: false - syntax: - content: 'function componentDidCatch(error: Error, errorInfo: ErrorInfo)' - parameters: - - id: error - type: Error - description: '' - - id: errorInfo - type: ErrorInfo - description: '' - inheritanceDescription: Inherited From Component.componentDidCatch - - name: componentDidUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseDashboard.componentDidUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately after updating occurs. Not called for the initial - render. - - - The snapshot is only present if - [getSnapshotBeforeUpdate](xref:@microsoft/teamsfx-react.BaseDashboard.getSnapshotBeforeUpdate) - is present and returns non-null. - remarks: '' - isDeprecated: false - syntax: - content: >- - function componentDidUpdate(prevProps: Readonly

, prevState: - Readonly, snapshot?: any) - parameters: - - id: prevProps - type: Readonly<P> - description: '' - - id: prevState - type: Readonly<S & BaseDashboardState> - description: '' - - id: snapshot - type: any - description: '' - inheritanceDescription: Inherited From Component.componentDidUpdate - - name: componentWillMount() - uid: '@microsoft/teamsfx-react.BaseDashboard.componentWillMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before mounting occurs, and before - . - - Avoid introducing any side-effects or subscriptions in this method. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use [componentDidMount](xref:ComponentLifecycle.componentDidMount) - or the constructor instead; will stop working in React 17 - syntax: - content: function componentWillMount() - inheritanceDescription: Inherited From Component.componentWillMount - - name: componentWillReceiveProps(Readonly

, any) - uid: '@microsoft/teamsfx-react.BaseDashboard.componentWillReceiveProps' - package: '@microsoft/teamsfx-react' - summary: >- - Called when the component may be receiving new props. - - React may call this even if props have not changed, so be sure to compare - new and existing - - props if you only want to handle changes. - - - Calling generally does not trigger this method. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use static - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - instead; will stop working in React 17 - syntax: - content: >- - function componentWillReceiveProps(nextProps: Readonly

, nextContext: - any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.componentWillReceiveProps - - name: componentWillUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseDashboard.componentWillUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before rendering when new props or state is received. - Not called for the initial render. - - - Note: You cannot call here. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 - syntax: - content: >- - function componentWillUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseDashboardState> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.componentWillUpdate - - name: forceUpdate(() => void) - uid: '@microsoft/teamsfx-react.BaseDashboard.forceUpdate' - package: '@microsoft/teamsfx-react' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function forceUpdate(callback?: () => void)' - parameters: - - id: callback - type: () => void - description: '' - inheritanceDescription: Inherited From Component.forceUpdate - - name: getSnapshotBeforeUpdate(Readonly

, Readonly) - uid: '@microsoft/teamsfx-react.BaseDashboard.getSnapshotBeforeUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Runs before React applies the result of [render](xref:Component.render) to - the document, and - - returns an object to be given to - [componentDidUpdate](xref:@microsoft/teamsfx-react.BaseDashboard.componentDidUpdate). - Useful for saving - - things such as scroll position before [render](xref:Component.render) - causes changes to it. - - - Note: the presence of this method prevents any of the deprecated - - lifecycle events from running. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: - Readonly): any - parameters: - - id: prevProps - type: Readonly<P> - description: '' - - id: prevState - type: Readonly<S & BaseDashboardState> - description: '' - return: - description: '' - type: any - inheritanceDescription: Inherited From Component.getSnapshotBeforeUpdate - - name: >- - setState(null | (S & BaseDashboardState) | (prevState: Readonly, props: Readonly

) => null | (S & - BaseDashboardState) | Pick | Pick, () => void) - uid: '@microsoft/teamsfx-react.BaseDashboard.setState' - package: '@microsoft/teamsfx-react' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function setState(state: null | (S & BaseDashboardState) | - (prevState: Readonly, props: Readonly

) => - null | (S & BaseDashboardState) | Pick | - Pick, callback?: () => void) - parameters: - - id: state - type: >- - null | (S & BaseDashboardState) | (prevState: Readonly<S & - BaseDashboardState>, props: Readonly<P>) => null | (S & - BaseDashboardState) | Pick<S & BaseDashboardState, K> | - Pick<S & BaseDashboardState, K> - description: '' - - id: callback - type: () => void - description: '' - inheritanceDescription: Inherited From Component.setState - - name: shouldComponentUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseDashboard.shouldComponentUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called to determine whether the change in props and state should trigger a - re-render. - - - `Component` always returns true. - - `PureComponent` implements a shallow comparison on props and state and - returns true if any - - props or states have changed. - - - If false is returned, , `componentWillUpdate` - - and `componentDidUpdate` will not be called. - remarks: '' - isDeprecated: false - syntax: - content: >- - function shouldComponentUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any): boolean - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseDashboardState> - description: '' - - id: nextContext - type: any - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Component.shouldComponentUpdate - - name: UNSAFE_componentWillMount() - uid: '@microsoft/teamsfx-react.BaseDashboard.UNSAFE_componentWillMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before mounting occurs, and before - . - - Avoid introducing any side-effects or subscriptions in this method. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use [componentDidMount](xref:ComponentLifecycle.componentDidMount) - or the constructor instead - syntax: - content: function UNSAFE_componentWillMount() - inheritanceDescription: Inherited From Component.UNSAFE_componentWillMount - - name: UNSAFE_componentWillReceiveProps(Readonly

, any) - uid: '@microsoft/teamsfx-react.BaseDashboard.UNSAFE_componentWillReceiveProps' - package: '@microsoft/teamsfx-react' - summary: >- - Called when the component may be receiving new props. - - React may call this even if props have not changed, so be sure to compare - new and existing - - props if you only want to handle changes. - - - Calling generally does not trigger this method. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use static - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - instead - syntax: - content: >- - function UNSAFE_componentWillReceiveProps(nextProps: Readonly

, - nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.UNSAFE_componentWillReceiveProps - - name: >- - UNSAFE_componentWillUpdate(Readonly

, Readonly, - any) - uid: '@microsoft/teamsfx-react.BaseDashboard.UNSAFE_componentWillUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before rendering when new props or state is received. - Not called for the initial render. - - - Note: You cannot call here. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: 16.3, use getSnapshotBeforeUpdate instead - syntax: - content: >- - function UNSAFE_componentWillUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseDashboardState> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.UNSAFE_componentWillUpdate -methods: - - name: componentDidMount() - uid: '@microsoft/teamsfx-react.BaseDashboard.componentDidMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called after the component is mounted. You can do initialization that - requires DOM nodes here. You can also make network requests here if you - need to load data from a remote endpoint. - remarks: '' - isDeprecated: false - syntax: - content: 'function componentDidMount(): Promise' - return: - description: '' - type: Promise<void> - - name: componentWillUnmount() - uid: '@microsoft/teamsfx-react.BaseDashboard.componentWillUnmount' - package: '@microsoft/teamsfx-react' - summary: >- - Called before the component is unmounted and destroyed. You can do - necessary cleanup here, such as invalidating timers, canceling network - requests, or removing any DOM elements. - remarks: '' - isDeprecated: false - syntax: - content: function componentWillUnmount() - - name: layout() - uid: '@microsoft/teamsfx-react.BaseDashboard.layout' - package: '@microsoft/teamsfx-react' - summary: Override this method to define the layout of the widget in the dashboard. - remarks: '' - isDeprecated: false - syntax: - content: 'function layout(): undefined | Element' - return: - description: The layout of the widget in the dashboard. - type: undefined | Element - - name: render() - uid: '@microsoft/teamsfx-react.BaseDashboard.render' - package: '@microsoft/teamsfx-react' - summary: Defines the default layout for the dashboard. - remarks: '' - isDeprecated: false - syntax: - content: 'function render(): Element' - return: - description: '' - type: Element - - name: styling() - uid: '@microsoft/teamsfx-react.BaseDashboard.styling' - package: '@microsoft/teamsfx-react' - summary: Override this method to customize the dashboard style. - remarks: '' - isDeprecated: false - syntax: - content: 'function styling(): string' - return: - description: The className for customizing the dashboard style. - type: string -extends: Component<P, S & BaseDashboardState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseWidget.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseWidget.yml deleted file mode 100644 index 27c3dada..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseWidget.yml +++ /dev/null @@ -1,712 +0,0 @@ -### YamlMime:TSType -name: BaseWidget -uid: '@microsoft/teamsfx-react.BaseWidget' -package: '@microsoft/teamsfx-react' -summary: The base component that provides basic functionality to create a widget. -fullName: BaseWidget -remarks: '' -isDeprecated: false -type: class -constructors: - - name: BaseWidget(Readonly

) - uid: '@microsoft/teamsfx-react.BaseWidget.constructor' - package: '@microsoft/teamsfx-react' - summary: Constructor of BaseWidget. - remarks: '' - isDeprecated: false - syntax: - content: 'new BaseWidget(props: Readonly

)' - parameters: - - id: props - type: Readonly<P> - description: The props of the component. -inheritedProperties: - - name: context - uid: '@microsoft/teamsfx-react.BaseWidget.context' - package: '@microsoft/teamsfx-react' - summary: |- - If using the new style context, re-declare this in your class to be the - `React.ContextType` of your `static contextType`. - Should be used with type annotation or static contextType. - - **Example** - - ```ts - static contextType = MyContext - // For TS pre-3.7: - context!: React.ContextType - // For TS 3.7 and above: - declare context: React.ContextType - ``` - - - - See [React Docs](https://react.dev/reference/react/Component#context) - fullName: context - remarks: '' - isDeprecated: false - syntax: - content: 'context: unknown' - return: - description: '' - type: unknown - inheritanceDescription: Inherited From Component.context - - name: contextType - uid: '@microsoft/teamsfx-react.BaseWidget.contextType' - package: '@microsoft/teamsfx-react' - summary: >- - If set, `this.context` will be set at runtime to the current value of the - given Context. - - - **Example** - - - ```ts - - type MyContext = number - - const Ctx = React.createContext(0) - - - class Foo extends React.Component { - static contextType = Ctx - context!: React.ContextType - render () { - return <>My context's value: {this.context}; - } - } - - ``` - - - - - See https://react.dev/reference/react/Component#static-contexttype - fullName: contextType - remarks: '' - isDeprecated: false - syntax: - content: 'static contextType?: Context' - return: - description: '' - type: Context<any> - inheritanceDescription: Inherited From Component.contextType - - name: props - uid: '@microsoft/teamsfx-react.BaseWidget.props' - package: '@microsoft/teamsfx-react' - summary: '' - fullName: props - remarks: '' - isDeprecated: false - syntax: - content: 'props: Readonly

' - return: - description: '' - type: Readonly<P> - inheritanceDescription: Inherited From Component.props - - name: refs - uid: '@microsoft/teamsfx-react.BaseWidget.refs' - package: '@microsoft/teamsfx-react' - summary: >- - - - See [Legacy React - Docs](https://legacy.reactjs.org/docs/refs-and-the-dom.html#legacy-api-string-refs) - fullName: refs - remarks: '' - isDeprecated: true - customDeprecatedMessage: '' - syntax: - content: 'refs: {[key: string]: ReactInstance}' - return: - description: '' - type: '{[key: string]: ReactInstance}' - inheritanceDescription: Inherited From Component.refs - - name: state - uid: '@microsoft/teamsfx-react.BaseWidget.state' - package: '@microsoft/teamsfx-react' - summary: '' - fullName: state - remarks: '' - isDeprecated: false - syntax: - content: 'state: Readonly' - return: - description: '' - type: Readonly<S & BaseWidgetState> - inheritanceDescription: Inherited From Component.state -inheritedMethods: - - name: componentDidCatch(Error, ErrorInfo) - uid: '@microsoft/teamsfx-react.BaseWidget.componentDidCatch' - package: '@microsoft/teamsfx-react' - summary: >- - Catches exceptions generated in descendant components. Unhandled - exceptions will cause - - the entire component tree to unmount. - remarks: '' - isDeprecated: false - syntax: - content: 'function componentDidCatch(error: Error, errorInfo: ErrorInfo)' - parameters: - - id: error - type: Error - description: '' - - id: errorInfo - type: ErrorInfo - description: '' - inheritanceDescription: Inherited From Component.componentDidCatch - - name: componentDidUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseWidget.componentDidUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately after updating occurs. Not called for the initial - render. - - - The snapshot is only present if - [getSnapshotBeforeUpdate](xref:@microsoft/teamsfx-react.BaseWidget.getSnapshotBeforeUpdate) - is present and returns non-null. - remarks: '' - isDeprecated: false - syntax: - content: >- - function componentDidUpdate(prevProps: Readonly

, prevState: - Readonly, snapshot?: any) - parameters: - - id: prevProps - type: Readonly<P> - description: '' - - id: prevState - type: Readonly<S & BaseWidgetState> - description: '' - - id: snapshot - type: any - description: '' - inheritanceDescription: Inherited From Component.componentDidUpdate - - name: componentWillMount() - uid: '@microsoft/teamsfx-react.BaseWidget.componentWillMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before mounting occurs, and before - . - - Avoid introducing any side-effects or subscriptions in this method. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use [componentDidMount](xref:ComponentLifecycle.componentDidMount) - or the constructor instead; will stop working in React 17 - syntax: - content: function componentWillMount() - inheritanceDescription: Inherited From Component.componentWillMount - - name: componentWillReceiveProps(Readonly

, any) - uid: '@microsoft/teamsfx-react.BaseWidget.componentWillReceiveProps' - package: '@microsoft/teamsfx-react' - summary: >- - Called when the component may be receiving new props. - - React may call this even if props have not changed, so be sure to compare - new and existing - - props if you only want to handle changes. - - - Calling generally does not trigger this method. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use static - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - instead; will stop working in React 17 - syntax: - content: >- - function componentWillReceiveProps(nextProps: Readonly

, nextContext: - any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.componentWillReceiveProps - - name: componentWillUnmount() - uid: '@microsoft/teamsfx-react.BaseWidget.componentWillUnmount' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before a component is destroyed. Perform any necessary - cleanup in this method, such as - - cancelled network requests, or cleaning up any DOM elements created in - `componentDidMount`. - remarks: '' - isDeprecated: false - syntax: - content: function componentWillUnmount() - inheritanceDescription: Inherited From Component.componentWillUnmount - - name: componentWillUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseWidget.componentWillUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before rendering when new props or state is received. - Not called for the initial render. - - - Note: You cannot call here. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: 16.3, use getSnapshotBeforeUpdate instead; will stop working in React 17 - syntax: - content: >- - function componentWillUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseWidgetState> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.componentWillUpdate - - name: forceUpdate(() => void) - uid: '@microsoft/teamsfx-react.BaseWidget.forceUpdate' - package: '@microsoft/teamsfx-react' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function forceUpdate(callback?: () => void)' - parameters: - - id: callback - type: () => void - description: '' - inheritanceDescription: Inherited From Component.forceUpdate - - name: getSnapshotBeforeUpdate(Readonly

, Readonly) - uid: '@microsoft/teamsfx-react.BaseWidget.getSnapshotBeforeUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Runs before React applies the result of [render](xref:Component.render) to - the document, and - - returns an object to be given to - [componentDidUpdate](xref:@microsoft/teamsfx-react.BaseWidget.componentDidUpdate). - Useful for saving - - things such as scroll position before [render](xref:Component.render) - causes changes to it. - - - Note: the presence of this method prevents any of the deprecated - - lifecycle events from running. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getSnapshotBeforeUpdate(prevProps: Readonly

, prevState: - Readonly): any - parameters: - - id: prevProps - type: Readonly<P> - description: '' - - id: prevState - type: Readonly<S & BaseWidgetState> - description: '' - return: - description: '' - type: any - inheritanceDescription: Inherited From Component.getSnapshotBeforeUpdate - - name: >- - setState(null | (S & BaseWidgetState) | (prevState: Readonly, props: Readonly

) => null | (S & BaseWidgetState) | - Pick | Pick, () => void) - uid: '@microsoft/teamsfx-react.BaseWidget.setState' - package: '@microsoft/teamsfx-react' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function setState(state: null | (S & BaseWidgetState) | (prevState: - Readonly, props: Readonly

) => null | (S & - BaseWidgetState) | Pick | Pick, callback?: () => void) - parameters: - - id: state - type: >- - null | (S & BaseWidgetState) | (prevState: Readonly<S & - BaseWidgetState>, props: Readonly<P>) => null | (S & - BaseWidgetState) | Pick<S & BaseWidgetState, K> | Pick<S & - BaseWidgetState, K> - description: '' - - id: callback - type: () => void - description: '' - inheritanceDescription: Inherited From Component.setState - - name: shouldComponentUpdate(Readonly

, Readonly, any) - uid: '@microsoft/teamsfx-react.BaseWidget.shouldComponentUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called to determine whether the change in props and state should trigger a - re-render. - - - `Component` always returns true. - - `PureComponent` implements a shallow comparison on props and state and - returns true if any - - props or states have changed. - - - If false is returned, , `componentWillUpdate` - - and `componentDidUpdate` will not be called. - remarks: '' - isDeprecated: false - syntax: - content: >- - function shouldComponentUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any): boolean - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseWidgetState> - description: '' - - id: nextContext - type: any - description: '' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From Component.shouldComponentUpdate - - name: UNSAFE_componentWillMount() - uid: '@microsoft/teamsfx-react.BaseWidget.UNSAFE_componentWillMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before mounting occurs, and before - . - - Avoid introducing any side-effects or subscriptions in this method. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#initializing-state - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use [componentDidMount](xref:ComponentLifecycle.componentDidMount) - or the constructor instead - syntax: - content: function UNSAFE_componentWillMount() - inheritanceDescription: Inherited From Component.UNSAFE_componentWillMount - - name: UNSAFE_componentWillReceiveProps(Readonly

, any) - uid: '@microsoft/teamsfx-react.BaseWidget.UNSAFE_componentWillReceiveProps' - package: '@microsoft/teamsfx-react' - summary: >- - Called when the component may be receiving new props. - - React may call this even if props have not changed, so be sure to compare - new and existing - - props if you only want to handle changes. - - - Calling generally does not trigger this method. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#updating-state-based-on-props - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - 16.3, use static - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - instead - syntax: - content: >- - function UNSAFE_componentWillReceiveProps(nextProps: Readonly

, - nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.UNSAFE_componentWillReceiveProps - - name: >- - UNSAFE_componentWillUpdate(Readonly

, Readonly, - any) - uid: '@microsoft/teamsfx-react.BaseWidget.UNSAFE_componentWillUpdate' - package: '@microsoft/teamsfx-react' - summary: >- - Called immediately before rendering when new props or state is received. - Not called for the initial render. - - - Note: You cannot call here. - - - This method will not stop working in React 17. - - - Note: the presence of - [getSnapshotBeforeUpdate](xref:NewLifecycle.getSnapshotBeforeUpdate) - - or - [getDerivedStateFromProps](xref:StaticLifecycle.getDerivedStateFromProps) - prevents - - this from being invoked. - - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#reading-dom-properties-before-an-update - - See - https://legacy.reactjs.org/blog/2018/03/27/update-on-async-rendering.html#gradual-migration-path - remarks: '' - isDeprecated: true - customDeprecatedMessage: 16.3, use getSnapshotBeforeUpdate instead - syntax: - content: >- - function UNSAFE_componentWillUpdate(nextProps: Readonly

, nextState: - Readonly, nextContext: any) - parameters: - - id: nextProps - type: Readonly<P> - description: '' - - id: nextState - type: Readonly<S & BaseWidgetState> - description: '' - - id: nextContext - type: any - description: '' - inheritanceDescription: Inherited From Component.UNSAFE_componentWillUpdate -methods: - - name: body() - uid: '@microsoft/teamsfx-react.BaseWidget.body' - package: '@microsoft/teamsfx-react' - summary: >- - The purpose of this method is to provide a way for you to add custom body - content to the widget. - - By overriding this method, you can add additional functionality or styling - to the widget's body. - - If the method is not overridden, the widget will return undefined as the - default value for the body, indicating that no custom body content has - been defined. - remarks: '' - isDeprecated: false - syntax: - content: 'function body(): undefined | Element' - return: - description: An optional JSX.Element representing the body of the widget. - type: undefined | Element - - name: componentDidMount() - uid: '@microsoft/teamsfx-react.BaseWidget.componentDidMount' - package: '@microsoft/teamsfx-react' - summary: >- - Called after the component is mounted. You can do initialization that - requires DOM nodes here. You can also make network requests here if you - need to load data from a remote endpoint. - remarks: '' - isDeprecated: false - syntax: - content: 'function componentDidMount(): Promise' - return: - description: '' - type: Promise<void> - - name: footer() - uid: '@microsoft/teamsfx-react.BaseWidget.footer' - package: '@microsoft/teamsfx-react' - summary: >- - The purpose of this method is to provide a way for you to add custom - footer content to the widget. - - By overriding this method, you can add additional functionality or styling - to the widget's footer. - - If the method is not overridden, the widget will return undefined as the - default value for the footer, indicating that no custom footer content has - been defined. - remarks: '' - isDeprecated: false - syntax: - content: 'function footer(): undefined | Element' - return: - description: An optional JSX.Element representing the footer of the widget. - type: undefined | Element - - name: getData() - uid: '@microsoft/teamsfx-react.BaseWidget.getData' - package: '@microsoft/teamsfx-react' - summary: Get data required by the widget - remarks: '' - isDeprecated: false - syntax: - content: 'function getData(): Promise' - return: - description: Data for the widget - type: Promise<S> - - name: header() - uid: '@microsoft/teamsfx-react.BaseWidget.header' - package: '@microsoft/teamsfx-react' - summary: >- - The purpose of this method is to provide a way for you to add custom - header content to the widget. - - By overriding this method, you can add additional functionality or styling - to the widget's header. - - If the method is not overridden, the widget will return undefined as the - default value for the header, indicating that no custom header content has - been defined. - remarks: '' - isDeprecated: false - syntax: - content: 'function header(): undefined | Element' - return: - description: An optional JSX.Element representing the header of the widget. - type: undefined | Element - - name: loading() - uid: '@microsoft/teamsfx-react.BaseWidget.loading' - package: '@microsoft/teamsfx-react' - summary: >- - This method is typically called when the widget is in the process of - fetching data. - - The `undefined` return value is used to indicate that no loading indicator - is required. - - If a loading indicator is required, the method can return a `JSX.Element` - containing the necessary components to render the loading indicator. - remarks: '' - isDeprecated: false - syntax: - content: 'function loading(): undefined | Element' - return: - description: A JSX element or `undefined` if no loading indicator is required. - type: undefined | Element - - name: render() - uid: '@microsoft/teamsfx-react.BaseWidget.render' - package: '@microsoft/teamsfx-react' - summary: Defines the default layout for the widget. - remarks: '' - isDeprecated: false - syntax: - content: 'function render(): Element' - return: - description: '' - type: Element - - name: styling() - uid: '@microsoft/teamsfx-react.BaseWidget.styling' - package: '@microsoft/teamsfx-react' - summary: >- - Override this method to returns an object that defines the class names for - the different parts of the widget. - - The returned object conforms to the - [IWidgetClassNames](xref:@microsoft/teamsfx-react.IWidgetClassNames) - interface which defines the possible keys and values for the class names. - remarks: '' - isDeprecated: false - syntax: - content: 'function styling(): IWidgetClassNames' - return: - description: >- - An object that defines the class names for the different parts of the - widget. - type: -extends: Component<P, S & BaseWidgetState> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/IWidgetClassNames.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/IWidgetClassNames.yml deleted file mode 100644 index 148401f1..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/IWidgetClassNames.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: IWidgetClassNames -uid: '@microsoft/teamsfx-react.IWidgetClassNames' -package: '@microsoft/teamsfx-react' -summary: Interface for defining the class names of widget elements -fullName: IWidgetClassNames -remarks: '' -isDeprecated: false -type: interface -properties: - - name: body - uid: '@microsoft/teamsfx-react.IWidgetClassNames.body' - package: '@microsoft/teamsfx-react' - summary: The class name for the body part of the widget. - fullName: body - remarks: '' - isDeprecated: false - syntax: - content: 'body?: string' - return: - description: '' - type: string - - name: footer - uid: '@microsoft/teamsfx-react.IWidgetClassNames.footer' - package: '@microsoft/teamsfx-react' - summary: The class name for the footer part of the widget. - fullName: footer - remarks: '' - isDeprecated: false - syntax: - content: 'footer?: string' - return: - description: '' - type: string - - name: header - uid: '@microsoft/teamsfx-react.IWidgetClassNames.header' - package: '@microsoft/teamsfx-react' - summary: The class name for the header part of the widget. - fullName: header - remarks: '' - isDeprecated: false - syntax: - content: 'header?: string' - return: - description: '' - type: string - - name: root - uid: '@microsoft/teamsfx-react.IWidgetClassNames.root' - package: '@microsoft/teamsfx-react' - summary: The class name for the root part of the widget. - fullName: root - remarks: '' - isDeprecated: false - syntax: - content: 'root?: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/TeamsContextWithCredential.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/TeamsContextWithCredential.yml deleted file mode 100644 index 2f93aafa..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/TeamsContextWithCredential.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSTypeAlias -name: TeamsContextWithCredential -uid: '@microsoft/teamsfx-react.TeamsContextWithCredential' -package: '@microsoft/teamsfx-react' -summary: '' -fullName: TeamsContextWithCredential -remarks: '' -isDeprecated: false -syntax: | - type TeamsContextWithCredential = { - context?: any - error: unknown - inTeams?: boolean - loading: boolean - teamsUserCredential?: TeamsUserCredential - theme: Theme - themeString: string - } diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/index.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/index.yml deleted file mode 100644 index ec601d73..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/index.yml +++ /dev/null @@ -1,111 +0,0 @@ -### YamlMime:TSPackage -uid: '@microsoft/teamsfx-react' -name: '@microsoft/teamsfx-react' -summary: '' -type: package -classes: - - '@microsoft/teamsfx-react.BaseDashboard' - - '@microsoft/teamsfx-react.BaseWidget' -interfaces: - - '@microsoft/teamsfx-react.IWidgetClassNames' -typeAliases: - - '@microsoft/teamsfx-react.TeamsContextWithCredential' -functions: - - name: 'useData(() => Promise, { autoLoad: boolean })' - uid: '@microsoft/teamsfx-react.useData' - package: '@microsoft/teamsfx-react' - summary: Helper function to fetch data with status and error. - remarks: '' - isDeprecated: false - syntax: - content: >- - function useData(fetchDataAsync: () => Promise, options?: { - autoLoad: boolean }): Data - parameters: - - id: fetchDataAsync - type: () => Promise<T> - description: async function of how to fetch data - - id: options - type: '{ autoLoad: boolean }' - description: if autoLoad is true, reload data immediately - return: - description: data, loading status, error and reload function - type: Data<T> - - name: >- - useGraphWithCredential((graph: Client, credential: TeamsUserCredential, - scope: string[]) => Promise, GraphOptionWithCredential) - uid: '@microsoft/teamsfx-react.useGraphWithCredential' - package: '@microsoft/teamsfx-react' - summary: Helper function to call Microsoft Graph API with authentication. - remarks: '' - isDeprecated: false - syntax: - content: >- - function useGraphWithCredential(fetchGraphDataAsync: (graph: Client, - credential: TeamsUserCredential, scope: string[]) => Promise, - options?: GraphOptionWithCredential): Data - parameters: - - id: fetchGraphDataAsync - type: >- - (graph: Client, credential: TeamsUserCredential, scope: string[]) - => Promise<T> - description: async function of how to call Graph API and fetch data. - - id: options - type: GraphOptionWithCredential - description: Authentication configuration and OAuth resource scope. - return: - description: data, loading status, error and reload function - type: Data<T> - - name: >- - useTeams({ initialTheme?: string, setThemeHandler?: (theme?: string) => - void }) - uid: '@microsoft/teamsfx-react.useTeams' - package: '@microsoft/teamsfx-react' - summary: Microsoft Teams React hook - remarks: '' - isDeprecated: false - syntax: - content: >- - function useTeams(options?: { initialTheme?: string, setThemeHandler?: - (theme?: string) => void }): [{ context?: app.Context, fullScreen?: - boolean, inTeams?: boolean, loading?: boolean, theme: Theme, - themeString: string }, { setTheme: (theme: string | undefined) => void - }] - parameters: - - id: options - type: >- - { initialTheme?: string, setThemeHandler?: (theme?: string) => - void } - description: optional options - return: - description: |- - A tuple with properties and methods - properties: - - inTeams: boolean = true if inside Microsoft Teams - - fullscreen: boolean = true if in full screen mode - - theme: Fluent UI Theme - - themeString: string - representation of the theme (default, dark or contrast) - - context - the Microsoft Teams JS SDK context - methods: - - setTheme - manually set the theme - type: >- - [{ context?: , fullScreen?: boolean, - inTeams?: boolean, loading?: boolean, theme: Theme, themeString: - string }, { setTheme: (theme: string | undefined) => void }] - - name: useTeamsUserCredential(TeamsUserCredentialAuthConfig) - uid: '@microsoft/teamsfx-react.useTeamsUserCredential' - package: '@microsoft/teamsfx-react' - summary: Initialize TeamsFx SDK with customized configuration. - remarks: '' - isDeprecated: false - syntax: - content: >- - function useTeamsUserCredential(authConfig: - TeamsUserCredentialAuthConfig): TeamsContextWithCredential - parameters: - - id: authConfig - type: - description: custom configuration to override default ones. - return: - description: TeamsContextWithCredential object - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AdaptiveCardResponse.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AdaptiveCardResponse.yml deleted file mode 100644 index 01dc645c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AdaptiveCardResponse.yml +++ /dev/null @@ -1,31 +0,0 @@ -### YamlMime:TSEnum -name: AdaptiveCardResponse -uid: '@microsoft/teamsfx.AdaptiveCardResponse' -package: '@microsoft/teamsfx' -summary: Options used to control how the response card will be sent to users. -fullName: AdaptiveCardResponse -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: ReplaceForInteractor - uid: '@microsoft/teamsfx.AdaptiveCardResponse.ReplaceForInteractor' - package: '@microsoft/teamsfx' - summary: >- - The response card will be replaced the current one for the interactor who - trigger the action. - numericValue: 0 - - name: ReplaceForAll - uid: '@microsoft/teamsfx.AdaptiveCardResponse.ReplaceForAll' - package: '@microsoft/teamsfx' - summary: >- - The response card will be replaced the current one for all users in the - chat. - numericValue: 1 - - name: NewForAll - uid: '@microsoft/teamsfx.AdaptiveCardResponse.NewForAll' - package: '@microsoft/teamsfx' - summary: The response card will be sent as a new message for all users in the chat. - numericValue: 2 diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.BotSsoExecutionDialog.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.BotSsoExecutionDialog.yml deleted file mode 100644 index df71b86b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.BotSsoExecutionDialog.yml +++ /dev/null @@ -1,504 +0,0 @@ -### YamlMime:TSType -name: BotSsoExecutionDialog -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog' -package: '@microsoft/teamsfx' -summary: Sso execution dialog, use to handle sso command -fullName: BotSsoExecutionDialog -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: >- - BotSsoExecutionDialog(Storage, TeamsBotSsoPromptSettings, - OnBehalfOfCredentialAuthConfig, string, string) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.constructor - package: '@microsoft/teamsfx' - summary: Creates a new instance of the BotSsoExecutionDialog. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new BotSsoExecutionDialog(dedupStorage: Storage, ssoPromptSettings: - TeamsBotSsoPromptSettings, authConfig: OnBehalfOfCredentialAuthConfig, - initiateLoginEndpoint: string, dialogName?: string) - parameters: - - id: dedupStorage - type: - description: '' - - id: ssoPromptSettings - type: - description: '' - - id: authConfig - type: - description: '' - - id: initiateLoginEndpoint - type: string - description: |- - Login URL for Teams to redirect to. - * - - id: dialogName - type: string - description: |- - custom dialog name - * -properties: - - name: id - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.id' - package: '@microsoft/teamsfx' - summary: Unique ID of the dialog. - fullName: id - remarks: '' - isDeprecated: false - syntax: - content: string id - return: - description: The Id for the dialog. - type: string -inheritedProperties: - - name: dialogs - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.dialogs' - package: '@microsoft/teamsfx' - summary: The containers dialog set. - fullName: dialogs - remarks: '' - isDeprecated: false - syntax: - content: 'dialogs: DialogSet' - return: - description: '' - type: - inheritanceDescription: Inherited From ComponentDialog.dialogs - - name: EndOfTurn - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.EndOfTurn - package: '@microsoft/teamsfx' - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: >- - <any> - inheritanceDescription: Inherited From ComponentDialog.EndOfTurn -inheritedMethods: - - name: addDialog(Dialog<{}>) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.addDialog - package: '@microsoft/teamsfx' - summary: Adds a child Dialog or prompt to the components internal DialogSet. - remarks: >- - The Dialog.id of the first child added to the component will be assigned - to the initialDialogId property. - isDeprecated: false - syntax: - content: 'function addDialog(dialog: Dialog<{}>): BotSsoExecutionDialog' - parameters: - - id: dialog - type: <{}> - description: The child Dialog or prompt to add. - return: - description: The ComponentDialog after the operation is complete. - type: >- - - inheritanceDescription: Inherited From ComponentDialog.addDialog - - name: beginDialog(DialogContext, {}) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.beginDialog - package: '@microsoft/teamsfx' - summary: >- - Called when the dialog is started and pushed onto the parent's dialog - stack. - - By default, this calls the - - Dialog.BeginDialogAsync(DialogContext, object, CancellationToken) method - - of the component dialog's initial dialog, as defined by InitialDialogId. - - Override this method in a derived class to implement interrupt logic. - remarks: >- - If the task is successful, the result indicates whether the dialog is - still - - active after the turn has been processed by the dialog. - isDeprecated: false - syntax: - content: >- - function beginDialog(outerDialogContext: DialogContext, options?: {}): - Promise> - parameters: - - id: outerDialogContext - type: - description: The parent DialogContext for the current turn of conversation. - - id: options - type: '{}' - description: Optional, initial information to pass to the dialog. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.beginDialog - - name: configure(Record) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.configure - package: '@microsoft/teamsfx' - summary: Fluent method for configuring the object. - remarks: '' - isDeprecated: false - syntax: - content: >- - function configure(config: Record): - BotSsoExecutionDialog - parameters: - - id: config - type: Record<string, unknown> - description: Configuration settings to apply. - return: - description: The Configurable after the operation is complete. - type: >- - - inheritanceDescription: Inherited From ComponentDialog.configure - - name: continueDialog(DialogContext) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.continueDialog - package: '@microsoft/teamsfx' - summary: >- - Called when the dialog is _continued_, where it is the active dialog and - the - - user replies with a new Activity. - - If this method is *not* overridden, the dialog automatically ends when the - user replies. - remarks: >- - If the task is successful, the result indicates whether the dialog is - still - - active after the turn has been processed by the dialog. The result may - also contain a - - return value. - isDeprecated: false - syntax: - content: >- - function continueDialog(outerDialogContext: DialogContext): - Promise> - parameters: - - id: outerDialogContext - type: - description: The parent DialogContext for the current turn of conversation. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.continueDialog - - name: createChildContext(DialogContext) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.createChildContext - package: '@microsoft/teamsfx' - summary: Creates the inner dialog context - remarks: '' - isDeprecated: false - syntax: - content: >- - function createChildContext(outerDialogContext: DialogContext): - DialogContext - parameters: - - id: outerDialogContext - type: - description: the outer dialog context - return: - description: The created Dialog Context. - type: - inheritanceDescription: Inherited From ComponentDialog.createChildContext - - name: endDialog(TurnContext, DialogInstance, DialogReason) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.endDialog - package: '@microsoft/teamsfx' - summary: Called when the Dialog is ending. - remarks: >- - When this method is called from the parent dialog's context, the component - Dialog - - cancels all of the dialogs on its inner dialog stack before ending. - isDeprecated: false - syntax: - content: >- - function endDialog(context: TurnContext, instance: DialogInstance, - reason: DialogReason): Promise - parameters: - - id: context - type: - description: The TurnContext object for this turn. - - id: instance - type: >- - <any> - description: >- - State information associated with the instance of this component - Dialog on its parent's dialog stack. - - id: reason - type: - description: Reason why the Dialog ended. - return: - description: A Promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From ComponentDialog.endDialog - - name: findDialog(string) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.findDialog - package: '@microsoft/teamsfx' - summary: Finds a child dialog that was previously added to the container. - remarks: '' - isDeprecated: false - syntax: - content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' - parameters: - - id: dialogId - type: string - description: ID of the dialog to lookup. - return: - description: The Dialog if found; otherwise null. - type: >- - undefined | <{}> - inheritanceDescription: Inherited From ComponentDialog.findDialog - - name: getConverter(string) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.getConverter - package: '@microsoft/teamsfx' - summary: |- - Gets the converter for the selector configuration. - * - remarks: '' - isDeprecated: false - syntax: - content: >- - function getConverter(_property: string): Converter | - ConverterFactory - parameters: - - id: _property - type: string - description: |- - The key of the conditional selector configuration. - * - return: - description: The converter for the selector configuration. - type: >- - <unknown, - unknown> | <unknown, unknown> - inheritanceDescription: Inherited From ComponentDialog.getConverter - - name: getVersion() - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.getVersion - package: '@microsoft/teamsfx' - summary: >- - An encoded string used to aid in the detection of agent changes on - re-deployment. - remarks: >- - This defaults to returning the dialog's `id` but can be overridden to - provide more - - precise change detection logic. Any dialog on the stack that has its - version change will - - result in a `versionChanged` event will be raised. If this event is not - handled by the agent, - - an error will be thrown resulting in the agent error handler logic being - run. - - - Returning an empty string will disable version tracking for the component - all together. - isDeprecated: false - syntax: - content: 'function getVersion(): string' - return: - description: >- - Unique string which should only change when dialog has changed in a - way that should restart the dialog. - type: string - inheritanceDescription: Inherited From ComponentDialog.getVersion - - name: onDialogEvent(DialogContext, DialogEvent) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.onDialogEvent - package: '@microsoft/teamsfx' - summary: |- - Called when an event has been raised, using `DialogContext.emitEvent()`, - by either the current dialog or a dialog that the current dialog started. - remarks: '' - isDeprecated: false - syntax: - content: >- - function onDialogEvent(dialogContext: DialogContext, event: - DialogEvent): Promise - parameters: - - id: dialogContext - type: - description: The dialog context for the current turn of conversation. - - id: event - type: - description: The event being raised. - return: - description: >- - True if the event is handled by the current dialog and bubbling should - stop. - type: Promise<boolean> - inheritanceDescription: Inherited From ComponentDialog.onDialogEvent - - name: repromptDialog(TurnContext, DialogInstance) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.repromptDialog - package: '@microsoft/teamsfx' - summary: Called when the dialog should re-prompt the user for input. - remarks: '' - isDeprecated: false - syntax: - content: >- - function repromptDialog(context: TurnContext, instance: - DialogInstance): Promise - parameters: - - id: context - type: - description: The TurnContext object for this turn. - - id: instance - type: >- - <any> - description: State information for this dialog. - return: - description: A Promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From ComponentDialog.repromptDialog - - name: resumeDialog(DialogContext, DialogReason, any) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.resumeDialog - package: '@microsoft/teamsfx' - summary: >- - Called when a child dialog on the parent's dialog stack completed this - turn, returning - - control to this dialog component. - remarks: >- - If the task is successful, the result indicates whether this dialog is - still - - active after this dialog turn has been processed. - - Generally, the child dialog was started with a call to - - beginDialog(DialogContext, object) in the parent's - - context. However, if the DialogContext.replaceDialog(string, object) - method - - is called, the logical child dialog may be different than the original. - - If this method is *not* overridden, the dialog automatically calls its - - RepromptDialog(ITurnContext, DialogInstance) when the user replies. - isDeprecated: false - syntax: - content: >- - function resumeDialog(outerDialogContext: DialogContext, _reason: - DialogReason, _result?: any): Promise> - parameters: - - id: outerDialogContext - type: - description: The DialogContext for the current turn of conversation. - - id: _reason - type: - description: Reason why the dialog resumed. - - id: _result - type: any - description: |- - Optional, value returned from the dialog that was called. The type - of the value returned is dependent on the child dialog. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.resumeDialog -methods: - - name: addCommand(BotSsoExecutionDialogHandler, TriggerPatterns) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.addCommand - package: '@microsoft/teamsfx' - summary: Add TeamsFxBotSsoCommandHandler instance - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function addCommand(handler: BotSsoExecutionDialogHandler, - triggerPatterns: TriggerPatterns) - parameters: - - id: handler - type: - description: >- - [BotSsoExecutionDialogHandler](xref:@microsoft/teamsfx.BotSsoExecutionDialogHandler) - callback function - - id: triggerPatterns - type: - description: The trigger pattern - - name: run(TurnContext, AgentStatePropertyAccessor) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog.run' - package: '@microsoft/teamsfx' - summary: >- - The run method handles the incoming activity (in the form of a - DialogContext) and passes it through the dialog system. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function run(context: TurnContext, accessor: - AgentStatePropertyAccessor): Promise - parameters: - - id: context - type: - description: The context object for the current turn. - - id: accessor - type: >- - <any> - description: The instance of StatePropertyAccessor for dialog system. - return: - description: '' - type: Promise<void> -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CardActionBot.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CardActionBot.yml deleted file mode 100644 index eb533922..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CardActionBot.yml +++ /dev/null @@ -1,69 +0,0 @@ -### YamlMime:TSType -name: CardActionBot -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot' -package: '@microsoft/teamsfx' -summary: A card action bot to respond to adaptive card universal actions. -fullName: CardActionBot -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: CardActionBot(CloudAdapter, CardActionOptions) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot.constructor' - package: '@microsoft/teamsfx' - summary: Create a new instance of the `CardActionBot`. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new CardActionBot(adapter: CloudAdapter, options?: CardActionOptions)' - parameters: - - id: adapter - type: - description: The bound `CloudAdapter`. - - id: options - type: - description: The initialize options. -methods: - - name: registerHandler(TeamsFxAdaptiveCardActionHandler) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot.registerHandler' - package: '@microsoft/teamsfx' - summary: Register a card action handler to the bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function registerHandler(actionHandler: - TeamsFxAdaptiveCardActionHandler) - parameters: - - id: actionHandler - type: - description: A card action handler to be registered. - - name: registerHandlers(TeamsFxAdaptiveCardActionHandler[]) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot.registerHandlers' - package: '@microsoft/teamsfx' - summary: Register card action handlers to the bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function registerHandlers(actionHandlers: - TeamsFxAdaptiveCardActionHandler[]) - parameters: - - id: actionHandlers - type: [] - description: A set of card action handlers to be registered. diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Channel.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Channel.yml deleted file mode 100644 index fe1a2036..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Channel.yml +++ /dev/null @@ -1,149 +0,0 @@ -### YamlMime:TSType -name: Channel -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel' -package: '@microsoft/teamsfx' -summary: >- - A [NotificationTarget](xref:@microsoft/teamsfx.NotificationTarget) that - represents a team channel. -fullName: Channel -remarks: >- - It's recommended to get channels from - [()](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.channels). -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: Channel(TeamsBotInstallation, ChannelInfo) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.constructor' - package: '@microsoft/teamsfx' - summary: Constructor. - remarks: >- - It's recommended to get channels from - [()](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.channels), - instead of using this constructor. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new Channel(parent: TeamsBotInstallation, info: ChannelInfo)' - parameters: - - id: parent - type: >- - - description: >- - The parent - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - where this channel is created from. - - id: info - type: >- - - description: Detailed channel information. -properties: - - name: info - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.info' - package: '@microsoft/teamsfx' - summary: Detailed channel information. - fullName: info - remarks: '' - isDeprecated: false - syntax: - content: 'info: ChannelInfo' - return: - description: '' - type: - - name: parent - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.parent' - package: '@microsoft/teamsfx' - summary: >- - The parent - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - where this channel is created from. - fullName: parent - remarks: '' - isDeprecated: false - syntax: - content: 'parent: TeamsBotInstallation' - return: - description: '' - type: >- - - - name: type - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.type' - package: '@microsoft/teamsfx' - summary: Notification target type. For channel it's always "Channel". - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: NotificationTargetType' - return: - description: '' - type: -methods: - - name: >- - sendAdaptiveCard(unknown, (context: TurnContext, error: Error) => - Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.sendAdaptiveCard' - package: '@microsoft/teamsfx' - summary: Send an adaptive card message. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function sendAdaptiveCard(card: unknown, onError?: (context: - TurnContext, error: Error) => Promise): Promise - parameters: - - id: card - type: unknown - description: The adaptive card raw JSON. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during adaptive - card sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending adaptive card message. - type: Promise<MessageResponse> - - name: 'sendMessage(string, (context: TurnContext, error: Error) => Promise)' - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel.sendMessage' - package: '@microsoft/teamsfx' - summary: Send a plain text message. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function sendMessage(text: string, onError?: (context: TurnContext, - error: Error) => Promise): Promise - parameters: - - id: text - type: string - description: The plain text message. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during message - sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending message. - type: Promise<MessageResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CommandBot.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CommandBot.yml deleted file mode 100644 index 8e4a8bf4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CommandBot.yml +++ /dev/null @@ -1,111 +0,0 @@ -### YamlMime:TSType -name: CommandBot -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot' -package: '@microsoft/teamsfx' -summary: A command bot for receiving commands and sending responses in Teams. -fullName: CommandBot -remarks: >- - Ensure each command should ONLY be registered with the command once, otherwise - it'll cause unexpected behavior if you register the same command more than - once. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: >- - CommandBot(CloudAdapter, CommandOptions, BotSsoExecutionActivityHandler, - BotSsoConfig) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot.constructor' - package: '@microsoft/teamsfx' - summary: Create a new instance of the `CommandBot`. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new CommandBot(adapter: CloudAdapter, options?: CommandOptions, - ssoCommandActivityHandler?: BotSsoExecutionActivityHandler, ssoConfig?: - BotSsoConfig) - parameters: - - id: adapter - type: - description: The bound `CloudAdapter`. - - id: options - type: - description: The initialize options - - id: ssoCommandActivityHandler - type: - description: SSO execution activity handler. - - id: ssoConfig - type: - description: SSO configuration for Bot SSO. -methods: - - name: registerCommand(TeamsFxBotCommandHandler) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot.registerCommand' - package: '@microsoft/teamsfx' - summary: Register a command into the command bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function registerCommand(command: TeamsFxBotCommandHandler)' - parameters: - - id: command - type: - description: The command to be registered. - - name: registerCommands(TeamsFxBotCommandHandler[]) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot.registerCommands' - package: '@microsoft/teamsfx' - summary: Register commands into the command bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function registerCommands(commands: TeamsFxBotCommandHandler[])' - parameters: - - id: commands - type: [] - description: The commands to be registered. - - name: registerSsoCommand(TeamsFxBotSsoCommandHandler) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot.registerSsoCommand' - package: '@microsoft/teamsfx' - summary: Register a sso command into the command bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function registerSsoCommand(ssoCommand: TeamsFxBotSsoCommandHandler)' - parameters: - - id: ssoCommand - type: - description: The sso command to be registered. - - name: registerSsoCommands(TeamsFxBotSsoCommandHandler[]) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot.registerSsoCommands' - package: '@microsoft/teamsfx' - summary: Register sso commands into the command bot. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function registerSsoCommands(ssoCommands: TeamsFxBotSsoCommandHandler[])' - parameters: - - id: ssoCommands - type: [] - description: The sso commands to be registered. diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationBot.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationBot.yml deleted file mode 100644 index b574127d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationBot.yml +++ /dev/null @@ -1,228 +0,0 @@ -### YamlMime:TSType -name: ConversationBot -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot' -package: '@microsoft/teamsfx' -summary: >+ - Provide utilities for bot conversation, including: - - handle command and response. - - send notification to varies targets (e.g., member, group, channel). - - **Example** - - - For command and response, you can register your commands through the - constructor, or use the `registerCommand` and `registerCommands` API to add - commands later. - - - ```typescript - - import { BotBuilderCloudAdapter } from "@microsoft/teamsfx"; - - import ConversationBot = BotBuilderCloudAdapter.ConversationBot; - - - // register through constructor - - const conversationBot = new ConversationBot({ - command: { - enabled: true, - commands: [ new HelloWorldCommandHandler() ], - }, - }); - - - // register through `register*` API - - conversationBot.command.registerCommand(new HelpCommandHandler()); - - ``` - - - For notification, you can enable notification at initialization, then send - notifications at any time. - - - ```typescript - - import { BotBuilderCloudAdapter } from "@microsoft/teamsfx"; - - import ConversationBot = BotBuilderCloudAdapter.ConversationBot; - - - // enable through constructor - - const conversationBot = new ConversationBot({ - notification: { - enabled: true, - }, - }); - - - // get all bot installations and send message - - for (const target of await conversationBot.notification.installations()) { - await target.sendMessage("Hello Notification"); - } - - - // alternative - send message to all members - - for (const target of await conversationBot.notification.installations()) { - for (const member of await target.members()) { - await member.sendMessage("Hello Notification"); - } - } - - ``` - -fullName: ConversationBot -remarks: >- - Set `adapter` in - [ConversationOptions](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions) - to use your own bot adapter. - - - For command and response, ensure each command should ONLY be registered with - the command once, otherwise it'll cause unexpected behavior if you register - the same command more than once. - - - For notification, set `notification.storage` in - [ConversationOptions](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions) - to use your own storage implementation. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: ConversationBot(ConversationOptions) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.constructor' - package: '@microsoft/teamsfx' - summary: Create new instance of the `ConversationBot`. - remarks: >- - It's recommended to create your own adapter and storage for production - environment instead of the default one. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new ConversationBot(options: ConversationOptions)' - parameters: - - id: options - type: >- - - description: The initialize options. -properties: - - name: adapter - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.adapter' - package: '@microsoft/teamsfx' - summary: The bot adapter. - fullName: adapter - remarks: '' - isDeprecated: false - syntax: - content: 'adapter: CloudAdapter' - return: - description: '' - type: - - name: cardAction - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.cardAction' - package: '@microsoft/teamsfx' - summary: The action handler used for adaptive card universal actions. - fullName: cardAction - remarks: '' - isDeprecated: false - syntax: - content: 'cardAction?: CardActionBot' - return: - description: '' - type: >- - - - name: command - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.command' - package: '@microsoft/teamsfx' - summary: The entrypoint of command and response. - fullName: command - remarks: '' - isDeprecated: false - syntax: - content: 'command?: CommandBot' - return: - description: '' - type: - - name: notification - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.notification' - package: '@microsoft/teamsfx' - summary: The entrypoint of notification. - fullName: notification - remarks: '' - isDeprecated: false - syntax: - content: 'notification?: NotificationBot' - return: - description: '' - type: >- - -methods: - - name: >- - requestHandler(Request, Record>, any, (context: TurnContext) => Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot.requestHandler' - package: '@microsoft/teamsfx' - summary: |+ - The request handler to integrate with web request. - - **Example** - - For example, to use with Express: - ``` typescript - // The default/empty behavior - const expressApp = express(); - expressApp.use(express.json()); - expressApp.post("/api/notification", conversationBot.requestHandler); - - // Or, add your own logic - const expressApp = express(); - expressApp.use(express.json()); - expressApp.post("/api/notification", async (req, res) => { - await conversationBot.requestHandler(req, res, async (context) => { - // your-own-context-logic - }); - }); - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function requestHandler(req: Request, - Record>, res: any, logic?: - (context: TurnContext) => Promise): Promise - parameters: - - id: req - type: >- - <Record<string, unknown>, Record<string, undefined | - string | string[]>> - description: An incoming HTTP [Request](xref:botbuilder.Request). - - id: res - type: any - description: The corresponding HTTP [Response](xref:botbuilder.Response). - - id: logic - type: '(context: TurnContext) => Promise<any>' - description: The additional function to handle bot context. - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationOptions.yml deleted file mode 100644 index ceda75b6..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationOptions.yml +++ /dev/null @@ -1,108 +0,0 @@ -### YamlMime:TSType -name: ConversationOptions -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions' -package: '@microsoft/teamsfx' -summary: >- - Options to initialize - [ConversationBot](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot) -fullName: ConversationOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: adapter - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.adapter' - package: '@microsoft/teamsfx' - summary: >- - The bot adapter. If not provided, a default adapter will be created: - - - with `adapterConfig` as constructor parameter. - - - with a default error handler that logs error to console, sends trace - activity, and sends error message to user. - fullName: adapter - remarks: >- - If neither `adapter` nor `adapterConfig` is provided, will use BOT_ID and - BOT_PASSWORD from environment variables. - isDeprecated: false - syntax: - content: 'adapter?: CloudAdapter' - return: - description: '' - type: - - name: adapterConfig - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.adapterConfig - package: '@microsoft/teamsfx' - summary: >- - If `adapter` is not provided, this `adapterConfig` will be passed to the - new `CloudAdapter` when created internally. - fullName: adapterConfig - remarks: >- - If neither `adapter` nor `adapterConfig` is provided, will use BOT_ID and - BOT_PASSWORD from environment variables. - isDeprecated: false - syntax: - content: 'adapterConfig?: AuthConfiguration' - return: - description: '' - type: - - name: cardAction - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.cardAction' - package: '@microsoft/teamsfx' - summary: The adaptive card action handler part. - fullName: cardAction - remarks: '' - isDeprecated: false - syntax: - content: 'cardAction?: CardActionOptions & { enabled?: boolean }' - return: - description: '' - type: >- - & { enabled?: - boolean } - - name: command - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.command' - package: '@microsoft/teamsfx' - summary: The command part. - fullName: command - remarks: '' - isDeprecated: false - syntax: - content: 'command?: CommandOptions & { enabled?: boolean }' - return: - description: '' - type: >- - & { enabled?: boolean - } - - name: notification - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.notification - package: '@microsoft/teamsfx' - summary: The notification part. - fullName: notification - remarks: '' - isDeprecated: false - syntax: - content: 'notification?: NotificationOptions_2 & { enabled?: boolean }' - return: - description: '' - type: >- - & { enabled?: boolean } - - name: ssoConfig - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions.ssoConfig' - package: '@microsoft/teamsfx' - summary: Configurations for sso command bot - fullName: ssoConfig - remarks: '' - isDeprecated: false - syntax: - content: 'ssoConfig?: BotSsoConfig' - return: - description: '' - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Member.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Member.yml deleted file mode 100644 index 415bceda..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Member.yml +++ /dev/null @@ -1,142 +0,0 @@ -### YamlMime:TSType -name: Member -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member' -package: '@microsoft/teamsfx' -summary: >- - A [NotificationTarget](xref:@microsoft/teamsfx.NotificationTarget) that - represents a team member. -fullName: Member -remarks: It's recommended to get members from . -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: Member(TeamsBotInstallation, TeamsChannelAccount) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.constructor' - package: '@microsoft/teamsfx' - summary: Constructor. - remarks: >- - It's recommended to get members from - , instead of using this constructor. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new Member(parent: TeamsBotInstallation, account: TeamsChannelAccount)' - parameters: - - id: parent - type: >- - - description: >- - The parent - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - where this member is created from. - - id: account - type: >- - - description: Detailed member account information. -properties: - - name: account - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.account' - package: '@microsoft/teamsfx' - summary: Detailed member account information. - fullName: account - remarks: '' - isDeprecated: false - syntax: - content: 'account: TeamsChannelAccount' - return: - description: '' - type: >- - - - name: parent - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.parent' - package: '@microsoft/teamsfx' - summary: >- - The parent - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - where this member is created from. - fullName: parent - remarks: '' - isDeprecated: false - syntax: - content: 'parent: TeamsBotInstallation' - return: - description: '' - type: >- - - - name: type - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.type' - package: '@microsoft/teamsfx' - summary: Notification target type. For member it's always "Person". - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type: NotificationTargetType' - return: - description: '' - type: -methods: - - name: >- - sendAdaptiveCard(unknown, (context: TurnContext, error: Error) => - Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.sendAdaptiveCard' - package: '@microsoft/teamsfx' - summary: Send an adaptive card message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendAdaptiveCard(card: unknown, onError?: (context: - TurnContext, error: Error) => Promise): Promise - parameters: - - id: card - type: unknown - description: The adaptive card raw JSON. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during adaptive - card sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending adaptive card message. - type: Promise<MessageResponse> - - name: 'sendMessage(string, (context: TurnContext, error: Error) => Promise)' - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member.sendMessage' - package: '@microsoft/teamsfx' - summary: Send a plain text message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendMessage(text: string, onError?: (context: TurnContext, - error: Error) => Promise): Promise - parameters: - - id: text - type: string - description: The plain text message. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during message - sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending message. - type: Promise<MessageResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationBot.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationBot.yml deleted file mode 100644 index 2de5be55..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationBot.yml +++ /dev/null @@ -1,263 +0,0 @@ -### YamlMime:TSType -name: NotificationBot -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot' -package: '@microsoft/teamsfx' -summary: >- - Provide utilities to send notification to varies targets (e.g., member, group, - channel). -fullName: NotificationBot -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: NotificationBot(CloudAdapter, NotificationOptions_2) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of the notification bot. - remarks: >- - To ensure accuracy, it's recommended to initialize before handling any - message. - isDeprecated: false - syntax: - content: >- - new NotificationBot(adapter: CloudAdapter, options?: - NotificationOptions_2) - parameters: - - id: adapter - type: - description: The bound `CloudAdapter` - - id: options - type: >- - - description: The initialize options -methods: - - name: buildTeamsBotInstallation(Partial) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.buildTeamsBotInstallation - package: '@microsoft/teamsfx' - summary: >- - Create a - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - instance with conversation reference. - remarks: '' - isDeprecated: false - syntax: - content: >- - function buildTeamsBotInstallation(conversationReference: - Partial): null | TeamsBotInstallation - parameters: - - id: conversationReference - type: >- - Partial<> - description: The bound `ConversationReference`. - return: - description: >- - - The - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - instance or null. - type: >- - null | - - name: >- - findAllChannels((channel: Channel, teamDetails: undefined | TeamDetails) - => Promise) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findAllChannels - package: '@microsoft/teamsfx' - summary: >- - Return all - [Channel](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel) where - predicate is true, and empty array otherwise. - - (Ensure the bot app is installed into the `General` channel, otherwise - empty array will be returned.) - remarks: '' - isDeprecated: false - syntax: - content: >- - function findAllChannels(predicate: (channel: Channel, teamDetails: - undefined | TeamDetails) => Promise): Promise - parameters: - - id: predicate - type: >- - (channel: Channel, teamDetails: undefined | TeamDetails) => - Promise<boolean> - description: Find calls predicate for each channel of the installation. - return: - description: >- - An array of - [Channel](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel) - where predicate is true, and empty array otherwise. - type: >- - Promise<[]> - - name: 'findAllMembers((member: Member) => Promise, SearchScope)' - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findAllMembers' - package: '@microsoft/teamsfx' - summary: >- - Return all - [Member](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Member) where - predicate is true, and empty array otherwise. - remarks: '' - isDeprecated: false - syntax: - content: >- - function findAllMembers(predicate: (member: Member) => Promise, - scope?: SearchScope): Promise - parameters: - - id: predicate - type: '(member: Member) => Promise<boolean>' - description: Find calls predicate for each member of the installation. - - id: scope - type: >- - - description: |- - The scope to find members from the installations - (personal chat, group chat, Teams channel). - return: - description: >- - An array of - [Member](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Member) - where predicate is true, and empty array otherwise. - type: >- - Promise<[]> - - name: >- - findChannel((channel: Channel, teamDetails: undefined | TeamDetails) => - Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findChannel' - package: '@microsoft/teamsfx' - summary: >- - Return the first - [Channel](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel) where - predicate is true, and undefined otherwise. - - (Ensure the bot app is installed into the `General` channel, otherwise - undefined will be returned.) - remarks: '' - isDeprecated: false - syntax: - content: >- - function findChannel(predicate: (channel: Channel, teamDetails: - undefined | TeamDetails) => Promise): Promise - parameters: - - id: predicate - type: >- - (channel: Channel, teamDetails: undefined | TeamDetails) => - Promise<boolean> - description: >- - Find calls predicate once for each channel of the installation, - - until it finds one where predicate returns true. If such a channel - is found, find - - immediately returns that channel. Otherwise, find returns - `undefined`. - return: - description: >- - The first - [Channel](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel) - where predicate is true, and `undefined` otherwise. - type: >- - Promise<undefined | > - - name: 'findMember((member: Member) => Promise, SearchScope)' - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findMember' - package: '@microsoft/teamsfx' - summary: >- - Return the first - [Member](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Member) where - predicate is true, and undefined otherwise. - remarks: '' - isDeprecated: false - syntax: - content: >- - function findMember(predicate: (member: Member) => Promise, - scope?: SearchScope): Promise - parameters: - - id: predicate - type: '(member: Member) => Promise<boolean>' - description: >- - Find calls predicate once for each member of the installation, - - until it finds one where predicate returns true. If such a member is - found, find - - immediately returns that member. Otherwise, find returns undefined. - - id: scope - type: >- - - description: |- - The scope to find members from the installations - (personal chat, group chat, Teams channel). - return: - description: >- - The first - [Member](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.Member) - where predicate is true, and `undefined` otherwise. - type: >- - Promise<undefined | > - - name: getPagedInstallations(number, string, boolean) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.getPagedInstallations - package: '@microsoft/teamsfx' - summary: Gets a pagined list of targets where the bot is installed. - remarks: The result is retrieving from the persisted storage. - isDeprecated: false - syntax: - content: >- - function getPagedInstallations(pageSize?: number, continuationToken?: - string, validationEnabled?: boolean): - Promise> - parameters: - - id: pageSize - type: number - description: Suggested number of entries on a page. - - id: continuationToken - type: string - description: A continuation token. - - id: validationEnabled - type: boolean - description: '' - return: - description: >- - An array of - [TeamsBotInstallation](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation) - with paged data and continuation token. - type: >- - Promise<<>> - - name: validateInstallation(Partial) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.validateInstallation - package: '@microsoft/teamsfx' - summary: Validate the installation by getting paged memebers. - remarks: '' - isDeprecated: false - syntax: - content: >- - function validateInstallation(conversationReference: - Partial): Promise - parameters: - - id: conversationReference - type: >- - Partial<> - description: The bound `ConversationReference`. - return: - description: >- - Returns false if recieves `BotNotInConversationRoster` error, - otherwise returns true. - type: Promise<boolean> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationOptions.yml deleted file mode 100644 index f40e3da4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationOptions.yml +++ /dev/null @@ -1,49 +0,0 @@ -### YamlMime:TSType -name: NotificationOptions -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions' -package: '@microsoft/teamsfx' -summary: >- - Options to initialize - [NotificationBot](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot). -fullName: NotificationOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: botAppId - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions.botAppId' - package: '@microsoft/teamsfx' - summary: An optional input of bot app Id. - fullName: botAppId - remarks: >- - If `botAppId` is not provided, `process.env.BOT_ID` will be used by - default. - isDeprecated: false - syntax: - content: 'botAppId?: string' - return: - description: '' - type: string - - name: store - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions.store' - package: '@microsoft/teamsfx' - summary: An optional store to persist bot notification target references. - fullName: store - remarks: >- - If `store` is not provided, a default conversation reference store will be - used, - - which stores notification target references into: - - `.notification.localstore.json` if running locally - - `${process.env.TEMP}/.notification.localstore.json` if `process.env.RUNNING_ON_AZURE` is set to "1" - - It's recommended to use your own store for production environment. - isDeprecated: false - syntax: - content: 'store?: ConversationReferenceStore' - return: - description: '' - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.SearchScope.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.SearchScope.yml deleted file mode 100644 index 185e4112..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.SearchScope.yml +++ /dev/null @@ -1,43 +0,0 @@ -### YamlMime:TSEnum -name: SearchScope -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope' -package: '@microsoft/teamsfx' -summary: >- - The search scope when calling - [findMember](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findMember) - and - [findAllMembers](xref:@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot.findAllMembers). - - The search scope is a flagged enum and it can be combined with `|`. - - For example, to search from personal chat and group chat, use - `SearchScope.Person | SearchScope.Group`. -fullName: SearchScope -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: Person - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope.Person' - package: '@microsoft/teamsfx' - summary: Search members from the installations in personal chat only. - numericValue: 1 - - name: Group - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope.Group' - package: '@microsoft/teamsfx' - summary: Search members from the installations in group chat only. - numericValue: 2 - - name: Channel - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope.Channel' - package: '@microsoft/teamsfx' - summary: Search members from the installations in Teams channel only. - numericValue: 4 - - name: All - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope.All' - package: '@microsoft/teamsfx' - summary: >- - Search members from all installations including personal chat, group chat - and Teams channel. - numericValue: 7 diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.TeamsBotInstallation.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.TeamsBotInstallation.yml deleted file mode 100644 index 99c545a5..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.TeamsBotInstallation.yml +++ /dev/null @@ -1,214 +0,0 @@ -### YamlMime:TSType -name: TeamsBotInstallation -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation' -package: '@microsoft/teamsfx' -summary: >- - A [NotificationTarget](xref:@microsoft/teamsfx.NotificationTarget) that - represents a bot installation. Teams Bot could be installed into - - - Personal chat - - - Group chat - - - Team (by default the `General` channel) -fullName: TeamsBotInstallation -remarks: >- - It's recommended to get bot installations from - . -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: TeamsBotInstallation(CloudAdapter, Partial, string) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.constructor - package: '@microsoft/teamsfx' - summary: Constructor - remarks: >- - It's recommended to get bot installations from - , instead of using this constructor. - isDeprecated: false - syntax: - content: >- - new TeamsBotInstallation(adapter: CloudAdapter, conversationReference: - Partial, botAppId: string) - parameters: - - id: adapter - type: - description: The bound `CloudAdapter`. - - id: conversationReference - type: >- - Partial<> - description: The bound `ConversationReference`. - - id: botAppId - type: string - description: The bot app id. -properties: - - name: adapter - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.adapter' - package: '@microsoft/teamsfx' - summary: The bound `CloudAdapter`. - fullName: adapter - remarks: '' - isDeprecated: false - syntax: - content: 'adapter: CloudAdapter' - return: - description: '' - type: - - name: botAppId - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.botAppId' - package: '@microsoft/teamsfx' - summary: The bot app id. - fullName: botAppId - remarks: '' - isDeprecated: false - syntax: - content: 'botAppId: string' - return: - description: '' - type: string - - name: conversationReference - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.conversationReference - package: '@microsoft/teamsfx' - summary: The bound `ConversationReference`. - fullName: conversationReference - remarks: '' - isDeprecated: false - syntax: - content: 'conversationReference: Partial' - return: - description: '' - type: >- - Partial<> - - name: type - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.type' - package: '@microsoft/teamsfx' - summary: Notification target type. - fullName: type - remarks: >- - - "Channel" means bot is installed into a team and notification will be - sent to its "General" channel. - - - "Group" means bot is installed into a group chat. - - - "Person" means bot is installed into a personal scope and notification - will be sent to personal chat. - isDeprecated: false - syntax: - content: 'type?: NotificationTargetType' - return: - description: '' - type: -methods: - - name: channels() - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.channels' - package: '@microsoft/teamsfx' - summary: Get channels from this bot installation. - remarks: '' - isDeprecated: false - syntax: - content: 'function channels(): Promise' - return: - description: >- - An array of channels if bot is installed into a team, otherwise - returns an empty array. - type: >- - Promise<[]> - - name: getPagedMembers(number, string) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.getPagedMembers - package: '@microsoft/teamsfx' - summary: Gets a pagined list of members from this bot installation. - remarks: '' - isDeprecated: false - syntax: - content: >- - function getPagedMembers(pageSize?: number, continuationToken?: string): - Promise> - parameters: - - id: pageSize - type: number - description: Suggested number of entries on a page. - - id: continuationToken - type: string - description: A continuation token. - return: - description: An array of members from where the bot is installed. - type: >- - Promise<<>> - - name: getTeamDetails() - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.getTeamDetails - package: '@microsoft/teamsfx' - summary: Get team details from this bot installation - remarks: '' - isDeprecated: false - syntax: - content: 'function getTeamDetails(): Promise' - return: - description: >- - The team details if bot is installed into a team, otherwise returns - `undefined`. - type: >- - Promise<undefined | > - - name: >- - sendAdaptiveCard(unknown, (context: TurnContext, error: Error) => - Promise) - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.sendAdaptiveCard - package: '@microsoft/teamsfx' - summary: Send an adaptive card message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendAdaptiveCard(card: unknown, onError?: (context: - TurnContext, error: Error) => Promise): Promise - parameters: - - id: card - type: unknown - description: The adaptive card raw JSON. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during adaptive - card sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending adaptive card message. - type: Promise<MessageResponse> - - name: 'sendMessage(string, (context: TurnContext, error: Error) => Promise)' - uid: >- - @microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation.sendMessage - package: '@microsoft/teamsfx' - summary: Send a plain text message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendMessage(text: string, onError?: (context: TurnContext, - error: Error) => Promise): Promise - parameters: - - id: text - type: string - description: The plain text message. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during message - sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending message. - type: Promise<MessageResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.yml deleted file mode 100644 index 37894868..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.yml +++ /dev/null @@ -1,89 +0,0 @@ -### YamlMime:TSPackage -uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter' -name: AgentBuilderCloudAdapter -summary: '' -type: module -classes: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation' -interfaces: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions' -enums: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope' -package: '@microsoft/teamsfx' -functions: - - name: >- - sendAdaptiveCard(NotificationTarget, unknown, (context: TurnContext, - error: Error) => Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.sendAdaptiveCard' - package: '@microsoft/teamsfx' - summary: Send an adaptive card message to a notification target. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function sendAdaptiveCard(target: NotificationTarget, card: unknown, - onError?: (context: TurnContext, error: Error) => Promise): - Promise - parameters: - - id: target - type: - description: The notification target. - - id: card - type: unknown - description: The adaptive card raw JSON. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during adaptive - card sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending adaptive card message. - type: Promise<MessageResponse> - - name: >- - sendMessage(NotificationTarget, string, (context: TurnContext, error: - Error) => Promise) - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.sendMessage' - package: '@microsoft/teamsfx' - summary: Send a plain text message to a notification target. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function sendMessage(target: NotificationTarget, text: string, onError?: - (context: TurnContext, error: Error) => Promise): - Promise - parameters: - - id: target - type: - description: The notification target. - - id: text - type: string - description: The plain text message. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - An optional error handler that can catch exceptions during message - sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: The response of sending message. - type: Promise<MessageResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyLocation.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyLocation.yml deleted file mode 100644 index ed81bc62..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyLocation.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSEnum -name: ApiKeyLocation -uid: '@microsoft/teamsfx.ApiKeyLocation' -package: '@microsoft/teamsfx' -summary: Define available location for API Key location -fullName: ApiKeyLocation -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: Header - uid: '@microsoft/teamsfx.ApiKeyLocation.Header' - package: '@microsoft/teamsfx' - summary: The API Key is placed in request header - numericValue: 0 - - name: QueryParams - uid: '@microsoft/teamsfx.ApiKeyLocation.QueryParams' - package: '@microsoft/teamsfx' - summary: The API Key is placed in query parameter - numericValue: 1 diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyProvider.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyProvider.yml deleted file mode 100644 index 83636b83..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyProvider.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: ApiKeyProvider -uid: '@microsoft/teamsfx.ApiKeyProvider' -package: '@microsoft/teamsfx' -summary: Provider that handles API Key authentication -fullName: ApiKeyProvider -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: ApiKeyProvider(string, string, ApiKeyLocation) - uid: '@microsoft/teamsfx.ApiKeyProvider.constructor' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new ApiKeyProvider(keyName: string, keyValue: string, keyLocation: - ApiKeyLocation) - parameters: - - id: keyName - type: string - description: The name of request header or query parameter that specifies API Key - - id: keyValue - type: string - description: The value of API Key - - id: keyLocation - type: - description: 'The location of API Key: request header or query parameter.' -methods: - - name: AddAuthenticationInfo(AxiosRequestConfig) - uid: '@microsoft/teamsfx.ApiKeyProvider.AddAuthenticationInfo' - package: '@microsoft/teamsfx' - summary: Adds authentication info to http requests - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function AddAuthenticationInfo(config: AxiosRequestConfig): - Promise> - parameters: - - id: config - type: AxiosRequestConfig<any> - description: >- - Contains all the request information and can be updated to include - extra authentication info. - - Refer https://axios-http.com/docs/req_config for detailed document. - return: - description: Updated axios request config. - type: Promise<AxiosRequestConfig<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredential.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredential.yml deleted file mode 100644 index 7c20f771..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredential.yml +++ /dev/null @@ -1,101 +0,0 @@ -### YamlMime:TSType -name: AppCredential -uid: '@microsoft/teamsfx.AppCredential' -package: '@microsoft/teamsfx' -summary: >+ - Represent Microsoft 365 tenant identity, and it is usually used when user is - not involved like time-triggered automation job. - - - **Example** - - - ```typescript - - loadConfiguration(); // load configuration from environment variables - - const credential = new AppCredential(); - - ``` - -fullName: AppCredential -remarks: Only works in in server side. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: AppCredential(OnBehalfOfCredentialAuthConfig) - uid: '@microsoft/teamsfx.AppCredential.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of AppCredential. - remarks: Only works in in server side. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new AppCredential(authConfig: OnBehalfOfCredentialAuthConfig)' - parameters: - - id: authConfig - type: - description: The authentication configuration. -methods: - - name: getToken(string | string[], GetTokenOptions) - uid: '@microsoft/teamsfx.AppCredential.getToken' - package: '@microsoft/teamsfx' - summary: >+ - Get access token for credential. - - - **Example** - - - ```typescript - - await credential.getToken(["User.Read.All"]) // Get Graph access token for - single scope using string array - - await credential.getToken("User.Read.All") // Get Graph access token for - single scope using string - - await credential.getToken(["User.Read.All", "Calendars.Read"]) // Get - Graph access token for multiple scopes using string array - - await credential.getToken("User.Read.All Calendars.Read") // Get Graph - access token for multiple scopes using space-separated string - - await credential.getToken("https://graph.microsoft.com/User.Read.All") // - Get Graph access token with full resource URI - - await credential.getToken(["https://outlook.office.com/Mail.Read"]) // Get - Outlook access token - - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function getToken(scopes: string | string[], options?: GetTokenOptions): - Promise - parameters: - - id: scopes - type: string | string[] - description: The list of scopes for which the token will have access. - - id: options - type: - description: >- - The options used to configure any requests this TokenCredential - implementation might make. - return: - description: |- - Access token with expected scopes. - * Throw error if get access token failed. - type: Promise<null | > diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredentialAuthConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredentialAuthConfig.yml deleted file mode 100644 index 937cb785..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredentialAuthConfig.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: AppCredentialAuthConfig -uid: '@microsoft/teamsfx.AppCredentialAuthConfig' -package: '@microsoft/teamsfx' -summary: Authentication configuration for AppCredential used in node environment -fullName: AppCredentialAuthConfig -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type AppCredentialAuthConfig = OnBehalfOfCredentialAuthConfig diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AuthProvider.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AuthProvider.yml deleted file mode 100644 index 9521b829..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AuthProvider.yml +++ /dev/null @@ -1,33 +0,0 @@ -### YamlMime:TSType -name: AuthProvider -uid: '@microsoft/teamsfx.AuthProvider' -package: '@microsoft/teamsfx' -summary: Defines method that injects authentication info to http requests -fullName: AuthProvider -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: AddAuthenticationInfo - uid: '@microsoft/teamsfx.AuthProvider.AddAuthenticationInfo' - package: '@microsoft/teamsfx' - summary: Adds authentication info to http requests - fullName: AddAuthenticationInfo - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - AddAuthenticationInfo: (config: AxiosRequestConfig) => - Promise> - return: - description: '' - type: >- - (config: AxiosRequestConfig<any>) => - Promise<AxiosRequestConfig<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AxiosInstance.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/AxiosInstance.yml deleted file mode 100644 index 1b443d17..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/AxiosInstance.yml +++ /dev/null @@ -1,349 +0,0 @@ -### YamlMime:TSType -name: AxiosInstance -uid: '@microsoft/teamsfx.AxiosInstance' -package: '@microsoft/teamsfx' -summary: '' -fullName: AxiosInstance -remarks: '' -isDeprecated: false -type: interface -properties: - - name: defaults - uid: '@microsoft/teamsfx.AxiosInstance.defaults' - package: '@microsoft/teamsfx' - summary: '' - fullName: defaults - remarks: '' - isDeprecated: false - syntax: - content: >- - defaults: Omit, "headers"> & { headers: - HeadersDefaults & {[key: string]: AxiosHeaderValue} } - return: - description: '' - type: >- - Omit<AxiosDefaults<any>, "headers"> & { headers: - HeadersDefaults & {[key: string]: AxiosHeaderValue} } -inheritedProperties: - - name: interceptors - uid: '@microsoft/teamsfx.AxiosInstance.interceptors' - package: '@microsoft/teamsfx' - summary: '' - fullName: interceptors - remarks: '' - isDeprecated: false - syntax: - content: >- - interceptors: { request: - AxiosInterceptorManager>, response: - AxiosInterceptorManager> } - return: - description: '' - type: >- - { request: - AxiosInterceptorManager<InternalAxiosRequestConfig<any>>, - response: AxiosInterceptorManager<AxiosResponse<any, any, - {}>> } - inheritanceDescription: Inherited From Axios.interceptors -inheritedMethods: - - name: delete(string, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.delete' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function delete(url: string, config?: AxiosRequestConfig): - Promise - parameters: - - id: url - type: string - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.delete - - name: get(string, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.get' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function get(url: string, config?: AxiosRequestConfig): - Promise - parameters: - - id: url - type: string - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.get - - name: getUri(AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.getUri' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function getUri(config?: AxiosRequestConfig): string' - parameters: - - id: config - type: AxiosRequestConfig<any> - description: '' - return: - description: '' - type: string - inheritanceDescription: Inherited From Axios.getUri - - name: head(string, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.head' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function head(url: string, config?: AxiosRequestConfig): - Promise - parameters: - - id: url - type: string - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.head - - name: options(string, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.options' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function options(url: string, config?: AxiosRequestConfig): - Promise - parameters: - - id: url - type: string - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.options - - name: patch(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.patch' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function patch(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.patch - - name: patchForm(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.patchForm' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function patchForm(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.patchForm - - name: post(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.post' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function post(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.post - - name: postForm(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.postForm' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function postForm(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.postForm - - name: put(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.put' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function put(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.put - - name: putForm(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.putForm' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function putForm(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.putForm - - name: query(string, D, AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.query' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: >- - function query(url: string, data?: D, config?: - AxiosRequestConfig): Promise - parameters: - - id: url - type: string - description: '' - - id: data - type: D - description: '' - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.query - - name: request(AxiosRequestConfig) - uid: '@microsoft/teamsfx.AxiosInstance.request' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function request(config: AxiosRequestConfig): Promise' - parameters: - - id: config - type: AxiosRequestConfig<D> - description: '' - return: - description: '' - type: Promise<R> - inheritanceDescription: Inherited From Axios.request -methods: - - name: create(CreateAxiosDefaults) - uid: '@microsoft/teamsfx.AxiosInstance.create' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: false - syntax: - content: 'function create(config?: CreateAxiosDefaults): AxiosInstance' - parameters: - - id: config - type: CreateAxiosDefaults<any> - description: '' - return: - description: '' - type: -extends: Axios diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BasicAuthProvider.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BasicAuthProvider.yml deleted file mode 100644 index ec96f2a1..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BasicAuthProvider.yml +++ /dev/null @@ -1,58 +0,0 @@ -### YamlMime:TSType -name: BasicAuthProvider -uid: '@microsoft/teamsfx.BasicAuthProvider' -package: '@microsoft/teamsfx' -summary: Provider that handles Basic authentication -fullName: BasicAuthProvider -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: BasicAuthProvider(string, string) - uid: '@microsoft/teamsfx.BasicAuthProvider.constructor' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new BasicAuthProvider(userName: string, password: string)' - parameters: - - id: userName - type: string - description: Username used in basic auth - - id: password - type: string - description: Password used in basic auth -methods: - - name: AddAuthenticationInfo(AxiosRequestConfig) - uid: '@microsoft/teamsfx.BasicAuthProvider.AddAuthenticationInfo' - package: '@microsoft/teamsfx' - summary: Adds authentication info to http requests - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function AddAuthenticationInfo(config: AxiosRequestConfig): - Promise> - parameters: - - id: config - type: AxiosRequestConfig<any> - description: >- - Contains all the request information and can be updated to include - extra authentication info. - - Refer https://axios-http.com/docs/req_config for detailed document. - return: - description: Updated axios request config. - type: Promise<AxiosRequestConfig<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BearerTokenAuthProvider.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BearerTokenAuthProvider.yml deleted file mode 100644 index 5b967843..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BearerTokenAuthProvider.yml +++ /dev/null @@ -1,57 +0,0 @@ -### YamlMime:TSType -name: BearerTokenAuthProvider -uid: '@microsoft/teamsfx.BearerTokenAuthProvider' -package: '@microsoft/teamsfx' -summary: Provider that handles Bearer Token authentication -fullName: BearerTokenAuthProvider -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: BearerTokenAuthProvider(() => Promise) - uid: '@microsoft/teamsfx.BearerTokenAuthProvider.constructor' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new BearerTokenAuthProvider(getToken: () => Promise)' - parameters: - - id: getToken - type: () => Promise<string> - description: >- - Function that returns the content of bearer token used in http - request -methods: - - name: AddAuthenticationInfo(AxiosRequestConfig) - uid: '@microsoft/teamsfx.BearerTokenAuthProvider.AddAuthenticationInfo' - package: '@microsoft/teamsfx' - summary: Adds authentication info to http requests - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function AddAuthenticationInfo(config: AxiosRequestConfig): - Promise> - parameters: - - id: config - type: AxiosRequestConfig<any> - description: >- - Contains all the request information and can be updated to include - extra authentication info. - - Refer https://axios-http.com/docs/req_config for detailed document. - return: - description: Updated axios request config. - type: Promise<AxiosRequestConfig<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoConfig.yml deleted file mode 100644 index 94c96dba..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoConfig.yml +++ /dev/null @@ -1,47 +0,0 @@ -### YamlMime:TSType -name: BotSsoConfig -uid: '@microsoft/teamsfx.BotSsoConfig' -package: '@microsoft/teamsfx' -summary: Interface for SSO configuration for Bot SSO -fullName: BotSsoConfig -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: aad - uid: '@microsoft/teamsfx.BotSsoConfig.aad' - package: '@microsoft/teamsfx' - summary: aad related configurations - fullName: aad - remarks: '' - isDeprecated: false - syntax: - content: 'aad: Object' - return: - description: '' - type: Object - - name: dialog - uid: '@microsoft/teamsfx.BotSsoConfig.dialog' - package: '@microsoft/teamsfx' - summary: '' - fullName: dialog - remarks: '' - isDeprecated: false - syntax: - content: >- - dialog?: { CustomBotSsoExecutionActivityHandler?: (ssoConfig: - BotSsoConfig) => BotSsoExecutionActivityHandler, conversationState?: - ConversationState, dedupStorage?: Storage, ssoPromptConfig?: { - endOnInvalidMessage?: boolean, timeout?: number }, userState?: UserState - } - return: - description: '' - type: >- - { CustomBotSsoExecutionActivityHandler?: (ssoConfig: BotSsoConfig) - => BotSsoExecutionActivityHandler, conversationState?: - ConversationState, dedupStorage?: Storage, ssoPromptConfig?: { - endOnInvalidMessage?: boolean, timeout?: number }, userState?: - UserState } diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionActivityHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionActivityHandler.yml deleted file mode 100644 index d057ec0c..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionActivityHandler.yml +++ /dev/null @@ -1,133 +0,0 @@ -### YamlMime:TSType -name: BotSsoExecutionActivityHandler -uid: '@microsoft/teamsfx.BotSsoExecutionActivityHandler' -package: '@microsoft/teamsfx' -summary: Interface for user to customize SSO execution activity handler -fullName: BotSsoExecutionActivityHandler -remarks: >- - Bot SSO execution activity handler is to handle SSO login process and trigger - SSO command using - [BotSsoExecutionDialog](xref:@microsoft/teamsfx.BotSsoExecutionDialog). - - You can use this interface to implement your own SSO execution dialog, and - pass it to ConversationBot options: - - - ```typescript - - export const commandBot = new ConversationBot({ - ... - ssoConfig: { - ... - dialog: { - CustomBotSsoExecutionActivityHandler: YourCustomBotSsoExecutionActivityHandler, - } - }, - ... - }); - - ``` - - For details information about how to implement a - BotSsoExecutionActivityHandler, please refer - DefaultBotSsoExecutionActivityHandler class source code: - https://aka.ms/teamsfx-default-sso-execution-activity-handler -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -methods: - - name: addCommand(BotSsoExecutionDialogHandler, TriggerPatterns) - uid: '@microsoft/teamsfx.BotSsoExecutionActivityHandler.addCommand' - package: '@microsoft/teamsfx' - summary: >- - Add - [TeamsFxBotSsoCommandHandler](xref:@microsoft/teamsfx.TeamsFxBotSsoCommandHandler) - instance to - [BotSsoExecutionDialog](xref:@microsoft/teamsfx.BotSsoExecutionDialog) - remarks: >- - This function is used to add SSO command to - [BotSsoExecutionDialog](xref:@microsoft/teamsfx.BotSsoExecutionDialog) - instance. - isDeprecated: false - syntax: - content: >- - function addCommand(handler: BotSsoExecutionDialogHandler, - triggerPatterns: TriggerPatterns) - parameters: - - id: handler - type: - description: >- - [BotSsoExecutionDialogHandler](xref:@microsoft/teamsfx.BotSsoExecutionDialogHandler) - callback function - - id: triggerPatterns - type: - description: The trigger pattern - - name: 'handleTeamsSigninTokenExchange(TurnContext, { state?: string })' - uid: >- - @microsoft/teamsfx.BotSsoExecutionActivityHandler.handleTeamsSigninTokenExchange - package: '@microsoft/teamsfx' - summary: Receives invoke activities with Activity name of 'signin/tokenExchange' - remarks: >- - It should trigger - [BotSsoExecutionDialog](xref:@microsoft/teamsfx.BotSsoExecutionDialog) - instance to handle signin process - isDeprecated: false - syntax: - content: >- - function handleTeamsSigninTokenExchange(context: TurnContext, query: { - state?: string }): Promise - parameters: - - id: context - type: - description: A context object for this turn. - - id: query - type: '{ state?: string }' - description: >- - Signin state (part of signin action auth flow) verification invoke - query - return: - description: A promise that represents the work queued. - type: Promise<void> - - name: 'handleTeamsSigninVerifyState(TurnContext, { state?: string })' - uid: >- - @microsoft/teamsfx.BotSsoExecutionActivityHandler.handleTeamsSigninVerifyState - package: '@microsoft/teamsfx' - summary: Receives invoke activities with Activity name of 'signin/verifyState'. - remarks: >- - It should trigger - [BotSsoExecutionDialog](xref:@microsoft/teamsfx.BotSsoExecutionDialog) - instance to handle signin process - isDeprecated: false - syntax: - content: >- - function handleTeamsSigninVerifyState(context: TurnContext, query: { - state?: string }): Promise - parameters: - - id: context - type: - description: A context object for this turn. - - id: query - type: '{ state?: string }' - description: >- - Signin state (part of signin action auth flow) verification invoke - query. - return: - description: A promise that represents the work queued. - type: Promise<void> - - name: run(TurnContext) - uid: '@microsoft/teamsfx.BotSsoExecutionActivityHandler.run' - package: '@microsoft/teamsfx' - summary: Called to initiate the event emission process. - remarks: '' - isDeprecated: false - syntax: - content: 'function run(context: TurnContext): Promise' - parameters: - - id: context - type: - description: The context object for the current turn. - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialog.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialog.yml deleted file mode 100644 index 485351d2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialog.yml +++ /dev/null @@ -1,489 +0,0 @@ -### YamlMime:TSType -name: BotSsoExecutionDialog -uid: '@microsoft/teamsfx.BotSsoExecutionDialog' -package: '@microsoft/teamsfx' -summary: Sso execution dialog, use to handle sso command -fullName: BotSsoExecutionDialog -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: >- - BotSsoExecutionDialog(Storage, TeamsBotSsoPromptSettings, - OnBehalfOfCredentialAuthConfig, string, string) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.constructor' - package: '@microsoft/teamsfx' - summary: Creates a new instance of the BotSsoExecutionDialog. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new BotSsoExecutionDialog(dedupStorage: Storage, ssoPromptSettings: - TeamsBotSsoPromptSettings, authConfig: OnBehalfOfCredentialAuthConfig, - initiateLoginEndpoint: string, dialogName?: string) - parameters: - - id: dedupStorage - type: - description: '' - - id: ssoPromptSettings - type: - description: '' - - id: authConfig - type: - description: '' - - id: initiateLoginEndpoint - type: string - description: |- - Login URL for Teams to redirect to. - * - - id: dialogName - type: string - description: |- - custom dialog name - * -properties: - - name: id - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.id' - package: '@microsoft/teamsfx' - summary: Unique ID of the dialog. - fullName: id - remarks: '' - isDeprecated: false - syntax: - content: string id - return: - description: The Id for the dialog. - type: string -inheritedProperties: - - name: dialogs - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.dialogs' - package: '@microsoft/teamsfx' - summary: The containers dialog set. - fullName: dialogs - remarks: '' - isDeprecated: false - syntax: - content: 'dialogs: DialogSet' - return: - description: '' - type: - inheritanceDescription: Inherited From ComponentDialog.dialogs - - name: EndOfTurn - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.EndOfTurn' - package: '@microsoft/teamsfx' - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: >- - <any> - inheritanceDescription: Inherited From ComponentDialog.EndOfTurn -inheritedMethods: - - name: addDialog(Dialog<{}>) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.addDialog' - package: '@microsoft/teamsfx' - summary: Adds a child Dialog or prompt to the components internal DialogSet. - remarks: >- - The Dialog.id of the first child added to the component will be assigned - to the initialDialogId property. - isDeprecated: false - syntax: - content: 'function addDialog(dialog: Dialog<{}>): BotSsoExecutionDialog' - parameters: - - id: dialog - type: <{}> - description: The child Dialog or prompt to add. - return: - description: The ComponentDialog after the operation is complete. - type: >- - - inheritanceDescription: Inherited From ComponentDialog.addDialog - - name: beginDialog(DialogContext, {}) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.beginDialog' - package: '@microsoft/teamsfx' - summary: >- - Called when the dialog is started and pushed onto the parent's dialog - stack. - - By default, this calls the - - Dialog.BeginDialogAsync(DialogContext, object, CancellationToken) method - - of the component dialog's initial dialog, as defined by InitialDialogId. - - Override this method in a derived class to implement interrupt logic. - remarks: >- - If the task is successful, the result indicates whether the dialog is - still - - active after the turn has been processed by the dialog. - isDeprecated: false - syntax: - content: >- - function beginDialog(outerDialogContext: DialogContext, options?: {}): - Promise> - parameters: - - id: outerDialogContext - type: - description: The parent DialogContext for the current turn of conversation. - - id: options - type: '{}' - description: Optional, initial information to pass to the dialog. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.beginDialog - - name: configure(Record) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.configure' - package: '@microsoft/teamsfx' - summary: Fluent method for configuring the object. - remarks: '' - isDeprecated: false - syntax: - content: >- - function configure(config: Record): - BotSsoExecutionDialog - parameters: - - id: config - type: Record<string, unknown> - description: Configuration settings to apply. - return: - description: The Configurable after the operation is complete. - type: >- - - inheritanceDescription: Inherited From ComponentDialog.configure - - name: continueDialog(DialogContext) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.continueDialog' - package: '@microsoft/teamsfx' - summary: >- - Called when the dialog is _continued_, where it is the active dialog and - the - - user replies with a new Activity. - - If this method is *not* overridden, the dialog automatically ends when the - user replies. - remarks: >- - If the task is successful, the result indicates whether the dialog is - still - - active after the turn has been processed by the dialog. The result may - also contain a - - return value. - isDeprecated: false - syntax: - content: >- - function continueDialog(outerDialogContext: DialogContext): - Promise> - parameters: - - id: outerDialogContext - type: - description: The parent DialogContext for the current turn of conversation. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.continueDialog - - name: createChildContext(DialogContext) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.createChildContext' - package: '@microsoft/teamsfx' - summary: Creates the inner dialog context - remarks: '' - isDeprecated: false - syntax: - content: >- - function createChildContext(outerDialogContext: DialogContext): - DialogContext - parameters: - - id: outerDialogContext - type: - description: the outer dialog context - return: - description: The created Dialog Context. - type: - inheritanceDescription: Inherited From ComponentDialog.createChildContext - - name: endDialog(TurnContext, DialogInstance, DialogReason) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.endDialog' - package: '@microsoft/teamsfx' - summary: Called when the Dialog is ending. - remarks: >- - When this method is called from the parent dialog's context, the component - Dialog - - cancels all of the dialogs on its inner dialog stack before ending. - isDeprecated: false - syntax: - content: >- - function endDialog(context: TurnContext, instance: DialogInstance, - reason: DialogReason): Promise - parameters: - - id: context - type: - description: The TurnContext object for this turn. - - id: instance - type: >- - <any> - description: >- - State information associated with the instance of this component - Dialog on its parent's dialog stack. - - id: reason - type: - description: Reason why the Dialog ended. - return: - description: A Promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From ComponentDialog.endDialog - - name: findDialog(string) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.findDialog' - package: '@microsoft/teamsfx' - summary: Finds a child dialog that was previously added to the container. - remarks: '' - isDeprecated: false - syntax: - content: 'function findDialog(dialogId: string): undefined | Dialog<{}>' - parameters: - - id: dialogId - type: string - description: ID of the dialog to lookup. - return: - description: The Dialog if found; otherwise null. - type: >- - undefined | <{}> - inheritanceDescription: Inherited From ComponentDialog.findDialog - - name: getConverter(string) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.getConverter' - package: '@microsoft/teamsfx' - summary: |- - Gets the converter for the selector configuration. - * - remarks: '' - isDeprecated: false - syntax: - content: >- - function getConverter(_property: string): Converter | - ConverterFactory - parameters: - - id: _property - type: string - description: |- - The key of the conditional selector configuration. - * - return: - description: The converter for the selector configuration. - type: >- - <unknown, - unknown> | <unknown, unknown> - inheritanceDescription: Inherited From ComponentDialog.getConverter - - name: getVersion() - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.getVersion' - package: '@microsoft/teamsfx' - summary: >- - An encoded string used to aid in the detection of agent changes on - re-deployment. - remarks: >- - This defaults to returning the dialog's `id` but can be overridden to - provide more - - precise change detection logic. Any dialog on the stack that has its - version change will - - result in a `versionChanged` event will be raised. If this event is not - handled by the agent, - - an error will be thrown resulting in the agent error handler logic being - run. - - - Returning an empty string will disable version tracking for the component - all together. - isDeprecated: false - syntax: - content: 'function getVersion(): string' - return: - description: >- - Unique string which should only change when dialog has changed in a - way that should restart the dialog. - type: string - inheritanceDescription: Inherited From ComponentDialog.getVersion - - name: onDialogEvent(DialogContext, DialogEvent) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.onDialogEvent' - package: '@microsoft/teamsfx' - summary: |- - Called when an event has been raised, using `DialogContext.emitEvent()`, - by either the current dialog or a dialog that the current dialog started. - remarks: '' - isDeprecated: false - syntax: - content: >- - function onDialogEvent(dialogContext: DialogContext, event: - DialogEvent): Promise - parameters: - - id: dialogContext - type: - description: The dialog context for the current turn of conversation. - - id: event - type: - description: The event being raised. - return: - description: >- - True if the event is handled by the current dialog and bubbling should - stop. - type: Promise<boolean> - inheritanceDescription: Inherited From ComponentDialog.onDialogEvent - - name: repromptDialog(TurnContext, DialogInstance) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.repromptDialog' - package: '@microsoft/teamsfx' - summary: Called when the dialog should re-prompt the user for input. - remarks: '' - isDeprecated: false - syntax: - content: >- - function repromptDialog(context: TurnContext, instance: - DialogInstance): Promise - parameters: - - id: context - type: - description: The TurnContext object for this turn. - - id: instance - type: >- - <any> - description: State information for this dialog. - return: - description: A Promise representing the asynchronous operation. - type: Promise<void> - inheritanceDescription: Inherited From ComponentDialog.repromptDialog - - name: resumeDialog(DialogContext, DialogReason, any) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.resumeDialog' - package: '@microsoft/teamsfx' - summary: >- - Called when a child dialog on the parent's dialog stack completed this - turn, returning - - control to this dialog component. - remarks: >- - If the task is successful, the result indicates whether this dialog is - still - - active after this dialog turn has been processed. - - Generally, the child dialog was started with a call to - - beginDialog(DialogContext, object) in the parent's - - context. However, if the DialogContext.replaceDialog(string, object) - method - - is called, the logical child dialog may be different than the original. - - If this method is *not* overridden, the dialog automatically calls its - - RepromptDialog(ITurnContext, DialogInstance) when the user replies. - isDeprecated: false - syntax: - content: >- - function resumeDialog(outerDialogContext: DialogContext, _reason: - DialogReason, _result?: any): Promise> - parameters: - - id: outerDialogContext - type: - description: The DialogContext for the current turn of conversation. - - id: _reason - type: - description: Reason why the dialog resumed. - - id: _result - type: any - description: |- - Optional, value returned from the dialog that was called. The type - of the value returned is dependent on the child dialog. - return: - description: A Promise representing the asynchronous operation. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From ComponentDialog.resumeDialog -methods: - - name: addCommand(BotSsoExecutionDialogHandler, TriggerPatterns) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.addCommand' - package: '@microsoft/teamsfx' - summary: Add TeamsFxBotSsoCommandHandler instance - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function addCommand(handler: BotSsoExecutionDialogHandler, - triggerPatterns: TriggerPatterns) - parameters: - - id: handler - type: - description: >- - [BotSsoExecutionDialogHandler](xref:@microsoft/teamsfx.BotSsoExecutionDialogHandler) - callback function - - id: triggerPatterns - type: - description: The trigger pattern - - name: run(TurnContext, AgentStatePropertyAccessor) - uid: '@microsoft/teamsfx.BotSsoExecutionDialog.run' - package: '@microsoft/teamsfx' - summary: >- - The run method handles the incoming activity (in the form of a - DialogContext) and passes it through the dialog system. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function run(context: TurnContext, accessor: - AgentStatePropertyAccessor): Promise - parameters: - - id: context - type: - description: The context object for the current turn. - - id: accessor - type: >- - <any> - description: The instance of StatePropertyAccessor for dialog system. - return: - description: '' - type: Promise<void> -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialogHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialogHandler.yml deleted file mode 100644 index d72bbae2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialogHandler.yml +++ /dev/null @@ -1,17 +0,0 @@ -### YamlMime:TSTypeAlias -name: BotSsoExecutionDialogHandler -uid: '@microsoft/teamsfx.BotSsoExecutionDialogHandler' -package: '@microsoft/teamsfx' -summary: '' -fullName: BotSsoExecutionDialogHandler -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type BotSsoExecutionDialogHandler = ( - context: TurnContext, - tokenResponse: TeamsBotSsoPromptTokenResponse, - message: CommandMessage - ) => Promise diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CardActionOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/CardActionOptions.yml deleted file mode 100644 index 809ab729..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CardActionOptions.yml +++ /dev/null @@ -1,31 +0,0 @@ -### YamlMime:TSType -name: CardActionOptions -uid: '@microsoft/teamsfx.CardActionOptions' -package: '@microsoft/teamsfx' -summary: >- - Options to initialize - . -fullName: CardActionOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: actions - uid: '@microsoft/teamsfx.CardActionOptions.actions' - package: '@microsoft/teamsfx' - summary: >- - The action handlers to registered with the action bot. Each command should - implement the interface - [TeamsFxAdaptiveCardActionHandler](xref:@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler) - so that it can be correctly handled by this bot. - fullName: actions - remarks: '' - isDeprecated: false - syntax: - content: 'actions?: TeamsFxAdaptiveCardActionHandler[]' - return: - description: '' - type: [] diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CertificateAuthProvider.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/CertificateAuthProvider.yml deleted file mode 100644 index 4dcc48c2..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CertificateAuthProvider.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: CertificateAuthProvider -uid: '@microsoft/teamsfx.CertificateAuthProvider' -package: '@microsoft/teamsfx' -summary: Provider that handles Certificate authentication -fullName: CertificateAuthProvider -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: CertificateAuthProvider(SecureContextOptions) - uid: '@microsoft/teamsfx.CertificateAuthProvider.constructor' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new CertificateAuthProvider(certOption: SecureContextOptions)' - parameters: - - id: certOption - type: SecureContextOptions - description: information about the cert used in http requests -methods: - - name: AddAuthenticationInfo(AxiosRequestConfig) - uid: '@microsoft/teamsfx.CertificateAuthProvider.AddAuthenticationInfo' - package: '@microsoft/teamsfx' - summary: Adds authentication info to http requests. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function AddAuthenticationInfo(config: AxiosRequestConfig): - Promise> - parameters: - - id: config - type: AxiosRequestConfig<any> - description: >- - Contains all the request information and can be updated to include - extra authentication info. - - Refer https://axios-http.com/docs/req_config for detailed document. - return: - description: Updated axios request config. - type: Promise<AxiosRequestConfig<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandMessage.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandMessage.yml deleted file mode 100644 index f21df1bc..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandMessage.yml +++ /dev/null @@ -1,41 +0,0 @@ -### YamlMime:TSType -name: CommandMessage -uid: '@microsoft/teamsfx.CommandMessage' -package: '@microsoft/teamsfx' -summary: Interface for a command message that can handled in a command handler. -fullName: CommandMessage -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: matches - uid: '@microsoft/teamsfx.CommandMessage.matches' - package: '@microsoft/teamsfx' - summary: >- - The capture groups that matched to the - [TriggerPatterns](xref:@microsoft/teamsfx.TriggerPatterns) in a - [TeamsFxBotCommandHandler](xref:@microsoft/teamsfx.TeamsFxBotCommandHandler) - instance. - fullName: matches - remarks: '' - isDeprecated: false - syntax: - content: 'matches?: RegExpMatchArray' - return: - description: '' - type: RegExpMatchArray - - name: text - uid: '@microsoft/teamsfx.CommandMessage.text' - package: '@microsoft/teamsfx' - summary: Text of the message sent by the user. - fullName: text - remarks: '' - isDeprecated: false - syntax: - content: 'text: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandOptions.yml deleted file mode 100644 index 139f6e60..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandOptions.yml +++ /dev/null @@ -1,47 +0,0 @@ -### YamlMime:TSType -name: CommandOptions -uid: '@microsoft/teamsfx.CommandOptions' -package: '@microsoft/teamsfx' -summary: >- - Options to initialize - . -fullName: CommandOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: commands - uid: '@microsoft/teamsfx.CommandOptions.commands' - package: '@microsoft/teamsfx' - summary: >- - The commands to registered with the command bot. Each command should - implement the interface - [TeamsFxBotCommandHandler](xref:@microsoft/teamsfx.TeamsFxBotCommandHandler) - so that it can be correctly handled by this command bot. - fullName: commands - remarks: '' - isDeprecated: false - syntax: - content: 'commands?: TeamsFxBotCommandHandler[]' - return: - description: '' - type: [] - - name: ssoCommands - uid: '@microsoft/teamsfx.CommandOptions.ssoCommands' - package: '@microsoft/teamsfx' - summary: >- - The commands to registered with the sso command bot. Each sso command - should implement the interface - [TeamsFxBotSsoCommandHandler](xref:@microsoft/teamsfx.TeamsFxBotSsoCommandHandler) - so that it can be correctly handled by this command bot. - fullName: ssoCommands - remarks: '' - isDeprecated: false - syntax: - content: 'ssoCommands?: TeamsFxBotSsoCommandHandler[]' - return: - description: '' - type: [] diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStore.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStore.yml deleted file mode 100644 index e09bfef1..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStore.yml +++ /dev/null @@ -1,89 +0,0 @@ -### YamlMime:TSType -name: ConversationReferenceStore -uid: '@microsoft/teamsfx.ConversationReferenceStore' -package: '@microsoft/teamsfx' -summary: A store to persist notification target references. -fullName: ConversationReferenceStore -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -methods: - - name: >- - add(string, Partial, - ConversationReferenceStoreAddOptions) - uid: '@microsoft/teamsfx.ConversationReferenceStore.add' - package: '@microsoft/teamsfx' - summary: >- - Add a conversation reference to the store. If overwrite, update existing - one, otherwise add when not exist. - remarks: '' - isDeprecated: false - syntax: - content: >- - function add(key: string, reference: Partial, - options: ConversationReferenceStoreAddOptions): Promise - parameters: - - id: key - type: string - description: the key of the conversation reference. - - id: reference - type: >- - Partial<> - description: the conversation reference to add. - - id: options - type: >- - - description: the options to add the conversation reference. - return: - description: true if added or updated, false if not changed. - type: Promise<boolean> - - name: list(number, string) - uid: '@microsoft/teamsfx.ConversationReferenceStore.list' - package: '@microsoft/teamsfx' - summary: List stored conversation reference by page. - remarks: '' - isDeprecated: false - syntax: - content: >- - function list(pageSize?: number, continuationToken?: string): - Promise>> - parameters: - - id: pageSize - type: number - description: the page size. - - id: continuationToken - type: string - description: the continuation token to get next page. - return: - description: a paged list of conversation references. - type: >- - Promise<<Partial<>>> - - name: remove(string, Partial) - uid: '@microsoft/teamsfx.ConversationReferenceStore.remove' - package: '@microsoft/teamsfx' - summary: Remove a conversation reference from the store. - remarks: '' - isDeprecated: false - syntax: - content: >- - function remove(key: string, reference: Partial): - Promise - parameters: - - id: key - type: string - description: the key of the conversation reference. - - id: reference - type: >- - Partial<> - description: the conversation reference to remove. - return: - description: true if exist and removed, false if not changed. - type: Promise<boolean> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStoreAddOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStoreAddOptions.yml deleted file mode 100644 index 47ce979f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStoreAddOptions.yml +++ /dev/null @@ -1,25 +0,0 @@ -### YamlMime:TSType -name: ConversationReferenceStoreAddOptions -uid: '@microsoft/teamsfx.ConversationReferenceStoreAddOptions' -package: '@microsoft/teamsfx' -summary: Options to add a conversation reference to the store. -fullName: ConversationReferenceStoreAddOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: overwrite - uid: '@microsoft/teamsfx.ConversationReferenceStoreAddOptions.overwrite' - package: '@microsoft/teamsfx' - summary: Whether to overwrite the existing conversation reference. - fullName: overwrite - remarks: '' - isDeprecated: false - syntax: - content: 'overwrite?: boolean' - return: - description: '' - type: boolean diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorCode.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorCode.yml deleted file mode 100644 index 6b0426ac..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorCode.yml +++ /dev/null @@ -1,88 +0,0 @@ -### YamlMime:TSEnum -name: ErrorCode -uid: '@microsoft/teamsfx.ErrorCode' -package: '@microsoft/teamsfx' -summary: Error code to trace the error types. -fullName: ErrorCode -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: AuthorizationInfoAlreadyExists - uid: '@microsoft/teamsfx.ErrorCode.AuthorizationInfoAlreadyExists' - package: '@microsoft/teamsfx' - summary: Authentication info already exists error. - - name: CannotFindCommand - uid: '@microsoft/teamsfx.ErrorCode.CannotFindCommand' - package: '@microsoft/teamsfx' - summary: Cannot find command - - name: ChannelNotSupported - uid: '@microsoft/teamsfx.ErrorCode.ChannelNotSupported' - package: '@microsoft/teamsfx' - summary: Channel is not supported error. - - name: ConsentFailed - uid: '@microsoft/teamsfx.ErrorCode.ConsentFailed' - package: '@microsoft/teamsfx' - summary: User failed to finish the AAD consent flow failed. - - name: FailedOperation - uid: '@microsoft/teamsfx.ErrorCode.FailedOperation' - package: '@microsoft/teamsfx' - summary: Operation failed. - - name: FailedToProcessSsoHandler - uid: '@microsoft/teamsfx.ErrorCode.FailedToProcessSsoHandler' - package: '@microsoft/teamsfx' - summary: Failed to process sso handler - - name: FailedToRetrieveSsoToken - uid: '@microsoft/teamsfx.ErrorCode.FailedToRetrieveSsoToken' - package: '@microsoft/teamsfx' - summary: Failed to retrieve sso token - - name: FailedToRunDedupStep - uid: '@microsoft/teamsfx.ErrorCode.FailedToRunDedupStep' - package: '@microsoft/teamsfx' - summary: Failed to run dedup step - - name: FailedToRunSsoStep - uid: '@microsoft/teamsfx.ErrorCode.FailedToRunSsoStep' - package: '@microsoft/teamsfx' - summary: Failed to run sso step - - name: InternalError - uid: '@microsoft/teamsfx.ErrorCode.InternalError' - package: '@microsoft/teamsfx' - summary: Internal error. - - name: InvalidCertificate - uid: '@microsoft/teamsfx.ErrorCode.InvalidCertificate' - package: '@microsoft/teamsfx' - summary: Invalid certificate error. - - name: InvalidConfiguration - uid: '@microsoft/teamsfx.ErrorCode.InvalidConfiguration' - package: '@microsoft/teamsfx' - summary: Invalid configuration error. - - name: InvalidParameter - uid: '@microsoft/teamsfx.ErrorCode.InvalidParameter' - package: '@microsoft/teamsfx' - summary: Invalid parameter error. - - name: InvalidResponse - uid: '@microsoft/teamsfx.ErrorCode.InvalidResponse' - package: '@microsoft/teamsfx' - summary: Invalid response error. - - name: RuntimeNotSupported - uid: '@microsoft/teamsfx.ErrorCode.RuntimeNotSupported' - package: '@microsoft/teamsfx' - summary: Runtime is not supported error. - - name: ServiceError - uid: '@microsoft/teamsfx.ErrorCode.ServiceError' - package: '@microsoft/teamsfx' - summary: Call service (AAD or simple authentication server) failed. - - name: SsoActivityHandlerIsUndefined - uid: '@microsoft/teamsfx.ErrorCode.SsoActivityHandlerIsUndefined' - package: '@microsoft/teamsfx' - summary: Sso activity handler is undefined - - name: TokenExpiredError - uid: '@microsoft/teamsfx.ErrorCode.TokenExpiredError' - package: '@microsoft/teamsfx' - summary: Token is not within its valid time range error. - - name: UiRequiredError - uid: '@microsoft/teamsfx.ErrorCode.UiRequiredError' - package: '@microsoft/teamsfx' - summary: The user or administrator has not consented to use the application error. diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorWithCode.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorWithCode.yml deleted file mode 100644 index 07736703..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorWithCode.yml +++ /dev/null @@ -1,224 +0,0 @@ -### YamlMime:TSType -name: ErrorWithCode -uid: '@microsoft/teamsfx.ErrorWithCode' -package: '@microsoft/teamsfx' -summary: Error class with code and message thrown by the SDK. -fullName: ErrorWithCode -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: ErrorWithCode(string, ErrorCode) - uid: '@microsoft/teamsfx.ErrorWithCode.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of ErrorWithCode. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new ErrorWithCode(message?: string, code?: ErrorCode)' - parameters: - - id: message - type: string - description: error message. - - id: code - type: - description: error code. -properties: - - name: code - uid: '@microsoft/teamsfx.ErrorWithCode.code' - package: '@microsoft/teamsfx' - summary: Error code - fullName: code - remarks: '' - isDeprecated: false - syntax: - content: 'code: undefined | string' - return: - description: '' - type: undefined | string -inheritedProperties: - - name: message - uid: '@microsoft/teamsfx.ErrorWithCode.message' - package: '@microsoft/teamsfx' - summary: '' - fullName: message - remarks: '' - isDeprecated: false - syntax: - content: 'message: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.message - - name: name - uid: '@microsoft/teamsfx.ErrorWithCode.name' - package: '@microsoft/teamsfx' - summary: '' - fullName: name - remarks: '' - isDeprecated: false - syntax: - content: 'name: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.name - - name: stack - uid: '@microsoft/teamsfx.ErrorWithCode.stack' - package: '@microsoft/teamsfx' - summary: '' - fullName: stack - remarks: '' - isDeprecated: false - syntax: - content: 'stack?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From Error.stack - - name: stackTraceLimit - uid: '@microsoft/teamsfx.ErrorWithCode.stackTraceLimit' - package: '@microsoft/teamsfx' - summary: >- - The `Error.stackTraceLimit` property specifies the number of stack frames - - collected by a stack trace (whether generated by `new Error().stack` or - - `Error.captureStackTrace(obj)`). - - - The default value is `10` but may be set to any valid JavaScript number. - Changes - - will affect any stack trace captured _after_ the value has been changed. - - - If set to a non-number value, or set to a negative number, stack traces - will - - not capture any frames. - fullName: stackTraceLimit - remarks: '' - isDeprecated: false - syntax: - content: 'static stackTraceLimit: number' - return: - description: '' - type: number - inheritanceDescription: Inherited From Error.stackTraceLimit -inheritedMethods: - - name: captureStackTrace(object, Function) - uid: '@microsoft/teamsfx.ErrorWithCode.captureStackTrace' - package: '@microsoft/teamsfx' - summary: >- - Creates a `.stack` property on `targetObject`, which when accessed returns - - a string representing the location in the code at which - - `Error.captureStackTrace()` was called. - - - ```js - - const myObject = {}; - - Error.captureStackTrace(myObject); - - myObject.stack; // Similar to `new Error().stack` - - ``` - - - The first line of the trace will be prefixed with - - `${myObject.name}: ${myObject.message}`. - - - The optional `constructorOpt` argument accepts a function. If given, all - frames - - above `constructorOpt`, including `constructorOpt`, will be omitted from - the - - generated stack trace. - - - The `constructorOpt` argument is useful for hiding implementation - - details of error generation from the user. For instance: - - - ```js - - function a() { - b(); - } - - - function b() { - c(); - } - - - function c() { - // Create an error without stack trace to avoid calculating the stack trace twice. - const { stackTraceLimit } = Error; - Error.stackTraceLimit = 0; - const error = new Error(); - Error.stackTraceLimit = stackTraceLimit; - - // Capture the stack trace above function b - Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace - throw error; - } - - - a(); - - ``` - remarks: '' - isDeprecated: false - syntax: - content: >- - static function captureStackTrace(targetObject: object, constructorOpt?: - Function) - parameters: - - id: targetObject - type: object - description: '' - - id: constructorOpt - type: Function - description: '' - inheritanceDescription: Inherited From Error.captureStackTrace - - name: prepareStackTrace(Error, CallSite[]) - uid: '@microsoft/teamsfx.ErrorWithCode.prepareStackTrace' - package: '@microsoft/teamsfx' - summary: |- - - - See https://v8.dev/docs/stack-trace-api#customizing-stack-traces - remarks: '' - isDeprecated: false - syntax: - content: >- - static function prepareStackTrace(err: Error, stackTraces: CallSite[]): - any - parameters: - - id: err - type: Error - description: '' - - id: stackTraces - type: CallSite[] - description: '' - return: - description: '' - type: any - inheritanceDescription: Inherited From Error.prepareStackTrace -extends: Error diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/GetTeamsUserTokenOptions.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/GetTeamsUserTokenOptions.yml deleted file mode 100644 index 09085498..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/GetTeamsUserTokenOptions.yml +++ /dev/null @@ -1,128 +0,0 @@ -### YamlMime:TSType -name: GetTeamsUserTokenOptions -uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions' -package: '@microsoft/teamsfx' -summary: '' -fullName: GetTeamsUserTokenOptions -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: resources - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.resources' - package: '@microsoft/teamsfx' - summary: '' - fullName: resources - remarks: '' - isDeprecated: false - syntax: - content: 'resources?: string[]' - return: - description: '' - type: string[] -inheritedProperties: - - name: abortSignal - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.abortSignal' - package: '@microsoft/teamsfx' - summary: The signal which can be used to abort requests. - fullName: abortSignal - remarks: '' - isDeprecated: false - syntax: - content: 'abortSignal?: AbortSignalLike' - return: - description: '' - type: - inheritanceDescription: Inherited From GetTokenOptions.abortSignal - - name: claims - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.claims' - package: '@microsoft/teamsfx' - summary: >- - Claim details to perform the Continuous Access Evaluation authentication - flow - fullName: claims - remarks: '' - isDeprecated: false - syntax: - content: 'claims?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From GetTokenOptions.claims - - name: enableCae - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.enableCae' - package: '@microsoft/teamsfx' - summary: >- - Indicates whether to enable the Continuous Access Evaluation - authentication flow - fullName: enableCae - remarks: '' - isDeprecated: false - syntax: - content: 'enableCae?: boolean' - return: - description: '' - type: boolean - inheritanceDescription: Inherited From GetTokenOptions.enableCae - - name: proofOfPossessionOptions - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.proofOfPossessionOptions' - package: '@microsoft/teamsfx' - summary: Options for Proof of Possession token requests - fullName: proofOfPossessionOptions - remarks: '' - isDeprecated: false - syntax: - content: >- - proofOfPossessionOptions?: { nonce: string, resourceRequestMethod: - HttpMethods, resourceRequestUrl: string } - return: - description: '' - type: >- - { nonce: string, resourceRequestMethod: HttpMethods, - resourceRequestUrl: string } - inheritanceDescription: Inherited From GetTokenOptions.proofOfPossessionOptions - - name: requestOptions - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.requestOptions' - package: '@microsoft/teamsfx' - summary: Options used when creating and sending HTTP requests for this operation. - fullName: requestOptions - remarks: '' - isDeprecated: false - syntax: - content: 'requestOptions?: { timeout?: number }' - return: - description: '' - type: '{ timeout?: number }' - inheritanceDescription: Inherited From GetTokenOptions.requestOptions - - name: tenantId - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.tenantId' - package: '@microsoft/teamsfx' - summary: >- - Allows specifying a tenantId. Useful to handle challenges that provide - tenant Id hints. - fullName: tenantId - remarks: '' - isDeprecated: false - syntax: - content: 'tenantId?: string' - return: - description: '' - type: string - inheritanceDescription: Inherited From GetTokenOptions.tenantId - - name: tracingOptions - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions.tracingOptions' - package: '@microsoft/teamsfx' - summary: Options used when tracing is enabled. - fullName: tracingOptions - remarks: '' - isDeprecated: false - syntax: - content: 'tracingOptions?: { tracingContext?: TracingContext }' - return: - description: '' - type: '{ tracingContext?: TracingContext }' - inheritanceDescription: Inherited From GetTokenOptions.tracingOptions -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseErrorCode.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseErrorCode.yml deleted file mode 100644 index 4551a21b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseErrorCode.yml +++ /dev/null @@ -1,22 +0,0 @@ -### YamlMime:TSEnum -name: InvokeResponseErrorCode -uid: '@microsoft/teamsfx.InvokeResponseErrorCode' -package: '@microsoft/teamsfx' -summary: Status code for an `application/vnd.microsoft.error` invoke response. -fullName: InvokeResponseErrorCode -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: BadRequest - uid: '@microsoft/teamsfx.InvokeResponseErrorCode.BadRequest' - package: '@microsoft/teamsfx' - summary: Invalid request. - numericValue: 400 - - name: InternalServerError - uid: '@microsoft/teamsfx.InvokeResponseErrorCode.InternalServerError' - package: '@microsoft/teamsfx' - summary: Internal server error. - numericValue: 500 diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseFactory.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseFactory.yml deleted file mode 100644 index b66b063e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseFactory.yml +++ /dev/null @@ -1,151 +0,0 @@ -### YamlMime:TSType -name: InvokeResponseFactory -uid: '@microsoft/teamsfx.InvokeResponseFactory' -package: '@microsoft/teamsfx' -summary: >- - Provides methods for formatting various invoke responses a bot can send to - respond to an invoke request. -fullName: InvokeResponseFactory -remarks: |- - All of these functions return an `InvokeResponse` object, which can be - passed as input to generate a new `invokeResponse` activity. - - This example sends an invoke response that contains an adaptive card. - - ```typescript - - const myCard = { - type: "AdaptiveCard", - body: [ - { - "type": "TextBlock", - "text": "This is a sample card" - }], - $schema: "http://adaptivecards.io/schemas/adaptive-card.json", - version: "1.4" - }; - - const invokeResponse = InvokeResponseFactory.adaptiveCard(myCard); - await context.sendActivity({ - type: ActivityTypes.InvokeResponse, - value: invokeResponse, - }); - ``` -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -methods: - - name: adaptiveCard(unknown) - uid: '@microsoft/teamsfx.InvokeResponseFactory.adaptiveCard' - package: '@microsoft/teamsfx' - summary: >- - Create an invoke response from an adaptive card. - - - The type of the invoke response is - `application/vnd.microsoft.card.adaptive` indicates - - the request was successfully processed, and the response includes an - adaptive card - - that the client should display in place of the current one. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'static function adaptiveCard(card: unknown): InvokeResponse' - parameters: - - id: card - type: unknown - description: The adaptive card JSON payload. - return: - description: An `InvokeResponse` object. - type: <any> - - name: createInvokeResponse(StatusCodes, unknown) - uid: '@microsoft/teamsfx.InvokeResponseFactory.createInvokeResponse' - package: '@microsoft/teamsfx' - summary: Create an invoke response with status code and response value. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function createInvokeResponse(statusCode: StatusCodes, body?: - unknown): InvokeResponse - parameters: - - id: statusCode - type: - description: The status code. - - id: body - type: unknown - description: The value of the response body. - return: - description: An `InvokeResponse` object. - type: <any> - - name: errorResponse(InvokeResponseErrorCode, string) - uid: '@microsoft/teamsfx.InvokeResponseFactory.errorResponse' - package: '@microsoft/teamsfx' - summary: >- - Create an invoke response with error code and message. - - - The type of the invoke response is `application/vnd.microsoft.error` - indicates - - the request was failed to processed. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function errorResponse(errorCode: InvokeResponseErrorCode, - errorMessage: string): InvokeResponse - parameters: - - id: errorCode - type: - description: |- - The status code indicates error, available values: - - 400 (BadRequest): indicate the incoming request was invalid. - - 500 (InternalServerError): indicate an unexpected error occurred. - - id: errorMessage - type: string - description: The error message. - return: - description: An `InvokeResponse` object. - type: <any> - - name: textMessage(string) - uid: '@microsoft/teamsfx.InvokeResponseFactory.textMessage' - package: '@microsoft/teamsfx' - summary: >- - Create an invoke response from a text message. - - The type of the invoke response is - `application/vnd.microsoft.activity.message` - - indicates the request was successfully processed. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'static function textMessage(message: string): InvokeResponse' - parameters: - - id: message - type: string - description: A text message included in a invoke response. - return: - description: An `InvokeResponse` object. - type: <any> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogFunction.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogFunction.yml deleted file mode 100644 index accfe39b..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogFunction.yml +++ /dev/null @@ -1,13 +0,0 @@ -### YamlMime:TSTypeAlias -name: LogFunction -uid: '@microsoft/teamsfx.LogFunction' -package: '@microsoft/teamsfx' -summary: Log function for customized logging. -fullName: LogFunction -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type LogFunction = (level: LogLevel, message: string) => void diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogLevel.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogLevel.yml deleted file mode 100644 index 8b741781..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogLevel.yml +++ /dev/null @@ -1,32 +0,0 @@ -### YamlMime:TSEnum -name: LogLevel -uid: '@microsoft/teamsfx.LogLevel' -package: '@microsoft/teamsfx' -summary: Log level. -fullName: LogLevel -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: Verbose - uid: '@microsoft/teamsfx.LogLevel.Verbose' - package: '@microsoft/teamsfx' - summary: Show verbose, information, warning and error message. - numericValue: 0 - - name: Info - uid: '@microsoft/teamsfx.LogLevel.Info' - package: '@microsoft/teamsfx' - summary: Show information, warning and error message. - numericValue: 1 - - name: Warn - uid: '@microsoft/teamsfx.LogLevel.Warn' - package: '@microsoft/teamsfx' - summary: Show warning and error message. - numericValue: 2 - - name: Error - uid: '@microsoft/teamsfx.LogLevel.Error' - package: '@microsoft/teamsfx' - summary: Show error message. - numericValue: 3 diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/Logger.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/Logger.yml deleted file mode 100644 index bcbdfebe..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/Logger.yml +++ /dev/null @@ -1,61 +0,0 @@ -### YamlMime:TSType -name: Logger -uid: '@microsoft/teamsfx.Logger' -package: '@microsoft/teamsfx' -summary: Interface for customized logger. -fullName: Logger -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -methods: - - name: error(string) - uid: '@microsoft/teamsfx.Logger.error' - package: '@microsoft/teamsfx' - summary: Writes to error level logging or lower. - remarks: '' - isDeprecated: false - syntax: - content: 'function error(message: string)' - parameters: - - id: message - type: string - description: '' - - name: info(string) - uid: '@microsoft/teamsfx.Logger.info' - package: '@microsoft/teamsfx' - summary: Writes to info level logging or lower. - remarks: '' - isDeprecated: false - syntax: - content: 'function info(message: string)' - parameters: - - id: message - type: string - description: '' - - name: verbose(string) - uid: '@microsoft/teamsfx.Logger.verbose' - package: '@microsoft/teamsfx' - summary: Writes to verbose level logging. - remarks: '' - isDeprecated: false - syntax: - content: 'function verbose(message: string)' - parameters: - - id: message - type: string - description: '' - - name: warn(string) - uid: '@microsoft/teamsfx.Logger.warn' - package: '@microsoft/teamsfx' - summary: Writes to warning level logging or lower. - remarks: '' - isDeprecated: false - syntax: - content: 'function warn(message: string)' - parameters: - - id: message - type: string - description: '' diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageBuilder.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageBuilder.yml deleted file mode 100644 index 47da362a..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageBuilder.yml +++ /dev/null @@ -1,268 +0,0 @@ -### YamlMime:TSType -name: MessageBuilder -uid: '@microsoft/teamsfx.MessageBuilder' -package: '@microsoft/teamsfx' -summary: >- - Provides utility method to build bot message with cards that supported in - Teams. -fullName: MessageBuilder -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -methods: - - name: attachAdaptiveCard(unknown, TData) - uid: '@microsoft/teamsfx.MessageBuilder.attachAdaptiveCard' - package: '@microsoft/teamsfx' - summary: |+ - Build a bot message activity attached with adaptive card. - - **Example** - - ```javascript - const cardTemplate = { - type: "AdaptiveCard", - body: [ - { - "type": "TextBlock", - "text": "${title}", - "size": "Large" - }, - { - "type": "TextBlock", - "text": "${description}" - }], - $schema: "http://adaptivecards.io/schemas/adaptive-card.json", - version: "1.4" - }; - - type CardData = { - title: string, - description: string - }; - const card = MessageBuilder.attachAdaptiveCard( - cardTemplate, { - title: "sample card title", - description: "sample card description" - }); - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachAdaptiveCard(cardTemplate: unknown, data: - TData): Partial - parameters: - - id: cardTemplate - type: unknown - description: The adaptive card template. - - id: data - type: TData - description: card data used to render the template. - return: - description: A bot message activity attached with an adaptive card. - type: Partial<> - - name: attachAdaptiveCardWithoutData(unknown) - uid: '@microsoft/teamsfx.MessageBuilder.attachAdaptiveCardWithoutData' - package: '@microsoft/teamsfx' - summary: Build a bot message activity attached with an adaptive card. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachAdaptiveCardWithoutData(card: unknown): - Partial - parameters: - - id: card - type: unknown - description: The adaptive card content. - return: - description: A bot message activity attached with an adaptive card. - type: Partial<> - - name: attachContent(Attachment) - uid: '@microsoft/teamsfx.MessageBuilder.attachContent' - package: '@microsoft/teamsfx' - summary: Add an attachement to a bot activity. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachContent(attachement: Attachment): - Partial - parameters: - - id: attachement - type: - description: The attachment object to attach. - return: - description: A message activity with an attachment. - type: Partial<> - - name: >- - attachHeroCard(string, (string | CardImage)[], (string | CardAction)[], - Partial) - uid: '@microsoft/teamsfx.MessageBuilder.attachHeroCard' - package: '@microsoft/teamsfx' - summary: |+ - Build a bot message activity attached with an hero card. - - **Example** - - ```javascript - const message = MessageBuilder.attachHeroCard( - 'sample title', - ['https://example.com/sample.jpg'], - ['action'] - ); - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachHeroCard(title: string, images?: (string | - CardImage)[], buttons?: (string | CardAction)[], other?: - Partial): Partial - parameters: - - id: title - type: string - description: The card title. - - id: images - type: (string | )[] - description: Optional. The array of images to include on the card. - - id: buttons - type: (string | )[] - description: >- - Optional. The array of buttons to include on the card. Each `string` - in the array - is converted to an `imBack` button with a title and value set to the value of the string. - - id: other - type: Partial<> - description: Optional. Any additional properties to include on the card. - return: - description: A bot message activity attached with a hero card. - type: Partial<> - - name: attachO365ConnectorCard(O365ConnectorCard) - uid: '@microsoft/teamsfx.MessageBuilder.attachO365ConnectorCard' - package: '@microsoft/teamsfx' - summary: Build a bot message activity attached with an Office 365 connector card. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachO365ConnectorCard(card: O365ConnectorCard): - Partial - parameters: - - id: card - type: - description: A description of the Office 365 connector card. - return: - description: A bot message activity attached with an Office 365 connector card. - type: Partial<> - - name: AttachReceiptCard(ReceiptCard) - uid: '@microsoft/teamsfx.MessageBuilder.AttachReceiptCard' - package: '@microsoft/teamsfx' - summary: Build a message activity attached with a receipt card. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'static function AttachReceiptCard(card: ReceiptCard): Partial' - parameters: - - id: card - type: - description: A description of the receipt card. - return: - description: A message activity attached with a receipt card. - type: Partial<> - - name: attachSigninCard(string, string, string) - uid: '@microsoft/teamsfx.MessageBuilder.attachSigninCard' - package: '@microsoft/teamsfx' - summary: Returns an attachment for a sign-in card. - remarks: >- - For channels that don't natively support sign-in cards, an alternative - message is rendered. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachSigninCard(title: string, url: string, text?: - string): Partial - parameters: - - id: title - type: string - description: The title for the card's sign-in button. - - id: url - type: string - description: The URL of the sign-in page to use. - - id: text - type: string - description: Optional. Additional text to include on the card. - return: - description: A bot message activity attached with a sign-in card. - type: Partial<> - - name: >- - attachThumbnailCard(string, (string | CardImage)[], (string | - CardAction)[], Partial) - uid: '@microsoft/teamsfx.MessageBuilder.attachThumbnailCard' - package: '@microsoft/teamsfx' - summary: '' - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - static function attachThumbnailCard(title: string, images?: (string | - CardImage)[], buttons?: (string | CardAction)[], other?: - Partial): Partial - parameters: - - id: title - type: string - description: The card title. - - id: images - type: (string | )[] - description: Optional. The array of images to include on the card. - - id: buttons - type: (string | )[] - description: >- - Optional. The array of buttons to include on the card. Each `string` - in the array - is converted to an `imBack` button with a title and value set to the value of the string. - - id: other - type: >- - Partial<> - description: Optional. Any additional properties to include on the card. - return: - description: A message activity attached with a thumbnail card - type: Partial<> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageExtensionTokenResponse.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageExtensionTokenResponse.yml deleted file mode 100644 index 12ec9830..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageExtensionTokenResponse.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: MessageExtensionTokenResponse -uid: '@microsoft/teamsfx.MessageExtensionTokenResponse' -package: '@microsoft/teamsfx' -summary: Token response provided by Teams Bot SSO prompt -fullName: MessageExtensionTokenResponse -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: channelId - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.channelId' - package: '@microsoft/teamsfx' - summary: '' - fullName: channelId - remarks: '' - isDeprecated: false - syntax: - content: 'channelId?: string' - return: - description: '' - type: string - - name: connectionName - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.connectionName' - package: '@microsoft/teamsfx' - summary: '' - fullName: connectionName - remarks: '' - isDeprecated: false - syntax: - content: 'connectionName: string' - return: - description: '' - type: string - - name: expiration - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.expiration' - package: '@microsoft/teamsfx' - summary: '' - fullName: expiration - remarks: '' - isDeprecated: false - syntax: - content: 'expiration: string' - return: - description: '' - type: string - - name: properties - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.properties' - package: '@microsoft/teamsfx' - summary: '' - fullName: properties - remarks: '' - isDeprecated: false - syntax: - content: 'properties?: {[propertyName: string]: any}' - return: - description: '' - type: '{[propertyName: string]: any}' - - name: ssoToken - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.ssoToken' - package: '@microsoft/teamsfx' - summary: SSO token for user - fullName: ssoToken - remarks: '' - isDeprecated: false - syntax: - content: 'ssoToken: string' - return: - description: '' - type: string - - name: ssoTokenExpiration - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.ssoTokenExpiration' - package: '@microsoft/teamsfx' - summary: Expire time of SSO token - fullName: ssoTokenExpiration - remarks: '' - isDeprecated: false - syntax: - content: 'ssoTokenExpiration: string' - return: - description: '' - type: string - - name: token - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse.token' - package: '@microsoft/teamsfx' - summary: '' - fullName: token - remarks: '' - isDeprecated: false - syntax: - content: 'token: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTarget.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTarget.yml deleted file mode 100644 index 78a83eda..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTarget.yml +++ /dev/null @@ -1,76 +0,0 @@ -### YamlMime:TSType -name: NotificationTarget -uid: '@microsoft/teamsfx.NotificationTarget' -package: '@microsoft/teamsfx' -summary: Represent a notification target. -fullName: NotificationTarget -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: type - uid: '@microsoft/teamsfx.NotificationTarget.type' - package: '@microsoft/teamsfx' - summary: The type of target, could be "Channel" or "Group" or "Person". - fullName: type - remarks: '' - isDeprecated: false - syntax: - content: 'type?: NotificationTargetType' - return: - description: '' - type: -methods: - - name: >- - sendAdaptiveCard(unknown, (context: TurnContext, error: Error) => - Promise) - uid: '@microsoft/teamsfx.NotificationTarget.sendAdaptiveCard' - package: '@microsoft/teamsfx' - summary: Send an adaptive card message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendAdaptiveCard(card: unknown, onError?: (context: - TurnContext, error: Error) => Promise): Promise - parameters: - - id: card - type: unknown - description: the adaptive card raw JSON. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - an optional error handler that can catch exceptions during adaptive - card sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: the response of sending adaptive card message. - type: Promise<MessageResponse> - - name: 'sendMessage(string, (context: TurnContext, error: Error) => Promise)' - uid: '@microsoft/teamsfx.NotificationTarget.sendMessage' - package: '@microsoft/teamsfx' - summary: Send a plain text message. - remarks: '' - isDeprecated: false - syntax: - content: >- - function sendMessage(text: string, onError?: (context: TurnContext, - error: Error) => Promise): Promise - parameters: - - id: text - type: string - description: the plain text message. - - id: onError - type: '(context: TurnContext, error: Error) => Promise<void>' - description: >- - an optional error handler that can catch exceptions during message - sending. - - If not defined, error will be handled by `BotAdapter.onTurnError`. - return: - description: the response of sending message. - type: Promise<MessageResponse> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTargetType.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTargetType.yml deleted file mode 100644 index d43a18ad..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTargetType.yml +++ /dev/null @@ -1,34 +0,0 @@ -### YamlMime:TSEnum -name: NotificationTargetType -uid: '@microsoft/teamsfx.NotificationTargetType' -package: '@microsoft/teamsfx' -summary: The target type where the notification will be sent to. -fullName: NotificationTargetType -remarks: >- - - "Channel" means to a team channel. (By default, notification to a team will - be sent to its "General" channel.) - - - "Group" means to a group chat. - - - "Person" means to a personal chat. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -fields: - - name: Channel - uid: '@microsoft/teamsfx.NotificationTargetType.Channel' - package: '@microsoft/teamsfx' - summary: >- - The notification will be sent to a team channel. - - (By default, notification to a team will be sent to its "General" - channel.) - - name: Group - uid: '@microsoft/teamsfx.NotificationTargetType.Group' - package: '@microsoft/teamsfx' - summary: The notification will be sent to a group chat. - - name: Person - uid: '@microsoft/teamsfx.NotificationTargetType.Person' - package: '@microsoft/teamsfx' - summary: The notification will be sent to a personal chat. diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfCredentialAuthConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfCredentialAuthConfig.yml deleted file mode 100644 index 2dfc94ab..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfCredentialAuthConfig.yml +++ /dev/null @@ -1,20 +0,0 @@ -### YamlMime:TSTypeAlias -name: OnBehalfOfCredentialAuthConfig -uid: '@microsoft/teamsfx.OnBehalfOfCredentialAuthConfig' -package: '@microsoft/teamsfx' -summary: Authentication configuration for OnBehalfOfCredential used in node environment -fullName: OnBehalfOfCredentialAuthConfig -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type OnBehalfOfCredentialAuthConfig = { - authorityHost: string - clientId: string - tenantId: string - } & ( - | { certificateContent?: never; clientSecret: string } - | { certificateContent: string; clientSecret?: never } - ) diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfUserCredential.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfUserCredential.yml deleted file mode 100644 index b2b12c25..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfUserCredential.yml +++ /dev/null @@ -1,136 +0,0 @@ -### YamlMime:TSType -name: OnBehalfOfUserCredential -uid: '@microsoft/teamsfx.OnBehalfOfUserCredential' -package: '@microsoft/teamsfx' -summary: >+ - Represent on-behalf-of flow to get user identity, and it is designed to be - used in server side. - - - **Example** - - - ```typescript - - const credential = new OnBehalfOfUserCredential(ssoToken); - - ``` - -fullName: OnBehalfOfUserCredential -remarks: Can only be used in server side. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: OnBehalfOfUserCredential(string, OnBehalfOfCredentialAuthConfig) - uid: '@microsoft/teamsfx.OnBehalfOfUserCredential.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of OnBehalfOfUserCredential - remarks: Only works in in server side. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new OnBehalfOfUserCredential(ssoToken: string, config: - OnBehalfOfCredentialAuthConfig) - parameters: - - id: ssoToken - type: string - description: User token provided by Teams SSO feature. - - id: config - type: - description: The authentication configuration. -methods: - - name: getToken(string | string[], GetTokenOptions) - uid: '@microsoft/teamsfx.OnBehalfOfUserCredential.getToken' - package: '@microsoft/teamsfx' - summary: >+ - Get access token from credential. - - - **Example** - - - ```typescript - - await credential.getToken([]) // Get SSO token using empty string array - - await credential.getToken("") // Get SSO token using empty string - - await credential.getToken([".default"]) // Get Graph access token with - default scope using string array - - await credential.getToken(".default") // Get Graph access token with - default scope using string - - await credential.getToken(["User.Read"]) // Get Graph access token for - single scope using string array - - await credential.getToken("User.Read") // Get Graph access token for - single scope using string - - await credential.getToken(["User.Read", "Application.Read.All"]) // Get - Graph access token for multiple scopes using string array - - await credential.getToken("User.Read Application.Read.All") // Get Graph - access token for multiple scopes using space-separated string - - await credential.getToken("https://graph.microsoft.com/User.Read") // Get - Graph access token with full resource URI - - await credential.getToken(["https://outlook.office.com/Mail.Read"]) // Get - Outlook access token - - ``` - - remarks: |- - * If scopes is empty string or array, it returns SSO token. - * If scopes is non-empty, it returns access token for target scope. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function getToken(scopes: string | string[], options?: GetTokenOptions): - Promise - parameters: - - id: scopes - type: string | string[] - description: The list of scopes for which the token will have access. - - id: options - type: - description: >- - The options used to configure any requests this TokenCredential - implementation might make. - return: - description: |- - Access token with expected scopes. - * - * - type: Promise<null | > - - name: getUserInfo() - uid: '@microsoft/teamsfx.OnBehalfOfUserCredential.getUserInfo' - package: '@microsoft/teamsfx' - summary: |+ - Get basic user info from SSO token. - - **Example** - - ```typescript - const currentUser = getUserInfo(); - ``` - - remarks: '' - isDeprecated: false - syntax: - content: 'function getUserInfo(): UserInfo' - return: - description: Basic user info with user displayName, objectId and preferredUserName. - type: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/PagedData.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/PagedData.yml deleted file mode 100644 index 127f70f4..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/PagedData.yml +++ /dev/null @@ -1,37 +0,0 @@ -### YamlMime:TSType -name: PagedData -uid: '@microsoft/teamsfx.PagedData' -package: '@microsoft/teamsfx' -summary: Represents a page of data. -fullName: PagedData -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: continuationToken - uid: '@microsoft/teamsfx.PagedData.continuationToken' - package: '@microsoft/teamsfx' - summary: The Continuation Token to pass to get the next page of results. - fullName: continuationToken - remarks: Undefined or empty token means the page reaches the end. - isDeprecated: false - syntax: - content: 'continuationToken?: string' - return: - description: '' - type: string - - name: data - uid: '@microsoft/teamsfx.PagedData.data' - package: '@microsoft/teamsfx' - summary: Page of data. - fullName: data - remarks: '' - isDeprecated: false - syntax: - content: 'data: T[]' - return: - description: '' - type: T[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPrompt.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPrompt.yml deleted file mode 100644 index b0b9fbe5..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPrompt.yml +++ /dev/null @@ -1,441 +0,0 @@ -### YamlMime:TSType -name: TeamsBotSsoPrompt -uid: '@microsoft/teamsfx.TeamsBotSsoPrompt' -package: '@microsoft/teamsfx' -summary: >+ - Creates a new prompt that leverage Teams Single Sign On (SSO) support for bot - to automatically sign in user and - - help receive oauth token, asks the user to consent if needed. - - - **Example** - - - When used with your bots `DialogSet` you can simply add a new instance of the - prompt as a named - - dialog using `DialogSet.add()`. You can then start the prompt from a waterfall - step using either - - `DialogContext.beginDialog()` or `DialogContext.prompt()`. The user will be - prompted to sign in as - - needed and their access token will be passed as an argument to the callers - next waterfall step: - - - ```JavaScript - - const { ConversationState, MemoryStorage } = require('botbuilder'); - - const { DialogSet, WaterfallDialog } = require('botbuilder-dialogs'); - - const { TeamsBotSsoPrompt } = require('@microsoft/teamsfx'); - - - const convoState = new ConversationState(new MemoryStorage()); - - const dialogState = convoState.createProperty('dialogState'); - - const dialogs = new DialogSet(dialogState); - - - dialogs.add(new TeamsBotSsoPrompt('TeamsBotSsoPrompt', { - scopes: ["User.Read"], - })); - - - dialogs.add(new WaterfallDialog('taskNeedingLogin', [ - async (step) => { - return await step.beginDialog('TeamsBotSsoPrompt'); - }, - async (step) => { - const token = step.result; - if (token) { - - // ... continue with task needing access token ... - - } else { - await step.context.sendActivity(`Sorry... We couldn't log you in. Try again later.`); - return await step.endDialog(); - } - } - ])); - - ``` - -fullName: TeamsBotSsoPrompt -remarks: >- - The prompt will attempt to retrieve the users current token of the desired - scopes and store it in - - the token store. - - - User will be automatically signed in leveraging Teams support of Bot Single - Sign On(SSO): - - https://docs.microsoft.com/en-us/microsoftteams/platform/bots/how-to/authentication/auth-aad-sso-bots -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: >- - TeamsBotSsoPrompt(OnBehalfOfCredentialAuthConfig, string, string, - TeamsBotSsoPromptSettings) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of TeamsBotSsoPrompt. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - new TeamsBotSsoPrompt(authConfig: OnBehalfOfCredentialAuthConfig, - initiateLoginEndpoint: string, dialogId: string, settings: - TeamsBotSsoPromptSettings) - parameters: - - id: authConfig - type: - description: Used to provide configuration and auth - - id: initiateLoginEndpoint - type: string - description: Login URL for Teams to redirect to - - id: dialogId - type: string - description: >- - Unique ID of the dialog within its parent `DialogSet` or - `ComponentDialog`. - - id: settings - type: - description: Settings used to configure the prompt. -properties: - - name: id - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.id' - package: '@microsoft/teamsfx' - summary: Unique ID of the dialog. - fullName: id - remarks: '' - isDeprecated: false - syntax: - content: string id - return: - description: The Id for the dialog. - type: string -inheritedProperties: - - name: EndOfTurn - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.EndOfTurn' - package: '@microsoft/teamsfx' - summary: Gets a default end-of-turn result. - fullName: EndOfTurn - remarks: >- - This result indicates that a dialog (or a logical step within a dialog) - has completed - - processing for the current turn, is still active, and is waiting for more - input. - isDeprecated: false - syntax: - content: 'static EndOfTurn: DialogTurnResult' - return: - description: '' - type: >- - <any> - inheritanceDescription: Inherited From Dialog.EndOfTurn -inheritedMethods: - - name: configure(Record) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.configure' - package: '@microsoft/teamsfx' - summary: Fluent method for configuring the object. - remarks: '' - isDeprecated: false - syntax: - content: 'function configure(config: Record): TeamsBotSsoPrompt' - parameters: - - id: config - type: Record<string, unknown> - description: Configuration settings to apply. - return: - description: The Configurable after the operation is complete. - type: - inheritanceDescription: Inherited From Dialog.configure - - name: endDialog(TurnContext, DialogInstance, DialogReason) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.endDialog' - package: '@microsoft/teamsfx' - summary: >- - When overridden in a derived class, performs clean up for the dialog - before it ends. - remarks: >- - Derived dialogs that need to perform logging or cleanup before ending - should override this method. - - By default, this method has no effect. - - - The calls this method when the current - - dialog is ending. - isDeprecated: false - syntax: - content: >- - function endDialog(_context: TurnContext, _instance: - DialogInstance, _reason: DialogReason): Promise - parameters: - - id: _context - type: - description: The context object for the turn. - - id: _instance - type: >- - <any> - description: Current state information for this dialog. - - id: _reason - type: - description: The reason the dialog is ending. - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From Dialog.endDialog - - name: getConverter(string) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.getConverter' - package: '@microsoft/teamsfx' - summary: |- - Gets the converter for the selector configuration. - * - remarks: '' - isDeprecated: false - syntax: - content: >- - function getConverter(_property: string): Converter | - ConverterFactory - parameters: - - id: _property - type: string - description: |- - The key of the conditional selector configuration. - * - return: - description: The converter for the selector configuration. - type: >- - <unknown, - unknown> | <unknown, unknown> - inheritanceDescription: Inherited From Dialog.getConverter - - name: getVersion() - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.getVersion' - package: '@microsoft/teamsfx' - summary: >- - An encoded string used to aid in the detection of agent changes on - re-deployment. - remarks: >- - This defaults to returning the dialog's `id` but can be overridden to - provide more - - precise change detection logic. Any dialog on the stack that has its - version change will - - result in a `versionChanged` event will be raised. If this event is not - handled by the agent, - - an error will be thrown resulting in the agent error handler logic being - run. - - - Returning an empty string will disable version tracking for the component - all together. - isDeprecated: false - syntax: - content: 'function getVersion(): string' - return: - description: >- - Unique string which should only change when dialog has changed in a - way that should restart the dialog. - type: string - inheritanceDescription: Inherited From Dialog.getVersion - - name: onDialogEvent(DialogContext, DialogEvent) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.onDialogEvent' - package: '@microsoft/teamsfx' - summary: >- - Called when an event has been raised, using [| DialogContext.emitEvent - method](xref:DialogContext.emitEvent), - - by either the current dialog or a dialog that the current dialog started. - remarks: '' - isDeprecated: false - syntax: - content: >- - function onDialogEvent(dialogContext: DialogContext, event: - DialogEvent): Promise - parameters: - - id: dialogContext - type: - description: The dialog context for the current turn of conversation. - - id: event - type: - description: The event being raised. - return: - description: >- - True if the event is handled by the current dialog and bubbling should - stop. - type: Promise<boolean> - inheritanceDescription: Inherited From Dialog.onDialogEvent - - name: repromptDialog(TurnContext, DialogInstance) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.repromptDialog' - package: '@microsoft/teamsfx' - summary: When overridden in a derived class, prompts the user again for input. - remarks: >- - Derived dialogs that support validation and re-prompt logic should - override this method. - - By default, this method has no effect. - - - The calls this method when the current - - dialog should re-request input from the user. This method is implemented - for prompt dialogs. - isDeprecated: false - syntax: - content: >- - function repromptDialog(_context: TurnContext, _instance: - DialogInstance): Promise - parameters: - - id: _context - type: - description: The context object for the turn. - - id: _instance - type: >- - <any> - description: Current state information for this dialog. - return: - description: '' - type: Promise<void> - inheritanceDescription: Inherited From Dialog.repromptDialog - - name: resumeDialog(DialogContext, DialogReason, any) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.resumeDialog' - package: '@microsoft/teamsfx' - summary: >- - When overridden in a derived class, resumes the dialog after the dialog - above it on the stack completes. - remarks: >- - Derived dialogs that support multiple-turn conversations should override - this method. - - By default, this method signals that the dialog is complete and returns. - - - The calls this method when it resumes - - the dialog. If the previous dialog on the stack returned a value, that - value is in the `result` - - parameter. - - - To start a _child_ dialog, use or - ; however, this dialog will not - - necessarily be the one that started the child dialog. - - To signal to the dialog context that this dialog has completed, await - before exiting this method. - isDeprecated: false - syntax: - content: >- - function resumeDialog(dc: DialogContext, reason: DialogReason, result?: - any): Promise> - parameters: - - id: dc - type: - description: The context for the current dialog turn. - - id: reason - type: - description: >- - The reason the dialog is resuming. This will typically be - DialogReason.endCalled - - id: result - type: any - description: Optional. The return value, if any, from the dialog that ended. - return: - description: A promise resolving to the dialog turn result. - type: >- - Promise<<any>> - inheritanceDescription: Inherited From Dialog.resumeDialog -methods: - - name: beginDialog(DialogContext) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.beginDialog' - package: '@microsoft/teamsfx' - summary: >- - Called when a prompt dialog is pushed onto the dialog stack and is being - activated. - remarks: >- - If the task is successful, the result indicates whether the prompt is - still - - active after the turn has been processed by the prompt. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function beginDialog(dc: DialogContext): Promise>' - parameters: - - id: dc - type: - description: The DialogContext for the current turn of the conversation. - return: - description: |- - A `Promise` representing the asynchronous operation. - * - type: >- - Promise<<any>> - - name: continueDialog(DialogContext) - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt.continueDialog' - package: '@microsoft/teamsfx' - summary: >- - Called when a prompt dialog is the active dialog and the user replied with - a new activity. - remarks: >- - If the task is successful, the result indicates whether the dialog is - still - - active after the turn has been processed by the dialog. - - The prompt generally continues to receive the user's replies until it - accepts the - - user's reply as valid input for the prompt. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function continueDialog(dc: DialogContext): - Promise> - parameters: - - id: dc - type: - description: The DialogContext for the current turn of the conversation. - return: - description: A `Promise` representing the asynchronous operation. - type: >- - Promise<<any>> -extends: diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptSettings.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptSettings.yml deleted file mode 100644 index f448ba6f..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptSettings.yml +++ /dev/null @@ -1,65 +0,0 @@ -### YamlMime:TSType -name: TeamsBotSsoPromptSettings -uid: '@microsoft/teamsfx.TeamsBotSsoPromptSettings' -package: '@microsoft/teamsfx' -summary: Settings used to configure an TeamsBotSsoPrompt instance. -fullName: TeamsBotSsoPromptSettings -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: endOnInvalidMessage - uid: '@microsoft/teamsfx.TeamsBotSsoPromptSettings.endOnInvalidMessage' - package: '@microsoft/teamsfx' - summary: >- - (Optional) value indicating whether the TeamsBotSsoPrompt should end upon - receiving an - - invalid message. Generally the TeamsBotSsoPrompt will end the auth flow - when receives user - - message not related to the auth flow. Setting the flag to false ignores - the user's message instead. - - Defaults to value `true` - fullName: endOnInvalidMessage - remarks: '' - isDeprecated: false - syntax: - content: 'endOnInvalidMessage?: boolean' - return: - description: '' - type: boolean - - name: scopes - uid: '@microsoft/teamsfx.TeamsBotSsoPromptSettings.scopes' - package: '@microsoft/teamsfx' - summary: >- - The array of strings that declare the desired permissions and the - resources requested. - fullName: scopes - remarks: '' - isDeprecated: false - syntax: - content: 'scopes: string[]' - return: - description: '' - type: string[] - - name: timeout - uid: '@microsoft/teamsfx.TeamsBotSsoPromptSettings.timeout' - package: '@microsoft/teamsfx' - summary: >- - (Optional) number of milliseconds the prompt will wait for the user to - authenticate. - - Defaults to a value `900,000` (15 minutes.) - fullName: timeout - remarks: '' - isDeprecated: false - syntax: - content: 'timeout?: number' - return: - description: '' - type: number diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptTokenResponse.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptTokenResponse.yml deleted file mode 100644 index 5bf51782..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptTokenResponse.yml +++ /dev/null @@ -1,97 +0,0 @@ -### YamlMime:TSType -name: TeamsBotSsoPromptTokenResponse -uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse' -package: '@microsoft/teamsfx' -summary: Token response provided by Teams Bot SSO prompt -fullName: TeamsBotSsoPromptTokenResponse -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: channelId - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.channelId' - package: '@microsoft/teamsfx' - summary: '' - fullName: channelId - remarks: '' - isDeprecated: false - syntax: - content: 'channelId?: string' - return: - description: '' - type: string - - name: connectionName - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.connectionName' - package: '@microsoft/teamsfx' - summary: '' - fullName: connectionName - remarks: '' - isDeprecated: false - syntax: - content: 'connectionName: string' - return: - description: '' - type: string - - name: expiration - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.expiration' - package: '@microsoft/teamsfx' - summary: '' - fullName: expiration - remarks: '' - isDeprecated: false - syntax: - content: 'expiration: string' - return: - description: '' - type: string - - name: properties - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.properties' - package: '@microsoft/teamsfx' - summary: '' - fullName: properties - remarks: '' - isDeprecated: false - syntax: - content: 'properties?: {[propertyName: string]: any}' - return: - description: '' - type: '{[propertyName: string]: any}' - - name: ssoToken - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.ssoToken' - package: '@microsoft/teamsfx' - summary: SSO token for user - fullName: ssoToken - remarks: '' - isDeprecated: false - syntax: - content: 'ssoToken: string' - return: - description: '' - type: string - - name: ssoTokenExpiration - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.ssoTokenExpiration' - package: '@microsoft/teamsfx' - summary: Expire time of SSO token - fullName: ssoTokenExpiration - remarks: '' - isDeprecated: false - syntax: - content: 'ssoTokenExpiration: string' - return: - description: '' - type: string - - name: token - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse.token' - package: '@microsoft/teamsfx' - summary: '' - fullName: token - remarks: '' - isDeprecated: false - syntax: - content: 'token: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxAdaptiveCardActionHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxAdaptiveCardActionHandler.yml deleted file mode 100644 index 61080561..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxAdaptiveCardActionHandler.yml +++ /dev/null @@ -1,91 +0,0 @@ -### YamlMime:TSType -name: TeamsFxAdaptiveCardActionHandler -uid: '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler' -package: '@microsoft/teamsfx' -summary: >- - Interface for adaptive card action handler that can process card action invoke - and return a response. -fullName: TeamsFxAdaptiveCardActionHandler -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: adaptiveCardResponse - uid: '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler.adaptiveCardResponse' - package: '@microsoft/teamsfx' - summary: >- - Specify the behavior for how the card response will be sent in Teams - conversation. - - The default value is `AdaptiveCardResponse.ReplaceForInteractor`, which - means the card - - response will replace the current one only for the interactor. - fullName: adaptiveCardResponse - remarks: '' - isDeprecated: false - syntax: - content: 'adaptiveCardResponse?: AdaptiveCardResponse' - return: - description: '' - type: - - name: triggerVerb - uid: '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler.triggerVerb' - package: '@microsoft/teamsfx' - summary: |- - The verb defined in adaptive card action that can trigger this handler. - The verb string here is case-insensitive. - fullName: triggerVerb - remarks: '' - isDeprecated: false - syntax: - content: 'triggerVerb: string' - return: - description: '' - type: string -methods: - - name: handleActionInvoked(TurnContext, any) - uid: '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler.handleActionInvoked' - package: '@microsoft/teamsfx' - summary: The handler function that will be invoked when the action is fired. - remarks: >- - For more details about the invoke response format, refer to - https://docs.microsoft.com/en-us/adaptive-cards/authoring-cards/universal-action-model#response-format. - isDeprecated: false - syntax: - content: >- - function handleActionInvoked(context: TurnContext, actionData: any): - Promise> - parameters: - - id: context - type: - description: The turn context. - - id: actionData - type: any - description: The contextual data that associated with the action. - return: - description: >- - A `Promise` representing a invoke response for the adaptive card - invoke action. - - You can use the `InvokeResponseFactory` utility class to create an - invoke response from - - A text message: - ```typescript - return InvokeResponseFactory.textMessage("Action is processed successfully!"); - ``` - - An adaptive card: - ```typescript - const responseCard = AdaptiveCards.declare(helloWorldCard).render(actionData); - return InvokeResponseFactory.adaptiveCard(responseCard); - ``` - - An error response: - ```typescript - return InvokeResponseFactory.errorResponse(InvokeResponseErrorCode.BadRequest, "Invalid request"); - ``` - type: >- - Promise<<any>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotCommandHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotCommandHandler.yml deleted file mode 100644 index de607073..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotCommandHandler.yml +++ /dev/null @@ -1,55 +0,0 @@ -### YamlMime:TSType -name: TeamsFxBotCommandHandler -uid: '@microsoft/teamsfx.TeamsFxBotCommandHandler' -package: '@microsoft/teamsfx' -summary: >- - Interface for a command handler that can process command to a TeamsFx bot and - return a response. -fullName: TeamsFxBotCommandHandler -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: triggerPatterns - uid: '@microsoft/teamsfx.TeamsFxBotCommandHandler.triggerPatterns' - package: '@microsoft/teamsfx' - summary: The string or regular expression patterns that can trigger this handler. - fullName: triggerPatterns - remarks: '' - isDeprecated: false - syntax: - content: 'triggerPatterns: TriggerPatterns' - return: - description: '' - type: -methods: - - name: handleCommandReceived(TurnContext, CommandMessage) - uid: '@microsoft/teamsfx.TeamsFxBotCommandHandler.handleCommandReceived' - package: '@microsoft/teamsfx' - summary: Handles a bot command received activity. - remarks: '' - isDeprecated: false - syntax: - content: >- - function handleCommandReceived(context: TurnContext, message: - CommandMessage): Promise> - parameters: - - id: context - type: - description: The bot context. - - id: message - type: - description: The command message the user types from Teams. - return: - description: >- - A `Promise` representing an activity or text to send as the command - response. - - Or no return value if developers want to send the response activity by - themselves in this method. - type: >- - Promise<string | void | Partial<>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotSsoCommandHandler.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotSsoCommandHandler.yml deleted file mode 100644 index 596d6b8d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotSsoCommandHandler.yml +++ /dev/null @@ -1,63 +0,0 @@ -### YamlMime:TSType -name: TeamsFxBotSsoCommandHandler -uid: '@microsoft/teamsfx.TeamsFxBotSsoCommandHandler' -package: '@microsoft/teamsfx' -summary: >- - Interface for a command handler that can process sso command to a TeamsFx bot - and return a response. -fullName: TeamsFxBotSsoCommandHandler -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: triggerPatterns - uid: '@microsoft/teamsfx.TeamsFxBotSsoCommandHandler.triggerPatterns' - package: '@microsoft/teamsfx' - summary: The string or regular expression patterns that can trigger this handler. - fullName: triggerPatterns - remarks: '' - isDeprecated: false - syntax: - content: 'triggerPatterns: TriggerPatterns' - return: - description: '' - type: -methods: - - name: >- - handleCommandReceived(TurnContext, CommandMessage, - TeamsBotSsoPromptTokenResponse) - uid: '@microsoft/teamsfx.TeamsFxBotSsoCommandHandler.handleCommandReceived' - package: '@microsoft/teamsfx' - summary: Handles a bot command received activity. - remarks: '' - isDeprecated: false - syntax: - content: >- - function handleCommandReceived(context: TurnContext, message: - CommandMessage, tokenResponse: TeamsBotSsoPromptTokenResponse): - Promise> - parameters: - - id: context - type: - description: The bot context. - - id: message - type: - description: The command message the user types from Teams. - - id: tokenResponse - type: - description: >- - The tokenResponse which contains sso token that can be used to - exchange access token for the bot. - return: - description: >- - A `Promise` representing an activity or text to send as the command - response. - - Or no return value if developers want to send the response activity by - themselves in this method. - type: >- - Promise<string | void | Partial<>> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredential.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredential.yml deleted file mode 100644 index 5e35953e..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredential.yml +++ /dev/null @@ -1,99 +0,0 @@ -### YamlMime:TSType -name: TeamsUserCredential -uid: '@microsoft/teamsfx.TeamsUserCredential' -package: '@microsoft/teamsfx' -summary: >- - Represent Teams current user's identity, and it is used within Teams client - applications. -fullName: TeamsUserCredential -remarks: Can only be used within Teams. -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: class -constructors: - - name: TeamsUserCredential(TeamsUserCredentialAuthConfig) - uid: '@microsoft/teamsfx.TeamsUserCredential.constructor' - package: '@microsoft/teamsfx' - summary: Constructor of TeamsUserCredential. - remarks: Can only be used within Teams. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'new TeamsUserCredential(authConfig: TeamsUserCredentialAuthConfig)' - parameters: - - id: authConfig - type: - description: '' -methods: - - name: getToken(string | string[], GetTokenOptions) - uid: '@microsoft/teamsfx.TeamsUserCredential.getToken' - package: '@microsoft/teamsfx' - summary: Get access token from credential. - remarks: Can only be used within Teams. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function getToken(scopes: string | string[], options?: GetTokenOptions): - Promise - parameters: - - id: scopes - type: string | string[] - description: '' - - id: options - type: - description: '' - return: - description: '' - type: Promise<null | > - - name: getUserInfo(string[]) - uid: '@microsoft/teamsfx.TeamsUserCredential.getUserInfo' - package: '@microsoft/teamsfx' - summary: Get basic user info from SSO token - remarks: Can only be used within Teams. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function getUserInfo(resources?: string[]): Promise' - parameters: - - id: resources - type: string[] - description: The optional list of resources for full trust Teams apps. - return: - description: '' - type: Promise<> - - name: login(string | string[], string[]) - uid: '@microsoft/teamsfx.TeamsUserCredential.login' - package: '@microsoft/teamsfx' - summary: Popup login page to get user's access token with specific scopes. - remarks: Can only be used within Teams. - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function login(scopes: string | string[], resources?: string[]): - Promise - parameters: - - id: scopes - type: string | string[] - description: '' - - id: resources - type: string[] - description: The optional list of resources for full trust Teams apps. - return: - description: '' - type: Promise<void> diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredentialAuthConfig.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredentialAuthConfig.yml deleted file mode 100644 index e645b40d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredentialAuthConfig.yml +++ /dev/null @@ -1,18 +0,0 @@ -### YamlMime:TSTypeAlias -name: TeamsUserCredentialAuthConfig -uid: '@microsoft/teamsfx.TeamsUserCredentialAuthConfig' -package: '@microsoft/teamsfx' -summary: >- - Authentication configuration for TeamsUserCredential used in browser - environment -fullName: TeamsUserCredentialAuthConfig -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type TeamsUserCredentialAuthConfig = { - clientId: string - initiateLoginEndpoint: string - } diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TriggerPatterns.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/TriggerPatterns.yml deleted file mode 100644 index 140ea89d..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/TriggerPatterns.yml +++ /dev/null @@ -1,16 +0,0 @@ -### YamlMime:TSTypeAlias -name: TriggerPatterns -uid: '@microsoft/teamsfx.TriggerPatterns' -package: '@microsoft/teamsfx' -summary: >- - The trigger pattern used to trigger a - [TeamsFxBotCommandHandler](xref:@microsoft/teamsfx.TeamsFxBotCommandHandler) - instance. -fullName: TriggerPatterns -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -syntax: | - type TriggerPatterns = string | RegExp | (string | RegExp)[] diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/UserInfo.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/UserInfo.yml deleted file mode 100644 index 0b4489ef..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/UserInfo.yml +++ /dev/null @@ -1,61 +0,0 @@ -### YamlMime:TSType -name: UserInfo -uid: '@microsoft/teamsfx.UserInfo' -package: '@microsoft/teamsfx' -summary: UserInfo with user displayName, objectId and preferredUserName. -fullName: UserInfo -remarks: '' -isDeprecated: true -customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 Agents - SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) instead. -type: interface -properties: - - name: displayName - uid: '@microsoft/teamsfx.UserInfo.displayName' - package: '@microsoft/teamsfx' - summary: User Display Name. - fullName: displayName - remarks: '' - isDeprecated: false - syntax: - content: 'displayName: string' - return: - description: '' - type: string - - name: objectId - uid: '@microsoft/teamsfx.UserInfo.objectId' - package: '@microsoft/teamsfx' - summary: User unique reference within the Azure Active Directory domain. - fullName: objectId - remarks: '' - isDeprecated: false - syntax: - content: 'objectId: string' - return: - description: '' - type: string - - name: preferredUserName - uid: '@microsoft/teamsfx.UserInfo.preferredUserName' - package: '@microsoft/teamsfx' - summary: Usually be the email address. - fullName: preferredUserName - remarks: '' - isDeprecated: false - syntax: - content: 'preferredUserName: string' - return: - description: '' - type: string - - name: tenantId - uid: '@microsoft/teamsfx.UserInfo.tenantId' - package: '@microsoft/teamsfx' - summary: User tenant ID. - fullName: tenantId - remarks: '' - isDeprecated: false - syntax: - content: 'tenantId: string' - return: - description: '' - type: string diff --git a/nodejs/docs-ref-autogen/@microsoft/teamsfx/index.yml b/nodejs/docs-ref-autogen/@microsoft/teamsfx/index.yml deleted file mode 100644 index ecd74bf3..00000000 --- a/nodejs/docs-ref-autogen/@microsoft/teamsfx/index.yml +++ /dev/null @@ -1,348 +0,0 @@ -### YamlMime:TSPackage -uid: '@microsoft/teamsfx' -name: '@microsoft/teamsfx' -summary: '' -type: package -classes: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation' - - '@microsoft/teamsfx.ApiKeyProvider' - - '@microsoft/teamsfx.AppCredential' - - '@microsoft/teamsfx.BasicAuthProvider' - - '@microsoft/teamsfx.BearerTokenAuthProvider' - - '@microsoft/teamsfx.BotSsoExecutionDialog' - - '@microsoft/teamsfx.CertificateAuthProvider' - - '@microsoft/teamsfx.ErrorWithCode' - - '@microsoft/teamsfx.InvokeResponseFactory' - - '@microsoft/teamsfx.MessageBuilder' - - '@microsoft/teamsfx.OnBehalfOfUserCredential' - - '@microsoft/teamsfx.TeamsBotSsoPrompt' - - '@microsoft/teamsfx.TeamsUserCredential' -interfaces: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions' - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions' - - '@microsoft/teamsfx.AuthProvider' - - '@microsoft/teamsfx.AxiosInstance' - - '@microsoft/teamsfx.BotSsoConfig' - - '@microsoft/teamsfx.BotSsoExecutionActivityHandler' - - '@microsoft/teamsfx.CardActionOptions' - - '@microsoft/teamsfx.CommandMessage' - - '@microsoft/teamsfx.CommandOptions' - - '@microsoft/teamsfx.ConversationReferenceStore' - - '@microsoft/teamsfx.ConversationReferenceStoreAddOptions' - - '@microsoft/teamsfx.GetTeamsUserTokenOptions' - - '@microsoft/teamsfx.Logger' - - '@microsoft/teamsfx.MessageExtensionTokenResponse' - - '@microsoft/teamsfx.NotificationTarget' - - '@microsoft/teamsfx.PagedData' - - '@microsoft/teamsfx.TeamsBotSsoPromptSettings' - - '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse' - - '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler' - - '@microsoft/teamsfx.TeamsFxBotCommandHandler' - - '@microsoft/teamsfx.TeamsFxBotSsoCommandHandler' - - '@microsoft/teamsfx.UserInfo' -enums: - - '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope' - - '@microsoft/teamsfx.AdaptiveCardResponse' - - '@microsoft/teamsfx.ApiKeyLocation' - - '@microsoft/teamsfx.ErrorCode' - - '@microsoft/teamsfx.InvokeResponseErrorCode' - - '@microsoft/teamsfx.LogLevel' - - '@microsoft/teamsfx.NotificationTargetType' -typeAliases: - - '@microsoft/teamsfx.AppCredentialAuthConfig' - - '@microsoft/teamsfx.BotSsoExecutionDialogHandler' - - '@microsoft/teamsfx.LogFunction' - - '@microsoft/teamsfx.OnBehalfOfCredentialAuthConfig' - - '@microsoft/teamsfx.TeamsUserCredentialAuthConfig' - - '@microsoft/teamsfx.TriggerPatterns' -functions: - - name: createApiClient(string, AuthProvider) - uid: '@microsoft/teamsfx.createApiClient' - package: '@microsoft/teamsfx' - summary: >+ - Initializes new Axios instance with specific auth provider - - - **Example** - - - ```typescript - - const client = createApiClient("https://my-api-endpoint-base-url", new - BasicAuthProvider("xxx","xxx")); - - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function createApiClient(apiEndpoint: string, authProvider: - AuthProvider): AxiosInstance - parameters: - - id: apiEndpoint - type: string - description: Base url of the API - - id: authProvider - type: - description: Auth provider that injects authentication info to each request - return: - description: axios instance configured with specfic auth provider - type: - - name: >- - createPemCertOption(string | Buffer, string | Buffer, { ca?: string | - Buffer, passphrase?: string }) - uid: '@microsoft/teamsfx.createPemCertOption' - package: '@microsoft/teamsfx' - summary: Helper to create SecureContextOptions from PEM format cert - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - * - syntax: - content: >- - function createPemCertOption(cert: string | Buffer, key: string | - Buffer, options?: { ca?: string | Buffer, passphrase?: string }): - SecureContextOptions - parameters: - - id: cert - type: string | Buffer - description: The cert chain in PEM format - - id: key - type: string | Buffer - description: The private key for the cert chain - - id: options - type: '{ ca?: string | Buffer, passphrase?: string }' - description: Optional settings when create the cert options. - return: - description: Instance of SecureContextOptions - type: SecureContextOptions - - name: 'createPfxCertOption(string | Buffer, { passphrase?: string })' - uid: '@microsoft/teamsfx.createPfxCertOption' - package: '@microsoft/teamsfx' - summary: Helper to create SecureContextOptions from PFX format cert - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - * - syntax: - content: >- - function createPfxCertOption(pfx: string | Buffer, options?: { - passphrase?: string }): SecureContextOptions - parameters: - - id: pfx - type: string | Buffer - description: The content of .pfx file - - id: options - type: '{ passphrase?: string }' - description: Optional settings when create the cert options. - return: - description: Instance of SecureContextOptions - type: SecureContextOptions - - name: getLogLevel() - uid: '@microsoft/teamsfx.getLogLevel' - package: '@microsoft/teamsfx' - summary: Get log level. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function getLogLevel(): LogLevel | undefined' - return: - description: Log level - type: | undefined - - name: >- - handleMessageExtensionLinkQueryWithSSO(TurnContext, - OnBehalfOfCredentialAuthConfig, string, string | string[], (token: - MessageExtensionTokenResponse) => Promise) - uid: '@microsoft/teamsfx.handleMessageExtensionLinkQueryWithSSO' - package: '@microsoft/teamsfx' - summary: Users execute link query in message extension with SSO or access token. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function handleMessageExtensionLinkQueryWithSSO(context: TurnContext, - config: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, - scopes: string | string[], logic: (token: MessageExtensionTokenResponse) - => Promise): Promise - parameters: - - id: context - type: - description: The context object for the current turn. - - id: config - type: - description: User custom the message extension authentication configuration. - - id: initiateLoginEndpoint - type: string - description: Login page for Teams to redirect to. - - id: scopes - type: string | string[] - description: The list of scopes for which the token will have access. - - id: logic - type: '(token: MessageExtensionTokenResponse) => Promise<any>' - description: >- - Business logic when executing the link query in message extension - with SSO or access token. - return: - description: >- - A MessageExtension Response for the activity. If the logic not return - any, return void instead. - type: >- - Promise<void | > - - name: >- - handleMessageExtensionQueryWithSSO(TurnContext, - OnBehalfOfCredentialAuthConfig, string, string | string[], (token: - MessageExtensionTokenResponse) => Promise) - uid: '@microsoft/teamsfx.handleMessageExtensionQueryWithSSO' - package: '@microsoft/teamsfx' - summary: Users execute query in message extension with SSO or access token. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: >- - function handleMessageExtensionQueryWithSSO(context: TurnContext, - config: OnBehalfOfCredentialAuthConfig, initiateLoginEndpoint: string, - scopes: string | string[], logic: (token: MessageExtensionTokenResponse) - => Promise): Promise - parameters: - - id: context - type: - description: The context object for the current turn. - - id: config - type: - description: User custom the message extension authentication configuration. - - id: initiateLoginEndpoint - type: string - description: Login page for Teams to redirect to. - - id: scopes - type: string | string[] - description: The list of scopes for which the token will have access. - - id: logic - type: '(token: MessageExtensionTokenResponse) => Promise<any>' - description: >- - Business logic when executing the query in message extension with - SSO or access token. - return: - description: >- - A MessageExtension Response for the activity. If the logic not return - any, return void instead. - type: >- - Promise<void | > - - name: setLogFunction(LogFunction) - uid: '@microsoft/teamsfx.setLogFunction' - package: '@microsoft/teamsfx' - summary: >+ - Set custom log function. Use the function if it's set. Priority is lower - than setLogger. - - - **Example** - - - ```typescript - - setLogFunction((level: LogLevel, message: string) => { - if (level === LogLevel.Error) { - console.log(message); - } - }); - - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function setLogFunction(logFunction?: LogFunction)' - parameters: - - id: logFunction - type: - description: >- - custom log function. If it's undefined, custom log function will be - cleared. - - name: setLogLevel(LogLevel) - uid: '@microsoft/teamsfx.setLogLevel' - package: '@microsoft/teamsfx' - summary: Update log level helper. - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function setLogLevel(level: LogLevel)' - parameters: - - id: level - type: - description: log level in configuration - - name: setLogger(Logger) - uid: '@microsoft/teamsfx.setLogger' - package: '@microsoft/teamsfx' - summary: >+ - Set custom logger. Use the output functions if it's set. Priority is - higher than setLogFunction. - - - **Example** - - - ```typescript - - setLogger({ - verbose: console.debug, - info: console.info, - warn: console.warn, - error: console.error, - }); - - ``` - - remarks: '' - isDeprecated: true - customDeprecatedMessage: >- - This package will be deprecated by 2026-07. Please use [Microsoft 365 - Agents SDK](https://www.npmjs.com/package/@microsoft/agents-hosting) - instead. - syntax: - content: 'function setLogger(logger?: Logger)' - parameters: - - id: logger - type: - description: custom logger. If it's undefined, custom logger will be cleared. diff --git a/nodejs/docs-ref-autogen/toc.yml b/nodejs/docs-ref-autogen/toc.yml index e6885c13..d62863a0 100644 --- a/nodejs/docs-ref-autogen/toc.yml +++ b/nodejs/docs-ref-autogen/toc.yml @@ -616,798 +616,6 @@ no-loc: - VolumeManager items: [] -- name: '@microsoft/teams-ai' - no-loc: - - '@microsoft/teams-ai' - items: - - name: Overview - uid: '@microsoft/teams-ai' - - uid: '@microsoft/teams-ai.ActionAugmentationSection' - name: ActionAugmentationSection - no-loc: - - ActionAugmentationSection - items: [] - - uid: '@microsoft/teams-ai.ActionHandler' - name: ActionHandler - no-loc: - - ActionHandler - items: [] - - uid: '@microsoft/teams-ai.ActionOutputMessage' - name: ActionOutputMessage - no-loc: - - ActionOutputMessage - items: [] - - uid: '@microsoft/teams-ai.ActionPlanner' - name: ActionPlanner - no-loc: - - ActionPlanner - items: [] - - uid: '@microsoft/teams-ai.ActionPlannerOptions' - name: ActionPlannerOptions - no-loc: - - ActionPlannerOptions - items: [] - - uid: '@microsoft/teams-ai.ActionPlannerPromptFactory' - name: ActionPlannerPromptFactory - no-loc: - - ActionPlannerPromptFactory - items: [] - - uid: '@microsoft/teams-ai.ActionResponseValidator' - name: ActionResponseValidator - no-loc: - - ActionResponseValidator - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCard' - name: AdaptiveCard - no-loc: - - AdaptiveCard - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCardActionExecuteResponseType' - name: AdaptiveCardActionExecuteResponseType - no-loc: - - AdaptiveCardActionExecuteResponseType - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCards' - name: AdaptiveCards - no-loc: - - AdaptiveCards - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCardSearchResult' - name: AdaptiveCardSearchResult - no-loc: - - AdaptiveCardSearchResult - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCardsOptions' - name: AdaptiveCardsOptions - no-loc: - - AdaptiveCardsOptions - items: [] - - uid: '@microsoft/teams-ai.AdaptiveCardsSearchParams' - name: AdaptiveCardsSearchParams - no-loc: - - AdaptiveCardsSearchParams - items: [] - - uid: '@microsoft/teams-ai.AI' - name: AI - no-loc: - - AI - items: [] - - uid: '@microsoft/teams-ai.AIOptions' - name: AIOptions - no-loc: - - AIOptions - items: [] - - uid: '@microsoft/teams-ai.Application' - name: Application - no-loc: - - Application - items: [] - - uid: '@microsoft/teams-ai.ApplicationBuilder' - name: ApplicationBuilder - no-loc: - - ApplicationBuilder - items: [] - - uid: '@microsoft/teams-ai.ApplicationOptions' - name: ApplicationOptions - no-loc: - - ApplicationOptions - items: [] - - uid: '@microsoft/teams-ai.AssistantMessage' - name: AssistantMessage - no-loc: - - AssistantMessage - items: [] - - uid: '@microsoft/teams-ai.Augmentation' - name: Augmentation - no-loc: - - Augmentation - items: [] - - uid: '@microsoft/teams-ai.AugmentationConfig' - name: AugmentationConfig - no-loc: - - AugmentationConfig - items: [] - - uid: '@microsoft/teams-ai.Authentication' - name: Authentication - no-loc: - - Authentication - items: [] - - uid: '@microsoft/teams-ai.AuthenticationManager' - name: AuthenticationManager - no-loc: - - AuthenticationManager - items: [] - - uid: '@microsoft/teams-ai.AuthenticationOptions' - name: AuthenticationOptions - no-loc: - - AuthenticationOptions - items: [] - - uid: '@microsoft/teams-ai.AuthenticatorResult' - name: AuthenticatorResult - no-loc: - - AuthenticatorResult - items: [] - - uid: '@microsoft/teams-ai.AuthError' - name: AuthError - no-loc: - - AuthError - items: [] - - uid: '@microsoft/teams-ai.AuthErrorReason' - name: AuthErrorReason - no-loc: - - AuthErrorReason - items: [] - - uid: '@microsoft/teams-ai.AzureContentSafetyModerator' - name: AzureContentSafetyModerator - no-loc: - - AzureContentSafetyModerator - items: [] - - uid: '@microsoft/teams-ai.AzureOpenAIEmbeddingsOptions' - name: AzureOpenAIEmbeddingsOptions - no-loc: - - AzureOpenAIEmbeddingsOptions - items: [] - - uid: '@microsoft/teams-ai.AzureOpenAIModelOptions' - name: AzureOpenAIModelOptions - no-loc: - - AzureOpenAIModelOptions - items: [] - - uid: '@microsoft/teams-ai.AzureOpenAIModeratorOptions' - name: AzureOpenAIModeratorOptions - no-loc: - - AzureOpenAIModeratorOptions - items: [] - - uid: '@microsoft/teams-ai.BaseOpenAIEmbeddingsOptions' - name: BaseOpenAIEmbeddingsOptions - no-loc: - - BaseOpenAIEmbeddingsOptions - items: [] - - uid: '@microsoft/teams-ai.BaseOpenAIModelOptions' - name: BaseOpenAIModelOptions - no-loc: - - BaseOpenAIModelOptions - items: [] - - uid: '@microsoft/teams-ai.ChatCompletionAction' - name: ChatCompletionAction - no-loc: - - ChatCompletionAction - items: [] - - uid: '@microsoft/teams-ai.Citation' - name: Citation - no-loc: - - Citation - items: [] - - uid: '@microsoft/teams-ai.ConfiguredAIOptions' - name: ConfiguredAIOptions - no-loc: - - ConfiguredAIOptions - items: [] - - uid: '@microsoft/teams-ai.ConfiguredLLMClientOptions' - name: ConfiguredLLMClientOptions - no-loc: - - ConfiguredLLMClientOptions - items: [] - - uid: '@microsoft/teams-ai.ConfiguredPromptManagerOptions' - name: ConfiguredPromptManagerOptions - no-loc: - - ConfiguredPromptManagerOptions - items: [] - - uid: '@microsoft/teams-ai.ConversationHistory' - name: ConversationHistory - no-loc: - - ConversationHistory - items: [] - - uid: '@microsoft/teams-ai.ConversationUpdateEvents' - name: ConversationUpdateEvents - no-loc: - - ConversationUpdateEvents - items: [] - - uid: '@microsoft/teams-ai.DataSource' - name: DataSource - no-loc: - - DataSource - items: [] - - uid: '@microsoft/teams-ai.DataSourceSection' - name: DataSourceSection - no-loc: - - DataSourceSection - items: [] - - uid: '@microsoft/teams-ai.DefaultAugmentation' - name: DefaultAugmentation - no-loc: - - DefaultAugmentation - items: [] - - uid: '@microsoft/teams-ai.DefaultConversationState' - name: DefaultConversationState - no-loc: - - DefaultConversationState - items: [] - - uid: '@microsoft/teams-ai.DefaultModerator' - name: DefaultModerator - no-loc: - - DefaultModerator - items: [] - - uid: '@microsoft/teams-ai.DefaultResponseValidator' - name: DefaultResponseValidator - no-loc: - - DefaultResponseValidator - items: [] - - uid: '@microsoft/teams-ai.DefaultTempState' - name: DefaultTempState - no-loc: - - DefaultTempState - items: [] - - uid: '@microsoft/teams-ai.DefaultUserState' - name: DefaultUserState - no-loc: - - DefaultUserState - items: [] - - uid: '@microsoft/teams-ai.EEMethodReturnType' - name: EEMethodReturnType - no-loc: - - EEMethodReturnType - items: [] - - uid: '@microsoft/teams-ai.EmitEventNames' - name: EmitEventNames - no-loc: - - EmitEventNames - items: [] - - uid: '@microsoft/teams-ai.EventNames' - name: EventNames - no-loc: - - EventNames - items: [] - - uid: '@microsoft/teams-ai.FeedbackLoopData' - name: FeedbackLoopData - no-loc: - - FeedbackLoopData - items: [] - - uid: '@microsoft/teams-ai.FunctionCall' - name: FunctionCall - no-loc: - - FunctionCall - items: [] - - uid: '@microsoft/teams-ai.FunctionCallMessage' - name: FunctionCallMessage - no-loc: - - FunctionCallMessage - items: [] - - uid: '@microsoft/teams-ai.FunctionResponseMessage' - name: FunctionResponseMessage - no-loc: - - FunctionResponseMessage - items: [] - - uid: '@microsoft/teams-ai.GPT3Tokenizer' - name: GPT3Tokenizer - no-loc: - - GPT3Tokenizer - items: [] - - uid: '@microsoft/teams-ai.GPTTokenizer' - name: GPTTokenizer - no-loc: - - GPTTokenizer - items: [] - - uid: '@microsoft/teams-ai.GroupSection' - name: GroupSection - no-loc: - - GroupSection - items: [] - - uid: '@microsoft/teams-ai.ImageContentPart' - name: ImageContentPart - no-loc: - - ImageContentPart - items: [] - - uid: '@microsoft/teams-ai.InnerEEMethodReturnType' - name: InnerEEMethodReturnType - no-loc: - - InnerEEMethodReturnType - items: [] - - uid: '@microsoft/teams-ai.InputFile' - name: InputFile - no-loc: - - InputFile - items: [] - - uid: '@microsoft/teams-ai.InputFileDownloader' - name: InputFileDownloader - no-loc: - - InputFileDownloader - items: [] - - uid: '@microsoft/teams-ai.JSONResponseValidator' - name: JSONResponseValidator - no-loc: - - JSONResponseValidator - items: [] - - uid: '@microsoft/teams-ai.LayoutEngine' - name: LayoutEngine - no-loc: - - LayoutEngine - items: [] - - uid: '@microsoft/teams-ai.ListenerType' - name: ListenerType - no-loc: - - ListenerType - items: [] - - uid: '@microsoft/teams-ai.LlamaModel' - name: LlamaModel - no-loc: - - LlamaModel - items: [] - - uid: '@microsoft/teams-ai.LlamaModelOptions' - name: LlamaModelOptions - no-loc: - - LlamaModelOptions - items: [] - - uid: '@microsoft/teams-ai.LLMClient' - name: LLMClient - no-loc: - - LLMClient - items: [] - - uid: '@microsoft/teams-ai.LLMClientOptions' - name: LLMClientOptions - no-loc: - - LLMClientOptions - items: [] - - uid: '@microsoft/teams-ai.MatchingKeys' - name: MatchingKeys - no-loc: - - MatchingKeys - items: [] - - uid: '@microsoft/teams-ai.Memory' - name: Memory - no-loc: - - Memory - items: [] - - uid: '@microsoft/teams-ai.MemoryFork' - name: MemoryFork - no-loc: - - MemoryFork - items: [] - - uid: '@microsoft/teams-ai.Message' - name: Message - no-loc: - - Message - items: [] - - uid: '@microsoft/teams-ai.MessageContentParts' - name: MessageContentParts - no-loc: - - MessageContentParts - items: [] - - uid: '@microsoft/teams-ai.MessageContext' - name: MessageContext - no-loc: - - MessageContext - items: [] - - uid: '@microsoft/teams-ai.MessageExtensions' - name: MessageExtensions - no-loc: - - MessageExtensions - items: [] - - uid: '@microsoft/teams-ai.MessageExtensionsInvokeNames' - name: MessageExtensionsInvokeNames - no-loc: - - MessageExtensionsInvokeNames - items: [] - - uid: '@microsoft/teams-ai.MessageReactionEvents' - name: MessageReactionEvents - no-loc: - - MessageReactionEvents - items: [] - - uid: '@microsoft/teams-ai.ModerationSeverity' - name: ModerationSeverity - no-loc: - - ModerationSeverity - items: [] - - uid: '@microsoft/teams-ai.Moderator' - name: Moderator - no-loc: - - Moderator - items: [] - - uid: '@microsoft/teams-ai.MonologueAugmentation' - name: MonologueAugmentation - no-loc: - - MonologueAugmentation - items: [] - - uid: '@microsoft/teams-ai.NoUndefined' - name: NoUndefined - no-loc: - - NoUndefined - items: [] - - uid: '@microsoft/teams-ai.OAuthSettings' - name: OAuthSettings - no-loc: - - OAuthSettings - items: [] - - uid: '@microsoft/teams-ai.OnEventNames' - name: OnEventNames - no-loc: - - OnEventNames - items: [] - - uid: '@microsoft/teams-ai.OpenAIEmbeddings' - name: OpenAIEmbeddings - no-loc: - - OpenAIEmbeddings - items: [] - - uid: '@microsoft/teams-ai.OpenAIEmbeddingsOptions' - name: OpenAIEmbeddingsOptions - no-loc: - - OpenAIEmbeddingsOptions - items: [] - - uid: '@microsoft/teams-ai.OpenAILikeEmbeddingsOptions' - name: OpenAILikeEmbeddingsOptions - no-loc: - - OpenAILikeEmbeddingsOptions - items: [] - - uid: '@microsoft/teams-ai.OpenAIModel' - name: OpenAIModel - no-loc: - - OpenAIModel - items: [] - - uid: '@microsoft/teams-ai.OpenAIModelOptions' - name: OpenAIModelOptions - no-loc: - - OpenAIModelOptions - items: [] - - uid: '@microsoft/teams-ai.OpenAIModerator' - name: OpenAIModerator - no-loc: - - OpenAIModerator - items: [] - - uid: '@microsoft/teams-ai.OpenAIModeratorOptions' - name: OpenAIModeratorOptions - no-loc: - - OpenAIModeratorOptions - items: [] - - uid: '@microsoft/teams-ai.OverriddenKeys' - name: OverriddenKeys - no-loc: - - OverriddenKeys - items: [] - - uid: '@microsoft/teams-ai.OverriddenMethods' - name: OverriddenMethods - no-loc: - - OverriddenMethods - items: [] - - uid: '@microsoft/teams-ai.Plan' - name: Plan - no-loc: - - Plan - items: [] - - uid: '@microsoft/teams-ai.Planner' - name: Planner - no-loc: - - Planner - items: [] - - uid: '@microsoft/teams-ai.PredictedCommand' - name: PredictedCommand - no-loc: - - PredictedCommand - items: [] - - uid: '@microsoft/teams-ai.PredictedDoCommand' - name: PredictedDoCommand - no-loc: - - PredictedDoCommand - items: [] - - uid: '@microsoft/teams-ai.PredictedDoCommandAndHandler' - name: PredictedDoCommandAndHandler - no-loc: - - PredictedDoCommandAndHandler - items: [] - - uid: '@microsoft/teams-ai.PredictedSayCommand' - name: PredictedSayCommand - no-loc: - - PredictedSayCommand - items: [] - - name: preview - no-loc: - - preview - items: - - name: Overview - uid: '@microsoft/teams-ai.preview' - - uid: '@microsoft/teams-ai.preview.AssistantsPlanner' - name: AssistantsPlanner - no-loc: - - AssistantsPlanner - items: [] - - uid: '@microsoft/teams-ai.preview.AssistantsPlannerOptions' - name: AssistantsPlannerOptions - no-loc: - - AssistantsPlannerOptions - items: [] - - uid: '@microsoft/teams-ai.Prompt' - name: Prompt - no-loc: - - Prompt - items: [] - - uid: '@microsoft/teams-ai.PromptChunk' - name: PromptChunk - no-loc: - - PromptChunk - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModel' - name: PromptCompletionModel - no-loc: - - PromptCompletionModel - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModelBeforeCompletionEvent' - name: PromptCompletionModelBeforeCompletionEvent - no-loc: - - PromptCompletionModelBeforeCompletionEvent - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModelChunkReceivedEvent' - name: PromptCompletionModelChunkReceivedEvent - no-loc: - - PromptCompletionModelChunkReceivedEvent - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModelEmitter' - name: PromptCompletionModelEmitter - no-loc: - - PromptCompletionModelEmitter - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModelEvents' - name: PromptCompletionModelEvents - no-loc: - - PromptCompletionModelEvents - items: [] - - uid: '@microsoft/teams-ai.PromptCompletionModelResponseReceivedEvent' - name: PromptCompletionModelResponseReceivedEvent - no-loc: - - PromptCompletionModelResponseReceivedEvent - items: [] - - uid: '@microsoft/teams-ai.PromptFunction' - name: PromptFunction - no-loc: - - PromptFunction - items: [] - - uid: '@microsoft/teams-ai.PromptFunctions' - name: PromptFunctions - no-loc: - - PromptFunctions - items: [] - - uid: '@microsoft/teams-ai.PromptManager' - name: PromptManager - no-loc: - - PromptManager - items: [] - - uid: '@microsoft/teams-ai.PromptManagerOptions' - name: PromptManagerOptions - no-loc: - - PromptManagerOptions - items: [] - - uid: '@microsoft/teams-ai.PromptResponseValidator' - name: PromptResponseValidator - no-loc: - - PromptResponseValidator - items: [] - - uid: '@microsoft/teams-ai.PromptSection' - name: PromptSection - no-loc: - - PromptSection - items: [] - - uid: '@microsoft/teams-ai.PromptSectionBase' - name: PromptSectionBase - no-loc: - - PromptSectionBase - items: [] - - uid: '@microsoft/teams-ai.PromptTemplate' - name: PromptTemplate - no-loc: - - PromptTemplate - items: [] - - uid: '@microsoft/teams-ai.PromptTemplateConfig' - name: PromptTemplateConfig - no-loc: - - PromptTemplateConfig - items: [] - - uid: '@microsoft/teams-ai.Query' - name: Query - no-loc: - - Query - items: [] - - uid: '@microsoft/teams-ai.RenderedPromptSection' - name: RenderedPromptSection - no-loc: - - RenderedPromptSection - items: [] - - uid: '@microsoft/teams-ai.ReturnTypeOfMethod' - name: ReturnTypeOfMethod - no-loc: - - ReturnTypeOfMethod - items: [] - - uid: '@microsoft/teams-ai.ReturnTypeOfMethodIfExists' - name: ReturnTypeOfMethodIfExists - no-loc: - - ReturnTypeOfMethodIfExists - items: [] - - uid: '@microsoft/teams-ai.RouteHandler' - name: RouteHandler - no-loc: - - RouteHandler - items: [] - - uid: '@microsoft/teams-ai.RouteSelector' - name: RouteSelector - no-loc: - - RouteSelector - items: [] - - uid: '@microsoft/teams-ai.Selector' - name: Selector - no-loc: - - Selector - items: [] - - uid: '@microsoft/teams-ai.SequenceAugmentation' - name: SequenceAugmentation - no-loc: - - SequenceAugmentation - items: [] - - uid: '@microsoft/teams-ai.SignInResponse' - name: SignInResponse - no-loc: - - SignInResponse - items: [] - - uid: '@microsoft/teams-ai.SignInStatus' - name: SignInStatus - no-loc: - - SignInStatus - items: [] - - uid: '@microsoft/teams-ai.StreamingResponse' - name: StreamingResponse - no-loc: - - StreamingResponse - items: [] - - uid: '@microsoft/teams-ai.StrictBroadcast' - name: StrictBroadcast - no-loc: - - StrictBroadcast - items: [] - - uid: '@microsoft/teams-ai.StrictEventEmitter' - name: StrictEventEmitter - no-loc: - - StrictEventEmitter - items: [] - - uid: '@microsoft/teams-ai.SystemMessage' - name: SystemMessage - no-loc: - - SystemMessage - items: [] - - uid: '@microsoft/teams-ai.TaskModuleInvokeNames' - name: TaskModuleInvokeNames - no-loc: - - TaskModuleInvokeNames - items: [] - - uid: '@microsoft/teams-ai.TaskModules' - name: TaskModules - no-loc: - - TaskModules - items: [] - - uid: '@microsoft/teams-ai.TaskModulesOptions' - name: TaskModulesOptions - no-loc: - - TaskModulesOptions - items: [] - - uid: '@microsoft/teams-ai.TeamsAdapter' - name: TeamsAdapter - no-loc: - - TeamsAdapter - items: [] - - uid: '@microsoft/teams-ai.TeamsAttachmentDownloader' - name: TeamsAttachmentDownloader - no-loc: - - TeamsAttachmentDownloader - items: [] - - uid: '@microsoft/teams-ai.TeamsAttachmentDownloaderOptions' - name: TeamsAttachmentDownloaderOptions - no-loc: - - TeamsAttachmentDownloaderOptions - items: [] - - uid: '@microsoft/teams-ai.TeamsMessageEvents' - name: TeamsMessageEvents - no-loc: - - TeamsMessageEvents - items: [] - - uid: '@microsoft/teams-ai.TemplateSection' - name: TemplateSection - no-loc: - - TemplateSection - items: [] - - uid: '@microsoft/teams-ai.TestModel' - name: TestModel - no-loc: - - TestModel - items: [] - - uid: '@microsoft/teams-ai.TextContentPart' - name: TextContentPart - no-loc: - - TextContentPart - items: [] - - uid: '@microsoft/teams-ai.TextDataSource' - name: TextDataSource - no-loc: - - TextDataSource - items: [] - - uid: '@microsoft/teams-ai.TextSection' - name: TextSection - no-loc: - - TextSection - items: [] - - uid: '@microsoft/teams-ai.Tokenizer' - name: Tokenizer - no-loc: - - Tokenizer - items: [] - - uid: '@microsoft/teams-ai.ToolsAugmentation' - name: ToolsAugmentation - no-loc: - - ToolsAugmentation - items: [] - - uid: '@microsoft/teams-ai.TurnEvents' - name: TurnEvents - no-loc: - - TurnEvents - items: [] - - uid: '@microsoft/teams-ai.TurnState' - name: TurnState - no-loc: - - TurnState - items: [] - - uid: '@microsoft/teams-ai.TurnStateEntry' - name: TurnStateEntry - no-loc: - - TurnStateEntry - items: [] - - uid: '@microsoft/teams-ai.TypeRecord' - name: TypeRecord - no-loc: - - TypeRecord - items: [] - - uid: '@microsoft/teams-ai.UserInputMessage' - name: UserInputMessage - no-loc: - - UserInputMessage - items: [] - - uid: '@microsoft/teams-ai.UserMessage' - name: UserMessage - no-loc: - - UserMessage - items: [] - - uid: '@microsoft/teams-ai.Utilities' - name: Utilities - no-loc: - - Utilities - items: [] - - uid: '@microsoft/teams-ai.ValidatedChatCompletionAction' - name: ValidatedChatCompletionAction - no-loc: - - ValidatedChatCompletionAction - items: [] - - uid: '@microsoft/teams-ai.Validation' - name: Validation - no-loc: - - Validation - items: [] - - uid: '@microsoft/teams-ai.VoidKeys' - name: VoidKeys - no-loc: - - VoidKeys - items: [] - name: '@microsoft/teams-js' no-loc: - '@microsoft/teams-js' @@ -2908,306 +2116,3 @@ no-loc: - webStorage items: [] -- name: '@microsoft/teamsfx' - no-loc: - - '@microsoft/teamsfx' - items: - - name: Overview - uid: '@microsoft/teamsfx' - - uid: '@microsoft/teamsfx.AdaptiveCardResponse' - name: AdaptiveCardResponse - no-loc: - - AdaptiveCardResponse - items: [] - - name: AgentBuilderCloudAdapter - no-loc: - - AgentBuilderCloudAdapter - items: - - name: Overview - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter' - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.BotSsoExecutionDialog' - name: BotSsoExecutionDialog - no-loc: - - BotSsoExecutionDialog - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CardActionBot' - name: CardActionBot - no-loc: - - CardActionBot - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Channel' - name: Channel - no-loc: - - Channel - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.CommandBot' - name: CommandBot - no-loc: - - CommandBot - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationBot' - name: ConversationBot - no-loc: - - ConversationBot - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.ConversationOptions' - name: ConversationOptions - no-loc: - - ConversationOptions - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.Member' - name: Member - no-loc: - - Member - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationBot' - name: NotificationBot - no-loc: - - NotificationBot - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.NotificationOptions' - name: NotificationOptions - no-loc: - - NotificationOptions - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.SearchScope' - name: SearchScope - no-loc: - - SearchScope - items: [] - - uid: '@microsoft/teamsfx.AgentBuilderCloudAdapter.TeamsBotInstallation' - name: TeamsBotInstallation - no-loc: - - TeamsBotInstallation - items: [] - - uid: '@microsoft/teamsfx.ApiKeyLocation' - name: ApiKeyLocation - no-loc: - - ApiKeyLocation - items: [] - - uid: '@microsoft/teamsfx.ApiKeyProvider' - name: ApiKeyProvider - no-loc: - - ApiKeyProvider - items: [] - - uid: '@microsoft/teamsfx.AppCredential' - name: AppCredential - no-loc: - - AppCredential - items: [] - - uid: '@microsoft/teamsfx.AppCredentialAuthConfig' - name: AppCredentialAuthConfig - no-loc: - - AppCredentialAuthConfig - items: [] - - uid: '@microsoft/teamsfx.AuthProvider' - name: AuthProvider - no-loc: - - AuthProvider - items: [] - - uid: '@microsoft/teamsfx.AxiosInstance' - name: AxiosInstance - no-loc: - - AxiosInstance - items: [] - - uid: '@microsoft/teamsfx.BasicAuthProvider' - name: BasicAuthProvider - no-loc: - - BasicAuthProvider - items: [] - - uid: '@microsoft/teamsfx.BearerTokenAuthProvider' - name: BearerTokenAuthProvider - no-loc: - - BearerTokenAuthProvider - items: [] - - uid: '@microsoft/teamsfx.BotSsoConfig' - name: BotSsoConfig - no-loc: - - BotSsoConfig - items: [] - - uid: '@microsoft/teamsfx.BotSsoExecutionActivityHandler' - name: BotSsoExecutionActivityHandler - no-loc: - - BotSsoExecutionActivityHandler - items: [] - - uid: '@microsoft/teamsfx.BotSsoExecutionDialog' - name: BotSsoExecutionDialog - no-loc: - - BotSsoExecutionDialog - items: [] - - uid: '@microsoft/teamsfx.BotSsoExecutionDialogHandler' - name: BotSsoExecutionDialogHandler - no-loc: - - BotSsoExecutionDialogHandler - items: [] - - uid: '@microsoft/teamsfx.CardActionOptions' - name: CardActionOptions - no-loc: - - CardActionOptions - items: [] - - uid: '@microsoft/teamsfx.CertificateAuthProvider' - name: CertificateAuthProvider - no-loc: - - CertificateAuthProvider - items: [] - - uid: '@microsoft/teamsfx.CommandMessage' - name: CommandMessage - no-loc: - - CommandMessage - items: [] - - uid: '@microsoft/teamsfx.CommandOptions' - name: CommandOptions - no-loc: - - CommandOptions - items: [] - - uid: '@microsoft/teamsfx.ConversationReferenceStore' - name: ConversationReferenceStore - no-loc: - - ConversationReferenceStore - items: [] - - uid: '@microsoft/teamsfx.ConversationReferenceStoreAddOptions' - name: ConversationReferenceStoreAddOptions - no-loc: - - ConversationReferenceStoreAddOptions - items: [] - - uid: '@microsoft/teamsfx.ErrorCode' - name: ErrorCode - no-loc: - - ErrorCode - items: [] - - uid: '@microsoft/teamsfx.ErrorWithCode' - name: ErrorWithCode - no-loc: - - ErrorWithCode - items: [] - - uid: '@microsoft/teamsfx.GetTeamsUserTokenOptions' - name: GetTeamsUserTokenOptions - no-loc: - - GetTeamsUserTokenOptions - items: [] - - uid: '@microsoft/teamsfx.InvokeResponseErrorCode' - name: InvokeResponseErrorCode - no-loc: - - InvokeResponseErrorCode - items: [] - - uid: '@microsoft/teamsfx.InvokeResponseFactory' - name: InvokeResponseFactory - no-loc: - - InvokeResponseFactory - items: [] - - uid: '@microsoft/teamsfx.LogFunction' - name: LogFunction - no-loc: - - LogFunction - items: [] - - uid: '@microsoft/teamsfx.Logger' - name: Logger - no-loc: - - Logger - items: [] - - uid: '@microsoft/teamsfx.LogLevel' - name: LogLevel - no-loc: - - LogLevel - items: [] - - uid: '@microsoft/teamsfx.MessageBuilder' - name: MessageBuilder - no-loc: - - MessageBuilder - items: [] - - uid: '@microsoft/teamsfx.MessageExtensionTokenResponse' - name: MessageExtensionTokenResponse - no-loc: - - MessageExtensionTokenResponse - items: [] - - uid: '@microsoft/teamsfx.NotificationTarget' - name: NotificationTarget - no-loc: - - NotificationTarget - items: [] - - uid: '@microsoft/teamsfx.NotificationTargetType' - name: NotificationTargetType - no-loc: - - NotificationTargetType - items: [] - - uid: '@microsoft/teamsfx.OnBehalfOfCredentialAuthConfig' - name: OnBehalfOfCredentialAuthConfig - no-loc: - - OnBehalfOfCredentialAuthConfig - items: [] - - uid: '@microsoft/teamsfx.OnBehalfOfUserCredential' - name: OnBehalfOfUserCredential - no-loc: - - OnBehalfOfUserCredential - items: [] - - uid: '@microsoft/teamsfx.PagedData' - name: PagedData - no-loc: - - PagedData - items: [] - - uid: '@microsoft/teamsfx.TeamsBotSsoPrompt' - name: TeamsBotSsoPrompt - no-loc: - - TeamsBotSsoPrompt - items: [] - - uid: '@microsoft/teamsfx.TeamsBotSsoPromptSettings' - name: TeamsBotSsoPromptSettings - no-loc: - - TeamsBotSsoPromptSettings - items: [] - - uid: '@microsoft/teamsfx.TeamsBotSsoPromptTokenResponse' - name: TeamsBotSsoPromptTokenResponse - no-loc: - - TeamsBotSsoPromptTokenResponse - items: [] - - uid: '@microsoft/teamsfx.TeamsFxAdaptiveCardActionHandler' - name: TeamsFxAdaptiveCardActionHandler - no-loc: - - TeamsFxAdaptiveCardActionHandler - items: [] - - uid: '@microsoft/teamsfx.TeamsFxBotCommandHandler' - name: TeamsFxBotCommandHandler - no-loc: - - TeamsFxBotCommandHandler - items: [] - - uid: '@microsoft/teamsfx.TeamsFxBotSsoCommandHandler' - name: TeamsFxBotSsoCommandHandler - no-loc: - - TeamsFxBotSsoCommandHandler - items: [] - - uid: '@microsoft/teamsfx.TeamsUserCredential' - name: TeamsUserCredential - no-loc: - - TeamsUserCredential - items: [] - - uid: '@microsoft/teamsfx.TeamsUserCredentialAuthConfig' - name: TeamsUserCredentialAuthConfig - no-loc: - - TeamsUserCredentialAuthConfig - items: [] - - uid: '@microsoft/teamsfx.TriggerPatterns' - name: TriggerPatterns - no-loc: - - TriggerPatterns - items: [] - - uid: '@microsoft/teamsfx.UserInfo' - name: UserInfo - no-loc: - - UserInfo - items: [] -- name: '@microsoft/teamsfx-react' - items: - - name: Overview - uid: '@microsoft/teamsfx-react' - - uid: '@microsoft/teamsfx-react.BaseDashboard' - name: BaseDashboard - items: [] - - uid: '@microsoft/teamsfx-react.BaseWidget' - name: BaseWidget - items: [] - - uid: '@microsoft/teamsfx-react.IWidgetClassNames' - name: IWidgetClassNames - items: [] - - uid: '@microsoft/teamsfx-react.TeamsContextWithCredential' - name: TeamsContextWithCredential - items: [] From b230f9f79c44bf24dbdc89f51f52f8f9a89721e2 Mon Sep 17 00:00:00 2001 From: Saisang Cai Date: Tue, 21 Jul 2026 01:55:25 +0800 Subject: [PATCH 2/3] Update msteams-client.md to remove SDK entries Removed Teams AI and TeamsFx SDK entries from the overview table. --- nodejs/overview/msteams-client.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/nodejs/overview/msteams-client.md b/nodejs/overview/msteams-client.md index 39b3fe87..bdec6072 100644 --- a/nodejs/overview/msteams-client.md +++ b/nodejs/overview/msteams-client.md @@ -13,8 +13,7 @@ There are several libraries available to support various aspects of Teams app de |-|-|-| | **Live Share SDK** | Live Share enables collaborative app experiences | [Live Share](../docs-ref-autogen/%40microsoft/live-share/index.yml)

[Live Share canvas](../docs-ref-autogen/%40microsoft/live-share-canvas/index.yml)

[Live Share media](../docs-ref-autogen/%40microsoft/live-share-media/index.yml) | | **TeamsJS library** | Teams JavaScript client library enables you to create hosted experiences in Teams, Outlook, and the Microsoft 365 app | [TeamsJS ](../docs-ref-autogen/%40microsoft/teams-js/index.yml) | -| **Teams AI library** | Teams AI library is a Teams-centric interface for integrating GPT-based language models and user intent engines. | [Teams AI](../docs-ref-autogen/%40microsoft/teams-ai/index.yml) | -| **TeamsFx SDK** | TeamsFx helps to reduce tasks by using Microsoft Teams single sign-on (SSO) and accessing cloud resources down to single line statements with little configuration | [Teamsfx](../docs-ref-autogen/%40microsoft/teamsfx/index.yml) | + ## Microsoft Teams Live Share From 0c3f6791eccaa9c4cc818a1d4322618d7dd321c9 Mon Sep 17 00:00:00 2001 From: Saisang Cai Date: Tue, 21 Jul 2026 14:52:32 +0800 Subject: [PATCH 3/3] Redirection for removed packages (#278) * Add .openpublishing.redirection.json --- .openpublishing.redirection.json | 1104 ++++++++++++++++++++++++++++++ 1 file changed, 1104 insertions(+) create mode 100644 .openpublishing.redirection.json diff --git a/.openpublishing.redirection.json b/.openpublishing.redirection.json new file mode 100644 index 00000000..0a63aacf --- /dev/null +++ b/.openpublishing.redirection.json @@ -0,0 +1,1104 @@ +{ + "redirections": [ + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionAugmentationSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionOutputMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlanner.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionPlannerPromptFactory.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ActionResponseValidator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCard.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardActionExecuteResponseType.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCards.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardSearchResult.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AdaptiveCardsSearchParams.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AI.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AIOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Application.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationBuilder.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ApplicationOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AssistantMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Augmentation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AugmentationConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Authentication.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationManager.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticationOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthenticatorResult.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthError.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AuthErrorReason.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureContentSafetyModerator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIEmbeddingsOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModelOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/AzureOpenAIModeratorOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIEmbeddingsOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/BaseOpenAIModelOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ChatCompletionAction.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Citation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredAIOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredLLMClientOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConfiguredPromptManagerOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationHistory.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ConversationUpdateEvents.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSource.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DataSourceSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultAugmentation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultConversationState.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultModerator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultResponseValidator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultTempState.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/DefaultUserState.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/EEMethodReturnType.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/EmitEventNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/EventNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/FeedbackLoopData.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCall.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionCallMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/FunctionResponseMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPT3Tokenizer.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/GPTTokenizer.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/GroupSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ImageContentPart.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/index.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/InnerEEMethodReturnType.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFile.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/InputFileDownloader.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/JSONResponseValidator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/LayoutEngine.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ListenerType.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/LlamaModelOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClient.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/LLMClientOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MatchingKeys.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Memory.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MemoryFork.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Message.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContentParts.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageContext.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageExtensionsInvokeNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MessageReactionEvents.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ModerationSeverity.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Moderator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/MonologueAugmentation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/NoUndefined.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OAuthSettings.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OnEventNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddings.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIEmbeddingsOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAILikeEmbeddingsOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModelOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModerator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OpenAIModeratorOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenKeys.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/OverriddenMethods.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Plan.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Planner.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedCommand.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommand.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedDoCommandAndHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PredictedSayCommand.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlanner.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.AssistantsPlannerOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/preview.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Prompt.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptChunk.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelBeforeCompletionEvent.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelChunkReceivedEvent.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEmitter.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelEvents.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptCompletionModelResponseReceivedEvent.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunction.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptFunctions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManager.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptManagerOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptResponseValidator.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptSectionBase.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplate.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/PromptTemplateConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Query.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/RenderedPromptSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethod.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ReturnTypeOfMethodIfExists.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/RouteSelector.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Selector.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/SequenceAugmentation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInResponse.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/SignInStatus.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/StreamingResponse.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictBroadcast.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/StrictEventEmitter.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/SystemMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModuleInvokeNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModules.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TaskModulesOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAdapter.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloader.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsAttachmentDownloaderOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TeamsMessageEvents.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TemplateSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TestModel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextContentPart.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextDataSource.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TextSection.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Tokenizer.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ToolsAugmentation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnEvents.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnState.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TurnStateEntry.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/TypeRecord.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserInputMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/UserMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Utilities.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/ValidatedChatCompletionAction.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/Validation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teams-ai/VoidKeys.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AdaptiveCardResponse.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.BotSsoExecutionDialog.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CardActionBot.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Channel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.CommandBot.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationBot.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.ConversationOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.Member.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationBot.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.NotificationOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.SearchScope.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.TeamsBotInstallation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AgentBuilderCloudAdapter.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyLocation.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ApiKeyProvider.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredential.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AppCredentialAuthConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AuthProvider.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/AxiosInstance.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BasicAuthProvider.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BearerTokenAuthProvider.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionActivityHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialog.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/BotSsoExecutionDialogHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/CardActionOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/CertificateAuthProvider.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandMessage.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/CommandOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStore.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ConversationReferenceStoreAddOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorCode.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/ErrorWithCode.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/GetTeamsUserTokenOptions.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/index.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseErrorCode.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/InvokeResponseFactory.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogFunction.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/Logger.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/LogLevel.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageBuilder.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/MessageExtensionTokenResponse.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTarget.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/NotificationTargetType.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfCredentialAuthConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/OnBehalfOfUserCredential.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/PagedData.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPrompt.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptSettings.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsBotSsoPromptTokenResponse.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxAdaptiveCardActionHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotCommandHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsFxBotSsoCommandHandler.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredential.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TeamsUserCredentialAuthConfig.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/TriggerPatterns.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx/UserInfo.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseDashboard.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/BaseWidget.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/index.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/IWidgetClassNames.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + }, + { + "source_path_from_root": "/nodejs/docs-ref-autogen/@microsoft/teamsfx-react/TeamsContextWithCredential.yml", + "redirect_url": "https://learn.microsoft.com/microsoftteams/platform/overview", + "redirect_document_id": false + } + ] +}