core Package
Packages
| adapters | |
| inspection | |
| integration | |
| oauth | |
| skills | |
| streaming | |
| teams |
Modules
| about | |
| activity_handler | |
| adapter_extensions | |
| auto_save_state_middleware | |
| bot | |
| bot_adapter | |
| bot_assert | |
| bot_framework_adapter | |
| bot_state | |
| bot_state_set | |
| bot_telemetry_client | |
| card_factory | |
| channel_service_handler | |
| cloud_adapter_base | |
| cloud_channel_service_handler | |
| component_registration | |
| conversation_reference_extension | |
| conversation_state | |
| intent_score | |
| invoke_response | |
| memory_storage | |
| memory_transcript_store |
The memory transcript store stores transcripts in volatile memory. |
| message_factory | |
| middleware_set | |
| null_telemetry_client | |
| private_conversation_state | |
| property_manager | |
| queue_storage | |
| re_escape | |
| recognizer | |
| recognizer_result | |
| register_class_middleware | |
| serializer_helper | |
| show_typing_middleware | |
| state_property_accessor | |
| state_property_info | |
| storage | |
| telemetry_constants | |
| telemetry_logger_constants | |
| telemetry_logger_middleware |
Middleware Component for logging Activity messages. |
| transcript_logger |
Logs incoming and outgoing activities to a TranscriptStore.. |
| turn_context | |
| user_state |
Classes
| ActivityHandler |
Handles activities and should be subclassed. |
| AdapterExtensions | |
| AnonymousReceiveMiddleware | |
| AutoSaveStateMiddleware | |
| Bot |
Represents a bot that can operate on incoming activities. |
| BotActionNotImplementedError |
Raised when an action is not implemented |
| BotAdapter | |
| BotAssert | |
| BotFrameworkAdapter |
Defines an adapter to connect a bot to a service endpoint. Initializes a new instance of the BotFrameworkAdapter class. |
| BotFrameworkAdapterSettings |
Contains the settings used to initialize a BotFrameworkAdapter instance. the value os the MicrosoftAppPassword parameter in the config.py file. :type app_password: str :param channel_auth_tenant: The channel tenant to use in conversation :type channel_auth_tenant: str :param oauth_endpoint: :type oauth_endpoint: str :param open_id_metadata: :type open_id_metadata: str :param channel_provider: The channel provider :type channel_provider: <xref:botframework.connector.auth.ChannelProvider>. Defaults to SimpleChannelProvider if one isn't specified. :param auth_configuration: :type auth_configuration: <xref:botframework.connector.auth.AuthenticationConfiguration> :param credential_provider: Defaults to SimpleCredentialProvider if one isn't specified. :param app_credentials: Allows for a custom AppCredentials. Used, for example, for CertificateAppCredentials. |
| BotState |
Defines a state management object and automates the reading and writing of associated state properties to a storage layer. Initializes a new instance of the BotState class. |
| BotStateSet | |
| BotTelemetryClient | |
| CardFactory | |
| ChannelServiceHandler |
Initializes a new instance of the <see cref="ChannelServiceHandler"/> class, using a credential provider. |
| CloudAdapterBase | |
| CloudChannelServiceHandler | |
| ComponentRegistration | |
| ConversationState |
Defines a state management object for conversation state. Creates a ConversationState instance. Creates a new instance of the ConversationState class. :param storage: The storage containing the conversation state. :type storage: Storage |
| ExtendedUserTokenProvider | |
| IntentScore | |
| InvokeResponse |
Tuple class containing an HTTP Status Code and a JSON serializable object. The HTTP Status code is, in the invoke activity scenario, what will be set in the resulting POST. The Body of the resulting POST will be JSON serialized content. The body content is defined by the producer. The caller must know what the content is and deserialize as needed. Gets or sets the HTTP status and/or body code for the response :param status: The HTTP status code. :param body: The JSON serializable body content for the response. This object must be serializable by the core Python json routines. The caller is responsible for serializing more complex/nested objects into native classes (lists and dictionaries of strings are acceptable). |
| MemoryStorage | |
| MemoryTranscriptStore |
This provider is most useful for simulating production storage when running locally against the emulator or as part of a unit test. |
| MessageFactory |
A set of utility functions designed to assist with the formatting of the various message types a bot can return. |
| Middleware | |
| MiddlewareSet |
A set of Middleware plugins. The set itself is middleware so you can easily package up a set of middleware that can be composed into a bot with a single bot.use(mySet) call or even into another middleware set using set.use(mySet). |
| NullTelemetryClient | |
| PrivateConversationState | |
| QueueStorage |
A base class for enqueueing an Activity for later processing. |
| Recognizer | |
| RecognizerResult |
Contains recognition results generated by a recognizer. |
| RegisterClassMiddleware |
Middleware for adding an object to or registering a service with the current turn context. |
| ShowTypingMiddleware |
When added, this middleware will send typing activities back to the user when a Message activity is received to let them know that the bot has received the message and is working on the response. You can specify a delay before the first typing activity is sent and then a frequency, which determines how often another typing activity is sent. Typing activities will continue to be sent until your bot sends another message back to the user. Initializes the middleware. |
| StatePropertyAccessor | |
| StatePropertyInfo | |
| Storage | |
| StoreItem |
Object which is stored in Storage with an optional eTag. |
| TelemetryConstants |
Telemetry logger property names. |
| TelemetryLoggerConstants |
The Telemetry Logger Event names. |
| TelemetryLoggerMiddleware |
Middleware for logging incoming, outgoing, updated or deleted Activity messages. |
| TopIntent |
The top scoring intent and its score. Create new instance of TopIntent(intent, score) |
| TranscriptLogger |
Transcript logger stores activities for conversations for recall. |
| TranscriptLoggerMiddleware |
Logs incoming and outgoing activities to a TranscriptStore. |
| TurnContext |
Creates a new TurnContext instance. :param adapter_or_context: :param request: |
| UserState |
Reads and writes user state for your bot to storage. Creates a new UserState instance. :param storage: :param namespace: |
| UserTokenProvider |
Enums
| Severity |
Functions
calculate_change_hash
Utility function to calculate a change hash for a StoreItem. :param item: :return:
calculate_change_hash(item: StoreItem) -> str
Parameters
| Name | Description |
|---|---|
|
item
Required
|
|