VOOZH about

URL: https://pypi.org/project/microsoft-agents-storage-cosmos/

โ‡ฑ microsoft-agents-storage-cosmos ยท PyPI


Skip to main content

microsoft-agents-storage-cosmos 1.0.0

pip install microsoft-agents-storage-cosmos

Latest release

Released:

A Cosmos DB storage library for Microsoft Agents

Navigation

Verified details

These details have been verified by PyPI
Maintainers
๐Ÿ‘ Avatar for microsoft from gravatar.com
microsoft

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Microsoft Corporation License-Expression: MIT
  • Requires: Python >=3.10

Project description

Microsoft Agents Storage - Cosmos DB

๐Ÿ‘ PyPI version

Azure Cosmos DB storage integration for Microsoft 365 Agents SDK. This library provides enterprise-grade persistent storage for conversation state, user data, and custom agent information using Azure Cosmos DB's globally distributed, multi-model database service.

This library implements the storage interface for the Microsoft 365 Agents SDK using Azure Cosmos DB as the backend. It provides automatic partitioning, global distribution, and low-latency access to your agent data. Perfect for production deployments requiring high availability, scalability, and multi-region support.

What is this?

This library is part of the Microsoft 365 Agents SDK for Python - a comprehensive framework for building enterprise-grade conversational AI agents. The SDK enables developers to create intelligent agents that work across multiple platforms including Microsoft Teams, M365 Copilot, Copilot Studio, and web chat, with support for third-party integrations like Slack, Facebook Messenger, and Twilio.

Release Notes

Version Date Release Notes
1.0.0 2026-05-22 1.0.0 Release Notes
0.9.0 2026-04-15 0.9.0 Release Notes
0.8.0 2026-02-23 0.8.0 Release Notes
0.7.0 2026-01-21 0.7.0 Release Notes
0.6.1 2025-12-01 0.6.1 Release Notes
0.6.0 2025-11-18 0.6.0 Release Notes
0.5.0 2025-10-22 0.5.0 Release Notes

Packages Overview

We offer the following PyPI packages to create conversational experiences based on Agents:

Package Name PyPI Version Description
microsoft-agents-activity ๐Ÿ‘ PyPI
Types and validators implementing the Activity protocol spec.
microsoft-agents-hosting-core ๐Ÿ‘ PyPI
Core library for Microsoft Agents hosting.
microsoft-agents-hosting-aiohttp ๐Ÿ‘ PyPI
Configures aiohttp to run the Agent.
microsoft-agents-hosting-teams ๐Ÿ‘ PyPI
Provides classes to host an Agent for Teams.
microsoft-agents-storage-blob ๐Ÿ‘ PyPI
Extension to use Azure Blob as storage.
microsoft-agents-storage-cosmos ๐Ÿ‘ PyPI
Extension to use CosmosDB as storage.
microsoft-agents-authentication-msal ๐Ÿ‘ PyPI
MSAL-based authentication for Microsoft Agents.

Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio:

Package Name PyPI Version Description
microsoft-agents-copilotstudio-client ๐Ÿ‘ PyPI
Direct to Engine client to interact with Agents created in CopilotStudio

Why Cosmos DB?

  • ๐ŸŒ Global distribution with multi-region writes
  • โšก Single-digit millisecond latency
  • ๐Ÿ“ˆ Automatic and instant scalability
  • ๐Ÿ”„ Multiple consistency models
  • ๐Ÿ’ช 99.999% availability SLA

Installation

pipinstallmicrosoft-agents-storage-cosmos

Environment Setup

Local Development with Cosmos DB Emulator

Install and run the Azure Cosmos DB Emulator for local testing:

Download: Azure Cosmos DB Emulator

Best Practices

  1. Use Managed Identity in Production - Avoid storing auth keys in code or environment variables
  2. Initialize Once - Call storage.initialize() during app startup, not per request
  3. Batch Operations - Read/write multiple items together when possible
  4. Monitor RU Consumption - Use Azure Monitor to track Request Units usage
  5. Set Appropriate Throughput - Start with 400 RU/s, scale up based on metrics
  6. Use Session Consistency - Default consistency level for most scenarios
  7. Implement Retry Logic - Handle transient failures with exponential backoff
  8. Partition Wisely - Current implementation uses /id partitioning (automatic)
  9. Enable Diagnostics - Configure Azure diagnostic logs for troubleshooting
  10. Test with Emulator - Use local emulator for development and testing

Key Classes Reference

  • CosmosDBStorage - Main storage implementation using Azure Cosmos DB
  • CosmosDBStorageConfig - Configuration settings for connection and behavior
  • StoreItem - Base class for data models (inherit to create custom types)

Quick Links

Sample Applications

Name Description README
Quickstart Simplest agent Quickstart
Auto Sign In Simple OAuth agent using Graph and GitHub auto-signin
OBO Authorization OBO flow to access a Copilot Studio Agent obo-authorization
Semantic Kernel Integration A weather agent built with Semantic Kernel semantic-kernel-multiturn
Streaming Agent Streams OpenAI responses azure-ai-streaming
Copilot Studio Client Console app to consume a Copilot Studio Agent copilotstudio-client
Cards Agent Agent that uses rich cards to enhance conversation design cards

Project details

Verified details

These details have been verified by PyPI
Maintainers
๐Ÿ‘ Avatar for microsoft from gravatar.com
microsoft

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • Author: Microsoft Corporation License-Expression: MIT
  • Requires: Python >=3.10

Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

microsoft_agents_storage_cosmos-1.0.0.tar.gz (12.0 kB view details)

Uploaded Source

Built Distribution

Filter files by name, interpreter, ABI, and platform.

If you're not sure about the file name format, learn more about wheel file names.

Copy a direct link to the current filters

microsoft_agents_storage_cosmos-1.0.0-py3-none-any.whl (11.1 kB view details)

Uploaded Python 3

File details

Details for the file microsoft_agents_storage_cosmos-1.0.0.tar.gz.

File metadata

File hashes

Hashes for microsoft_agents_storage_cosmos-1.0.0.tar.gz
Algorithm Hash digest
SHA256 0532fdf46a59d3ff5e92820706d543c8c0cdd4f42c233a80d6873f1e84fe7429
MD5 c7560673ba8c71c569f9e9e6ac163488
BLAKE2b-256 1b90aeb5ee6bc776c936219d3037904122685894b28d68709c067fae9ed47226

See more details on using hashes here.

File details

Details for the file microsoft_agents_storage_cosmos-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for microsoft_agents_storage_cosmos-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40c8c15adc5a5b64d02eeb6b422bf55d2a90cba9e74f3e41e1f0c57bf0576e37
MD5 368cdc0fb17add267b4148d4c8c5ab05
BLAKE2b-256 b4ec675a3632d3e1e737eecedafdbc431f77b03514f6dd3d7c2ecb8ccbf76652

See more details on using hashes here.

Supported by

๐Ÿ‘ Image
AWS Cloud computing and Security Sponsor ๐Ÿ‘ Image
Datadog Monitoring ๐Ÿ‘ Image
Depot Continuous Integration ๐Ÿ‘ Image
Fastly CDN ๐Ÿ‘ Image
Google Download Analytics ๐Ÿ‘ Image
Pingdom Monitoring ๐Ÿ‘ Image
Sentry Error logging ๐Ÿ‘ Image
StatusPage Status page